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