.\" Copyright (C) 1996
.\" David L. Nugent. All rights reserved.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 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.
-.\"
+.\"
.\" THIS SOFTWARE IS PROVIDED BY DAVID L. NUGENT AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: pw.8,v 1.5 1996/12/19 15:22:41 davidn Exp $
+.\" $FreeBSD$
.\"
-.Dd December 9, 1996
+.Dd September 12, 2016
.Dt PW 8
.Os
.Sh NAME
.Nm pw
.Nd create, remove, modify & display system users and groups
.Sh SYNOPSIS
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar useradd
-.Op name|uid
+.Oo Fl n Oc name Oo Fl u Ar uid Oc
.Op Fl C Ar config
.Op Fl q
-.Op Fl n Ar name
-.Op Fl u Ar uid
.Op Fl c Ar comment
.Op Fl d Ar dir
.Op Fl e Ar date
.Op Fl g Ar group
.Op Fl G Ar grouplist
.Op Fl m
+.Op Fl M Ar mode
.Op Fl k Ar dir
+.Op Fl w Ar method
.Op Fl s Ar shell
.Op Fl o
.Op Fl L Ar class
-.Op Fl h Ar fd
+.Op Fl h Ar fd | Fl H Ar fd
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar useradd
-.Op name|uid
.Fl D
.Op Fl C Ar config
.Op Fl q
.Op Fl g Ar group
.Op Fl G Ar grouplist
.Op Fl k Ar dir
-.Op Fl u Ar min,max
-.Op Fl i Ar min,max
+.Op Fl M Ar mode
+.Op Fl u Ar min , Ns Ar max
+.Op Fl i Ar min , Ns Ar max
.Op Fl w Ar method
.Op Fl s Ar shell
.Op Fl y Ar path
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar userdel
-.Op name|uid
-.Op Fl n Ar name
-.Op Fl u Ar uid
+.Oo Fl n Oc name|uid | Fl u Ar uid
.Op Fl r
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar usermod
-.Op name|uid
+.Oo Fl n Oc name|uid Oo Fl u Ar newuid Oc | Fl u Ar uid
.Op Fl C Ar config
.Op Fl q
-.Op Fl n Ar name
-.Op Fl u Ar uid
.Op Fl c Ar comment
.Op Fl d Ar dir
.Op Fl e Ar date
.Op Fl p Ar date
.Op Fl g Ar group
.Op Fl G Ar grouplist
-.Op Fl l Ar name
+.Op Fl l Ar newname
.Op Fl m
+.Op Fl M Ar mode
.Op Fl k Ar dir
.Op Fl w Ar method
.Op Fl s Ar shell
.Op Fl L Ar class
-.Op Fl h Ar fd
+.Op Fl h Ar fd | Fl H Ar fd
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar usershow
-.Op name|uid
-.Op Fl n Ar name
-.Op Fl u Ar uid
+.Oo Fl n Oc name|uid | Fl u Ar uid
.Op Fl F
.Op Fl P
+.Op Fl 7
.Op Fl a
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar usernext
.Op Fl C Ar config
.Op Fl q
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar groupadd
-.Op group|gid
+.Oo Fl n Oc name Oo Fl g Ar gid Oc
.Op Fl C Ar config
.Op Fl q
-.Op Fl n Ar group
-.Op Fl g Ar gid
.Op Fl M Ar members
.Op Fl o
-.Op Fl h Ar fd
+.Op Fl h Ar fd | Fl H Ar fd
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar groupdel
-.Op Fl n Ar name
-.Op Fl g Ar gid
+.Oo Fl n Oc name|gid | Fl g Ar gid
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar groupmod
+.Oo Fl n Oc name|gid Oo Fl g Ar newgid Oc | Fl g Ar gid
.Op Fl C Ar config
.Op Fl q
-.Op Fl F
-.Op Fl n Ar name
-.Op Fl g Ar gid
-.Op Fl l Ar name
+.Op Fl l Ar newname
.Op Fl M Ar members
.Op Fl m Ar newmembers
-.Op Fl h Ar fd
+.Op Fl d Ar oldmembers
+.Op Fl h Ar fd | Fl H Ar fd
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar groupshow
-.Op Fl n Ar name
-.Op Fl g Ar gid
+.Oo Fl n Oc name|gid | Fl g Ar gid
.Op Fl F
.Op Fl P
.Op Fl a
-.Nm pw
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
.Ar groupnext
.Op Fl C Ar config
.Op Fl q
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
+.Ar lock
+.Oo Fl n Oc name|uid | Fl u Ar uid
+.Op Fl C Ar config
+.Op Fl q
+.Nm
+.Op Fl R Ar rootdir
+.Op Fl V Ar etcdir
+.Ar unlock
+.Oo Fl n Oc name|uid | Fl u Ar uid
+.Op Fl C Ar config
+.Op Fl q
.Sh DESCRIPTION
-.Nm pw
-is a command-line based editor for the system
-.Em user
+The
+.Nm
+utility is a command-line based editor for the system
+.Ar user
and
-.Em group
-files, allowing the superuser and easy to use and standardized way of adding,
+.Ar group
+files, allowing the superuser an easy to use and standardized way of adding,
modifying and removing users and groups.
Note that
-.Nm pw
-only operates on the local user and group files; NIS users and groups must be
-maintained on the NIS server.
-.Nm pw
-handles updating the
-.Pa passwd ,
-.Pa master.passwd ,
+.Nm
+only operates on the local user and group files.
+.Tn NIS
+users and groups must be
+maintained on the
+.Tn NIS
+server.
+The
+.Nm
+utility handles updating the
+.Pa passwd ,
+.Pa master.passwd ,
.Pa group
and the secure and insecure
password database files, and must be run as root.
.Pp
-The first one or two keywords provided on
-.Xr pw 8 's
-command line provide the context for the remainder of the arguments.
-One of the keywords
+The first one or two keywords provided to
+.Nm
+on the command line provide the context for the remainder of the arguments.
+The keywords
.Ar user
and
.Ar group
-may be combined or provided separately with
+may be combined with
.Ar add ,
.Ar del ,
.Ar mod ,
.Ar show ,
or
-.Ar next ,
-and may be specified in either order (ie. showuser, usershow, show user and user show
-are all considered to be the same thing).
-This flexibility is useful for interactive scripts which call
-.Nm pw
-for the actual user and group database manipulation.
-Following these keywords, you may optionally specify the user or group name or numeric
-id as an alternative to using the
+.Ar next
+in any order.
+(For example,
+.Ar showuser ,
+.Ar usershow ,
+.Ar show user ,
+and
+.Ar user show
+all mean the same thing.)
+This flexibility is useful for interactive scripts calling
+.Nm
+for user and group database manipulation.
+Following these keywords,
+the user or group name or numeric id may be optionally specified as an
+alternative to using the
.Fl n Ar name ,
.Fl u Ar uid ,
.Fl g Ar gid
options.
.Pp
-The following flags are common to all or most modes of operation:
-.Pp
+The following flags are common to most or all modes of operation:
.Bl -tag -width "-G grouplist"
+.It Fl R Ar rootdir
+Specifies an alternate root directory within which
+.Nm
+will operate.
+Any paths specified will be relative to
+.Va rootdir .
+.It Fl V Ar etcdir
+Set an alternate location for the password, group, and configuration files.
+Can be used to maintain a user/group database in an alternate location.
+If this switch is specified, the system
+.Pa /etc/pw.conf
+will not be sourced for default configuration data,
+but the file pw.conf in the specified directory will be used instead
+.Pq or none, if it does not exist .
+The
+.Fl C
+flag may be used to override this behaviour.
+As an exception to the general rule where options must follow the operation
+type, the
+.Fl V
+flag must be used on the command line before the operation keyword.
.It Fl C Ar config
By default,
-.Nm pw
+.Nm
reads the file
.Pa /etc/pw.conf
-to obtain policy information on how new user accounts and groups are to be created,
-and the
+to obtain policy information on how new user accounts and groups are to be created.
+The
.Fl C
option specifies a different configuration file.
-Most of the contents in the configuration file may be overridden via command line
-options, but it may be more useful to set up standard information for addition of
-new accounts in the configuration file.
+While most of the contents of the configuration file may be overridden via
+command-line options, it may be more convenient to keep standard information in a
+configuration file.
.It Fl q
Use of this option causes
-.Nm pw
-to suppress error messages, which may be useful in interactive environments where it
+.Nm
+to suppress error messages,
+which may be useful in interactive environments where it
is preferable to interpret status codes returned by
-.Nm pw
+.Nm
rather than messing up a carefully formatted display.
.It Fl N
-This option is available in add and modify operations, and causes
-.Nm pw
-to skip updating the user/group databases and instead print the result
-of the operation without actually performing it.
+This option is available in
+.Ar add
+and
+.Ar modify
+operations, and tells
+.Nm
+to output the result of the operation without updating the user or group
+databases.
You may use the
.Fl P
option to switch between standard passwd and readable formats.
.It Fl Y
Using this option with any of the update modes causes
-.Nm pw
+.Nm
to run
.Xr make 1
after changing to the directory
.Pa /var/yp .
-This is intended to allow automatic updating of the NIS database files.
-If separate passwd and group files are being used by NIS, then use the
+This is intended to allow automatic updating of
+.Tn NIS
+database files.
+If separate passwd and group files are being used by
+.Tn NIS ,
+then use the
.Fl y Ar path
-option to specify the location of the NIS passwd database so that pw
-will automatically update it concurrently with the system password
+option to specify the location of the
+.Tn NIS
+passwd database so that
+.Nm
+will concurrently update it with the system password
databases.
.El
-.Pp
.Sh USER OPTIONS
The following options apply to the
-.Ar useradd ,
+.Ar useradd
and
-.Ar usermod ,
+.Ar usermod
commands:
-.Pp
.Bl -tag -width "-G grouplist"
-.It Fl n Ar name
-Specifies the user/account name.
+.It Oo Fl n Oc Ar name
+Required unless
+.Fl u Ar uid
+is given.
+Specify the user/account name.
+In the case of
+.Ar usermod
+can be a uid.
.It Fl u Ar uid
-Specifies the user/account numeric id.
-.Pp
-Usually, you need only to provide one or the other of these options, as the account
-name will imply the uid, and vice versa.
-Also, you may provide either the account or userid immediately after the
-.Ar useradd ,
-.Ar userdel ,
+Required if
+.Ar name
+is not given.
+Specify the user/account numeric id.
+In the case of
.Ar usermod
-or
-.Ar usershow
-keyword on the command line without the need to use
-.Ql Fl n
-or
-.Ql Fl u .
-There are times, however, were you need to provide both.
+if paired with
+.Ar name ,
+changes the numeric id of the named user/account.
+.Pp
+Usually, only one of these options is required,
+as the account name will imply the uid, or vice versa.
+However, there are times when both are needed.
For example, when changing the uid of an existing user with
.Ar usermod ,
-or overriding the default uid when creating a new account.
-If you wish
-.Nm pw
-to automatically allocate the uid to a new user on
+or overriding the default uid when creating a new account with
+.Ar useradd .
+To automatically allocate the uid to a new user with
.Ar useradd ,
-then you should
+then do
.Em not
use the
-.Ql Fl u
+.Fl u
option.
-.El
-.Pp
-Options available with both
-.Ar useradd
-and
+Either the account or userid can also be provided immediately after the
+.Ar useradd ,
+.Ar userdel ,
.Ar usermod
-are:
+or
+.Ar usershow
+keywords on the command line without using the
+.Fl n
+or
+.Fl u
+options.
+.El
.Bl -tag -width "-G grouplist"
.It Fl c Ar comment
-This field sets the contents of the passwd GECOS field, which normally contains up
-to four comma-separated fields containing the user's full name, office or location,
-work and home phone numbers.
+This field sets the contents of the passwd GECOS field,
+which normally contains up to four comma-separated fields containing the
+user's full name, office or location,
+and work and home phone numbers.
These sub-fields are used by convention only, however, and are optional.
-If this field is to contain spaces, you need to quote the comment itself with double
-quotes
+If this field is to contain spaces,
+the comment must be enclosed in double quotes
.Ql \&" .
-Avoid using commas in this field as these are used as sub-field separators, and the
-colon
+Avoid using commas in this field as these are used as sub-field separators,
+and the colon
.Ql \&:
-character also cannot be used as this is the field separator in the passwd file.
+character also cannot be used as this is the field separator for the passwd
+file itself.
.It Fl d Ar dir
This option sets the account's home directory.
-Normally, you will only use this if the home directory is to be different from the
-default (which is determined from pw.conf, which specifies the base home directory
-- normally /home - with the account name as a subdirectory).
+Normally,
+this is only used if the home directory is to be different from the
+default determined from
+.Pa /etc/pw.conf
+- normally
+.Pa /home
+with the account name as a subdirectory.
.It Fl e Ar date
-Sets the account's expiration date.
+Set the account's expiration date.
Format of the date is either a UNIX time in decimal, or a date in
-.Ql \& dd-mmm-yy[yy]
-format, where dd is the day, mmm is the month, either in numeric or alphabetic format
-('Jan', 'Feb' etc) and year is either a two or four digit year.
+.Ql dd-mmm-yy[yy]
+format, where dd is the day,
+mmm is the month, either in numeric or alphabetic format
+('Jan', 'Feb', etc) and year is either a two or four digit year.
This option also accepts a relative date in the form
.Ql \&+n[mhdwoy]
where
.Ql \&n
-is a decimal, octal (leading 0) or hexadecimal (leading 0x) digit followed by the
+is a decimal,
+octal (leading 0) or hexadecimal (leading 0x) digit followed by the
number of Minutes, Hours, Days, Weeks, Months or Years from the current date at
-which the expiry date is to be set.
+which the expiration date is to be set.
.It Fl p Ar date
-Sets the account's password expiration date.
-This field is identical to the account expiration date option, except that it
+Set the account's password expiration date.
+This field is similar to the account expiration date option, except that it
applies to forced password changes.
-The same formats are accepted as with the account expiration option.
+This is set in the same manner as the
+.Fl e
+option.
.It Fl g Ar group
-Sets the account's primary group to the given group.
+Set the account's primary group to the given group.
.Ar group
-may be either the group name or its corresponding group id number.
+may be defined by either its name or group number.
.It Fl G Ar grouplist
-Sets the additional groups to which an account belongs.
+Set secondary group memberships for an account.
.Ar grouplist
-is a comma-separated list or group names or group ids.
-When adding a user, the user's name is added to the group lists in
-.Pa /etc/group ,
-and when editing a user, the user's name is also added to the group lists, and
-removed from any groups not specified in
+is a comma, space, or tab-separated list of group names or group numbers.
+The user is added to the groups specified in
+.Ar grouplist ,
+and removed from all groups not specified.
+The current login session is not affected by group membership changes,
+which only take effect when the user reconnects.
+Note: do not add a user to their primary group with
.Ar grouplist .
-Note: a user should not be added to their primary group in
-.Pa /etc/group .
-Also, group membership changes do not take effect immediately for current logins,
-only logins subsequent to the change.
.It Fl L Ar class
This option sets the login class for the user being created.
See
.Xr login.conf 5
-for more information on user classes.
+and
+.Xr passwd 5
+for more information on user login classes.
.It Fl m
This option instructs
-.Nm pw
+.Nm
to attempt to create the user's home directory.
While primarily useful when adding a new account with
.Ar useradd ,
-this may also be of use when moving an existing user's home directory elsewhere on
-the filesystem.
+this may also be of use when moving an existing user's home directory elsewhere
+on the file system.
The new home directory is populated with the contents of the
.Ar skeleton
directory, which typically contains a set of shell configuration files that the
user may personalize to taste.
+Files in this directory are usually named
+.Pa dot . Ns Aq Ar config
+where the
+.Pa dot
+prefix will be stripped.
When
-.Ql Fl m
+.Fl m
is used on an account with
.Ar usermod ,
-any existing configuration files in the user's home directory are
+existing configuration files in the user's home directory are
.Em not
-overwritten with the prototype files.
+overwritten from the skeleton files.
.Pp
-When a user's home directory is created, it will be default be as a subdirectory of the
+When a user's home directory is created,
+it will by default be a subdirectory of the
.Ar basehome
-directory specified with the
-.Ql Fl b Ar dir
-option (see below), and will be named the same as the account.
-This may be overridden with the
-.Ql Fl d Ar dir
+directory as specified by the
+.Fl b
+option (see below), bearing the name of the new account.
+This can be overridden by the
+.Fl d
option on the command line, if desired.
+.It Fl M Ar mode
+Create the user's home directory with the specified
+.Ar mode ,
+modified by the current
+.Xr umask 2 .
+If omitted, it is derived from the parent process'
+.Xr umask 2 .
+This option is only useful in combination with the
+.Fl m
+flag.
.It Fl k Ar dir
-Sets the
+Set the
.Ar skeleton
-subdirectory, from which the basic startup and configuration files are copied when
+directory, from which basic startup and configuration files are copied when
the user's home directory is created.
-This option only has meaning when used with
-.Ql Fl D
-(see below) or
-.Ql Fl m .
+This option only has meaning when used with the
+.Fl d
+or
+.Fl m
+flags.
.It Fl s Ar shell
-Sets or changes the user's login shell to
+Set or changes the user's login shell to
.Ar shell .
If the path to the shell program is omitted,
-.Nm pw
+.Nm
searches the
.Ar shellpath
specified in
and fills it in as appropriate.
Note that unless you have a specific reason to do so, you should avoid
specifying the path - this will allow
-.Nm pw
+.Nm
to validate that the program exists and is executable.
Specifying a full path (or supplying a blank "" shell) avoids this check
and allows for such entries as
-.Ql \& /nonexistent
+.Pa /nonexistent
that should be set for accounts not intended for interactive login.
-.It Fl L Ar class
-Sets the
-.Em class
-field in the user's passwd record.
-This field is not currently used, but will be in the future used to specify a
-.Em termcap
-entry like tag (see
-.Xr passwd 5
-for details).
.It Fl h Ar fd
This option provides a special interface by which interactive scripts can
set an account password using
-.Nm pw .
-Because the command line and environment are fundamental insecure mechanisms
+.Nm .
+Because the command line and environment are fundamentally insecure mechanisms
by which programs can accept information,
-.Nm pw
+.Nm
will only allow setting of account and group passwords via a file descriptor
(usually a pipe between an interactive script and the program).
.Ar sh ,
.Ar ksh
and
.Ar perl
-all posses mechanisms by which this can be done.
+all possess mechanisms by which this can be done.
Alternatively,
-.Nm pw
+.Nm
will prompt for the user's password if
-.Ql Fl h Ar 0
+.Fl h Ar 0
is given, nominating
.Em stdin
as the file descriptor on which to read the password.
-Note that this password will be read once and once only and is intended
-for use by a script or similar rather than interactive use.
+Note that this password will be read only once and is intended
+for use by a script rather than for interactive use.
If you wish to have new password confirmation along the lines of
.Xr passwd 1 ,
-this must be implemented as part of the interactive script that calls
-.Nm pw .
+this must be implemented as part of an interactive script that calls
+.Nm .
.Pp
If a value of
.Ql \&-
.Ar fd ,
then the password will be set to
.Ql \&* ,
-rendering the account inaccessible via passworded login.
+rendering the account inaccessible via password-based login.
+.It Fl H Ar fd
+Read an encrypted password string from the specified file descriptor.
+This is like
+.Fl h ,
+but the password should be supplied already encrypted in a form
+suitable for writing directly to the password database.
.El
.Pp
It is possible to use
.Ar useradd
to create a new account that duplicates an existing user id.
While this is normally considered an error and will be rejected, the
-.Ql Fl o
+.Fl o
option overrides the check for duplicates and allows the duplication of
the user id.
This may be useful if you allow the same user to login under
The
.Ar useradd
command also has the ability to set new user and group defaults by using the
-.Ql Fl D
+.Fl D
option.
Instead of adding a new user,
-.Nm pw
+.Nm
writes a new set of defaults to its configuration file,
.Pa /etc/pw.conf .
When using the
-.Ql Fl D
+.Fl D
option, you must not use either
-.Ql Fl n Ar name
+.Fl n Ar name
or
-.Ql Fl u Ar uid
+.Fl u Ar uid
or an error will result.
Use of
-.Ql Fl D
+.Fl D
changes the meaning of several command line switches in the
.Ar useradd
command.
Set default values in
.Pa /etc/pw.conf
configuration file, or a different named configuration file if the
-.Ql Fl C Ar config
+.Fl C Ar config
option is used.
.It Fl b Ar dir
-Sets the root directory in which user home directories are created.
+Set the root directory in which user home directories are created.
The default value for this is
-.Ql \&/home ,
+.Pa /home ,
but it may be set elsewhere as desired.
.It Fl e Ar days
-Sets the default account expiration period in days.
-Unlike use without
-.Ql Fl D ,
-the argument must be numeric, which specifies the number of days after creation when
-the account is to expire.
+Set the default account expiration period in days.
+When
+.Fl D
+is used, the
+.Ar days
+argument is interpreted differently.
+It must be numeric and represents the number of days after creation
+that the account expires.
A value of 0 suppresses automatic calculation of the expiry date.
.It Fl p Ar days
-Sets the default password expiration period in days.
+Set the default password expiration period in days.
.It Fl g Ar group
-Sets the default group for new users.
+Set the default group for new users.
If a blank group is specified using
-.Ql Fl g Ar \&"" ,
-then new users will be allocated their own private primary group (a new group created
-with the same name as their login name).
+.Fl g Ar \&"" ,
+then new users will be allocated their own private primary group
+with the same name as their login name.
If a group is supplied, either its name or uid may be given as an argument.
.It Fl G Ar grouplist
-Sets the default groups in which new users are made members.
-This is a separate set of groups from the primary group, and you should avoid
-nominating the same group as both the primary and in extra groups.
+Set the default groups in which new users are granted membership.
+This is a separate set of groups from the primary group.
+Avoid nominating the same group as both primary and extra groups.
In other words, these extra groups determine membership in groups
.Em other than
the primary group.
.Ar grouplist
-is a comma-separated list of group names or ids, or a mixture of both, and are always
+is a comma-separated list of group names or ids, and are always
stored in
.Pa /etc/pw.conf
by their symbolic names.
.It Fl L Ar class
This option sets the default login class for new users.
.It Fl k Ar dir
-Sets the default
+Set the default
.Em skeleton
-directory, from which prototype shell and other initialization files are copied when
-.Nm pw
+directory,
+from which prototype shell and other initialization files are copied when
+.Nm
creates a user's home directory.
-.It Fl u Ar min,max , Fl i Ar min,max
-These options set the minimum and maximum user and group ids allocated for new accounts
-and groups created by
-.Nm pw .
+See description of
+.Fl k
+for naming conventions of these files.
+.It Xo
+.Fl u Ar min , Ns Ar max ,
+.Fl i Ar min , Ns Ar max
+.Xc
+Set the minimum and maximum user and group ids allocated for new
+accounts and groups created by
+.Nm .
The default values for each is 1000 minimum and 32000 maximum.
.Ar min
and
.Ar max
-are both numbers, where max must be greater than min, and both must be between 0
-and 32767.
-In general, user and group ids less than 100 are reserved for use by the system,
-and numbers greater than 32000 may also be reserved for special purposes (used by
-some system daemons).
+are both numbers, where max must be greater than min,
+and both must be between 0 and 32767.
+In general,
+user and group ids less than 100 are reserved for use by the system,
+and numbers greater than 32000 may also be reserved for special purposes
+.Pq used by some system daemons .
.It Fl w Ar method
The
-.Ql Fl w
-option sets the default method used to set passwords for newly created user accounts.
+.Fl w
+option selects the default method used to set passwords for newly created user
+accounts.
.Ar method
is one of:
.Pp
.Bl -tag -width random -offset indent -compact
.It no
-disables login on newly created accounts
+disable login on newly created accounts
.It yes
-forces the password to be the account name
+force the password to be the account name
.It none
-forces a blank password
+force a blank password
.It random
-Generates a random password
+generate a random password
.El
.Pp
The
or
.Ql \&no
methods are the most secure; in the former case,
-.Nm pw
-generates a password and prints it to stdout, which is suitable where you issue
-users with passwords to access their accounts rather than having the user nominate
-their own (possibly poorly chosen) password.
+.Nm
+generates a password and prints it to stdout,
+which is suitable when users are issued passwords rather than being allowed
+to select their own
+.Pq possibly poorly chosen
+password.
The
.Ql \&no
method requires that the superuser use
.Xr passwd 1
to render the account accessible with a password.
.It Fl y Ar path
-This sets the pathname of the database used by NIS if you are not sharing
+This sets the pathname of the database used by
+.Tn NIS
+if you are not sharing
the information from
.Pa /etc/master.passwd
-directly with NIS.
-You should only set this option on NIS servers.
+directly with
+.Tn NIS .
+You should only set this option for
+.Tn NIS
+servers.
.El
.Pp
The
.Ar userdel
-command has only three valid options. The
-.Ql Fl n Ar name
+command has three distinct options.
+The
+.Fl n Ar name
and
-.Ql Fl u Ar uid
+.Fl u Ar uid
options have already been covered above.
The additional option is:
.Bl -tag -width "-G grouplist"
.It Fl r
This tells
-.Nm pw
+.Nm
to remove the user's home directory and all of its contents.
-.Nm pw
-errs on the side of caution when removing files from the system.
-Firstly, it will not do so if the uid of the account being removed is also used by
+The
+.Nm
+utility errs on the side of caution when removing files from the system.
+Firstly,
+it will not do so if the uid of the account being removed is also used by
another account on the system, and the 'home' directory in the password file is
a valid path that commences with the character
.Ql \&/ .
If any additional cleanup work is required, this is left to the administrator.
.El
.Pp
-Mail spool files and crontabs are always removed when an account is deleted as these
-are unconditionally attached to the user name.
+Mail spool files and crontabs are always removed when an account is deleted as
+these are unconditionally attached to the user name.
Jobs queued for processing by
.Ar at
-are also removed if the user's uid is unique (not also used by another account on the
-system).
+are also removed if the user's uid is unique and not also used by another
+account on the system.
+.Pp
+The
+.Ar usermod
+command adds one additional option:
+.Bl -tag -width "-G grouplist"
+.It Fl l Ar newname
+This option allows changing of an existing account name to
+.Ql \&newname .
+The new name must not already exist, and any attempt to duplicate an
+existing account name will be rejected.
+.El
.Pp
The
.Ar usershow
with the password field replaced with a
.Ql \&* .
If the
-.Ql Fl P
+.Fl P
option is used, then
-.Nm pw
+.Nm
outputs the account details in a more human readable form.
+If the
+.Fl 7
+option is used, the account details are shown in v7 format.
The
-.Ql Fl a
+.Fl a
option lists all users currently on file.
+Using
+.Fl F
+forces
+.Nm
+to print the details of an account even if it does not exist.
.Pp
The command
.Ar usernext
returns the next available user and group ids separated by a colon.
This is normally of interest only to interactive scripts or front-ends
that use
-.Nm pw .
-.Pp
+.Nm .
.Sh GROUP OPTIONS
The
-.Ql Fl C Ar config
+.Fl C
and
-.Ql Fl q
+.Fl q
options (explained at the start of the previous section) are available
with the group manipulation commands.
Other common options to all group-related commands are:
.Bl -tag -width "-m newmembers"
-.It Fl n Ar name
-Specifies the group name.
+.It Oo Fl n Oc Ar name
+Required unless
+.Fl g Ar gid
+is given.
+Specify the group name.
+In the case of
+.Ar groupmod
+can be a gid.
.It Fl g Ar gid
-Specifies the group numeric id.
+Required if
+.Ar name
+is not given.
+Specify the group numeric id.
+In the case of
+.Ar groupmod
+if paired with
+.Ar name ,
+changes the numeric id of the named group.
.Pp
As with the account name and id fields, you will usually only need
to supply one of these, as the group name implies the uid and vice
is a comma separated list of valid and existing user names or uids.
.It Fl m Ar newmembers
Similar to
-.Op M ,
+.Fl M ,
this option allows the
.Em addition
-of existing users to a group without first replacing the existing list of
+of existing users to a group without replacing the existing list of
+members.
+Login names or user ids may be used, and duplicate users are
+silently eliminated.
+.It Fl d Ar oldmembers
+Similar to
+.Fl M ,
+this option allows the
+.Em deletion
+of existing users from a group without replacing the existing list of
members.
-Login names or user ids may be used, and duplicated users are automatically
-and silently eliminated.
+Login names or user ids may be used, and duplicate users are
+silently eliminated.
.El
.Pp
.Ar groupadd
also has a
-.Ql Fl o
-option that allows allocation of an existing group id to new group.
-The default action is to reject an attempt to add a group, and this option overrides
-the check for duplicate group ids.
+.Fl o
+option that allows allocation of an existing group id to a new group.
+The default action is to reject an attempt to add a group,
+and this option overrides the check for duplicate group ids.
There is rarely any need to duplicate a group id.
.Pp
The
.Ar groupmod
-command adds one additonal option:
-.Pp
+command adds one additional option:
.Bl -tag -width "-m newmembers"
-.It Fl l Ar name
+.It Fl l Ar newname
This option allows changing of an existing group name to
-.Ql \&name .
-The new name must not already exist, and any attempt to duplicate an existing group
+.Ql \&newname .
+The new name must not already exist,
+and any attempt to duplicate an existing group
name will be rejected.
.El
.Pp
are the same as for
.Ar usershow ,
with the
-.Ql Fl g Ar gid
+.Fl g Ar gid
replacing
-.Ql Fl u Ar uid
+.Fl u Ar uid
to specify the group id.
+The
+.Fl 7
+option does not apply to the
+.Ar groupshow
+command.
.Pp
The command
.Ar groupnext
returns the next available group id on standard output.
-.Sh DIAGNOSTICS
-.Nm pw
-returns EXIT_SUCCESS on successful operation, otherwise one of the
+.Sh USER LOCKING
+The
+.Nm
+utility
+supports a simple password locking mechanism for users; it works by
+prepending the string
+.Ql *LOCKED*
+to the beginning of the password field in
+.Pa master.passwd
+to prevent successful authentication.
+.Pp
+The
+.Ar lock
+and
+.Ar unlock
+commands take a user name or uid of the account to lock or unlock,
+respectively.
+The
+.Fl V ,
+.Fl C ,
+and
+.Fl q
+options as described above are accepted by these commands.
+.Sh NOTES
+For a summary of options available with each command, you can use
+.Dl pw [command] help
+For example,
+.Dl pw useradd help
+lists all available options for the useradd operation.
+.Pp
+The
+.Nm
+utility allows 8-bit characters in the passwd GECOS field (user's full name,
+office, work and home phone number subfields), but disallows them in
+user login and group names.
+Use 8-bit characters with caution, as connection to the Internet will
+require that your mail transport program supports 8BITMIME, and will
+convert headers containing 8-bit characters to 7-bit quoted-printable
+format.
+.Xr sendmail 8
+does support this.
+Use of 8-bit characters in the GECOS field should be used in
+conjunction with the user's default locale and character set
+and should not be implemented without their use.
+Using 8-bit characters may also affect other
+programs that transmit the contents of the GECOS field over the
+Internet, such as
+.Xr fingerd 8 ,
+and a small number of TCP/IP clients, such as IRC, where full names
+specified in the passwd file may be used by default.
+.Pp
+The
+.Nm
+utility writes a log to the
+.Pa /var/log/userlog
+file when actions such as user or group additions or deletions occur.
+The location of this logfile can be changed in
+.Xr pw.conf 5 .
+.Sh FILES
+.Bl -tag -width /etc/master.passwd.new -compact
+.It Pa /etc/master.passwd
+The user database
+.It Pa /etc/passwd
+A Version 7 format password file
+.It Pa /etc/login.conf
+The user capabilities database
+.It Pa /etc/group
+The group database
+.It Pa /etc/pw.conf
+Pw default options file
+.It Pa /var/log/userlog
+User/group modification logfile
+.El
+.Sh EXAMPLES
+Add new user Glurmo Smith (gsmith).
+A gsmith login group is created if not already present.
+The login shell is set to
+.Xr csh 1 .
+A new home directory at
+.Pa /home/gsmith
+is created if it does not already exist.
+Finally, a random password is generated and displayed:
+.Bd -literal -offset indent
+pw useradd -n gsmith -c "Glurmo Smith" -s /bin/csh -m -w random
+.Ed
+.Pp
+Delete the gsmith user and their home directory, including contents.
+.Bd -literal -offset indent
+pw userdel -n gsmith -r
+.Ed
+.Sh EXIT STATUS
+The
+.Nm
+utility returns EXIT_SUCCESS on successful operation, otherwise
+.Nm
+returns one of the
following exit codes defined by
.Xr sysexits 3
as follows:
.It EX_USAGE
.Bl -bullet -compact
.It
-Command line syntax errors (invalid keyword, unknown option)
+Command line syntax errors (invalid keyword, unknown option).
.El
.It EX_NOPERM
.Bl -bullet -compact
.Bl -bullet -compact
.It
Bad or invalid data provided or missing on the command line or
-via the password flie descriptor.
+via the password file descriptor.
.It
Attempted to remove, rename root account or change its uid.
.El
.It
Base home directory is invalid or does not exist.
.It
-Invalid or non-existant shell specified.
+Invalid or non-existent shell specified.
.El
.It EX_NOUSER
.Bl -bullet -compact
.It
User, user id, group or group id specified does not exist.
.It
-User or group recorded added or modified unexpectedly disappeared.
+User or group recorded, added, or modified unexpectedly disappeared.
.El
.It EX_SOFTWARE
.Bl -bullet -compact
No base home directory configured.
.El
.El
-.Pp
-.Sh NOTES
-For a summary of options available with each command, you can use
-.Dl pw [command] help
-For example,
-.Dl pw useradd help
-lists all available options for the useradd operation.
-.Pp
-.Nm pw
-allows 8-bit characters in the passwd gecos field (user's full name,
-office, work and home phone number subfields), but disallows them in
-user login and group names.
-Use 8-bit characters with caution, as connection to the internet will
-require that your mail transport program supports 8BITMIME, and will
-convert headers containing 8-bit characters to 7-bit quoted-printable
-format.
-.Xr sendmail 8
-does support this.
-Use of 8-bit characters in the gecos field should be used in
-conjunction with the user's default locale and character set
-and should not be implemented without their use.
-Using 8-bit characters may also affect other
-programs that transmit the contents of the gecos field over the
-internet, such as
-.Xr fingerd 8 ,
-and a small number of tcpip clients, such as irc, where fullnames
-specified in the passwd file may be used by default.
-.Sh FILES
-.Bl -tag -width /etc/master.passwd.new -compact
-.It Pa /etc/master.passwd
-The user database
-.It Pa /etc/passwd
-A Version 7 format password file
-.It Pa /etc/login.conf
-The user capabilities database
-.It Pa /etc/group
-The group database
-.It Pa /etc/master.passwd.new
-Temporary copy of the master password file
-.It Pa /etc/passwd.new
-Temporary copy of the Version 7 password file
-.It Pa /etc/group.new
-Temporary copy of the group file
-.It Pa /etc/pw.conf
-Pw default options file
-.El
.Sh SEE ALSO
.Xr chpass 1 ,
.Xr passwd 1 ,
+.Xr umask 2 ,
.Xr group 5 ,
+.Xr login.conf 5 ,
.Xr passwd 5 ,
.Xr pw.conf 5 ,
.Xr pwd_mkdb 8 ,
-.Xr login.conf 5 ,
.Xr vipw 8
.Sh HISTORY
-.Nm pw
-was written to mimic many of the options used in the SYSV
+The
+.Nm
+utility was written to mimic many of the options used in the SYSV
.Em shadow
support suite, but is modified for passwd and group fields specific to
the
git.ckatri.com / pw-darwin.git / blobdiff