Do not expose password if it is empty and PWF_STANDARD format is requested

[pw-darwin.git] / pw / pw.8

diff --git a/pw/pw.8 b/pw/pw.8
index 96538ae93c97ff23d7668f1cefca636f68d93d6f..6b6a6727fb0ed511eb583ce67a335ea73c0bc8ba 100644 (file)
--- a/pw/pw.8
+++ b/pw/pw.8
@@ -1,6 +1,6 @@
 .\" Copyright (C) 1996
 .\" David L. Nugent.  All rights reserved.
 .\" 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:
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:


@@ -9,7 +9,7 @@
 .\" 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.
 .\" 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
 .\" 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


@@ -47,6 +47,7 @@
 .Op Fl G Ar grouplist
 .Op Fl m
 .Op Fl k Ar dir
 .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 s Ar shell
 .Op Fl o
 .Op Fl L Ar class


@@ -112,6 +113,7 @@
 .Op Fl u Ar uid
 .Op Fl F
 .Op Fl P
 .Op Fl u Ar uid
 .Op Fl F
 .Op Fl P

+.Op Fl 7

 .Op Fl a
 .Nm
 .Op Fl V Ar etcdir
 .Op Fl a
 .Nm
 .Op Fl V Ar etcdir


@@ -145,7 +147,6 @@
 .Op group|gid
 .Op Fl C Ar config
 .Op Fl q
 .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 n Ar name
 .Op Fl g Ar gid
 .Op Fl l Ar name


@@ -182,8 +183,9 @@
 .Op Fl C Ar config
 .Op Fl q
 .Sh DESCRIPTION
 .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
 .Ar user
 and
 .Ar group


@@ -191,18 +193,23 @@ files, allowing the superuser an easy to use and standardized way of adding,
 modifying and removing users and groups.
 Note that
 .Nm
 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
 .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
 on the command line provide the context for the remainder of the arguments.
 The keywords
 .Ar user


@@ -217,8 +224,8 @@ or
 .Ar next
 in any order.
 (For example,
 .Ar next
 in any order.
 (For example,

-.Ar showuser , 
-.Ar usershow , 
+.Ar showuser ,
+.Ar usershow ,

 .Ar show user ,
 and
 .Ar user show
 .Ar show user ,
 and
 .Ar user show


@@ -233,7 +240,7 @@ id as an alternative to using the
 .Fl g Ar gid
 options.
 .Pp
 .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
 .Pp
 .Bl -tag -width "-G grouplist"
 .It Fl V Ar etcdir


@@ -270,10 +277,10 @@ is preferable to interpret status codes returned by
 .Nm
 rather than messing up a carefully formatted display.
 .It Fl N
 .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
 operations, and tells
 .Nm
 to output the result of the operation without updating the user or group


@@ -288,10 +295,16 @@ to run
 .Xr make 1
 after changing to the directory
 .Pa /var/yp .
 .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
 .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.
 .Nm
 will concurrently update it with the system password
 databases.


@@ -333,7 +346,7 @@ or
 keywords on the command line without using the
 .Fl n
 or
 keywords on the command line without using the
 .Fl n
 or

-.Fl u 
+.Fl u

 options.
 .El
 .Pp
 options.
 .El
 .Pp


@@ -354,13 +367,13 @@ 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
 .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
 .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
 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


@@ -384,7 +397,7 @@ Set the account's primary group to the given group.
 .Ar group
 may be defined by either its name or group number.
 .It Fl G Ar grouplist
 .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
 .Ar grouplist
 is a comma-separated list of group names or group numbers.
 The user's name is added to the group lists in


@@ -400,6 +413,8 @@ sessions, requiring the user to reconnect to be affected by the changes.
 This option sets the login class for the user being created.
 See
 .Xr login.conf 5
 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
 for more information on user login classes.
 .It Fl m
 This option instructs


@@ -408,7 +423,7 @@ 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
 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
 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


@@ -424,10 +439,10 @@ overwritten from the skeleton files.
 When a user's home directory is created, it will by default be a subdirectory of the
 .Ar basehome
 directory as specified by 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
 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
 option on the command line, if desired.
 .It Fl k Ar dir
 Set the


@@ -437,7 +452,7 @@ the user's home directory is created.
 This option only has meaning when used with the
 .Fl d
 or
 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
 flags.
 .It Fl s Ar shell
 Set or changes the user's login shell to


@@ -457,16 +472,6 @@ Specifying a full path (or supplying a blank "" shell) avoids this check
 and allows for such entries as
 .Pa /nonexistent
 that should be set for accounts not intended for interactive login.
 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
 .It Fl h Ar fd
 This option provides a special interface by which interactive scripts can
 set an account password using


@@ -636,11 +641,16 @@ method requires that the superuser use
 .Xr passwd 1
 to render the account accessible with a password.
 .It Fl y Ar path
 .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
 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
 .El
 .Pp
 The


@@ -657,8 +667,9 @@ The additional option is:
 This tells
 .Nm
 to remove the user's home directory and all of its contents.
 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
 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


@@ -689,9 +700,17 @@ If the
 option is used, then
 .Nm
 outputs the account details in a more human readable form.
 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.
 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
 .Pp
 The command
 .Ar usernext


@@ -701,7 +720,7 @@ that use
 .Nm .
 .Sh GROUP OPTIONS
 The
 .Nm .
 .Sh GROUP OPTIONS
 The

-.Fl C 
+.Fl C

 and
 .Fl q
 options (explained at the start of the previous section) are available
 and
 .Fl q
 options (explained at the start of the previous section) are available


@@ -764,12 +783,19 @@ with the
 replacing
 .Fl u Ar uid
 to specify the group id.
 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
 .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*
 supports a simple password locking mechanism for users; it works by
 prepending the string
 .Ql *LOCKED*


@@ -789,8 +815,9 @@ and
 .Fl q
 options as described above are accepted by these commands.
 .Sh DIAGNOSTICS
 .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
 .Nm
 returns one of the
 following exit codes defined by


@@ -865,8 +892,9 @@ For example,
 .Dl pw useradd help
 lists all available options for the useradd operation.
 .Pp
 .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
 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


@@ -888,7 +916,7 @@ specified in the passwd file may be used by default.
 .Bl -tag -width /etc/master.passwd.new -compact
 .It Pa /etc/master.passwd
 The user database
 .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
 A Version 7 format password file
 .It Pa /etc/login.conf
 The user capabilities database


@@ -913,8 +941,9 @@ Pw default options file
 .Xr pwd_mkdb 8 ,
 .Xr vipw 8
 .Sh HISTORY
 .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
 .Em shadow
 support suite, but is modified for passwd and group fields specific to
 the