diff options
| -rw-r--r-- | adduser/adduser.8 | 13 | ||||
| -rw-r--r-- | adduser/rmuser.8 | 24 | ||||
| -rw-r--r-- | pw/pw.8 | 67 |
3 files changed, 67 insertions, 37 deletions
diff --git a/adduser/adduser.8 b/adduser/adduser.8 index 71078a3..0f52c3b 100644 --- a/adduser/adduser.8 +++ b/adduser/adduser.8 @@ -48,9 +48,9 @@ .Op Fl v | verbose .Ek .Sh DESCRIPTION -.Nm Adduser -is a simple program for adding new users. -Adduser checks +The +.Nm +utility is a simple program for adding new users. It checks the passwd, group and shell databases. It creates passwd/group entries, .Ev HOME @@ -189,8 +189,9 @@ Recommended for novice users. .Ql Pa # is a comment. .It Sy configuration file -.Nm Adduser -reads and writes this file. +The +.Nm +utility reads and writes this file. See .Pa /etc/adduser.conf for more details. @@ -239,5 +240,5 @@ logfile for adduser .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 2.1 . diff --git a/adduser/rmuser.8 b/adduser/rmuser.8 index d3ed353..2e55694 100644 --- a/adduser/rmuser.8 +++ b/adduser/rmuser.8 @@ -37,8 +37,9 @@ .Op Fl y .Op Ar username .Sh DESCRIPTION -The utility +The .Nm +utility .Pp .Bl -enum .It @@ -76,7 +77,9 @@ the group is removed; this complements per-user unique groups). .El .Pp -.Nm Rmuser +The +.Nm +utility politely refuses to remove users whose uid is 0 (typically root), since certain actions (namely, killing all the user's processes, and perhaps removing the user's home directory) would cause damage to a running system. @@ -139,17 +142,19 @@ interactively asks for the user to be removed. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 2.2 . .\" .Sh AUTHOR .\" Guy Helmer, Ames, Iowa .Sh BUGS -.Nm Rmuser -does not comprehensively search the filesystem for all files +The +.Nm +utility does not comprehensively search the filesystem for all files owned by the removed user and remove them; to do so on a system of any size is prohibitively slow and I/O intensive. -.Nm Rmuser -also is unable to remove symbolic links that were created by the +The +.Nm +utility also is unable to remove symbolic links that were created by the user in .Pa /tmp or @@ -165,6 +170,7 @@ and .Pa /var/mail/.pop.username that are not owned by the removed user but should be removed. .Pp -.Nm Rmuser -has no knowledge of NIS (Yellow Pages), and it operates only on the +The +.Nm +utility has no knowledge of NIS (Yellow Pages), and it operates only on the local password file. @@ -183,8 +183,9 @@ .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 @@ -192,10 +193,15 @@ files, allowing the superuser an easy to use and standardized way of adding, 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 +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 @@ -289,10 +295,16 @@ to run .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. @@ -385,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 -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 @@ -629,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 -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 @@ -650,8 +667,9 @@ The additional option is: 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 @@ -775,7 +793,9 @@ 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* @@ -795,8 +815,9 @@ and .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 @@ -871,8 +892,9 @@ For example, .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 @@ -919,8 +941,9 @@ Pw default options file .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 |