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