Annotation of src/usr.bin/chpass/chpass.1, Revision 1.1
1.1 ! deraadt 1: .\" $NetBSD: chpass.1,v 1.6 1995/09/14 06:10:53 jtc Exp $
! 2: .\"
! 3: .\" Copyright (c) 1988, 1990, 1993
! 4: .\" The Regents of the University of California. All rights reserved.
! 5: .\"
! 6: .\" Redistribution and use in source and binary forms, with or without
! 7: .\" modification, are permitted provided that the following conditions
! 8: .\" are met:
! 9: .\" 1. Redistributions of source code must retain the above copyright
! 10: .\" notice, this list of conditions and the following disclaimer.
! 11: .\" 2. Redistributions in binary form must reproduce the above copyright
! 12: .\" notice, this list of conditions and the following disclaimer in the
! 13: .\" documentation and/or other materials provided with the distribution.
! 14: .\" 3. All advertising materials mentioning features or use of this software
! 15: .\" must display the following acknowledgement:
! 16: .\" This product includes software developed by the University of
! 17: .\" California, Berkeley and its contributors.
! 18: .\" 4. Neither the name of the University nor the names of its contributors
! 19: .\" may be used to endorse or promote products derived from this software
! 20: .\" without specific prior written permission.
! 21: .\"
! 22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
! 23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
! 24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
! 25: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
! 26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
! 27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
! 28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
! 29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! 30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
! 31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
! 32: .\" SUCH DAMAGE.
! 33: .\"
! 34: .\" @(#)chpass.1 8.2 (Berkeley) 12/30/93
! 35: .\"
! 36: .Dd December 30, 1993
! 37: .Dt CHPASS 1
! 38: .Os
! 39: .Sh NAME
! 40: .Nm chpass
! 41: .Nd add or change user database information
! 42: .Sh SYNOPSIS
! 43: .Nm chpass
! 44: .Op Fl a Ar list
! 45: .Op Fl s Ar newshell
! 46: .Op user
! 47: .Sh DESCRIPTION
! 48: .Nm Chpass
! 49: allows editing of the user database information associated
! 50: with
! 51: .Ar user
! 52: or, by default, the current user.
! 53: The information is formatted and supplied to an editor for changes.
! 54: .Pp
! 55: Only the information that the user is allowed to change is displayed.
! 56: .Pp
! 57: The options are as follows:
! 58: .Bl -tag -width Ds
! 59: .It Fl a
! 60: The super-user is allowed to directly supply a user database
! 61: entry, in the format specified by
! 62: .Xr passwd 5 ,
! 63: as an argument.
! 64: This argument must be a colon (``:'') separated list of all the
! 65: user database fields, although they may be empty.
! 66: .It Fl s
! 67: The
! 68: .Fl s
! 69: option attempts to change the user's shell to
! 70: .Ar newshell .
! 71: .El
! 72: .Pp
! 73: Possible display items are as follows:
! 74: .Pp
! 75: .Bl -tag -width "Home Directory:" -compact -offset indent
! 76: .It Login:
! 77: user's login name
! 78: .It Password:
! 79: user's encrypted password
! 80: .It Uid:
! 81: user's login
! 82: .It Gid:
! 83: user's login group
! 84: .It Change:
! 85: password change time
! 86: .It Expire:
! 87: account expiration time
! 88: .It Class:
! 89: user's general classification
! 90: .It Home Directory:
! 91: user's home directory
! 92: .It Shell:
! 93: user's login shell
! 94: .It Full Name:
! 95: user's real name
! 96: .It Location:
! 97: user's normal location
! 98: .It Home Phone:
! 99: user's home phone
! 100: .It Office Phone:
! 101: user's office phone
! 102: .El
! 103: .Pp
! 104: The
! 105: .Ar login
! 106: field is the user name used to access the computer account.
! 107: .Pp
! 108: The
! 109: .Ar password
! 110: field contains the encrypted form of the user's password.
! 111: .Pp
! 112: The
! 113: .Ar uid
! 114: field is the number associated with the
! 115: .Ar login
! 116: field.
! 117: Both of these fields should be unique across the system (and often
! 118: across a group of systems) as they control file access.
! 119: .Pp
! 120: While it is possible to have multiple entries with identical login names
! 121: and/or identical user id's, it is usually a mistake to do so. Routines
! 122: that manipulate these files will often return only one of the multiple
! 123: entries, and that one by random selection.
! 124: .Pp
! 125: The
! 126: .Ar group
! 127: field is the group that the user will be placed in at login.
! 128: Since BSD supports multiple groups (see
! 129: .Xr groups 1 )
! 130: this field currently has little special meaning.
! 131: This field may be filled in with either a number or a group name (see
! 132: .Xr group 5 ) .
! 133: .Pp
! 134: The
! 135: .Ar change
! 136: field is the date by which the password must be changed.
! 137: .Pp
! 138: The
! 139: .Ar expire
! 140: field is the date on which the account expires.
! 141: .Pp
! 142: Both the
! 143: .Ar change
! 144: and
! 145: .Ar expire
! 146: fields should be entered in the form ``month day year'' where
! 147: .Ar month
! 148: is the month name (the first three characters are sufficient),
! 149: .Ar day
! 150: is the day of the month, and
! 151: .Ar year
! 152: is the year.
! 153: .Pp
! 154: The
! 155: .Ar class
! 156: field is currently unused. In the near future it will be a key to
! 157: a
! 158: .Xr termcap 5
! 159: style database of user attributes.
! 160: .Pp
! 161: The user's
! 162: .Ar home directory
! 163: is the full UNIX path name where the user
! 164: will be placed at login.
! 165: .Pp
! 166: The
! 167: .Ar shell
! 168: field is the command interpreter the user prefers.
! 169: If the
! 170: .Ar shell
! 171: field is empty, the Bourne shell,
! 172: .Pa /bin/sh ,
! 173: is assumed.
! 174: When altering a login shell, and not the super-user, the user
! 175: may not change from a non-standard shell or to a non-standard
! 176: shell.
! 177: Non-standard is defined as a shell not found in
! 178: .Pa /etc/shells .
! 179: .Pp
! 180: The last four fields are for storing the user's
! 181: .Ar full name , office location ,
! 182: and
! 183: .Ar home
! 184: and
! 185: .Ar work telephone
! 186: numbers.
! 187: .Pp
! 188: Once the information has been verified,
! 189: .Nm chpass
! 190: uses
! 191: .Xr pwd_mkdb 8
! 192: to update the user database.
! 193: .Sh ENVIRONMENT
! 194: The
! 195: .Xr vi 1
! 196: editor will be used unless the environment variable EDITOR is set to
! 197: an alternate editor.
! 198: When the editor terminates, the information is re-read and used to
! 199: update the user database itself.
! 200: Only the user, or the super-user, may edit the information associated
! 201: with the user.
! 202: .Sh FILES
! 203: .Bl -tag -width /etc/master.passwd -compact
! 204: .It Pa /etc/master.passwd
! 205: The user database
! 206: .It Pa /etc/passwd
! 207: A Version 7 format password file
! 208: .It Pa /etc/chpass.XXXXXX
! 209: Temporary copy of the password file
! 210: .It Pa /etc/shells
! 211: The list of approved shells
! 212: .El
! 213: .Sh SEE ALSO
! 214: .Xr login 1 ,
! 215: .Xr finger 1 ,
! 216: .Xr passwd 1 ,
! 217: .Xr getusershell 3 ,
! 218: .Xr passwd 5 ,
! 219: .Xr pwd_mkdb 8 ,
! 220: .Xr vipw 8
! 221: .Rs
! 222: .%A Robert Morris
! 223: .%A Ken Thompson
! 224: .%T "UNIX Password security"
! 225: .Re
! 226: .Sh BUGS
! 227: User information should (and eventually will) be stored elsewhere.
! 228: .Sh HISTORY
! 229: The
! 230: .Nm
! 231: command appeared in
! 232: .Bx 4.3 Reno .
![[BACK]](/icons/back.gif){kind=icon}
Return to chpass.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / chpass