.\" 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
.Op Fl G Ar grouplist
.Op Fl m
.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 u Ar uid
.Op Fl F
.Op Fl P
+.Op Fl 7
.Op Fl a
.Nm
.Op Fl V Ar etcdir
.Op group|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 C Ar config
.Op Fl q
.Sh DESCRIPTION
-.Nm Pw
-is a command-line based editor for the system
+The
+.Nm
+utility is a command-line based editor for the system
.Ar user
and
.Ar group
modifying and removing users and groups.
Note that
.Nm
-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 ,
+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 to
-.Nm
+.Nm
on the command line provide the context for the remainder of the arguments.
The keywords
.Ar user
.Ar next
in any order.
(For example,
-.Ar showuser ,
-.Ar usershow ,
+.Ar showuser ,
+.Ar usershow ,
.Ar show user ,
and
.Ar user show
.Fl g Ar gid
options.
.Pp
-The following flags are common to most or all modes of operation;
+The following flags are common to most or all modes of operation:
.Pp
.Bl -tag -width "-G grouplist"
.It Fl V Ar etcdir
.Nm
rather than messing up a carefully formatted display.
.It Fl N
-This option is available in
-.Ar add
-and
-.Ar modify
+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
.Xr make 1
after changing to the directory
.Pa /var/yp .
-This is intended to allow automatic updating of 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
+option to specify the location of the
+.Tn NIS
+passwd database so that
.Nm
will concurrently update it with the system password
databases.
keywords on the command line without using the
.Fl n
or
-.Fl u
+.Fl u
options.
.El
.Pp
.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 determined from
+default determined from
.Pa /etc/pw.conf
- normally
.Pa /home
with the account name as a subdirectory.
.It Fl e Ar date
-Set 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
.Ar group
may be defined by either its name or group number.
.It Fl G Ar grouplist
-Sets additional group memberships for an account.
+Set additional group memberships for an account.
.Ar grouplist
is a comma-separated list of group names or group numbers.
The user's name is added to the group lists in
This option sets the login class for the user being created.
See
.Xr login.conf 5
+and
+.Xr passwd 5
for more information on user login classes.
.It Fl m
This option instructs
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.
+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
When a user's home directory is created, it will by default be a subdirectory of the
.Ar basehome
directory as specified by the
-.Fl b
+.Fl b
option (see below), bearing the name of the new account.
This can be overridden by the
-.Fl d
+.Fl d
option on the command line, if desired.
.It Fl k Ar dir
Set the
This option only has meaning when used with the
.Fl d
or
-.Fl m
+.Fl m
flags.
.It Fl s Ar shell
Set or changes the user's login shell to
and allows for such entries as
.Pa /nonexistent
that should be set for accounts not intended for interactive login.
-.It Fl L Ar class
-Set the
-.Em class
-field in the user's passwd record.
-This field is not currently used, but will be used in the future 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
.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 for NIS servers.
+directly with
+.Tn NIS .
+You should only set this option for
+.Tn NIS
+servers.
.El
.Pp
The
This tells
.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.
+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
option is used, then
.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
.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
.Nm .
.Sh GROUP OPTIONS
The
-.Fl C
+.Fl C
and
.Fl q
options (explained at the start of the previous section) are available
replacing
.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 USER LOCKING
-.Nm Pw
+The
+.Nm
+utility
supports a simple password locking mechanism for users; it works by
prepending the string
.Ql *LOCKED*
.Fl q
options as described above are accepted by these commands.
.Sh DIAGNOSTICS
-.Nm Pw
-returns EXIT_SUCCESS on successful operation, otherwise
+The
+.Nm
+utility returns EXIT_SUCCESS on successful operation, otherwise
.Nm
returns one of the
following exit codes defined by
.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,
+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
.Bl -tag -width /etc/master.passwd.new -compact
.It Pa /etc/master.passwd
The user database
-.It Pa /etc/passwd
+.It Pa /etc/passwd
A Version 7 format password file
.It Pa /etc/login.conf
The user capabilities database
.Xr pwd_mkdb 8 ,
.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