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 March 30, 2007 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 h Ar fd | Fl H Ar fd 159.Op Fl N 160.Op Fl P 161.Op Fl Y 162.Nm 163.Op Fl V Ar etcdir 164.Ar groupshow 165.Op group|gid 166.Op Fl n Ar name 167.Op Fl g Ar gid 168.Op Fl F 169.Op Fl P 170.Op Fl a 171.Nm 172.Op Fl V Ar etcdir 173.Ar groupnext 174.Op Fl C Ar config 175.Op Fl q 176.Nm 177.Op Fl V Ar etcdir 178.Ar lock 179.Op name|uid 180.Op Fl C Ar config 181.Op Fl q 182.Nm 183.Op Fl V Ar etcdir 184.Ar unlock 185.Op name|uid 186.Op Fl C Ar config 187.Op Fl q 188.Sh DESCRIPTION 189The 190.Nm 191utility is a command-line based editor for the system 192.Ar user 193and 194.Ar group 195files, allowing the superuser an easy to use and standardized way of adding, 196modifying and removing users and groups. 197Note that 198.Nm 199only operates on the local user and group files. 200.Tn NIS 201users and groups must be 202maintained on the 203.Tn NIS 204server. 205The 206.Nm 207utility handles updating the 208.Pa passwd , 209.Pa master.passwd , 210.Pa group 211and the secure and insecure 212password database files, and must be run as root. 213.Pp 214The first one or two keywords provided to 215.Nm 216on the command line provide the context for the remainder of the arguments. 217The keywords 218.Ar user 219and 220.Ar group 221may be combined with 222.Ar add , 223.Ar del , 224.Ar mod , 225.Ar show , 226or 227.Ar next 228in any order. 229(For example, 230.Ar showuser , 231.Ar usershow , 232.Ar show user , 233and 234.Ar user show 235all mean the same thing.) 236This flexibility is useful for interactive scripts calling 237.Nm 238for user and group database manipulation. 239Following these keywords, you may optionally specify the user or group name or numeric 240id as an alternative to using the 241.Fl n Ar name , 242.Fl u Ar uid , 243.Fl g Ar gid 244options. 245.Pp 246The following flags are common to most or all modes of operation: 247.Pp 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.Pp 322.Bl -tag -width "-G grouplist" 323.It Fl n Ar name 324Specify the user/account name. 325.It Fl u Ar uid 326Specify the user/account numeric id. 327.Pp 328Usually, you only need to provide one or the other of these options, as the account 329name will imply the uid, or vice versa. 330However, there are times when you need to provide both. 331For example, when changing the uid of an existing user with 332.Ar usermod , 333or overriding the default uid when creating a new account. 334If you wish 335.Nm 336to automatically allocate the uid to a new user with 337.Ar useradd , 338then you should 339.Em not 340use the 341.Fl u 342option. 343You may also provide either the account or userid immediately after the 344.Ar useradd , 345.Ar userdel , 346.Ar usermod 347or 348.Ar usershow 349keywords on the command line without using the 350.Fl n 351or 352.Fl u 353options. 354.El 355.Pp 356.Bl -tag -width "-G grouplist" 357.It Fl c Ar comment 358This field sets the contents of the passwd GECOS field, which normally contains up 359to four comma-separated fields containing the user's full name, office or location, 360and work and home phone numbers. 361These sub-fields are used by convention only, however, and are optional. 362If this field is to contain spaces, you need to quote the comment itself with double 363quotes 364.Ql \&" . 365Avoid using commas in this field as these are used as sub-field separators, and the 366colon 367.Ql \&: 368character also cannot be used as this is the field separator for the passwd 369file itself. 370.It Fl d Ar dir 371This option sets the account's home directory. 372Normally, you will only use this if the home directory is to be different from the 373default determined from 374.Pa /etc/pw.conf 375- normally 376.Pa /home 377with the account name as a subdirectory. 378.It Fl e Ar date 379Set the account's expiration date. 380Format of the date is either a UNIX time 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. 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 usershow 720command allows viewing of an account in one of two formats. 721By default, the format is identical to the format used in 722.Pa /etc/master.passwd 723with the password field replaced with a 724.Ql \&* . 725If the 726.Fl P 727option is used, then 728.Nm 729outputs the account details in a more human readable form. 730If the 731.Fl 7 732option is used, the account details are shown in v7 format. 733The 734.Fl a 735option lists all users currently on file. 736Using 737.Fl F 738forces 739.Nm 740to print the details of an account even if it does not exist. 741.Pp 742The command 743.Ar usernext 744returns the next available user and group ids separated by a colon. 745This is normally of interest only to interactive scripts or front-ends 746that use 747.Nm . 748.Sh GROUP OPTIONS 749The 750.Fl C 751and 752.Fl q 753options (explained at the start of the previous section) are available 754with the group manipulation commands. 755Other common options to all group-related commands are: 756.Bl -tag -width "-m newmembers" 757.It Fl n Ar name 758Specify the group name. 759.It Fl g Ar gid 760Specify the group numeric id. 761.Pp 762As with the account name and id fields, you will usually only need 763to supply one of these, as the group name implies the uid and vice 764versa. 765You will only need to use both when setting a specific group id 766against a new group or when changing the uid of an existing group. 767.It Fl M Ar memberlist 768This option provides an alternative way to add existing users to a 769new group (in groupadd) or replace an existing membership list (in 770groupmod). 771.Ar memberlist 772is a comma separated list of valid and existing user names or uids. 773.It Fl m Ar newmembers 774Similar to 775.Fl M , 776this option allows the 777.Em addition 778of existing users to a group without replacing the existing list of 779members. 780Login names or user ids may be used, and duplicate users are 781silently eliminated. 782.El 783.Pp 784.Ar groupadd 785also has a 786.Fl o 787option that allows allocation of an existing group id to a new group. 788The default action is to reject an attempt to add a group, and this option overrides 789the check for duplicate group ids. 790There is rarely any need to duplicate a group id. 791.Pp 792The 793.Ar groupmod 794command adds one additional option: 795.Pp 796.Bl -tag -width "-m newmembers" 797.It Fl l Ar name 798This option allows changing of an existing group name to 799.Ql \&name . 800The new name must not already exist, and any attempt to duplicate an existing group 801name will be rejected. 802.El 803.Pp 804Options for 805.Ar groupshow 806are the same as for 807.Ar usershow , 808with the 809.Fl g Ar gid 810replacing 811.Fl u Ar uid 812to specify the group id. 813The 814.Fl 7 815option does not apply to the 816.Ar groupshow 817command. 818.Pp 819The command 820.Ar groupnext 821returns the next available group id on standard output. 822.Sh USER LOCKING 823The 824.Nm 825utility 826supports a simple password locking mechanism for users; it works by 827prepending the string 828.Ql *LOCKED* 829to the beginning of the password field in 830.Pa master.passwd 831to prevent successful authentication. 832.Pp 833The 834.Ar lock 835and 836.Ar unlock 837commands take a user name or uid of the account to lock or unlock, 838respectively. 839The 840.Fl V , 841.Fl C , 842and 843.Fl q 844options as described above are accepted by these commands. 845.Sh NOTES 846For a summary of options available with each command, you can use 847.Dl pw [command] help 848For example, 849.Dl pw useradd help 850lists all available options for the useradd operation. 851.Pp 852The 853.Nm 854utility allows 8-bit characters in the passwd GECOS field (user's full name, 855office, work and home phone number subfields), but disallows them in 856user login and group names. 857Use 8-bit characters with caution, as connection to the Internet will 858require that your mail transport program supports 8BITMIME, and will 859convert headers containing 8-bit characters to 7-bit quoted-printable 860format. 861.Xr sendmail 8 862does support this. 863Use of 8-bit characters in the GECOS field should be used in 864conjunction with the user's default locale and character set 865and should not be implemented without their use. 866Using 8-bit characters may also affect other 867programs that transmit the contents of the GECOS field over the 868Internet, such as 869.Xr fingerd 8 , 870and a small number of TCP/IP clients, such as IRC, where full names 871specified in the passwd file may be used by default. 872.Pp 873The 874.Nm 875utility writes a log to the 876.Pa /var/log/userlog 877file when actions such as user or group additions or deletions occur. 878The location of this logfile can be changed in 879.Xr pw.conf 5 . 880.Sh FILES 881.Bl -tag -width /etc/master.passwd.new -compact 882.It Pa /etc/master.passwd 883The user database 884.It Pa /etc/passwd 885A Version 7 format password file 886.It Pa /etc/login.conf 887The user capabilities database 888.It Pa /etc/group 889The group database 890.It Pa /etc/master.passwd.new 891Temporary copy of the master password file 892.It Pa /etc/passwd.new 893Temporary copy of the Version 7 password file 894.It Pa /etc/group.new 895Temporary copy of the group file 896.It Pa /etc/pw.conf 897Pw default options file 898.It Pa /var/log/userlog 899User/group modification logfile 900.El 901.Sh EXIT STATUS 902The 903.Nm 904utility returns EXIT_SUCCESS on successful operation, otherwise 905.Nm 906returns one of the 907following exit codes defined by 908.Xr sysexits 3 909as follows: 910.Bl -tag -width xxxx 911.It EX_USAGE 912.Bl -bullet -compact 913.It 914Command line syntax errors (invalid keyword, unknown option). 915.El 916.It EX_NOPERM 917.Bl -bullet -compact 918.It 919Attempting to run one of the update modes as non-root. 920.El 921.It EX_OSERR 922.Bl -bullet -compact 923.It 924Memory allocation error. 925.It 926Read error from password file descriptor. 927.El 928.It EX_DATAERR 929.Bl -bullet -compact 930.It 931Bad or invalid data provided or missing on the command line or 932via the password file descriptor. 933.It 934Attempted to remove, rename root account or change its uid. 935.El 936.It EX_OSFILE 937.Bl -bullet -compact 938.It 939Skeleton directory is invalid or does not exist. 940.It 941Base home directory is invalid or does not exist. 942.It 943Invalid or non-existent shell specified. 944.El 945.It EX_NOUSER 946.Bl -bullet -compact 947.It 948User, user id, group or group id specified does not exist. 949.It 950User or group recorded, added, or modified unexpectedly disappeared. 951.El 952.It EX_SOFTWARE 953.Bl -bullet -compact 954.It 955No more group or user ids available within specified range. 956.El 957.It EX_IOERR 958.Bl -bullet -compact 959.It 960Unable to rewrite configuration file. 961.It 962Error updating group or user database files. 963.It 964Update error for passwd or group database files. 965.El 966.It EX_CONFIG 967.Bl -bullet -compact 968.It 969No base home directory configured. 970.El 971.El 972.Sh SEE ALSO 973.Xr chpass 1 , 974.Xr passwd 1 , 975.Xr umask 2 , 976.Xr group 5 , 977.Xr login.conf 5 , 978.Xr passwd 5 , 979.Xr pw.conf 5 , 980.Xr pwd_mkdb 8 , 981.Xr vipw 8 982.Sh HISTORY 983The 984.Nm 985utility was written to mimic many of the options used in the SYSV 986.Em shadow 987support suite, but is modified for passwd and group fields specific to 988the 989.Bx 4.4 990operating system, and combines all of the major elements 991into a single command. 992