.\" 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.
.\"
.\" @(#)chpass.1 8.2 (Berkeley) 12/30/93
.\" $FreeBSD$
.\"
-.Dd December 30, 1993
+.Dd November 17, 2020
.Dt CHPASS 1
.Os
.Sh NAME
.Sh SYNOPSIS
.Nm chpass
.Op Fl a Ar list
+.Op Fl e Ar expiretime
+.Op Fl p Ar encpass
+.Op Fl s Ar newshell
+.Op user
+.Nm ypchpass
+.Op Fl loy
+.Op Fl a Ar list
+.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
+.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 ,
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
The
.Ar class
field references class descriptions in
-.Ar /etc/login.conf
+.Pa /etc/login.conf
and is typically used to initialize the user's system resource limits
when they login.
.Pp
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
.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
can only make changes to the NIS passwd maps through
.Xr rpc.yppasswdd 8 ,
which normally only permits changes to a user's password, shell and GECOS
-fields. Except when invoked by the super-user on the NIS master server,
+fields.
+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.
Furthermore,
.Xr rpc.yppasswdd 8
requires password authentication before it will make any
-changes. The only user allowed to submit changes without supplying
+changes.
+The only user allowed to submit changes without supplying
a password is the super-user on the NIS master server; all other users,
including those with root privileges on NIS clients (and NIS slave
servers) must enter a password.
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
-any changes. If the password is invalid, all changes will be
+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.
.Pp
Exception: the super-user on the NIS master server is allowed to
-submit changes without supplying a password. (The super-user may
+submit changes without supplying a password.
+(The super-user may
choose to turn off this feature using the
.Fl o
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.
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.
.Xr passwd 1
or
.Xr yppasswd 1
-to change their NIS passwords. The super-user is allowed to specify
+to change their NIS passwords.
+The super-user is allowed to specify
a new password (even though the
.Dq Password:
field does not show
.Pp
Exception: the super-user on the NIS master server is permitted to
change a user's NIS password with
-.Nm Ns .
+.Nm .
.El
.Pp
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. The
+utility.
+The
.Fl d
option can be used to override a default, or to specify a domain
when the system domain name is not set.
.It Fl h Ar host
-Specify the name or address of an NIS server to query. Normally,
+Specify the name or address of an NIS server to query.
+Normally,
.Nm
will communicate with the NIS master host specified in the
.Pa master.passwd
or
.Pa passwd
-maps. On hosts that have not been configured as NIS clients, there is
+maps.
+On hosts that have not been configured as NIS clients, there is
no way for the program to determine this information unless the user
-provides the hostname of a server. Note that the specified hostname need
+provides the hostname of a server.
+Note that the specified hostname need
not be that of the NIS master server; the name of any server, master or
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
.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
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
+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
.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 ,
.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 Ns .
-.Sh BUGS
-User information should (and eventually will) be stored elsewhere.
.Sh HISTORY
The
-.Nm chpass
-command appeared in
+.Nm
+utility appeared in
.Bx 4.3 Reno .
+.Sh BUGS
+User information should (and eventually will) be stored elsewhere.
git.ckatri.com / pw-darwin.git / blobdiff