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