Annotation of 43BSDReno/usr.bin/chpass/chpass.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1988, 1990 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)chpass.1   5.9 (Berkeley) 7/24/90
                     19: .\"
                     20: .Dd July 24, 1990
                     21: .Dt CHPASS 1
                     22: .Os BSD 4.4
                     23: .Sh NAME
                     24: .Nm chpass
                     25: .Nd add or change user database information
                     26: .Sh SYNOPSIS
                     27: chpass
                     28: .Op Fl a Ar list
                     29: .Op Fl s Ar shell
                     30: .Op user
                     31: .Sh DESCRIPTION
                     32: .Nm Chpass
                     33: allows editing of the user database information associated
                     34: with
                     35: .Ar user
                     36: or, by default, the current user.
                     37: The information is formatted and supplied to an editor for changes.
                     38: .Pp
                     39: Only the information that the user is allowed to change is displayed.
                     40: .Pp
                     41: The options are as follows:
                     42: .Tw Ds
                     43: .Tp Fl a
                     44: The super-user is allowed to directly supply a user database
                     45: entry, in the format specified by
                     46: .Xr passwd 5 ,
                     47: as an argument.
                     48: This argument must be a colon (``:'') separated list of all the
                     49: user database fields, although they may be empty.
                     50: .Tp Fl s
                     51: The
                     52: .Fl s
                     53: option attempts to change the user's shell to
                     54: .Ar newsh .
                     55: .Tp
                     56: .Pp
                     57: Possible display items are as follows:
                     58: .Pp
                     59: .Dw Home\ Directory:
                     60: .Dp Login:
                     61: user's login name
                     62: .Dp Password:
                     63: user's encrypted password
                     64: .Dp Uid:
                     65: user's id
                     66: .Dp Gid:
                     67: user's login group id
                     68: .Dp Change:
                     69: password change time
                     70: .Dp Expire:
                     71: account expiration time
                     72: .Dp Class:
                     73: user's general classification
                     74: .Dp Home Directory:
                     75: user's home directory
                     76: .Dp Shell:
                     77: user's login shell
                     78: .Dp Full Name:
                     79: user's real name
                     80: .Dp Location:
                     81: user's normal location
                     82: .Dp Home Phone:
                     83: user's home phone
                     84: .Dp Office Phone:
                     85: user's office phone
                     86: .Dp
                     87: .Pp
                     88: The
                     89: .Ar login
                     90: field is the user name used to access the computer account.
                     91: .Pp
                     92: The
                     93: .Ar password
                     94: field contains the encrypted form of the user's password.
                     95: .Pp
                     96: The
                     97: .Ar uid
                     98: field is the number associated with the
                     99: .Ar login
                    100: field.
                    101: Both of these fields should be unique across the system (and often
                    102: across a group of systems) as they control file access.
                    103: .Pp
                    104: While it is possible to have multiple entries with identical login names
                    105: and/or identical user id's, it is usually a mistake to do so.  Routines
                    106: that manipulate these files will often return only one of the multiple
                    107: entries, and that one by random selection.
                    108: .Pp
                    109: The
                    110: .Ar group
                    111: field is the group that the user will be placed in at login.
                    112: Since this system supports multiple groups (see
                    113: .Xr groups 1 )
                    114: this field currently has little special meaning.
                    115: This field may be filled in with either a number or a group name (see
                    116: .Xr group 5 ) .
                    117: .Pp
                    118: The
                    119: .Ar change
                    120: field is the date by which the password must be changed.
                    121: .Pp
                    122: The
                    123: .Ar expire
                    124: field is the date on which the account expires.
                    125: .Pp
                    126: Both the
                    127: .Ar change
                    128: and
                    129: .Ar expire
                    130: fields should be entered in the form ``month day year'' where
                    131: .Ar month
                    132: is the month name (the first three characters are sufficient),
                    133: .Ar day
                    134: is the day of the month, and
                    135: .Ar year
                    136: is the year.
                    137: .bp
                    138: The
                    139: .Ar class
                    140: field is currently unused.  In the near future it will be a key to
                    141: a
                    142: .Xr termcap 5
                    143: style database of user attributes.
                    144: .Pp
                    145: The user's
                    146: .Ar home directory
                    147: is the full UNIX path name where the user
                    148: will be placed at login.
                    149: .Pp
                    150: The
                    151: .Ar shell
                    152: field is the command interpreter the user prefers.
                    153: If the
                    154: .Ar shell
                    155: field is empty, the Bourne shell,
                    156: .Pa /bin/sh ,
                    157: is assumed.
                    158: When altering a login shell, and not the super-user, the user
                    159: may not change from a non-standard shell or to a non-standard
                    160: shell.
                    161: Non-standard is defined as a shell not found in
                    162: .Pa /etc/shells .
                    163: .Pp
                    164: The last four fields are for storing the user's
                    165: .Ar full name , office location ,
                    166: and
                    167: .Ar home
                    168: and
                    169: .Ar work telephone
                    170: numbers.
                    171: .Pp
                    172: Once the information has been verified,
                    173: .Nm chpass
                    174: uses
                    175: .Xr mkpasswd 8
                    176: to update the user database.  This is run in the background, and,
                    177: at very large sites could take several minutes.  Until this update
                    178: is completed, the password file is unavailable for other updates
                    179: and the new information will not be available to programs.
                    180: .Sh ENVIRONMENT
                    181: The
                    182: .Xr vi 1
                    183: editor will be used unless the environment variable EDITOR is set to
                    184: an alternate editor.
                    185: When the editor terminates, the information is re-read and used to
                    186: update the user database itself.
                    187: Only the user, or the super-user, may edit the information associated
                    188: with the user.
                    189: .Sh FILES
                    190: .Dw /etc/master.passwd
                    191: .Di L
                    192: .Dp Pa /etc/master.passwd
                    193: The user database
                    194: .Dp Pa /etc/shells
                    195: The list of approved shells
                    196: .Dp
                    197: .Sh SEE ALSO
                    198: .Xr login 1 ,
                    199: .Xr finger 1 ,
                    200: .Xr getusershell 3 ,
                    201: .Xr passwd 5 ,
                    202: .Xr mkpasswd 8 ,
                    203: .Xr vipw 8
                    204: .Pp
                    205: Robert Morris and Ken Thompson,
                    206: .Ar UNIX Password security
                    207: .Sh HISTORY
                    208: First release 4.3 Reno BSD.
                    209: .Sh BUGS
                    210: User information should (and eventually will) be stored elsewhere.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.