get the temporary file and fd handling right.

[unix-history] / usr / src / usr.bin / chpass / chpass.1

diff --git a/usr/src/usr.bin/chpass/chpass.1 b/usr/src/usr.bin/chpass/chpass.1
index 9288237..47e3c85 100644 (file)
--- a/usr/src/usr.bin/chpass/chpass.1
+++ b/usr/src/usr.bin/chpass/chpass.1
@@ -1,169 +1,200 @@
-.\" Copyright (c) 1988 The Regents of the University of California.
+.\" Copyright (c) 1988, 1990 The Regents of the University of California.

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

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.\"    @(#)chpass.1    5.7 (Berkeley) %G%
+.\"     @(#)chpass.1   5.10 (Berkeley) %G%

 .\"
 .\"

-.TH CHPASS 1 ""
-.UC 4
-.SH NAME
-chpass \- add or change user database information
-.SH SYNOPSIS
-chpass [ -a list ] [ -s shell ] [ user ]
-.SH DESCRIPTION
-.I Chpass
+.Dd 
+.Dt CHPASS 1
+.Os BSD 4.4
+.Sh NAME
+.Nm chpass
+.Nd add or change user database information
+.Sh SYNOPSIS
+chpass
+.Op Fl a Ar list
+.Op Fl s Ar shell
+.Op user
+.Sh DESCRIPTION
+.Nm Chpass

 allows editing of the user database information associated
 with
 allows editing of the user database information associated
 with

-.I user
+.Ar user

 or, by default, the current user.
 The information is formatted and supplied to an editor for changes.
 or, by default, the current user.
 The information is formatted and supplied to an editor for changes.

-The
-.I vi
-editor will be used unless the environmental variable EDITOR selects
-an alternate editor.
-When the editor terminates, the information is re-read and used to
-update the user database itself.
-Only the user, or the super-user, may edit the information associated
-with the user.
-.PP
+.Pp

 Only the information that the user is allowed to change is displayed.
 Only the information that the user is allowed to change is displayed.

-.PP
+.Pp
+The options are as follows:
+.Tw Ds
+.Tp Fl a
+The super-user is allowed to directly supply a user database
+entry, in the format specified by
+.Xr passwd 5 ,
+as an argument.
+This argument must be a colon (``:'') separated list of all the
+user database fields, although they may be empty.
+.Tp Fl s
+The
+.Fl s
+option attempts to change the user's shell to
+.Ar newsh .
+.Tp
+.Pp

 Possible display items are as follows:
 Possible display items are as follows:

-.PP
-.RS
- Login:                        user's login name
- Password:             user's encrypted password
- Uid:                  user's id
- Gid:                  user's login group id
- Change:                       password change time
- Expire:                       account expiration time
- Class:                        user's general classification
- Home Directory:       user's home directory
- Shell:                        user's login shell
- Full Name:            user's real name
- Location:             user's normal location
- Home Phone:           user's home phone
- Office Phone:         user's office phone
-.RE
-.PP
-.PP
+.Pp
+.Dw Home\ Directory:
+.Dp Login:
+user's login name
+.Dp Password:
+user's encrypted password
+.Dp Uid:
+user's id
+.Dp Gid:
+user's login group id
+.Dp Change:
+password change time
+.Dp Expire:
+account expiration time
+.Dp Class:
+user's general classification
+.Dp Home Directory:
+user's home directory
+.Dp Shell:
+user's login shell
+.Dp Full Name:
+user's real name
+.Dp Location:
+user's normal location
+.Dp Home Phone:
+user's home phone
+.Dp Office Phone:
+user's office phone
+.Dp
+.Pp

 The
 The

-.I login
+.Ar login

 field is the user name used to access the computer account.
 field is the user name used to access the computer account.

-.PP
+.Pp

 The
 The

-.I password
+.Ar password

 field contains the encrypted form of the user's password.
 field contains the encrypted form of the user's password.

-.PP
+.Pp

 The
 The

-.I uid
+.Ar uid

 field is the number associated with the
 field is the number associated with the

-.I login
+.Ar login

 field.
 Both of these fields should be unique across the system (and often
 across a group of systems) as they control file access.
 field.
 Both of these fields should be unique across the system (and often
 across a group of systems) as 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
 The

