.\"
.\" $FreeBSD$
.\"
-.Dd January 11, 2004
+.Dd June 14, 2015
.Dt PW 8
.Os
.Sh NAME
.Nd create, remove, modify & display system users and groups
.Sh SYNOPSIS
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar useradd
.Op name|uid
.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 P
.Op Fl Y
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar useradd
.Op name|uid
.Op Fl g Ar group
.Op Fl G Ar grouplist
.Op Fl k Ar dir
+.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
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar userdel
.Op name|uid
.Op Fl r
.Op Fl Y
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar usermod
.Op name|uid
.Op Fl G Ar grouplist
.Op Fl l Ar name
.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 P
.Op Fl Y
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar usershow
.Op name|uid
.Op Fl 7
.Op Fl a
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar usernext
.Op Fl C Ar config
.Op Fl q
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar groupadd
.Op group|gid
.Op Fl P
.Op Fl Y
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar groupdel
.Op group|gid
.Op Fl g Ar gid
.Op Fl Y
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar groupmod
.Op group|gid
.Op Fl l Ar name
.Op Fl M Ar members
.Op Fl m Ar newmembers
+.Op Fl d Ar oldmembers
.Op Fl h Ar fd | Fl H Ar fd
.Op Fl N
.Op Fl P
.Op Fl Y
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar groupshow
.Op group|gid
.Op Fl P
.Op Fl a
.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
.Op name|uid
.Op Fl C Ar config
.Op Fl q
.Nm
+.Op Fl R Ar rootdir
.Op Fl V Ar etcdir
.Ar unlock
.Op name|uid
options.
.Pp
The following flags are common to most or all modes of operation:
-.Pp
.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
This flag sets an alternate location for the password, group and configuration files,
and may be used to maintain a user/group database in an alternate location.
As an exception to the general rule where options must follow the operation
type, the
.Fl V
-flag may be used on the command line before the operation keyword.
+flag must be used on the command line before the operation keyword.
.It Fl C Ar config
By default,
.Nm
and
.Ar usermod
commands:
-.Pp
.Bl -tag -width "-G grouplist"
.It Fl n Ar name
Specify the user/account name.
.Fl u
options.
.El
-.Pp
.Bl -tag -width "-G grouplist"
.It Fl c Ar comment
This field sets the contents of the passwd GECOS field, which normally contains up
.It Fl G Ar grouplist
Set additional group memberships for an account.
.Ar grouplist
-is a comma-separated list of group names or group numbers.
+is a comma, space or tab-separated list of group names or group numbers.
The user's name is added to the group lists in
.Pa /etc/group ,
and
.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
.Fl m
is used on an account with
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
Set the
.Ar skeleton
directory, from which prototype shell and other initialization files are copied when
.Nm
creates a user's home directory.
+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
system.
.Pp
The
+.Ar usermod
+command adds one additional option:
+.Bl -tag -width "-G grouplist"
+.It Fl l Ar name
+This option allows changing of an existing account name to
+.Ql \&name .
+The new name must not already exist, and any attempt to duplicate an
+existing account name will be rejected.
+.El
+.Pp
+The
.Ar usershow
command allows viewing of an account in one of two formats.
By default, the format is identical to the format used in
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 duplicate users are
+silently eliminated.
.El
.Pp
.Ar groupadd
The
.Ar groupmod
command adds one additional option:
-.Pp
.Bl -tag -width "-m newmembers"
.It Fl l Ar name
This option allows changing of an existing group name to
and
.Fl q
options as described above are accepted by these commands.
-.Sh DIAGNOSTICS
+.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 EXIT STATUS
The
.Nm
utility returns EXIT_SUCCESS on successful operation, otherwise
No base home directory configured.
.El
.El
-.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/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
-.It Pa /var/log/userlog
-User/group modification logfile
-.El
.Sh SEE ALSO
.Xr chpass 1 ,
.Xr passwd 1 ,
+.Xr umask 2 ,
.Xr group 5 ,
.Xr login.conf 5 ,
.Xr passwd 5 ,
git.ckatri.com / pw-darwin.git / blobdiff