BSD 4_3_Net_2 release

[unix-history] / usr / src / share / man / man5 / passwd.5

diff --git a/usr/src/share/man/man5/passwd.5 b/usr/src/share/man/man5/passwd.5
index 4171956..e46611b 100644 (file)
--- a/usr/src/share/man/man5/passwd.5
+++ b/usr/src/share/man/man5/passwd.5
@@ -1,109 +1,169 @@
-.\" Copyright (c) 1988 The Regents of the University of California.
+.\" Copyright (c) 1988, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)passwd.5    6.6 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH PASSWD 5  ""
-.AT 3
-.SH NAME
-passwd \- password files
-.SH DESCRIPTION
-.I Passwd
+.\"     @(#)passwd.5   6.7 (Berkeley) 4/29/91
+.\"
+.Dd April 29, 1991
+.Dt PASSWD 5
+.Os
+.Sh NAME
+.Nm passwd
+.Nd format of the password file
+.Sh DESCRIPTION
+The
+.Nm passwd

 files are files consisting of newline separated records, one per user,
 containing ten colon (``:'') separated fields.  These fields are as
 follows:
 files are files consisting of newline separated records, one per user,
 containing ten colon (``:'') separated fields.  These fields are as
 follows:

-.PP
-.RS
- name          user's login name
- password              user's \fIencrypted\fP password
- uid                   user's id
- gid                   user's login group id
- class         user's general classification (unused)
- change                password change time
- expire                account expiration time
- gecos         general information about the user
- home_dir              user's home directory
- shell         user's login shell
-.RE
-.PP
+.Pp
+.Bl -tag -width password -offset indent
+.It name
+User's login name.
+.It password
+User's
+.Em encrypted
+password.
+.It uid
+User's id.
+.It gid
+User's login group id.
+.It class
+User's general classification (unused).
+.It change
+Password change time.
+.It expire
+Account expiration time.
+.It gecos
+General information about the user.
+.It home_dir
+User's home directory.
+.It shell
+User's login shell.
+.El
+.Pp

 The
 The

-.I name
+.Ar name

 field is the login used to access the computer account, and the
 field is the login used to access the computer account, and the

-.I uid
+.Ar uid

 field is the number associated with it.  They should both be unique
 across the system (and often across a group of systems) since they
 control file access.
 field is the number associated with it.  They should both be unique
 across the system (and often across a group of systems) since they
 control file access.

-.PP
+.Pp

 While it is possible to have multiple entries with identical login names
 and/or identical user id's, it is usually a mistake to do so.  Routines
 that manipulate these files will often return only one of the multiple
 entries, and that one by random selection.
 While it is possible to have multiple entries with identical login names
 and/or identical user id's, it is usually a mistake to do so.  Routines
 that manipulate these files will often return only one of the multiple
 entries, and that one by random selection.

-.PP
+.Pp

 The login name must never begin with a hyphen (``-''); also, it is strongly
 suggested that neither upper-case characters or dots (``.'') be part
 of the name, as this tends to confuse mailers.  No field may contain a
 colon (``:'') as this has been used historically to separate the fields
 in the user database.
 The login name must never begin with a hyphen (``-''); also, it is strongly
 suggested that neither upper-case characters or dots (``.'') be part
 of the name, as this tends to confuse mailers.  No field may contain a
 colon (``:'') as this has been used historically to separate the fields
 in the user database.

-.PP
+.Pp

 The password field is the
 The password field is the

-.I encrypted
+.Em encrypted

 form of the password.
 If the
 form of the password.
 If the

-.I password
+.Ar password

 field is empty, no password will be required to gain access to the
 machine.  This is almost invariably a mistake.
 Because these files contain the encrypted user passwords, they should
 not be readable by anyone without appropriate privileges.
 field is empty, no password will be required to gain access to the
 machine.  This is almost invariably a mistake.
 Because these files contain the encrypted user passwords, they should
 not be readable by anyone without appropriate privileges.

-.PP
+.Pp

 The group field is the group that the user will be placed in upon login.
 Since this system supports multiple groups (see
 The group field is the group that the user will be placed in upon login.
 Since this system supports multiple groups (see

-.IR groups (1))
+.Xr groups 1 )

 this field currently has little special meaning.
 this field currently has little special meaning.

-.PP
+.Pp

 The
 The

-.I class
+.Ar class

 field is currently unused.  In the near future it will be a key to
 a
 field is currently unused.  In the near future it will be a key to
 a

-.IR termcap (5)
+.Xr termcap 5

 style database of user attributes.
 style database of user attributes.

-.PP
+.Pp

 The
 The

-.I change
-field is the number in seconds, GMT, from the epoch, until the
+.Ar change
+field is the number in seconds,
+.Dv GMT ,
+from the epoch, until the

 password for the account must be changed.
 This field may be left empty to turn off the password aging feature.
 password for the account must be changed.
 This field may be left empty to turn off the password aging feature.

-.PP
+.Pp

 The
 The

-.I expire
-field is the number in seconds, GMT, from the epoch, until the
+.Ar expire
+field is the number in seconds,
+.Dv GMT ,
+from the epoch, until the

 account expires.
 This field may be left empty to turn off the account aging feature.
 account expires.
 This field may be left empty to turn off the account aging feature.

-.PP
+.Pp

 The
 The

-.I gecos
+.Ar gecos

 field normally contains comma (``,'') separated subfields as follows:
 field normally contains comma (``,'') separated subfields as follows:

-.PP
-.RS
- name          user's full name
- office                user's office number
- wphone                user's work phone number
- hphone                user's home phone number
-.RE
-.PP
+.Pp
+.Bd -unfilled -offset indent
+name           user's full name
+office         user's office number
+wphone         user's work phone number
+hphone         user's home phone number
+.Ed
+.Pp

 This information is used by the
 This information is used by the

-.IR finger (1)
+.Xr finger 1

 program.
 program.

-.PP
-The user's home directory is the full UNIX path name where the user
+.Pp
+The user's home directory is the full
+.Tn UNIX
+path name where the user

 will be placed on login.
 will be placed on login.

-.PP
+.Pp

 The shell field is the command interpreter the user prefers.
 The shell field is the command interpreter the user prefers.

-If the
-.I shell
-field is empty, the Bourne shell (\fI/bin/sh\fP) is assumed.
-.SH "SEE ALSO"
-chpass(1), login(1), passwd(1), getpwent(3), mkpasswd(8), vipw(8) adduser(8)
-.SH BUGS
+If there is nothing in the
+.Ar shell
+field, the Bourne shell
+.Pq Pa /bin/sh
+is assumed.
+.Sh SEE ALSO
+.Xr chpass 1 ,
+.Xr login 1 ,
+.Xr passwd 1 ,
+.Xr getpwent 3 ,
+.Xr mkpasswd 8 ,
+.Xr vipw 8
+.Xr adduser 8
+.Sh BUGS

 User information should (and eventually will) be stored elsewhere.
 User information should (and eventually will) be stored elsewhere.

+.Sh HISTORY
+A
+.Nm
+file format appeared in
+.At v6 .