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