.\" 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.13 1998/03/23 08:28:12 charnier Exp $
+.\" $FreeBSD$
.\"
.Dd December 9, 1996
.Dt PW 8
.Nm pw
.Nd create, remove, modify & display system users and groups
.Sh SYNOPSIS
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar useradd
.Op name|uid
.Op Fl C Ar config
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar useradd
.Op name|uid
.Fl D
.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 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 V Ar etcdir
.Ar userdel
.Op name|uid
.Op Fl n Ar name
.Op Fl u Ar uid
.Op Fl r
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar usermod
.Op name|uid
.Op Fl C Ar config
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar usershow
.Op name|uid
.Op Fl n Ar name
.Op Fl F
.Op Fl P
.Op Fl a
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar usernext
.Op Fl C Ar config
.Op Fl q
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar groupadd
.Op group|gid
.Op Fl C Ar config
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar groupdel
.Op group|gid
.Op Fl n Ar name
.Op Fl g Ar gid
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar groupmod
.Op group|gid
.Op Fl C Ar config
.Op Fl N
.Op Fl P
.Op Fl Y
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar groupshow
.Op group|gid
.Op Fl n Ar name
.Op Fl F
.Op Fl P
.Op Fl a
-.Nm pw
+.Nm
+.Op Fl V Ar etcdir
.Ar groupnext
.Op Fl C Ar config
.Op Fl q
+.Nm
+.Op Fl V Ar etcdir
+.Ar lock
+.Op name|uid
+.Op Fl C Ar config
+.Op Fl q
+.Nm
+.Op Fl V Ar etcdir
+.Ar unlock
+.Op name|uid
+.Op Fl C Ar config
+.Op Fl q
.Sh DESCRIPTION
.Nm Pw
is a command-line based editor for the system
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 ,
+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 show ,
or
.Ar next
-in any order. (For example,
-.Ar showuser ,
-.Ar usershow ,
-.Ar show user , and
+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
.Fl g Ar gid
options.
.Pp
-The following flags are common to most 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
+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.
+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 (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 may be used on the command line before the operation keyword.
.It Fl C Ar config
By default,
.Nm
.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
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
.Fl y Ar path
-option to specify the location of the NIS passwd database so that
+option to specify the location of the 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
then you should
.Em not
use the
-.Ql Fl u
+.Fl u
option.
You may also provide either the account or userid immediately after the
.Ar useradd ,
or
.Ar usershow
keywords on the command line without using the
-.Ql Fl n
+.Fl n
or
-.Ql 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
This field is similar to the account expiration date option, except that it
applies to forced password changes.
This is set in the same manner as the
-.Ql Fl e
+.Fl e
option.
.It Fl g Ar group
Set the account's primary group to the given group.
directory, which typically contains a set of shell configuration files that the
user may personalize to taste.
When
-.Ql Fl m
+.Fl m
is used on an account with
.Ar usermod ,
existing configuration files in the user's home directory are
When a user's home directory is created, it will by default be a subdirectory of the
.Ar basehome
directory as specified by the
-.Ql Fl b
+.Fl b
option (see below), bearing the name of the new account.
This can be overridden by the
-.Ql Fl d
+.Fl d
option on the command line, if desired.
.It Fl k Ar dir
Set the
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 the
-.Ql Fl d
+.Fl d
or
-.Ql Fl m
+.Fl m
flags.
.It Fl s Ar shell
Set or changes the user's login shell to
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
+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 .
+.Nm .
Because the command line and environment are fundamentally insecure mechanisms
by which programs can accept information,
.Nm
Alternatively,
.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.
If you wish to have new password confirmation along the lines of
.Xr passwd 1 ,
this must be implemented as part of an interactive script that calls
-.Nm pw .
+.Nm .
.Pp
If a value of
.Ql \&-
.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
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
Set the root directory in which user home directories are created.
.It Fl e Ar days
Set the default account expiration period in days.
Unlike use without
-.Ql Fl D ,
+.Fl D ,
the argument must be numeric, which specifies the number of days after creation when
the account is to expire.
A value of 0 suppresses automatic calculation of the expiry date.
.It Fl g Ar group
Set the default group for new users.
If a blank group is specified using
-.Ql Fl g Ar \&"" ,
+.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.
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
+.It Xo
+.Fl u Ar min , Ns Ar max ,
+.Fl i Ar min , Ns Ar max
+.Xc
These options set the minimum and maximum user and group ids allocated for new accounts
and groups created by
-.Nm pw .
+.Nm .
The default values for each is 1000 minimum and 32000 maximum.
.Ar min
and
some system daemons).
.It Fl w Ar method
The
-.Ql Fl w
+.Fl w
option sets the default method used to set passwords for newly created user accounts.
.Ar method
is one of:
.Pp
The
.Ar userdel
-command has only three valid options. The
-.Ql Fl n Ar name
+command has only three valid 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"
with the password field replaced with a
.Ql \&* .
If the
-.Ql Fl P
+.Fl P
option is used, then
.Nm
outputs the account details in a more human readable form.
The
-.Ql Fl a
+.Fl a
option lists all users currently on file.
.Pp
The command
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
+.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:
versa.
You will only need to use both when setting a specific group id
against a new group or when changing the uid of an existing group.
-.Ql Fl M Ar memberlist
+.It Fl M Ar memberlist
This option provides an alternative way to add existing users to a
new group (in groupadd) or replace an existing membership list (in
groupmod).
is a comma separated list of valid and existing user names or uids.
.It Fl m Ar newmembers
Similar to
-.Ql Fl M ,
+.Fl M ,
this option allows the
.Em addition
of existing users to a group without replacing the existing list of
.Pp
.Ar groupadd
also has a
-.Ql Fl o
+.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.
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.
.Pp
The command
.Ar groupnext
returns the next available group id on standard output.
+.Sh USER LOCKING
+.Nm Pw
+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 DIAGNOSTICS
.Nm Pw
-returns EXIT_SUCCESS on successful operation, otherwise
+returns EXIT_SUCCESS on successful operation, otherwise
.Nm
returns one of the
following exit codes defined by
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
.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
git.ckatri.com / pw-darwin.git / blobdiff