-.I group
+.Ar group

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

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

 this field currently has little special meaning.
 This field may be filled in with either a number or a group name (see
 this field currently has little special meaning.
 This field may be filled in with either a number or a group name (see

-.IR group (5)).
-.PP
+.Xr group 5 ) .
+.Pp

 The
 The

-.I change
+.Ar change

 field is the date by which the password must be changed.
 field is the date by which the password must be changed.

-.PP
+.Pp

 The
 The

-.I expire
+.Ar expire

 field is the date on which the account expires.
 field is the date on which the account expires.

-.PP
+.Pp

 Both the
 Both the

-.I change
+.Ar change

 and
 and

-.I expire
+.Ar expire

 fields should be entered in the form ``month day year'' where
 fields should be entered in the form ``month day year'' where

-.I month
+.Ar month

 is the month name (the first three characters are sufficient),
 is the month name (the first three characters are sufficient),

-.I day
+.Ar day

 is the day of the month, and
 is the day of the month, and

-.I year
+.Ar year

 is the year.
 is the year.

-.PP
+.bp

 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
-The user's home directory is the full UNIX path name where the user
+.Pp
+The user's
+.Ar home directory
+is the full UNIX path name where the user

 will be placed at login.
 will be placed at login.

-.PP
-The shell field is the command interpreter the user prefers.
+.Pp
+The
+.Ar shell
+field is the command interpreter the user prefers.

 If the
 If the

-.I shell
-field is empty, the Bourne shell (\fI/bin/sh\fP) is assumed.
+.Ar shell
+field is empty, the Bourne shell,
+.Pa /bin/sh ,
+is assumed.

 When altering a login shell, and not the super-user, the user
 may not change from a non-standard shell or to a non-standard
 shell.
 Non-standard is defined as a shell not found in
 When altering a login shell, and not the super-user, the user
 may not change from a non-standard shell or to a non-standard
 shell.
 Non-standard is defined as a shell not found in

-.IR /etc/shells .
-.PP
-The last four fields are for storing the user's full name, office
-location, and home and work telephone numbers.
-.PP
-The options are as follows:
-.TP
-.I -a
-The super-user is allowed to directly supply a user database
-entry, in the format specified by
-.IR passwd (5),
-as an argument.
-This argument must be a colon (``:'') separated list of all the
-user database fields, although they may be empty.
-.TP
-.I -s
-The
-.I -s
-option attempts to change the user's shell to
-.IR newsh .
-.PP
+.Pa /etc/shells .
+.Pp
+The last four fields are for storing the user's
+.Ar full name , office location ,
+and
+.Ar home
+and
+.Ar work telephone
+numbers.
+.Pp

 Once the information has been verified,
 Once the information has been verified,

-.I chpass
+.Nm chpass

 uses
 uses

-.IR mkpasswd (8)
-to update the user database.  This is run in the background, and,
-at very large sites could take several minutes.  Until this update
-is completed, the password file is unavailable for other updates
-and the new information will not be available to programs.
-.SH FILES
-.DT
-/etc/master.passwd             The user database
-/etc/shells                    The list of approved shells
-.RE
-.SH "SEE ALSO"
-login(1), finger(1), getusershell(3), passwd(5), mkpasswd(8), vipw(8)
-.br
+.Xr pwd_mkdb 8
+to update the user database.
+.Sh ENVIRONMENT
+The
+.Xr vi 1
+editor will be used unless the environment variable EDITOR is set to
+an alternate editor.
+When the editor terminates, the information is re-read and used to
+update the user database itself.
+Only the user, or the super-user, may edit the information associated
+with the user.
+.Sh FILES
+.Dw /etc/master.passwd
+.Di L
+.Dp Pa /etc/master.passwd
+The user database
+.Dp Pa /etc/passwd
+A Version 7 format password file
+.Dp Pa /etc/chpass.XXXXXX
+Temporary copy of the password file
+.Dp Pa /etc/shells
+The list of approved shells
+.Dp
+.Sh SEE ALSO
+.Xr login 1 ,
+.Xr finger 1 ,
+.Xr passwd 1 ,
+.Xr getusershell 3 ,
+.Xr passwd 5 ,
+.Xr pwd_mkdb 8 ,
+.Xr vipw 8
+.Pp

 Robert Morris and Ken Thompson,
 Robert Morris and Ken Thompson,

-.I UNIX password security
-.SH BUGS
+.Ar UNIX Password security
+.Sh HISTORY
+First release 4.3 Reno BSD.
+.Sh BUGS

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