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