xref: /freebsd/usr.sbin/pw/pw.8 (revision 0fddbf874719b9bd50cf66ac26d1140bb3f2be69)
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 a
116.Nm
117.Op Fl V Ar etcdir
118.Ar usernext
119.Op Fl C Ar config
120.Op Fl q
121.Nm
122.Op Fl V Ar etcdir
123.Ar groupadd
124.Op group|gid
125.Op Fl C Ar config
126.Op Fl q
127.Op Fl n Ar group
128.Op Fl g Ar gid
129.Op Fl M Ar members
130.Op Fl o
131.Op Fl h Ar fd
132.Op Fl N
133.Op Fl P
134.Op Fl Y
135.Nm
136.Op Fl V Ar etcdir
137.Ar groupdel
138.Op group|gid
139.Op Fl n Ar name
140.Op Fl g Ar gid
141.Op Fl Y
142.Nm
143.Op Fl V Ar etcdir
144.Ar groupmod
145.Op group|gid
146.Op Fl C Ar config
147.Op Fl q
148.Op Fl F
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
403for more information on user login classes.
404.It Fl m
405This option instructs
406.Nm
407to attempt to create the user's home directory.
408While primarily useful when adding a new account with
409.Ar useradd ,
410this may also be of use when moving an existing user's home directory elsewhere on
411the filesystem.
412The new home directory is populated with the contents of the
413.Ar skeleton
414directory, which typically contains a set of shell configuration files that the
415user may personalize to taste.
416When
417.Fl m
418is used on an account with
419.Ar usermod ,
420existing configuration files in the user's home directory are
421.Em not
422overwritten from the skeleton files.
423.Pp
424When a user's home directory is created, it will by default be a subdirectory of the
425.Ar basehome
426directory as specified by the
427.Fl b
428option (see below), bearing the name of the new account.
429This can be overridden by the
430.Fl d
431option on the command line, if desired.
432.It Fl k Ar dir
433Set the
434.Ar skeleton
435directory, from which basic startup and configuration files are copied when
436the user's home directory is created.
437This option only has meaning when used with the
438.Fl d
439or
440.Fl m
441flags.
442.It Fl s Ar shell
443Set or changes the user's login shell to
444.Ar shell .
445If the path to the shell program is omitted,
446.Nm
447searches the
448.Ar shellpath
449specified in
450.Pa /etc/pw.conf
451and fills it in as appropriate.
452Note that unless you have a specific reason to do so, you should avoid
453specifying the path - this will allow
454.Nm
455to validate that the program exists and is executable.
456Specifying a full path (or supplying a blank "" shell) avoids this check
457and allows for such entries as
458.Pa /nonexistent
459that should be set for accounts not intended for interactive login.
460.It Fl L Ar class
461Set the
462.Em class
463field in the user's passwd record.
464This field is not currently used, but will be used in the future to specify a
465.Em termcap
466entry like tag.
467See
468.Xr passwd 5
469for details.
470.It Fl h Ar fd
471This option provides a special interface by which interactive scripts can
472set an account password using
473.Nm .
474Because the command line and environment are fundamentally insecure mechanisms
475by which programs can accept information,
476.Nm
477will only allow setting of account and group passwords via a file descriptor
478(usually a pipe between an interactive script and the program).
479.Ar sh ,
480.Ar bash ,
481.Ar ksh
482and
483.Ar perl
484all possess mechanisms by which this can be done.
485Alternatively,
486.Nm
487will prompt for the user's password if
488.Fl h Ar 0
489is given, nominating
490.Em stdin
491as the file descriptor on which to read the password.
492Note that this password will be read only once and is intended
493for use by a script rather than for interactive use.
494If you wish to have new password confirmation along the lines of
495.Xr passwd 1 ,
496this must be implemented as part of an interactive script that calls
497.Nm .
498.Pp
499If a value of
500.Ql \&-
501is given as the argument
502.Ar fd ,
503then the password will be set to
504.Ql \&* ,
505rendering the account inaccessible via password-based login.
506.El
507.Pp
508It is possible to use
509.Ar useradd
510to create a new account that duplicates an existing user id.
511While this is normally considered an error and will be rejected, the
512.Fl o
513option overrides the check for duplicates and allows the duplication of
514the user id.
515This may be useful if you allow the same user to login under
516different contexts (different group allocations, different home
517directory, different shell) while providing basically the same
518permissions for access to the user's files in each account.
519.Pp
520The
521.Ar useradd
522command also has the ability to set new user and group defaults by using the
523.Fl D
524option.
525Instead of adding a new user,
526.Nm
527writes a new set of defaults to its configuration file,
528.Pa /etc/pw.conf .
529When using the
530.Fl D
531option, you must not use either
532.Fl n Ar name
533or
534.Fl u Ar uid
535or an error will result.
536Use of
537.Fl D
538changes the meaning of several command line switches in the
539.Ar useradd
540command.
541These are:
542.Bl -tag -width "-G grouplist"
543.It Fl D
544Set default values in
545.Pa /etc/pw.conf
546configuration file, or a different named configuration file if the
547.Fl C Ar config
548option is used.
549.It Fl b Ar dir
550Set the root directory in which user home directories are created.
551The default value for this is
552.Pa /home ,
553but it may be set elsewhere as desired.
554.It Fl e Ar days
555Set the default account expiration period in days.
556Unlike use without
557.Fl D ,
558the argument must be numeric, which specifies the number of days after creation when
559the account is to expire.
560A value of 0 suppresses automatic calculation of the expiry date.
561.It Fl p Ar days
562Set the default password expiration period in days.
563.It Fl g Ar group
564Set the default group for new users.
565If a blank group is specified using
566.Fl g Ar \&"" ,
567then new users will be allocated their own private primary group
568with the same name as their login name.
569If a group is supplied, either its name or uid may be given as an argument.
570.It Fl G Ar grouplist
571Set the default groups in which new users are granted membership.
572This is a separate set of groups from the primary group, and you should avoid
573nominating the same group as both primary and extra groups.
574In other words, these extra groups determine membership in groups
575.Em other than
576the primary group.
577.Ar grouplist
578is a comma-separated list of group names or ids, and are always
579stored in
580.Pa /etc/pw.conf
581by their symbolic names.
582.It Fl L Ar class
583This option sets the default login class for new users.
584.It Fl k Ar dir
585Set the default
586.Em skeleton
587directory, from which prototype shell and other initialization files are copied when
588.Nm
589creates a user's home directory.
590.It Xo
591.Fl u Ar min , Ns Ar max ,
592.Fl i Ar min , Ns Ar max
593.Xc
594These options set the minimum and maximum user and group ids allocated for new accounts
595and groups created by
596.Nm .
597The default values for each is 1000 minimum and 32000 maximum.
598.Ar min
599and
600.Ar max
601are both numbers, where max must be greater than min, and both must be between 0
602and 32767.
603In general, user and group ids less than 100 are reserved for use by the system,
604and numbers greater than 32000 may also be reserved for special purposes (used by
605some system daemons).
606.It Fl w Ar method
607The
608.Fl w
609option sets the default method used to set passwords for newly created user accounts.
610.Ar method
611is one of:
612.Pp
613.Bl -tag -width random -offset indent -compact
614.It no
615disable login on newly created accounts
616.It yes
617force the password to be the account name
618.It none
619force a blank password
620.It random
621generate a random password
622.El
623.Pp
624The
625.Ql \&random
626or
627.Ql \&no
628methods are the most secure; in the former case,
629.Nm
630generates a password and prints it to stdout, which is suitable where you issue
631users with passwords to access their accounts rather than having the user nominate
632their own (possibly poorly chosen) password.
633The
634.Ql \&no
635method requires that the superuser use
636.Xr passwd 1
637to render the account accessible with a password.
638.It Fl y Ar path
639This sets the pathname of the database used by NIS if you are not sharing
640the information from
641.Pa /etc/master.passwd
642directly with NIS.
643You should only set this option for NIS servers.
644.El
645.Pp
646The
647.Ar userdel
648command has only three valid options.
649The
650.Fl n Ar name
651and
652.Fl u Ar uid
653options have already been covered above.
654The additional option is:
655.Bl -tag -width "-G grouplist"
656.It Fl r
657This tells
658.Nm
659to remove the user's home directory and all of its contents.
660.Nm Pw
661errs on the side of caution when removing files from the system.
662Firstly, it will not do so if the uid of the account being removed is also used by
663another account on the system, and the 'home' directory in the password file is
664a valid path that commences with the character
665.Ql \&/ .
666Secondly, it will only remove files and directories that are actually owned by
667the user, or symbolic links owned by anyone under the user's home directory.
668Finally, after deleting all contents owned by the user only empty directories
669will be removed.
670If any additional cleanup work is required, this is left to the administrator.
671.El
672.Pp
673Mail spool files and crontabs are always removed when an account is deleted as these
674are unconditionally attached to the user name.
675Jobs queued for processing by
676.Ar at
677are also removed if the user's uid is unique and not also used by another account on the
678system.
679.Pp
680The
681.Ar usershow
682command allows viewing of an account in one of two formats.
683By default, the format is identical to the format used in
684.Pa /etc/master.passwd
685with the password field replaced with a
686.Ql \&* .
687If the
688.Fl P
689option is used, then
690.Nm
691outputs the account details in a more human readable form.
692The
693.Fl a
694option lists all users currently on file.
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.
767.Pp
768The command
769.Ar groupnext
770returns the next available group id on standard output.
771.Sh USER LOCKING
772.Nm Pw
773supports a simple password locking mechanism for users; it works by
774prepending the string
775.Ql *LOCKED*
776to the beginning of the password field in
777.Pa master.passwd
778to prevent successful authentication.
779.Pp
780The
781.Ar lock
782and
783.Ar unlock
784commands take a user name or uid of the account to lock or unlock,
785respectively.  The
786.Fl V ,
787.Fl C ,
788and
789.Fl q
790options as described above are accepted by these commands.
791.Sh DIAGNOSTICS
792.Nm Pw
793returns EXIT_SUCCESS on successful operation, otherwise
794.Nm
795returns one of the
796following exit codes defined by
797.Xr sysexits 3
798as follows:
799.Bl -tag -width xxxx
800.It EX_USAGE
801.Bl -bullet -compact
802.It
803Command line syntax errors (invalid keyword, unknown option).
804.El
805.It EX_NOPERM
806.Bl -bullet -compact
807.It
808Attempting to run one of the update modes as non-root.
809.El
810.It EX_OSERR
811.Bl -bullet -compact
812.It
813Memory allocation error.
814.It
815Read error from password file descriptor.
816.El
817.It EX_DATAERR
818.Bl -bullet -compact
819.It
820Bad or invalid data provided or missing on the command line or
821via the password file descriptor.
822.It
823Attempted to remove, rename root account or change its uid.
824.El
825.It EX_OSFILE
826.Bl -bullet -compact
827.It
828Skeleton directory is invalid or does not exist.
829.It
830Base home directory is invalid or does not exist.
831.It
832Invalid or non-existent shell specified.
833.El
834.It EX_NOUSER
835.Bl -bullet -compact
836.It
837User, user id, group or group id specified does not exist.
838.It
839User or group recorded, added, or modified unexpectedly disappeared.
840.El
841.It EX_SOFTWARE
842.Bl -bullet -compact
843.It
844No more group or user ids available within specified range.
845.El
846.It EX_IOERR
847.Bl -bullet -compact
848.It
849Unable to rewrite configuration file.
850.It
851Error updating group or user database files.
852.It
853Update error for passwd or group database files.
854.El
855.It EX_CONFIG
856.Bl -bullet -compact
857.It
858No base home directory configured.
859.El
860.El
861.Sh NOTES
862For a summary of options available with each command, you can use
863.Dl pw [command] help
864For example,
865.Dl pw useradd help
866lists all available options for the useradd operation.
867.Pp
868.Nm Pw
869allows 8-bit characters in the passwd GECOS field (user's full name,
870office, work and home phone number subfields), but disallows them in
871user login and group names.
872Use 8-bit characters with caution, as connection to the Internet will
873require that your mail transport program supports 8BITMIME, and will
874convert headers containing 8-bit characters to 7-bit quoted-printable
875format.
876.Xr sendmail 8
877does support this.
878Use of 8-bit characters in the GECOS field should be used in
879conjunction with the user's default locale and character set
880and should not be implemented without their use.
881Using 8-bit characters may also affect other
882programs that transmit the contents of the GECOS field over the
883Internet, such as
884.Xr fingerd 8 ,
885and a small number of TCP/IP clients, such as IRC, where full names
886specified in the passwd file may be used by default.
887.Sh FILES
888.Bl -tag -width /etc/master.passwd.new -compact
889.It Pa /etc/master.passwd
890The user database
891.It Pa /etc/passwd
892A Version 7 format password file
893.It Pa /etc/login.conf
894The user capabilities database
895.It Pa /etc/group
896The group database
897.It Pa /etc/master.passwd.new
898Temporary copy of the master password file
899.It Pa /etc/passwd.new
900Temporary copy of the Version 7 password file
901.It Pa /etc/group.new
902Temporary copy of the group file
903.It Pa /etc/pw.conf
904Pw default options file
905.El
906.Sh SEE ALSO
907.Xr chpass 1 ,
908.Xr passwd 1 ,
909.Xr group 5 ,
910.Xr login.conf 5 ,
911.Xr passwd 5 ,
912.Xr pw.conf 5 ,
913.Xr pwd_mkdb 8 ,
914.Xr vipw 8
915.Sh HISTORY
916.Nm Pw
917was written to mimic many of the options used in the SYSV
918.Em shadow
919support suite, but is modified for passwd and group fields specific to
920the
921.Bx 4.4
922operating system, and combines all of the major elements
923into a single command.
924