xref: /freebsd/usr.sbin/pw/pw.8 (revision 3ff369fed2a08f32dda232c10470b949bef9489f)
1.\" Copyright (C) 1996
2.\" David L. Nugent.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY DAVID L. NUGENT AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL DAVID L. NUGENT OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd December 9, 1996
28.Dt PW 8
29.Os
30.Sh NAME
31.Nm pw
32.Nd create, remove, modify & display system users and groups
33.Sh SYNOPSIS
34.Nm
35.Op Fl V Ar etcdir
36.Ar useradd
37.Op name|uid
38.Op Fl C Ar config
39.Op Fl q
40.Op Fl n Ar name
41.Op Fl u Ar uid
42.Op Fl c Ar comment
43.Op Fl d Ar dir
44.Op Fl e Ar date
45.Op Fl p Ar date
46.Op Fl g Ar group
47.Op Fl G Ar grouplist
48.Op Fl m
49.Op Fl k Ar dir
50.Op Fl s Ar shell
51.Op Fl o
52.Op Fl L Ar class
53.Op Fl h Ar fd
54.Op Fl N
55.Op Fl P
56.Op Fl Y
57.Nm
58.Op Fl V Ar etcdir
59.Ar useradd
60.Op name|uid
61.Fl D
62.Op Fl C Ar config
63.Op Fl q
64.Op Fl b Ar dir
65.Op Fl e Ar days
66.Op Fl p Ar days
67.Op Fl g Ar group
68.Op Fl G Ar grouplist
69.Op Fl k Ar dir
70.Op Fl u Ar min , Ns Ar max
71.Op Fl i Ar min , Ns Ar max
72.Op Fl w Ar method
73.Op Fl s Ar shell
74.Op Fl y Ar path
75.Nm
76.Op Fl V Ar etcdir
77.Ar userdel
78.Op name|uid
79.Op Fl n Ar name
80.Op Fl u Ar uid
81.Op Fl r
82.Op Fl Y
83.Nm
84.Op Fl V Ar etcdir
85.Ar usermod
86.Op name|uid
87.Op Fl C Ar config
88.Op Fl q
89.Op Fl n Ar name
90.Op Fl u Ar uid
91.Op Fl c Ar comment
92.Op Fl d Ar dir
93.Op Fl e Ar date
94.Op Fl p Ar date
95.Op Fl g Ar group
96.Op Fl G Ar grouplist
97.Op Fl l Ar name
98.Op Fl m
99.Op Fl k Ar dir
100.Op Fl w Ar method
101.Op Fl s Ar shell
102.Op Fl L Ar class
103.Op Fl h Ar fd
104.Op Fl N
105.Op Fl P
106.Op Fl Y
107.Nm
108.Op Fl V Ar etcdir
109.Ar usershow
110.Op name|uid
111.Op Fl n Ar name
112.Op Fl u Ar uid
113.Op Fl F
114.Op Fl P
115.Op Fl 7
116.Op Fl a
117.Nm
118.Op Fl V Ar etcdir
119.Ar usernext
120.Op Fl C Ar config
121.Op Fl q
122.Nm
123.Op Fl V Ar etcdir
124.Ar groupadd
125.Op group|gid
126.Op Fl C Ar config
127.Op Fl q
128.Op Fl n Ar group
129.Op Fl g Ar gid
130.Op Fl M Ar members
131.Op Fl o
132.Op Fl h Ar fd
133.Op Fl N
134.Op Fl P
135.Op Fl Y
136.Nm
137.Op Fl V Ar etcdir
138.Ar groupdel
139.Op group|gid
140.Op Fl n Ar name
141.Op Fl g Ar gid
142.Op Fl Y
143.Nm
144.Op Fl V Ar etcdir
145.Ar groupmod
146.Op group|gid
147.Op Fl C Ar config
148.Op Fl q
149.Op Fl n Ar name
150.Op Fl g Ar gid
151.Op Fl l Ar name
152.Op Fl M Ar members
153.Op Fl m Ar newmembers
154.Op Fl h Ar fd
155.Op Fl N
156.Op Fl P
157.Op Fl Y
158.Nm
159.Op Fl V Ar etcdir
160.Ar groupshow
161.Op group|gid
162.Op Fl n Ar name
163.Op Fl g Ar gid
164.Op Fl F
165.Op Fl P
166.Op Fl a
167.Nm
168.Op Fl V Ar etcdir
169.Ar groupnext
170.Op Fl C Ar config
171.Op Fl q
172.Nm
173.Op Fl V Ar etcdir
174.Ar lock
175.Op name|uid
176.Op Fl C Ar config
177.Op Fl q
178.Nm
179.Op Fl V Ar etcdir
180.Ar unlock
181.Op name|uid
182.Op Fl C Ar config
183.Op Fl q
184.Sh DESCRIPTION
185.Nm Pw
186is a command-line based editor for the system
187.Ar user
188and
189.Ar group
190files, allowing the superuser an easy to use and standardized way of adding,
191modifying and removing users and groups.
192Note that
193.Nm
194only operates on the local user and group files.  NIS users and groups must be
195maintained on the NIS server.
196.Nm Pw
197handles updating the
198.Pa passwd ,
199.Pa master.passwd ,
200.Pa group
201and the secure and insecure
202password database files, and must be run as root.
203.Pp
204The first one or two keywords provided to
205.Nm
206on the command line provide the context for the remainder of the arguments.
207The keywords
208.Ar user
209and
210.Ar group
211may be combined with
212.Ar add ,
213.Ar del ,
214.Ar mod ,
215.Ar show ,
216or
217.Ar next
218in any order.
219(For example,
220.Ar showuser ,
221.Ar usershow ,
222.Ar show user ,
223and
224.Ar user show
225all mean the same thing.)
226This flexibility is useful for interactive scripts calling
227.Nm
228for user and group database manipulation.
229Following these keywords, you may optionally specify the user or group name or numeric
230id as an alternative to using the
231.Fl n Ar name ,
232.Fl u Ar uid ,
233.Fl g Ar gid
234options.
235.Pp
236The following flags are common to most or all modes of operation;
237.Pp
238.Bl -tag -width "-G grouplist"
239.It Fl V Ar etcdir
240This flag sets an alternate location for the password, group and configuration files,
241and may be used to maintain a user/group database in an alternate location.
242If this switch is specified, the system
243.Pa /etc/pw.conf
244will not be sourced for default configuration data, but the file pw.conf in the
245specified directory will be used instead (or none, if it does not exist).
246The
247.Fl C
248flag may be used to override this behaviour.
249As an exception to the general rule where options must follow the operation
250type, the
251.Fl V
252flag may be used on the command line before the operation keyword.
253.It Fl C Ar config
254By default,
255.Nm
256reads the file
257.Pa /etc/pw.conf
258to obtain policy information on how new user accounts and groups are to be created.
259The
260.Fl C
261option specifies a different configuration file.
262While most of the contents of the configuration file may be overridden via
263command-line options, it may be more convenient to keep standard information in a
264configuration file.
265.It Fl q
266Use of this option causes
267.Nm
268to suppress error messages, which may be useful in interactive environments where it
269is preferable to interpret status codes returned by
270.Nm
271rather than messing up a carefully formatted display.
272.It Fl N
273This option is available in
274.Ar add
275and
276.Ar modify
277operations, and tells
278.Nm
279to output the result of the operation without updating the user or group
280databases.
281You may use the
282.Fl P
283option to switch between standard passwd and readable formats.
284.It Fl Y
285Using this option with any of the update modes causes
286.Nm
287to run
288.Xr make 1
289after changing to the directory
290.Pa /var/yp .
291This is intended to allow automatic updating of NIS database files.
292If separate passwd and group files are being used by NIS, then use the
293.Fl y Ar path
294option to specify the location of the NIS passwd database so that
295.Nm
296will concurrently update it with the system password
297databases.
298.El
299.Sh USER OPTIONS
300The following options apply to the
301.Ar useradd
302and
303.Ar usermod
304commands:
305.Pp
306.Bl -tag -width "-G grouplist"
307.It Fl n Ar name
308Specify the user/account name.
309.It Fl u Ar uid
310Specify the user/account numeric id.
311.Pp
312Usually, you only need to provide one or the other of these options, as the account
313name will imply the uid, or vice versa.
314However, there are times when you need to provide both.
315For example, when changing the uid of an existing user with
316.Ar usermod ,
317or overriding the default uid when creating a new account.
318If you wish
319.Nm
320to automatically allocate the uid to a new user with
321.Ar useradd ,
322then you should
323.Em not
324use the
325.Fl u
326option.
327You may also provide either the account or userid immediately after the
328.Ar useradd ,
329.Ar userdel ,
330.Ar usermod
331or
332.Ar usershow
333keywords on the command line without using the
334.Fl n
335or
336.Fl u
337options.
338.El
339.Pp
340.Bl -tag -width "-G grouplist"
341.It Fl c Ar comment
342This field sets the contents of the passwd GECOS field, which normally contains up
343to four comma-separated fields containing the user's full name, office or location,
344and work and home phone numbers.
345These sub-fields are used by convention only, however, and are optional.
346If this field is to contain spaces, you need to quote the comment itself with double
347quotes
348.Ql \&" .
349Avoid using commas in this field as these are used as sub-field separators, and the
350colon
351.Ql \&:
352character also cannot be used as this is the field separator for the passwd
353file itself.
354.It Fl d Ar dir
355This option sets the account's home directory.
356Normally, you will only use this if the home directory is to be different from the
357default determined from
358.Pa /etc/pw.conf
359- normally
360.Pa /home
361with the account name as a subdirectory.
362.It Fl e Ar date
363Set the account's expiration date.
364Format of the date is either a UNIX time in decimal, or a date in
365.Ql dd-mmm-yy[yy]
366format, where dd is the day, mmm is the month, either in numeric or alphabetic format
367('Jan', 'Feb', etc) and year is either a two or four digit year.
368This option also accepts a relative date in the form
369.Ql \&+n[mhdwoy]
370where
371.Ql \&n
372is a decimal, octal (leading 0) or hexadecimal (leading 0x) digit followed by the
373number of Minutes, Hours, Days, Weeks, Months or Years from the current date at
374which the expiration date is to be set.
375.It Fl p Ar date
376Set the account's password expiration date.
377This field is similar to the account expiration date option, except that it
378applies to forced password changes.
379This is set in the same manner as the
380.Fl e
381option.
382.It Fl g Ar group
383Set the account's primary group to the given group.
384.Ar group
385may be defined by either its name or group number.
386.It Fl G Ar grouplist
387Sets additional group memberships for an account.
388.Ar grouplist
389is a comma-separated list of group names or group numbers.
390The user's name is added to the group lists in
391.Pa /etc/group ,
392and
393removed from any groups not specified in
394.Ar grouplist .
395Note: a user should not be added to their primary group with
396.Ar grouplist .
397Also, group membership changes do not take effect for current user login
398sessions, requiring the user to reconnect to be affected by the changes.
399.It Fl L Ar class
400This option sets the login class for the user being created.
401See
402.Xr login.conf 5
403and
404.Xr passwd 5
405for more information on user login classes.
406.It Fl m
407This option instructs
408.Nm
409to attempt to create the user's home directory.
410While primarily useful when adding a new account with
411.Ar useradd ,
412this may also be of use when moving an existing user's home directory elsewhere on
413the filesystem.
414The new home directory is populated with the contents of the
415.Ar skeleton
416directory, which typically contains a set of shell configuration files that the
417user may personalize to taste.
418When
419.Fl m
420is used on an account with
421.Ar usermod ,
422existing configuration files in the user's home directory are
423.Em not
424overwritten from the skeleton files.
425.Pp
426When a user's home directory is created, it will by default be a subdirectory of the
427.Ar basehome
428directory as specified by the
429.Fl b
430option (see below), bearing the name of the new account.
431This can be overridden by the
432.Fl d
433option on the command line, if desired.
434.It Fl k Ar dir
435Set the
436.Ar skeleton
437directory, from which basic startup and configuration files are copied when
438the user's home directory is created.
439This option only has meaning when used with the
440.Fl d
441or
442.Fl m
443flags.
444.It Fl s Ar shell
445Set or changes the user's login shell to
446.Ar shell .
447If the path to the shell program is omitted,
448.Nm
449searches the
450.Ar shellpath
451specified in
452.Pa /etc/pw.conf
453and fills it in as appropriate.
454Note that unless you have a specific reason to do so, you should avoid
455specifying the path - this will allow
456.Nm
457to validate that the program exists and is executable.
458Specifying a full path (or supplying a blank "" shell) avoids this check
459and allows for such entries as
460.Pa /nonexistent
461that should be set for accounts not intended for interactive login.
462.It Fl h Ar fd
463This option provides a special interface by which interactive scripts can
464set an account password using
465.Nm .
466Because the command line and environment are fundamentally insecure mechanisms
467by which programs can accept information,
468.Nm
469will only allow setting of account and group passwords via a file descriptor
470(usually a pipe between an interactive script and the program).
471.Ar sh ,
472.Ar bash ,
473.Ar ksh
474and
475.Ar perl
476all possess mechanisms by which this can be done.
477Alternatively,
478.Nm
479will prompt for the user's password if
480.Fl h Ar 0
481is given, nominating
482.Em stdin
483as the file descriptor on which to read the password.
484Note that this password will be read only once and is intended
485for use by a script rather than for interactive use.
486If you wish to have new password confirmation along the lines of
487.Xr passwd 1 ,
488this must be implemented as part of an interactive script that calls
489.Nm .
490.Pp
491If a value of
492.Ql \&-
493is given as the argument
494.Ar fd ,
495then the password will be set to
496.Ql \&* ,
497rendering the account inaccessible via password-based login.
498.El
499.Pp
500It is possible to use
501.Ar useradd
502to create a new account that duplicates an existing user id.
503While this is normally considered an error and will be rejected, the
504.Fl o
505option overrides the check for duplicates and allows the duplication of
506the user id.
507This may be useful if you allow the same user to login under
508different contexts (different group allocations, different home
509directory, different shell) while providing basically the same
510permissions for access to the user's files in each account.
511.Pp
512The
513.Ar useradd
514command also has the ability to set new user and group defaults by using the
515.Fl D
516option.
517Instead of adding a new user,
518.Nm
519writes a new set of defaults to its configuration file,
520.Pa /etc/pw.conf .
521When using the
522.Fl D
523option, you must not use either
524.Fl n Ar name
525or
526.Fl u Ar uid
527or an error will result.
528Use of
529.Fl D
530changes the meaning of several command line switches in the
531.Ar useradd
532command.
533These are:
534.Bl -tag -width "-G grouplist"
535.It Fl D
536Set default values in
537.Pa /etc/pw.conf
538configuration file, or a different named configuration file if the
539.Fl C Ar config
540option is used.
541.It Fl b Ar dir
542Set the root directory in which user home directories are created.
543The default value for this is
544.Pa /home ,
545but it may be set elsewhere as desired.
546.It Fl e Ar days
547Set the default account expiration period in days.
548Unlike use without
549.Fl D ,
550the argument must be numeric, which specifies the number of days after creation when
551the account is to expire.
552A value of 0 suppresses automatic calculation of the expiry date.
553.It Fl p Ar days
554Set the default password expiration period in days.
555.It Fl g Ar group
556Set the default group for new users.
557If a blank group is specified using
558.Fl g Ar \&"" ,
559then new users will be allocated their own private primary group
560with the same name as their login name.
561If a group is supplied, either its name or uid may be given as an argument.
562.It Fl G Ar grouplist
563Set the default groups in which new users are granted membership.
564This is a separate set of groups from the primary group, and you should avoid
565nominating the same group as both primary and extra groups.
566In other words, these extra groups determine membership in groups
567.Em other than
568the primary group.
569.Ar grouplist
570is a comma-separated list of group names or ids, and are always
571stored in
572.Pa /etc/pw.conf
573by their symbolic names.
574.It Fl L Ar class
575This option sets the default login class for new users.
576.It Fl k Ar dir
577Set the default
578.Em skeleton
579directory, from which prototype shell and other initialization files are copied when
580.Nm
581creates a user's home directory.
582.It Xo
583.Fl u Ar min , Ns Ar max ,
584.Fl i Ar min , Ns Ar max
585.Xc
586These options set the minimum and maximum user and group ids allocated for new accounts
587and groups created by
588.Nm .
589The default values for each is 1000 minimum and 32000 maximum.
590.Ar min
591and
592.Ar max
593are both numbers, where max must be greater than min, and both must be between 0
594and 32767.
595In general, user and group ids less than 100 are reserved for use by the system,
596and numbers greater than 32000 may also be reserved for special purposes (used by
597some system daemons).
598.It Fl w Ar method
599The
600.Fl w
601option sets the default method used to set passwords for newly created user accounts.
602.Ar method
603is one of:
604.Pp
605.Bl -tag -width random -offset indent -compact
606.It no
607disable login on newly created accounts
608.It yes
609force the password to be the account name
610.It none
611force a blank password
612.It random
613generate a random password
614.El
615.Pp
616The
617.Ql \&random
618or
619.Ql \&no
620methods are the most secure; in the former case,
621.Nm
622generates a password and prints it to stdout, which is suitable where you issue
623users with passwords to access their accounts rather than having the user nominate
624their own (possibly poorly chosen) password.
625The
626.Ql \&no
627method requires that the superuser use
628.Xr passwd 1
629to render the account accessible with a password.
630.It Fl y Ar path
631This sets the pathname of the database used by NIS if you are not sharing
632the information from
633.Pa /etc/master.passwd
634directly with NIS.
635You should only set this option for NIS servers.
636.El
637.Pp
638The
639.Ar userdel
640command has only three valid options.
641The
642.Fl n Ar name
643and
644.Fl u Ar uid
645options have already been covered above.
646The additional option is:
647.Bl -tag -width "-G grouplist"
648.It Fl r
649This tells
650.Nm
651to remove the user's home directory and all of its contents.
652.Nm Pw
653errs on the side of caution when removing files from the system.
654Firstly, it will not do so if the uid of the account being removed is also used by
655another account on the system, and the 'home' directory in the password file is
656a valid path that commences with the character
657.Ql \&/ .
658Secondly, it will only remove files and directories that are actually owned by
659the user, or symbolic links owned by anyone under the user's home directory.
660Finally, after deleting all contents owned by the user only empty directories
661will be removed.
662If any additional cleanup work is required, this is left to the administrator.
663.El
664.Pp
665Mail spool files and crontabs are always removed when an account is deleted as these
666are unconditionally attached to the user name.
667Jobs queued for processing by
668.Ar at
669are also removed if the user's uid is unique and not also used by another account on the
670system.
671.Pp
672The
673.Ar usershow
674command allows viewing of an account in one of two formats.
675By default, the format is identical to the format used in
676.Pa /etc/master.passwd
677with the password field replaced with a
678.Ql \&* .
679If the
680.Fl P
681option is used, then
682.Nm
683outputs the account details in a more human readable form.
684If the
685.Fl 7
686option is used, the account details are shown in v7 format.
687The
688.Fl a
689option lists all users currently on file.
690Using
691.Fl F
692forces
693.Nm
694to print the details of an account even if it does not exist.
695.Pp
696The command
697.Ar usernext
698returns the next available user and group ids separated by a colon.
699This is normally of interest only to interactive scripts or front-ends
700that use
701.Nm .
702.Sh GROUP OPTIONS
703The
704.Fl C
705and
706.Fl q
707options (explained at the start of the previous section) are available
708with the group manipulation commands.
709Other common options to all group-related commands are:
710.Bl -tag -width "-m newmembers"
711.It Fl n Ar name
712Specify the group name.
713.It Fl g Ar gid
714Specify the group numeric id.
715.Pp
716As with the account name and id fields, you will usually only need
717to supply one of these, as the group name implies the uid and vice
718versa.
719You will only need to use both when setting a specific group id
720against a new group or when changing the uid of an existing group.
721.It Fl M Ar memberlist
722This option provides an alternative way to add existing users to a
723new group (in groupadd) or replace an existing membership list (in
724groupmod).
725.Ar memberlist
726is a comma separated list of valid and existing user names or uids.
727.It Fl m Ar newmembers
728Similar to
729.Fl M ,
730this option allows the
731.Em addition
732of existing users to a group without replacing the existing list of
733members.
734Login names or user ids may be used, and duplicate users are
735silently eliminated.
736.El
737.Pp
738.Ar groupadd
739also has a
740.Fl o
741option that allows allocation of an existing group id to a new group.
742The default action is to reject an attempt to add a group, and this option overrides
743the check for duplicate group ids.
744There is rarely any need to duplicate a group id.
745.Pp
746The
747.Ar groupmod
748command adds one additional option:
749.Pp
750.Bl -tag -width "-m newmembers"
751.It Fl l Ar name
752This option allows changing of an existing group name to
753.Ql \&name .
754The new name must not already exist, and any attempt to duplicate an existing group
755name will be rejected.
756.El
757.Pp
758Options for
759.Ar groupshow
760are the same as for
761.Ar usershow ,
762with the
763.Fl g Ar gid
764replacing
765.Fl u Ar uid
766to specify the group id.
767The
768.Fl 7
769option does not apply to the
770.Ar groupshow
771command.
772.Pp
773The command
774.Ar groupnext
775returns the next available group id on standard output.
776.Sh USER LOCKING
777.Nm Pw
778supports a simple password locking mechanism for users; it works by
779prepending the string
780.Ql *LOCKED*
781to the beginning of the password field in
782.Pa master.passwd
783to prevent successful authentication.
784.Pp
785The
786.Ar lock
787and
788.Ar unlock
789commands take a user name or uid of the account to lock or unlock,
790respectively.  The
791.Fl V ,
792.Fl C ,
793and
794.Fl q
795options as described above are accepted by these commands.
796.Sh DIAGNOSTICS
797.Nm Pw
798returns EXIT_SUCCESS on successful operation, otherwise
799.Nm
800returns one of the
801following exit codes defined by
802.Xr sysexits 3
803as follows:
804.Bl -tag -width xxxx
805.It EX_USAGE
806.Bl -bullet -compact
807.It
808Command line syntax errors (invalid keyword, unknown option).
809.El
810.It EX_NOPERM
811.Bl -bullet -compact
812.It
813Attempting to run one of the update modes as non-root.
814.El
815.It EX_OSERR
816.Bl -bullet -compact
817.It
818Memory allocation error.
819.It
820Read error from password file descriptor.
821.El
822.It EX_DATAERR
823.Bl -bullet -compact
824.It
825Bad or invalid data provided or missing on the command line or
826via the password file descriptor.
827.It
828Attempted to remove, rename root account or change its uid.
829.El
830.It EX_OSFILE
831.Bl -bullet -compact
832.It
833Skeleton directory is invalid or does not exist.
834.It
835Base home directory is invalid or does not exist.
836.It
837Invalid or non-existent shell specified.
838.El
839.It EX_NOUSER
840.Bl -bullet -compact
841.It
842User, user id, group or group id specified does not exist.
843.It
844User or group recorded, added, or modified unexpectedly disappeared.
845.El
846.It EX_SOFTWARE
847.Bl -bullet -compact
848.It
849No more group or user ids available within specified range.
850.El
851.It EX_IOERR
852.Bl -bullet -compact
853.It
854Unable to rewrite configuration file.
855.It
856Error updating group or user database files.
857.It
858Update error for passwd or group database files.
859.El
860.It EX_CONFIG
861.Bl -bullet -compact
862.It
863No base home directory configured.
864.El
865.El
866.Sh NOTES
867For a summary of options available with each command, you can use
868.Dl pw [command] help
869For example,
870.Dl pw useradd help
871lists all available options for the useradd operation.
872.Pp
873.Nm Pw
874allows 8-bit characters in the passwd GECOS field (user's full name,
875office, work and home phone number subfields), but disallows them in
876user login and group names.
877Use 8-bit characters with caution, as connection to the Internet will
878require that your mail transport program supports 8BITMIME, and will
879convert headers containing 8-bit characters to 7-bit quoted-printable
880format.
881.Xr sendmail 8
882does support this.
883Use of 8-bit characters in the GECOS field should be used in
884conjunction with the user's default locale and character set
885and should not be implemented without their use.
886Using 8-bit characters may also affect other
887programs that transmit the contents of the GECOS field over the
888Internet, such as
889.Xr fingerd 8 ,
890and a small number of TCP/IP clients, such as IRC, where full names
891specified in the passwd file may be used by default.
892.Sh FILES
893.Bl -tag -width /etc/master.passwd.new -compact
894.It Pa /etc/master.passwd
895The user database
896.It Pa /etc/passwd
897A Version 7 format password file
898.It Pa /etc/login.conf
899The user capabilities database
900.It Pa /etc/group
901The group database
902.It Pa /etc/master.passwd.new
903Temporary copy of the master password file
904.It Pa /etc/passwd.new
905Temporary copy of the Version 7 password file
906.It Pa /etc/group.new
907Temporary copy of the group file
908.It Pa /etc/pw.conf
909Pw default options file
910.El
911.Sh SEE ALSO
912.Xr chpass 1 ,
913.Xr passwd 1 ,
914.Xr group 5 ,
915.Xr login.conf 5 ,
916.Xr passwd 5 ,
917.Xr pw.conf 5 ,
918.Xr pwd_mkdb 8 ,
919.Xr vipw 8
920.Sh HISTORY
921.Nm Pw
922was written to mimic many of the options used in the SYSV
923.Em shadow
924support suite, but is modified for passwd and group fields specific to
925the
926.Bx 4.4
927operating system, and combines all of the major elements
928into a single command.
929