X-Git-Url: https://git.cameronkatri.com/pw-darwin.git/blobdiff_plain/70c9fcd9c18e978a44f982db899a530efd793248..HEAD:/chpass/chpass.1 diff --git a/chpass/chpass.1 b/chpass/chpass.1 index 449269e..607f2c8 100644 --- a/chpass/chpass.1 +++ b/chpass/chpass.1 @@ -9,11 +9,7 @@ .\" 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 +.\" 3. 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. .\" @@ -32,7 +28,7 @@ .\" @(#)chpass.1 8.2 (Berkeley) 12/30/93 .\" $FreeBSD$ .\" -.Dd December 30, 1993 +.Dd May 25, 2021 .Dt CHPASS 1 .Os .Sh NAME @@ -44,54 +40,65 @@ .Nm ypchsh .Nd add or change user database information .Sh SYNOPSIS -.Nm +.Nm chpass .Op Fl a Ar list -.Op Fl p Ar encpass .Op Fl e Ar expiretime +.Op Fl p Ar encpass .Op Fl s Ar newshell .Op user -.Pp -.Nm -.Op Fl oly +.Nm ypchpass +.Op Fl loy .Op Fl a Ar list -.Op Fl p Ar encpass -.Op Fl e Ar expiretime -.Op Fl s Ar newshell .Op Fl d Ar domain +.Op Fl e Ar expiretime .Op Fl h Ar host +.Op Fl p Ar encpass +.Op Fl s Ar newshell .Op user .Sh DESCRIPTION The .Nm -program +utility allows editing of the user database information associated with .Ar user or, by default, the current user. +.Pp +The +.Nm chfn , +.Nm chsh , +.Nm ypchpass , +.Nm ypchfn +and +.Nm ypchsh +utilities behave identically to +.Nm . +(There is only one program.) +.Pp The information is formatted and supplied to an editor for changes. .Pp Only the information that the user is allowed to change is displayed. .Pp The options are as follows: -.Bl -tag -width indent -.It Fl a +.Bl -tag -width "-e expiretime" +.It Fl a Ar list 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 -.Pq Dq \: +.Pq Dq \&: separated list of all the user database fields, although they may be empty. -.It Fl p -The super-user is allowed to directly supply an encrypted password field, -in the format used by -.Xr crypt 3 , -as an argument. .It Fl e Ar expiretime Change the account expire time. This option is used to set the expire time from a script as if it was done in the interactive editor. +.It Fl p Ar encpass +The super-user is allowed to directly supply an encrypted password field, +in the format used by +.Xr crypt 3 , +as an argument. .It Fl s Ar newshell Attempt to change the user's shell to .Ar newshell . @@ -151,14 +158,17 @@ Both of these fields should be unique across the system (and often across a group of systems) as they control file access. .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 +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 The -.Ar group +.Ar gid field is the group that the user will be placed in at login. -Since BSD supports multiple groups (see +Since +.Bx +supports multiple groups (see .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 @@ -201,12 +211,12 @@ and numbers and finally .Ar other information which is a single comma delimited string to represent any additional -gcos fields (typically used for site specific user information). +gecos fields (typically used for site specific user information). Note that .Xr finger 1 will display the office location and office phone together under the -heading -.Ar Office: . +heading +.Ar Office\&: . .Pp The user's .Ar home directory @@ -252,8 +262,9 @@ for an explanation of the impact of setting the .Ev PW_SCAN_BIG_IDS environment variable. .Sh NIS INTERACTION -.Nm Chpass -can also be used in conjunction with NIS, however some restrictions +The +.Nm +utility can also be used in conjunction with NIS, however some restrictions apply. Currently, .Nm @@ -265,7 +276,7 @@ Except when invoked by the super-user on the NIS master server, .Nm (and, similarly, .Xr passwd 1 ) -can not use the +cannot use the .Xr rpc.yppasswdd 8 server to change other user information or add new records to the NIS passwd maps. @@ -302,15 +313,15 @@ changing other fields could be added, this would lead to compatibility problems with other NIS-capable systems. Even though the super-user may supply data for other fields while editing an entry, the extra information (other than the -password -- see below) will be silently discarded. +password \(em see below) will be silently discarded. .Pp Exception: the super-user on the NIS master server is permitted to change any field. -.Pp .It .Em "Password authentication is required" . -.Nm Chpass -will prompt for the user's NIS password before effecting +The +.Nm +utility will prompt for the user's NIS password before effecting any changes. If the password is invalid, all changes will be discarded. @@ -323,8 +334,9 @@ choose to turn off this feature using the flag, described below.) .It .Em "Adding new records to the local password database is discouraged" . -.Nm Chpass -will allow the administrator to add new records to the +The +.Nm +utility will allow the administrator to add new records to the local password database while NIS is enabled, but this can lead to some confusion since the new records are appended to the end of the master password file, usually after the special NIS '+' entries. @@ -339,8 +351,9 @@ to the NIS password maps, provided the server has been started with the .Fl a flag to permitted additions (it refuses them by default). -.Nm Chpass -tries to update the local password database by default; to update the +The +.Nm +utility tries to update the local password database by default; to update the NIS maps instead, invoke chpass with the .Fl y flag. @@ -369,25 +382,14 @@ change a user's NIS password with There are also a few extra option flags that are available when .Nm is compiled with NIS support: -.Bl -tag -width indent -.It Fl l -Force -.Nm -to modify the local copy of a user's password -information in the even that a user exists in both -the local and NIS databases. -.It Fl y -Opposite effect of -.Fl l . -This flag is largely redundant since -.Nm -operates on NIS entries by default if NIS is enabled. +.Bl -tag -width "-d domain" .It Fl d Ar domain Specify a particular NIS domain. -.Nm Chpass -uses the system domain name by default, as set by the +The +.Nm +utility uses the system domain name by default, as set by the .Xr domainname 1 -command. +utility. The .Fl d option can be used to override a default, or to specify a domain @@ -410,7 +412,7 @@ slave, in a given NIS domain will do. .Pp When using the .Fl d -option, the hostname defaults to +option, the hostname defaults to .Dq localhost . The .Fl h @@ -418,7 +420,12 @@ option can be used in conjunction with the .Fl d option, in which case the user-specified hostname will override the default. -.Pp +.It Fl l +Force +.Nm +to modify the local copy of a user's password +information in the event that a user exists in both +the local and NIS databases. .It Fl o Force the use of RPC-based updates when communicating with .Xr rpc.yppasswdd 8 @@ -428,26 +435,38 @@ When invoked by the super-user on the NIS master server, allows unrestricted changes to the NIS passwd maps using dedicated, non-RPC-based mechanism (in this case, a .Ux -domain socket). The +domain socket). +The .Fl o flag can be used to force .Nm to use the standard update mechanism instead. This option is provided mainly for testing purposes. +.It Fl y +Opposite effect of +.Fl l . +This flag is largely redundant since +.Nm +operates on NIS entries by default if NIS is enabled. .El -.Pp .Sh FILES .Bl -tag -width /etc/master.passwd -compact .It Pa /etc/master.passwd the user database .It Pa /etc/passwd a Version 7 format password file -.It Pa /etc/chpass.XXXXXX -temporary copy of the password file +.It Pa /etc/pw.XXXXXX +temporary file .It Pa /etc/shells the list of approved shells .El +.Sh EXAMPLES +Change the shell of the current user to +.Ql /usr/local/bin/zsh : +.Bd -literal -offset indent +chsh -s /usr/local/bin/zsh +.Ed .Sh SEE ALSO .Xr finger 1 , .Xr login 1 , @@ -455,28 +474,18 @@ the list of approved shells .Xr getusershell 3 , .Xr login.conf 5 , .Xr passwd 5 , +.Xr pw 8 , .Xr pwd_mkdb 8 , .Xr vipw 8 .Rs .%A Robert Morris -and .%A Ken Thompson .%T "UNIX Password security" .Re -.Sh NOTES -The -.Xr chfn 1 , -.Xr chsh 1 , -.Xr ypchpass 1 , -.Xr ypchfn 1 -and -.Xr ypchsh 1 -commands are really only links to -.Nm . -.Sh BUGS -User information should (and eventually will) be stored elsewhere. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.3 Reno . +.Sh BUGS +User information should (and eventually will) be stored elsewhere.