Remove __P() usage.

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

diff --git a/pw/pw.8 b/pw/pw.8
index 51ebe1936bd1345b99dc6b1925b9d61b69dee812..c927c1335666489b0138c6d0df524fddb0865910 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


@@ -194,15 +194,15 @@ Note that
 only operates on the local user and group files.  NIS users and groups must be
 maintained on the NIS server.
 .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 , 
+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 +217,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


@@ -270,10 +270,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


@@ -291,12 +291,11 @@ after changing to the directory
 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
 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
 .Nm
 will concurrently update it with the system password
 databases.
 .El

-.Pp

 .Sh USER OPTIONS
 The following options apply to the
 .Ar useradd
 .Sh USER OPTIONS
 The following options apply to the
 .Ar useradd


@@ -323,7 +322,7 @@ to automatically allocate the uid to a new user with
 then you should
 .Em not
 use the
 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 ,
 option.
 You may also provide either the account or userid immediately after the
 .Ar useradd ,


@@ -332,9 +331,9 @@ You may also provide either the account or userid immediately after the
 or
 .Ar usershow
 keywords on the command line without using the
 or
 .Ar usershow
 keywords on the command line without using the

-.Ql Fl n
+.Fl n

 or
 or

-.Ql Fl u 
+.Fl u

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


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


@@ -378,7 +377,7 @@ 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.
 This is set in the same manner as the
 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.
 option.
 .It Fl g Ar group
 Set the account's primary group to the given group.


@@ -401,6 +400,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


@@ -415,7 +416,7 @@ The new home directory is populated with the contents of the
 directory, which typically contains a set of shell configuration files that the
 user may personalize to taste.
 When
 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
 is used on an account with
 .Ar usermod ,
 existing configuration files in the user's home directory are


@@ -425,10 +426,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

-.Ql 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

-.Ql 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


@@ -436,9 +437,9 @@ 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
 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
 or

-.Ql 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


@@ -458,16 +459,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


@@ -486,7 +477,7 @@ all possess mechanisms by which this can be done.
 Alternatively,
 .Nm
 will prompt for the user's password if
 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.
 is given, nominating
 .Em stdin
 as the file descriptor on which to read the password.


@@ -510,7 +501,7 @@ 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
 .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
 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


@@ -521,21 +512,21 @@ permissions for access to the user's files in each account.
 The
 .Ar useradd
 command also has the ability to set new user and group defaults by using the
 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
 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
 option, you must not use either

-.Ql Fl n Ar name
+.Fl n Ar name

 or
 or

-.Ql Fl u Ar uid
+.Fl u Ar uid

 or an error will result.
 Use of
 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.
 changes the meaning of several command line switches in the
 .Ar useradd
 command.


@@ -545,7 +536,7 @@ These are:
 Set default values in
 .Pa /etc/pw.conf
 configuration file, or a different named configuration file if the
 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.
 option is used.
 .It Fl b Ar dir
 Set the root directory in which user home directories are created.


@@ -555,7 +546,7 @@ but it may be set elsewhere as desired.
 .It Fl e Ar days
 Set the default account expiration period in days.
 Unlike use without
 .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.
 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.


@@ -564,7 +555,7 @@ Set the default password expiration period in days.
 .It Fl g Ar group
 Set the default group for new users.
 If a blank group is specified using
 .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.
 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.


@@ -606,7 +597,7 @@ and numbers greater than 32000 may also be reserved for special purposes (used b
 some system daemons).
 .It Fl w Ar method
 The
 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:
 option sets the default method used to set passwords for newly created user accounts.
 .Ar method
 is one of:


@@ -648,9 +639,9 @@ The
 .Ar userdel
 command has only three valid options.
 The
 .Ar userdel
 command has only three valid options.
 The

-.Ql Fl n Ar name
+.Fl n Ar name

 and
 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"
 options have already been covered above.
 The additional option is:
 .Bl -tag -width "-G grouplist"


@@ -686,12 +677,12 @@ By default, the format is identical to the format used in
 with the password field replaced with a
 .Ql \&* .
 If the
 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
 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
 option lists all users currently on file.
 .Pp
 The command


@@ -700,12 +691,11 @@ 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 .
 This is normally of interest only to interactive scripts or front-ends
 that use
 .Nm .

-.Pp

 .Sh GROUP OPTIONS
 The
 .Sh GROUP OPTIONS
 The

-.Ql Fl C 
+.Fl C

 and
 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:
 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:


@@ -728,7 +718,7 @@ groupmod).
 is a comma separated list of valid and existing user names or uids.
 .It Fl m Ar newmembers
 Similar to
 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
 this option allows the
 .Em addition
 of existing users to a group without replacing the existing list of


@@ -739,7 +729,7 @@ silently eliminated.
 .Pp
 .Ar groupadd
 also has a
 .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.
 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.


@@ -762,9 +752,9 @@ Options for
 are the same as for
 .Ar usershow ,
 with the
 are the same as for
 .Ar usershow ,
 with the

-.Ql Fl g Ar gid
+.Fl g Ar gid

 replacing
 replacing

-.Ql Fl u Ar uid
+.Fl u Ar uid

 to specify the group id.
 .Pp
 The command
 to specify the group id.
 .Pp
 The command


@@ -785,14 +775,14 @@ and
 .Ar unlock
 commands take a user name or uid of the account to lock or unlock,
 respectively.  The
 .Ar unlock
 commands take a user name or uid of the account to lock or unlock,
 respectively.  The

-.Ql Fl V ,
-.Ql Fl C ,
+.Fl V ,
+.Fl C ,

 and
 and

-.Ql Fl q
+.Fl q

 options as described above are accepted by these commands.
 .Sh DIAGNOSTICS
 .Nm Pw
 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
 .Nm
 returns one of the
 following exit codes defined by


@@ -860,7 +850,6 @@ Update error for passwd or group database files.
 No base home directory configured.
 .El
 .El
 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
 .Sh NOTES
 For a summary of options available with each command, you can use
 .Dl pw [command] help


@@ -891,7 +880,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