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 October 9, 2006 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 | 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 | 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 | 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 | 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. 431Files in this directory are usually named 432.Pa dot . Ns Aq Ar config 433where the 434.Pa dot 435prefix will be stripped. 436When 437.Fl m 438is used on an account with 439.Ar usermod , 440existing configuration files in the user's home directory are 441.Em not 442overwritten from the skeleton files. 443.Pp 444When a user's home directory is created, it will by default be a subdirectory of the 445.Ar basehome 446directory as specified by the 447.Fl b 448option (see below), bearing the name of the new account. 449This can be overridden by the 450.Fl d 451option on the command line, if desired. 452.It Fl k Ar dir 453Set the 454.Ar skeleton 455directory, from which basic startup and configuration files are copied when 456the user's home directory is created. 457This option only has meaning when used with the 458.Fl d 459or 460.Fl m 461flags. 462.It Fl s Ar shell 463Set or changes the user's login shell to 464.Ar shell . 465If the path to the shell program is omitted, 466.Nm 467searches the 468.Ar shellpath 469specified in 470.Pa /etc/pw.conf 471and fills it in as appropriate. 472Note that unless you have a specific reason to do so, you should avoid 473specifying the path - this will allow 474.Nm 475to validate that the program exists and is executable. 476Specifying a full path (or supplying a blank "" shell) avoids this check 477and allows for such entries as 478.Pa /nonexistent 479that should be set for accounts not intended for interactive login. 480.It Fl h Ar fd 481This option provides a special interface by which interactive scripts can 482set an account password using 483.Nm . 484Because the command line and environment are fundamentally insecure mechanisms 485by which programs can accept information, 486.Nm 487will only allow setting of account and group passwords via a file descriptor 488(usually a pipe between an interactive script and the program). 489.Ar sh , 490.Ar bash , 491.Ar ksh 492and 493.Ar perl 494all possess mechanisms by which this can be done. 495Alternatively, 496.Nm 497will prompt for the user's password if 498.Fl h Ar 0 499is given, nominating 500.Em stdin 501as the file descriptor on which to read the password. 502Note that this password will be read only once and is intended 503for use by a script rather than for interactive use. 504If you wish to have new password confirmation along the lines of 505.Xr passwd 1 , 506this must be implemented as part of an interactive script that calls 507.Nm . 508.Pp 509If a value of 510.Ql \&- 511is given as the argument 512.Ar fd , 513then the password will be set to 514.Ql \&* , 515rendering the account inaccessible via password-based login. 516.It Fl H Ar fd 517Read an encrypted password string from the specified file descriptor. 518This is like 519.Fl h , 520but the password should be supplied already encrypted in a form 521suitable for writing directly to the password database. 522.El 523.Pp 524It is possible to use 525.Ar useradd 526to create a new account that duplicates an existing user id. 527While this is normally considered an error and will be rejected, the 528.Fl o 529option overrides the check for duplicates and allows the duplication of 530the user id. 531This may be useful if you allow the same user to login under 532different contexts (different group allocations, different home 533directory, different shell) while providing basically the same 534permissions for access to the user's files in each account. 535.Pp 536The 537.Ar useradd 538command also has the ability to set new user and group defaults by using the 539.Fl D 540option. 541Instead of adding a new user, 542.Nm 543writes a new set of defaults to its configuration file, 544.Pa /etc/pw.conf . 545When using the 546.Fl D 547option, you must not use either 548.Fl n Ar name 549or 550.Fl u Ar uid 551or an error will result. 552Use of 553.Fl D 554changes the meaning of several command line switches in the 555.Ar useradd 556command. 557These are: 558.Bl -tag -width "-G grouplist" 559.It Fl D 560Set default values in 561.Pa /etc/pw.conf 562configuration file, or a different named configuration file if the 563.Fl C Ar config 564option is used. 565.It Fl b Ar dir 566Set the root directory in which user home directories are created. 567The default value for this is 568.Pa /home , 569but it may be set elsewhere as desired. 570.It Fl e Ar days 571Set the default account expiration period in days. 572Unlike use without 573.Fl D , 574the argument must be numeric, which specifies the number of days after creation when 575the account is to expire. 576A value of 0 suppresses automatic calculation of the expiry date. 577.It Fl p Ar days 578Set the default password expiration period in days. 579.It Fl g Ar group 580Set the default group for new users. 581If a blank group is specified using 582.Fl g Ar \&"" , 583then new users will be allocated their own private primary group 584with the same name as their login name. 585If a group is supplied, either its name or uid may be given as an argument. 586.It Fl G Ar grouplist 587Set the default groups in which new users are granted membership. 588This is a separate set of groups from the primary group, and you should avoid 589nominating the same group as both primary and extra groups. 590In other words, these extra groups determine membership in groups 591.Em other than 592the primary group. 593.Ar grouplist 594is a comma-separated list of group names or ids, and are always 595stored in 596.Pa /etc/pw.conf 597by their symbolic names. 598.It Fl L Ar class 599This option sets the default login class for new users. 600.It Fl k Ar dir 601Set the default 602.Em skeleton 603directory, from which prototype shell and other initialization files are copied when 604.Nm 605creates a user's home directory. 606See description of 607.Fl k 608for naming conventions of these files. 609.It Xo 610.Fl u Ar min , Ns Ar max , 611.Fl i Ar min , Ns Ar max 612.Xc 613These options set the minimum and maximum user and group ids allocated for new accounts 614and groups created by 615.Nm . 616The default values for each is 1000 minimum and 32000 maximum. 617.Ar min 618and 619.Ar max 620are both numbers, where max must be greater than min, and both must be between 0 621and 32767. 622In general, user and group ids less than 100 are reserved for use by the system, 623and numbers greater than 32000 may also be reserved for special purposes (used by 624some system daemons). 625.It Fl w Ar method 626The 627.Fl w 628option sets the default method used to set passwords for newly created user accounts. 629.Ar method 630is one of: 631.Pp 632.Bl -tag -width random -offset indent -compact 633.It no 634disable login on newly created accounts 635.It yes 636force the password to be the account name 637.It none 638force a blank password 639.It random 640generate a random password 641.El 642.Pp 643The 644.Ql \&random 645or 646.Ql \&no 647methods are the most secure; in the former case, 648.Nm 649generates a password and prints it to stdout, which is suitable where you issue 650users with passwords to access their accounts rather than having the user nominate 651their own (possibly poorly chosen) password. 652The 653.Ql \&no 654method requires that the superuser use 655.Xr passwd 1 656to render the account accessible with a password. 657.It Fl y Ar path 658This sets the pathname of the database used by 659.Tn NIS 660if you are not sharing 661the information from 662.Pa /etc/master.passwd 663directly with 664.Tn NIS . 665You should only set this option for 666.Tn NIS 667servers. 668.El 669.Pp 670The 671.Ar userdel 672command has only three valid options. 673The 674.Fl n Ar name 675and 676.Fl u Ar uid 677options have already been covered above. 678The additional option is: 679.Bl -tag -width "-G grouplist" 680.It Fl r 681This tells 682.Nm 683to remove the user's home directory and all of its contents. 684The 685.Nm 686utility errs on the side of caution when removing files from the system. 687Firstly, it will not do so if the uid of the account being removed is also used by 688another account on the system, and the 'home' directory in the password file is 689a valid path that commences with the character 690.Ql \&/ . 691Secondly, it will only remove files and directories that are actually owned by 692the user, or symbolic links owned by anyone under the user's home directory. 693Finally, after deleting all contents owned by the user only empty directories 694will be removed. 695If any additional cleanup work is required, this is left to the administrator. 696.El 697.Pp 698Mail spool files and crontabs are always removed when an account is deleted as these 699are unconditionally attached to the user name. 700Jobs queued for processing by 701.Ar at 702are also removed if the user's uid is unique and not also used by another account on the 703system. 704.Pp 705The 706.Ar usershow 707command allows viewing of an account in one of two formats. 708By default, the format is identical to the format used in 709.Pa /etc/master.passwd 710with the password field replaced with a 711.Ql \&* . 712If the 713.Fl P 714option is used, then 715.Nm 716outputs the account details in a more human readable form. 717If the 718.Fl 7 719option is used, the account details are shown in v7 format. 720The 721.Fl a 722option lists all users currently on file. 723Using 724.Fl F 725forces 726.Nm 727to print the details of an account even if it does not exist. 728.Pp 729The command 730.Ar usernext 731returns the next available user and group ids separated by a colon. 732This is normally of interest only to interactive scripts or front-ends 733that use 734.Nm . 735.Sh GROUP OPTIONS 736The 737.Fl C 738and 739.Fl q 740options (explained at the start of the previous section) are available 741with the group manipulation commands. 742Other common options to all group-related commands are: 743.Bl -tag -width "-m newmembers" 744.It Fl n Ar name 745Specify the group name. 746.It Fl g Ar gid 747Specify the group numeric id. 748.Pp 749As with the account name and id fields, you will usually only need 750to supply one of these, as the group name implies the uid and vice 751versa. 752You will only need to use both when setting a specific group id 753against a new group or when changing the uid of an existing group. 754.It Fl M Ar memberlist 755This option provides an alternative way to add existing users to a 756new group (in groupadd) or replace an existing membership list (in 757groupmod). 758.Ar memberlist 759is a comma separated list of valid and existing user names or uids. 760.It Fl m Ar newmembers 761Similar to 762.Fl M , 763this option allows the 764.Em addition 765of existing users to a group without replacing the existing list of 766members. 767Login names or user ids may be used, and duplicate users are 768silently eliminated. 769.El 770.Pp 771.Ar groupadd 772also has a 773.Fl o 774option that allows allocation of an existing group id to a new group. 775The default action is to reject an attempt to add a group, and this option overrides 776the check for duplicate group ids. 777There is rarely any need to duplicate a group id. 778.Pp 779The 780.Ar groupmod 781command adds one additional option: 782.Pp 783.Bl -tag -width "-m newmembers" 784.It Fl l Ar name 785This option allows changing of an existing group name to 786.Ql \&name . 787The new name must not already exist, and any attempt to duplicate an existing group 788name will be rejected. 789.El 790.Pp 791Options for 792.Ar groupshow 793are the same as for 794.Ar usershow , 795with the 796.Fl g Ar gid 797replacing 798.Fl u Ar uid 799to specify the group id. 800The 801.Fl 7 802option does not apply to the 803.Ar groupshow 804command. 805.Pp 806The command 807.Ar groupnext 808returns the next available group id on standard output. 809.Sh USER LOCKING 810The 811.Nm 812utility 813supports a simple password locking mechanism for users; it works by 814prepending the string 815.Ql *LOCKED* 816to the beginning of the password field in 817.Pa master.passwd 818to prevent successful authentication. 819.Pp 820The 821.Ar lock 822and 823.Ar unlock 824commands take a user name or uid of the account to lock or unlock, 825respectively. 826The 827.Fl V , 828.Fl C , 829and 830.Fl q 831options as described above are accepted by these commands. 832.Sh NOTES 833For a summary of options available with each command, you can use 834.Dl pw [command] help 835For example, 836.Dl pw useradd help 837lists all available options for the useradd operation. 838.Pp 839The 840.Nm 841utility allows 8-bit characters in the passwd GECOS field (user's full name, 842office, work and home phone number subfields), but disallows them in 843user login and group names. 844Use 8-bit characters with caution, as connection to the Internet will 845require that your mail transport program supports 8BITMIME, and will 846convert headers containing 8-bit characters to 7-bit quoted-printable 847format. 848.Xr sendmail 8 849does support this. 850Use of 8-bit characters in the GECOS field should be used in 851conjunction with the user's default locale and character set 852and should not be implemented without their use. 853Using 8-bit characters may also affect other 854programs that transmit the contents of the GECOS field over the 855Internet, such as 856.Xr fingerd 8 , 857and a small number of TCP/IP clients, such as IRC, where full names 858specified in the passwd file may be used by default. 859.Pp 860The 861.Nm 862utility writes a log to the 863.Pa /var/log/userlog 864file when actions such as user or group additions or deletions occur. 865The location of this logfile can be changed in 866.Xr pw.conf 5 . 867.Sh FILES 868.Bl -tag -width /etc/master.passwd.new -compact 869.It Pa /etc/master.passwd 870The user database 871.It Pa /etc/passwd 872A Version 7 format password file 873.It Pa /etc/login.conf 874The user capabilities database 875.It Pa /etc/group 876The group database 877.It Pa /etc/master.passwd.new 878Temporary copy of the master password file 879.It Pa /etc/passwd.new 880Temporary copy of the Version 7 password file 881.It Pa /etc/group.new 882Temporary copy of the group file 883.It Pa /etc/pw.conf 884Pw default options file 885.It Pa /var/log/userlog 886User/group modification logfile 887.El 888.Sh EXIT STATUS 889The 890.Nm 891utility returns EXIT_SUCCESS on successful operation, otherwise 892.Nm 893returns one of the 894following exit codes defined by 895.Xr sysexits 3 896as follows: 897.Bl -tag -width xxxx 898.It EX_USAGE 899.Bl -bullet -compact 900.It 901Command line syntax errors (invalid keyword, unknown option). 902.El 903.It EX_NOPERM 904.Bl -bullet -compact 905.It 906Attempting to run one of the update modes as non-root. 907.El 908.It EX_OSERR 909.Bl -bullet -compact 910.It 911Memory allocation error. 912.It 913Read error from password file descriptor. 914.El 915.It EX_DATAERR 916.Bl -bullet -compact 917.It 918Bad or invalid data provided or missing on the command line or 919via the password file descriptor. 920.It 921Attempted to remove, rename root account or change its uid. 922.El 923.It EX_OSFILE 924.Bl -bullet -compact 925.It 926Skeleton directory is invalid or does not exist. 927.It 928Base home directory is invalid or does not exist. 929.It 930Invalid or non-existent shell specified. 931.El 932.It EX_NOUSER 933.Bl -bullet -compact 934.It 935User, user id, group or group id specified does not exist. 936.It 937User or group recorded, added, or modified unexpectedly disappeared. 938.El 939.It EX_SOFTWARE 940.Bl -bullet -compact 941.It 942No more group or user ids available within specified range. 943.El 944.It EX_IOERR 945.Bl -bullet -compact 946.It 947Unable to rewrite configuration file. 948.It 949Error updating group or user database files. 950.It 951Update error for passwd or group database files. 952.El 953.It EX_CONFIG 954.Bl -bullet -compact 955.It 956No base home directory configured. 957.El 958.El 959.Sh SEE ALSO 960.Xr chpass 1 , 961.Xr passwd 1 , 962.Xr group 5 , 963.Xr login.conf 5 , 964.Xr passwd 5 , 965.Xr pw.conf 5 , 966.Xr pwd_mkdb 8 , 967.Xr vipw 8 968.Sh HISTORY 969The 970.Nm 971utility was written to mimic many of the options used in the SYSV 972.Em shadow 973support suite, but is modified for passwd and group fields specific to 974the 975.Bx 4.4 976operating system, and combines all of the major elements 977into a single command. 978