1db34a710SJoerg Wunsch.\" Copyright (C) 1996 2db34a710SJoerg Wunsch.\" David L. Nugent. All rights reserved. 3d6f907dcSJoerg Wunsch.\" 49fd0dafcSJoerg Wunsch.\" Redistribution and use in source and binary forms, with or without 59fd0dafcSJoerg Wunsch.\" modification, are permitted provided that the following conditions 69fd0dafcSJoerg Wunsch.\" are met: 79fd0dafcSJoerg Wunsch.\" 1. Redistributions of source code must retain the above copyright 89fd0dafcSJoerg Wunsch.\" notice, this list of conditions and the following disclaimer. 99fd0dafcSJoerg Wunsch.\" 2. Redistributions in binary form must reproduce the above copyright 109fd0dafcSJoerg Wunsch.\" notice, this list of conditions and the following disclaimer in the 119fd0dafcSJoerg Wunsch.\" documentation and/or other materials provided with the distribution. 12d6f907dcSJoerg Wunsch.\" 13db34a710SJoerg Wunsch.\" THIS SOFTWARE IS PROVIDED BY DAVID L. NUGENT AND CONTRIBUTORS ``AS IS'' AND 149fd0dafcSJoerg Wunsch.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 159fd0dafcSJoerg Wunsch.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16db34a710SJoerg Wunsch.\" ARE DISCLAIMED. IN NO EVENT SHALL DAVID L. NUGENT OR CONTRIBUTORS BE LIABLE 179fd0dafcSJoerg Wunsch.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 189fd0dafcSJoerg Wunsch.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 199fd0dafcSJoerg Wunsch.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 209fd0dafcSJoerg Wunsch.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 219fd0dafcSJoerg Wunsch.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 229fd0dafcSJoerg Wunsch.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 239fd0dafcSJoerg Wunsch.\" SUCH DAMAGE. 249fd0dafcSJoerg Wunsch.\" 2597d92980SPeter Wemm.\" $FreeBSD$ 269fd0dafcSJoerg Wunsch.\" 279fd0dafcSJoerg Wunsch.Dd December 9, 1996 28d6f907dcSJoerg Wunsch.Dt PW 8 29d6f907dcSJoerg Wunsch.Os 30d6f907dcSJoerg Wunsch.Sh NAME 31d6f907dcSJoerg Wunsch.Nm pw 329fd0dafcSJoerg Wunsch.Nd create, remove, modify & display system users and groups 33d6f907dcSJoerg Wunsch.Sh SYNOPSIS 34e97407b4SRuslan Ermilov.Nm 355f12594aSDavid Nugent.Op Fl V Ar etcdir 36d6f907dcSJoerg Wunsch.Ar useradd 37d6f907dcSJoerg Wunsch.Op name|uid 38d6f907dcSJoerg Wunsch.Op Fl C Ar config 39d6f907dcSJoerg Wunsch.Op Fl q 40d6f907dcSJoerg Wunsch.Op Fl n Ar name 41d6f907dcSJoerg Wunsch.Op Fl u Ar uid 42d6f907dcSJoerg Wunsch.Op Fl c Ar comment 43d6f907dcSJoerg Wunsch.Op Fl d Ar dir 44d6f907dcSJoerg Wunsch.Op Fl e Ar date 45d6f907dcSJoerg Wunsch.Op Fl p Ar date 46d6f907dcSJoerg Wunsch.Op Fl g Ar group 47d6f907dcSJoerg Wunsch.Op Fl G Ar grouplist 48d6f907dcSJoerg Wunsch.Op Fl m 49d6f907dcSJoerg Wunsch.Op Fl k Ar dir 50d6f907dcSJoerg Wunsch.Op Fl s Ar shell 51d6f907dcSJoerg Wunsch.Op Fl o 52d6f907dcSJoerg Wunsch.Op Fl L Ar class 53d6f907dcSJoerg Wunsch.Op Fl h Ar fd 549fd0dafcSJoerg Wunsch.Op Fl N 559fd0dafcSJoerg Wunsch.Op Fl P 56f1d684faSDavid Nugent.Op Fl Y 57e97407b4SRuslan Ermilov.Nm 585f12594aSDavid Nugent.Op Fl V Ar etcdir 59d6f907dcSJoerg Wunsch.Ar useradd 60d6f907dcSJoerg Wunsch.Op name|uid 61f1d684faSDavid Nugent.Fl D 62d6f907dcSJoerg Wunsch.Op Fl C Ar config 63d6f907dcSJoerg Wunsch.Op Fl q 64d6f907dcSJoerg Wunsch.Op Fl b Ar dir 65d6f907dcSJoerg Wunsch.Op Fl e Ar days 66d6f907dcSJoerg Wunsch.Op Fl p Ar days 67d6f907dcSJoerg Wunsch.Op Fl g Ar group 68d6f907dcSJoerg Wunsch.Op Fl G Ar grouplist 69d6f907dcSJoerg Wunsch.Op Fl k Ar dir 70610a5778SRuslan Ermilov.Op Fl u Ar min , Ns Ar max 71610a5778SRuslan Ermilov.Op Fl i Ar min , Ns Ar max 72d6f907dcSJoerg Wunsch.Op Fl w Ar method 73d6f907dcSJoerg Wunsch.Op Fl s Ar shell 74f1d684faSDavid Nugent.Op Fl y Ar path 75e97407b4SRuslan Ermilov.Nm 765f12594aSDavid Nugent.Op Fl V Ar etcdir 77d6f907dcSJoerg Wunsch.Ar userdel 78d6f907dcSJoerg Wunsch.Op name|uid 79d6f907dcSJoerg Wunsch.Op Fl n Ar name 80d6f907dcSJoerg Wunsch.Op Fl u Ar uid 81d6f907dcSJoerg Wunsch.Op Fl r 82f1d684faSDavid Nugent.Op Fl Y 83e97407b4SRuslan Ermilov.Nm 845f12594aSDavid Nugent.Op Fl V Ar etcdir 85d6f907dcSJoerg Wunsch.Ar usermod 86d6f907dcSJoerg Wunsch.Op name|uid 87d6f907dcSJoerg Wunsch.Op Fl C Ar config 88d6f907dcSJoerg Wunsch.Op Fl q 89d6f907dcSJoerg Wunsch.Op Fl n Ar name 90d6f907dcSJoerg Wunsch.Op Fl u Ar uid 91d6f907dcSJoerg Wunsch.Op Fl c Ar comment 92d6f907dcSJoerg Wunsch.Op Fl d Ar dir 93d6f907dcSJoerg Wunsch.Op Fl e Ar date 94d6f907dcSJoerg Wunsch.Op Fl p Ar date 95d6f907dcSJoerg Wunsch.Op Fl g Ar group 96d6f907dcSJoerg Wunsch.Op Fl G Ar grouplist 97d6f907dcSJoerg Wunsch.Op Fl l Ar name 98d6f907dcSJoerg Wunsch.Op Fl m 99d6f907dcSJoerg Wunsch.Op Fl k Ar dir 1009fd0dafcSJoerg Wunsch.Op Fl w Ar method 101d6f907dcSJoerg Wunsch.Op Fl s Ar shell 102d6f907dcSJoerg Wunsch.Op Fl L Ar class 103d6f907dcSJoerg Wunsch.Op Fl h Ar fd 1049fd0dafcSJoerg Wunsch.Op Fl N 1059fd0dafcSJoerg Wunsch.Op Fl P 106f1d684faSDavid Nugent.Op Fl Y 107e97407b4SRuslan Ermilov.Nm 1085f12594aSDavid Nugent.Op Fl V Ar etcdir 109d6f907dcSJoerg Wunsch.Ar usershow 110d6f907dcSJoerg Wunsch.Op name|uid 111d6f907dcSJoerg Wunsch.Op Fl n Ar name 112d6f907dcSJoerg Wunsch.Op Fl u Ar uid 113d6f907dcSJoerg Wunsch.Op Fl F 1149fd0dafcSJoerg Wunsch.Op Fl P 115d6f907dcSJoerg Wunsch.Op Fl a 116e97407b4SRuslan Ermilov.Nm 1175f12594aSDavid Nugent.Op Fl V Ar etcdir 1189fd0dafcSJoerg Wunsch.Ar usernext 1199fd0dafcSJoerg Wunsch.Op Fl C Ar config 1209fd0dafcSJoerg Wunsch.Op Fl q 121e97407b4SRuslan Ermilov.Nm 1225f12594aSDavid Nugent.Op Fl V Ar etcdir 123d6f907dcSJoerg Wunsch.Ar groupadd 124d6f907dcSJoerg Wunsch.Op group|gid 125d6f907dcSJoerg Wunsch.Op Fl C Ar config 126d6f907dcSJoerg Wunsch.Op Fl q 127d6f907dcSJoerg Wunsch.Op Fl n Ar group 128d6f907dcSJoerg Wunsch.Op Fl g Ar gid 1299fd0dafcSJoerg Wunsch.Op Fl M Ar members 130d6f907dcSJoerg Wunsch.Op Fl o 131d6f907dcSJoerg Wunsch.Op Fl h Ar fd 1329fd0dafcSJoerg Wunsch.Op Fl N 1339fd0dafcSJoerg Wunsch.Op Fl P 134f1d684faSDavid Nugent.Op Fl Y 135e97407b4SRuslan Ermilov.Nm 1365f12594aSDavid Nugent.Op Fl V Ar etcdir 137d6f907dcSJoerg Wunsch.Ar groupdel 13806f64964SJoseph Koshy.Op group|gid 139d6f907dcSJoerg Wunsch.Op Fl n Ar name 140d6f907dcSJoerg Wunsch.Op Fl g Ar gid 141f1d684faSDavid Nugent.Op Fl Y 142e97407b4SRuslan Ermilov.Nm 1435f12594aSDavid Nugent.Op Fl V Ar etcdir 144d6f907dcSJoerg Wunsch.Ar groupmod 14506f64964SJoseph Koshy.Op group|gid 146d6f907dcSJoerg Wunsch.Op Fl C Ar config 147d6f907dcSJoerg Wunsch.Op Fl q 148d6f907dcSJoerg Wunsch.Op Fl F 149d6f907dcSJoerg Wunsch.Op Fl n Ar name 150d6f907dcSJoerg Wunsch.Op Fl g Ar gid 151d6f907dcSJoerg Wunsch.Op Fl l Ar name 1529fd0dafcSJoerg Wunsch.Op Fl M Ar members 1539fd0dafcSJoerg Wunsch.Op Fl m Ar newmembers 154d6f907dcSJoerg Wunsch.Op Fl h Ar fd 1559fd0dafcSJoerg Wunsch.Op Fl N 1569fd0dafcSJoerg Wunsch.Op Fl P 157f1d684faSDavid Nugent.Op Fl Y 158e97407b4SRuslan Ermilov.Nm 1595f12594aSDavid Nugent.Op Fl V Ar etcdir 160d6f907dcSJoerg Wunsch.Ar groupshow 16106f64964SJoseph Koshy.Op group|gid 162d6f907dcSJoerg Wunsch.Op Fl n Ar name 163d6f907dcSJoerg Wunsch.Op Fl g Ar gid 164d6f907dcSJoerg Wunsch.Op Fl F 1659fd0dafcSJoerg Wunsch.Op Fl P 166d6f907dcSJoerg Wunsch.Op Fl a 167e97407b4SRuslan Ermilov.Nm 1685f12594aSDavid Nugent.Op Fl V Ar etcdir 1699fd0dafcSJoerg Wunsch.Ar groupnext 1709fd0dafcSJoerg Wunsch.Op Fl C Ar config 1719fd0dafcSJoerg Wunsch.Op Fl q 172e468afb4SDima Dorfman.Nm 173e468afb4SDima Dorfman.Op Fl V Ar etcdir 174e468afb4SDima Dorfman.Ar lock 175e468afb4SDima Dorfman.Op name|uid 176e468afb4SDima Dorfman.Op Fl C Ar config 177e468afb4SDima Dorfman.Op Fl q 178e468afb4SDima Dorfman.Nm 179e468afb4SDima Dorfman.Op Fl V Ar etcdir 180e468afb4SDima Dorfman.Ar unlock 181e468afb4SDima Dorfman.Op name|uid 182e468afb4SDima Dorfman.Op Fl C Ar config 183e468afb4SDima Dorfman.Op Fl q 184d6f907dcSJoerg Wunsch.Sh DESCRIPTION 1851dcc6ec7SPhilippe Charnier.Nm Pw 186d6f907dcSJoerg Wunschis a command-line based editor for the system 1871dcc6ec7SPhilippe Charnier.Ar user 188d6f907dcSJoerg Wunschand 1891dcc6ec7SPhilippe Charnier.Ar group 1903a7e7077SDaniel O'Callaghanfiles, allowing the superuser an easy to use and standardized way of adding, 191d6f907dcSJoerg Wunschmodifying and removing users and groups. 192d6f907dcSJoerg WunschNote that 1931dcc6ec7SPhilippe Charnier.Nm 194137db389SSteve Priceonly operates on the local user and group files. NIS users and groups must be 195d6f907dcSJoerg Wunschmaintained on the NIS server. 1961dcc6ec7SPhilippe Charnier.Nm Pw 197053375e8SMike Pritchardhandles updating the 198053375e8SMike Pritchard.Pa passwd , 199053375e8SMike Pritchard.Pa master.passwd , 200053375e8SMike Pritchard.Pa group 201053375e8SMike Pritchardand the secure and insecure 202d6f907dcSJoerg Wunschpassword database files, and must be run as root. 203d6f907dcSJoerg Wunsch.Pp 204137db389SSteve PriceThe first one or two keywords provided to 205137db389SSteve Price.Nm 206137db389SSteve Priceon the command line provide the context for the remainder of the arguments. 207137db389SSteve PriceThe keywords 208d6f907dcSJoerg Wunsch.Ar user 209d6f907dcSJoerg Wunschand 210d6f907dcSJoerg Wunsch.Ar group 211137db389SSteve Pricemay be combined with 212d6f907dcSJoerg Wunsch.Ar add , 213d6f907dcSJoerg Wunsch.Ar del , 2149fd0dafcSJoerg Wunsch.Ar mod , 215d6f907dcSJoerg Wunsch.Ar show , 2169fd0dafcSJoerg Wunschor 217137db389SSteve Price.Ar next 2184e86fcacSSheldon Hearnin any order. 2194e86fcacSSheldon Hearn(For example, 220137db389SSteve Price.Ar showuser , 221137db389SSteve Price.Ar usershow , 222610a5778SRuslan Ermilov.Ar show user , 223610a5778SRuslan Ermilovand 224137db389SSteve Price.Ar user show 225137db389SSteve Priceall mean the same thing.) 226137db389SSteve PriceThis flexibility is useful for interactive scripts calling 2271dcc6ec7SPhilippe Charnier.Nm 228137db389SSteve Pricefor user and group database manipulation. 229d6f907dcSJoerg WunschFollowing these keywords, you may optionally specify the user or group name or numeric 230d6f907dcSJoerg Wunschid as an alternative to using the 231d6f907dcSJoerg Wunsch.Fl n Ar name , 232d6f907dcSJoerg Wunsch.Fl u Ar uid , 233d6f907dcSJoerg Wunsch.Fl g Ar gid 2349fd0dafcSJoerg Wunschoptions. 235d6f907dcSJoerg Wunsch.Pp 2365f12594aSDavid NugentThe following flags are common to most or all modes of operation; 237d6f907dcSJoerg Wunsch.Pp 2389fd0dafcSJoerg Wunsch.Bl -tag -width "-G grouplist" 2395f12594aSDavid Nugent.It Fl V Ar etcdir 2405f12594aSDavid NugentThis flag sets an alternate location for the password, group and configuration files, 2415f12594aSDavid Nugentand may be used to maintain a user/group database in an alternate location. 2425f12594aSDavid NugentIf this switch is specified, the system 2435f12594aSDavid Nugent.Pa /etc/pw.conf 2445f12594aSDavid Nugentwill not be sourced for default configuration data, but the file pw.conf in the 2455f12594aSDavid Nugentspecified directory will be used instead (or none, if it does not exist). 2465f12594aSDavid NugentThe 2475f12594aSDavid Nugent.Fl C 2485f12594aSDavid Nugentflag may be used to override this behaviour. 2495f12594aSDavid NugentAs an exception to the general rule where options must follow the operation 2505f12594aSDavid Nugenttype, the 2515f12594aSDavid Nugent.Fl V 2525f12594aSDavid Nugentflag may be used on the command line before the operation keyword. 253d6f907dcSJoerg Wunsch.It Fl C Ar config 254d6f907dcSJoerg WunschBy default, 2551dcc6ec7SPhilippe Charnier.Nm 256d6f907dcSJoerg Wunschreads the file 257d6f907dcSJoerg Wunsch.Pa /etc/pw.conf 258137db389SSteve Priceto obtain policy information on how new user accounts and groups are to be created. 259137db389SSteve PriceThe 2609fd0dafcSJoerg Wunsch.Fl C 2619fd0dafcSJoerg Wunschoption specifies a different configuration file. 262137db389SSteve PriceWhile most of the contents of the configuration file may be overridden via 263137db389SSteve Pricecommand-line options, it may be more convenient to keep standard information in a 264137db389SSteve Priceconfiguration file. 265d6f907dcSJoerg Wunsch.It Fl q 266d6f907dcSJoerg WunschUse of this option causes 2671dcc6ec7SPhilippe Charnier.Nm 268d6f907dcSJoerg Wunschto suppress error messages, which may be useful in interactive environments where it 269d6f907dcSJoerg Wunschis preferable to interpret status codes returned by 2701dcc6ec7SPhilippe Charnier.Nm 271d6f907dcSJoerg Wunschrather than messing up a carefully formatted display. 2729fd0dafcSJoerg Wunsch.It Fl N 273137db389SSteve PriceThis option is available in 274137db389SSteve Price.Ar add 275137db389SSteve Priceand 276137db389SSteve Price.Ar modify 277137db389SSteve Priceoperations, and tells 2781dcc6ec7SPhilippe Charnier.Nm 279137db389SSteve Priceto output the result of the operation without updating the user or group 280137db389SSteve Pricedatabases. 2819fd0dafcSJoerg WunschYou may use the 2829fd0dafcSJoerg Wunsch.Fl P 2839fd0dafcSJoerg Wunschoption to switch between standard passwd and readable formats. 284f1d684faSDavid Nugent.It Fl Y 285f1d684faSDavid NugentUsing this option with any of the update modes causes 2861dcc6ec7SPhilippe Charnier.Nm 287f1d684faSDavid Nugentto run 288f1d684faSDavid Nugent.Xr make 1 289f1d684faSDavid Nugentafter changing to the directory 290f1d684faSDavid Nugent.Pa /var/yp . 291137db389SSteve PriceThis is intended to allow automatic updating of NIS database files. 292f1d684faSDavid NugentIf separate passwd and group files are being used by NIS, then use the 293f1d684faSDavid Nugent.Fl y Ar path 294137db389SSteve Priceoption to specify the location of the NIS passwd database so that 295137db389SSteve Price.Nm 296137db389SSteve Pricewill concurrently update it with the system password 297f1d684faSDavid Nugentdatabases. 298d6f907dcSJoerg Wunsch.El 299d6f907dcSJoerg Wunsch.Pp 300d6f907dcSJoerg Wunsch.Sh USER OPTIONS 301d6f907dcSJoerg WunschThe following options apply to the 302137db389SSteve Price.Ar useradd 303d6f907dcSJoerg Wunschand 304137db389SSteve Price.Ar usermod 305d6f907dcSJoerg Wunschcommands: 306d6f907dcSJoerg Wunsch.Pp 3079fd0dafcSJoerg Wunsch.Bl -tag -width "-G grouplist" 308d6f907dcSJoerg Wunsch.It Fl n Ar name 3091dcc6ec7SPhilippe CharnierSpecify the user/account name. 310d6f907dcSJoerg Wunsch.It Fl u Ar uid 3111dcc6ec7SPhilippe CharnierSpecify the user/account numeric id. 312d6f907dcSJoerg Wunsch.Pp 313137db389SSteve PriceUsually, you only need to provide one or the other of these options, as the account 314137db389SSteve Pricename will imply the uid, or vice versa. 315137db389SSteve PriceHowever, there are times when you need to provide both. 316d6f907dcSJoerg WunschFor example, when changing the uid of an existing user with 317d6f907dcSJoerg Wunsch.Ar usermod , 318d6f907dcSJoerg Wunschor overriding the default uid when creating a new account. 319d6f907dcSJoerg WunschIf you wish 3201dcc6ec7SPhilippe Charnier.Nm 321137db389SSteve Priceto automatically allocate the uid to a new user with 322d6f907dcSJoerg Wunsch.Ar useradd , 323d6f907dcSJoerg Wunschthen you should 324d6f907dcSJoerg Wunsch.Em not 325d6f907dcSJoerg Wunschuse the 326d6f907dcSJoerg Wunsch.Ql Fl u 3279fd0dafcSJoerg Wunschoption. 328137db389SSteve PriceYou may also provide either the account or userid immediately after the 329137db389SSteve Price.Ar useradd , 330137db389SSteve Price.Ar userdel , 331137db389SSteve Price.Ar usermod 332137db389SSteve Priceor 333137db389SSteve Price.Ar usershow 334137db389SSteve Pricekeywords on the command line without using the 335137db389SSteve Price.Ql Fl n 336137db389SSteve Priceor 337137db389SSteve Price.Ql Fl u 338137db389SSteve Priceoptions. 339d6f907dcSJoerg Wunsch.El 340d6f907dcSJoerg Wunsch.Pp 341d6f907dcSJoerg Wunsch.Bl -tag -width "-G grouplist" 342d6f907dcSJoerg Wunsch.It Fl c Ar comment 343d6f907dcSJoerg WunschThis field sets the contents of the passwd GECOS field, which normally contains up 344d6f907dcSJoerg Wunschto four comma-separated fields containing the user's full name, office or location, 345137db389SSteve Priceand work and home phone numbers. 346d6f907dcSJoerg WunschThese sub-fields are used by convention only, however, and are optional. 347d6f907dcSJoerg WunschIf this field is to contain spaces, you need to quote the comment itself with double 348d6f907dcSJoerg Wunschquotes 349d6f907dcSJoerg Wunsch.Ql \&" . 350d6f907dcSJoerg WunschAvoid using commas in this field as these are used as sub-field separators, and the 351d6f907dcSJoerg Wunschcolon 352d6f907dcSJoerg Wunsch.Ql \&: 353137db389SSteve Pricecharacter also cannot be used as this is the field separator for the passwd 354137db389SSteve Pricefile itself. 355d6f907dcSJoerg Wunsch.It Fl d Ar dir 356d6f907dcSJoerg WunschThis option sets the account's home directory. 357d6f907dcSJoerg WunschNormally, you will only use this if the home directory is to be different from the 358137db389SSteve Pricedefault determined from 359137db389SSteve Price.Pa /etc/pw.conf 3601dcc6ec7SPhilippe Charnier- normally 3611dcc6ec7SPhilippe Charnier.Pa /home 362137db389SSteve Pricewith the account name as a subdirectory. 363d6f907dcSJoerg Wunsch.It Fl e Ar date 3641dcc6ec7SPhilippe CharnierSet the account's expiration date. 365d6f907dcSJoerg WunschFormat of the date is either a UNIX time in decimal, or a date in 366137db389SSteve Price.Ql dd-mmm-yy[yy] 367d6f907dcSJoerg Wunschformat, where dd is the day, mmm is the month, either in numeric or alphabetic format 3681dcc6ec7SPhilippe Charnier('Jan', 'Feb', etc) and year is either a two or four digit year. 369d6f907dcSJoerg WunschThis option also accepts a relative date in the form 370d6f907dcSJoerg Wunsch.Ql \&+n[mhdwoy] 371d6f907dcSJoerg Wunschwhere 372d6f907dcSJoerg Wunsch.Ql \&n 373d6f907dcSJoerg Wunschis a decimal, octal (leading 0) or hexadecimal (leading 0x) digit followed by the 374053375e8SMike Pritchardnumber of Minutes, Hours, Days, Weeks, Months or Years from the current date at 375137db389SSteve Pricewhich the expiration date is to be set. 376d6f907dcSJoerg Wunsch.It Fl p Ar date 3771dcc6ec7SPhilippe CharnierSet the account's password expiration date. 378137db389SSteve PriceThis field is similar to the account expiration date option, except that it 379d6f907dcSJoerg Wunschapplies to forced password changes. 380137db389SSteve PriceThis is set in the same manner as the 381137db389SSteve Price.Ql Fl e 382137db389SSteve Priceoption. 383d6f907dcSJoerg Wunsch.It Fl g Ar group 3841dcc6ec7SPhilippe CharnierSet the account's primary group to the given group. 385d6f907dcSJoerg Wunsch.Ar group 386137db389SSteve Pricemay be defined by either its name or group number. 387d6f907dcSJoerg Wunsch.It Fl G Ar grouplist 388137db389SSteve PriceSets additional group memberships for an account. 389d6f907dcSJoerg Wunsch.Ar grouplist 390137db389SSteve Priceis a comma-separated list of group names or group numbers. 391137db389SSteve PriceThe user's name is added to the group lists in 392d6f907dcSJoerg Wunsch.Pa /etc/group , 393137db389SSteve Priceand 394d6f907dcSJoerg Wunschremoved from any groups not specified in 395d6f907dcSJoerg Wunsch.Ar grouplist . 396137db389SSteve PriceNote: a user should not be added to their primary group with 397137db389SSteve Price.Ar grouplist . 398137db389SSteve PriceAlso, group membership changes do not take effect for current user login 399137db389SSteve Pricesessions, requiring the user to reconnect to be affected by the changes. 4009fd0dafcSJoerg Wunsch.It Fl L Ar class 4019fd0dafcSJoerg WunschThis option sets the login class for the user being created. 4029fd0dafcSJoerg WunschSee 4039fd0dafcSJoerg Wunsch.Xr login.conf 5 404137db389SSteve Pricefor more information on user login classes. 405d6f907dcSJoerg Wunsch.It Fl m 406d6f907dcSJoerg WunschThis option instructs 4071dcc6ec7SPhilippe Charnier.Nm 408d6f907dcSJoerg Wunschto attempt to create the user's home directory. 409d6f907dcSJoerg WunschWhile primarily useful when adding a new account with 410d6f907dcSJoerg Wunsch.Ar useradd , 411d6f907dcSJoerg Wunschthis may also be of use when moving an existing user's home directory elsewhere on 412d6f907dcSJoerg Wunschthe filesystem. 413d6f907dcSJoerg WunschThe new home directory is populated with the contents of the 414d6f907dcSJoerg Wunsch.Ar skeleton 415d6f907dcSJoerg Wunschdirectory, which typically contains a set of shell configuration files that the 416053375e8SMike Pritcharduser may personalize to taste. 417d6f907dcSJoerg WunschWhen 418d6f907dcSJoerg Wunsch.Ql Fl m 419d6f907dcSJoerg Wunschis used on an account with 420d6f907dcSJoerg Wunsch.Ar usermod , 421137db389SSteve Priceexisting configuration files in the user's home directory are 422d6f907dcSJoerg Wunsch.Em not 423137db389SSteve Priceoverwritten from the skeleton files. 424d6f907dcSJoerg Wunsch.Pp 425137db389SSteve PriceWhen a user's home directory is created, it will by default be a subdirectory of the 426d6f907dcSJoerg Wunsch.Ar basehome 427137db389SSteve Pricedirectory as specified by the 428137db389SSteve Price.Ql Fl b 429137db389SSteve Priceoption (see below), bearing the name of the new account. 430137db389SSteve PriceThis can be overridden by the 431137db389SSteve Price.Ql Fl d 432d6f907dcSJoerg Wunschoption on the command line, if desired. 433d6f907dcSJoerg Wunsch.It Fl k Ar dir 4341dcc6ec7SPhilippe CharnierSet the 435d6f907dcSJoerg Wunsch.Ar skeleton 436137db389SSteve Pricedirectory, from which basic startup and configuration files are copied when 437d6f907dcSJoerg Wunschthe user's home directory is created. 438137db389SSteve PriceThis option only has meaning when used with the 439137db389SSteve Price.Ql Fl d 440137db389SSteve Priceor 441137db389SSteve Price.Ql Fl m 442137db389SSteve Priceflags. 443d6f907dcSJoerg Wunsch.It Fl s Ar shell 4441dcc6ec7SPhilippe CharnierSet or changes the user's login shell to 445d6f907dcSJoerg Wunsch.Ar shell . 446d6f907dcSJoerg WunschIf the path to the shell program is omitted, 4471dcc6ec7SPhilippe Charnier.Nm 448d6f907dcSJoerg Wunschsearches the 449d6f907dcSJoerg Wunsch.Ar shellpath 450d6f907dcSJoerg Wunschspecified in 451d6f907dcSJoerg Wunsch.Pa /etc/pw.conf 452d6f907dcSJoerg Wunschand fills it in as appropriate. 453d6f907dcSJoerg WunschNote that unless you have a specific reason to do so, you should avoid 454d6f907dcSJoerg Wunschspecifying the path - this will allow 4551dcc6ec7SPhilippe Charnier.Nm 456d6f907dcSJoerg Wunschto validate that the program exists and is executable. 457d6f907dcSJoerg WunschSpecifying a full path (or supplying a blank "" shell) avoids this check 458d6f907dcSJoerg Wunschand allows for such entries as 4591dcc6ec7SPhilippe Charnier.Pa /nonexistent 460d6f907dcSJoerg Wunschthat should be set for accounts not intended for interactive login. 461d6f907dcSJoerg Wunsch.It Fl L Ar class 4621dcc6ec7SPhilippe CharnierSet the 463d6f907dcSJoerg Wunsch.Em class 464d6f907dcSJoerg Wunschfield in the user's passwd record. 465137db389SSteve PriceThis field is not currently used, but will be used in the future to specify a 466d6f907dcSJoerg Wunsch.Em termcap 467f2e366a1SSheldon Hearnentry like tag. 468f2e366a1SSheldon HearnSee 469d6f907dcSJoerg Wunsch.Xr passwd 5 470137db389SSteve Pricefor details. 471d6f907dcSJoerg Wunsch.It Fl h Ar fd 472d6f907dcSJoerg WunschThis option provides a special interface by which interactive scripts can 473d6f907dcSJoerg Wunschset an account password using 474e97407b4SRuslan Ermilov.Nm . 475137db389SSteve PriceBecause the command line and environment are fundamentally insecure mechanisms 476d6f907dcSJoerg Wunschby which programs can accept information, 4771dcc6ec7SPhilippe Charnier.Nm 478d6f907dcSJoerg Wunschwill only allow setting of account and group passwords via a file descriptor 479d6f907dcSJoerg Wunsch(usually a pipe between an interactive script and the program). 480d6f907dcSJoerg Wunsch.Ar sh , 481d6f907dcSJoerg Wunsch.Ar bash , 482d6f907dcSJoerg Wunsch.Ar ksh 483d6f907dcSJoerg Wunschand 484d6f907dcSJoerg Wunsch.Ar perl 485137db389SSteve Priceall possess mechanisms by which this can be done. 486d6f907dcSJoerg WunschAlternatively, 487325970a9SPhilippe Charnier.Nm 488d6f907dcSJoerg Wunschwill prompt for the user's password if 489d6f907dcSJoerg Wunsch.Ql Fl h Ar 0 490d6f907dcSJoerg Wunschis given, nominating 491d6f907dcSJoerg Wunsch.Em stdin 492d6f907dcSJoerg Wunschas the file descriptor on which to read the password. 493137db389SSteve PriceNote that this password will be read only once and is intended 494137db389SSteve Pricefor use by a script rather than for interactive use. 495d6f907dcSJoerg WunschIf you wish to have new password confirmation along the lines of 496d6f907dcSJoerg Wunsch.Xr passwd 1 , 497137db389SSteve Pricethis must be implemented as part of an interactive script that calls 498e97407b4SRuslan Ermilov.Nm . 499d6f907dcSJoerg Wunsch.Pp 500d6f907dcSJoerg WunschIf a value of 501d6f907dcSJoerg Wunsch.Ql \&- 502d6f907dcSJoerg Wunschis given as the argument 503d6f907dcSJoerg Wunsch.Ar fd , 504d6f907dcSJoerg Wunschthen the password will be set to 505d6f907dcSJoerg Wunsch.Ql \&* , 506137db389SSteve Pricerendering the account inaccessible via password-based login. 507d6f907dcSJoerg Wunsch.El 508d6f907dcSJoerg Wunsch.Pp 509d6f907dcSJoerg WunschIt is possible to use 510d6f907dcSJoerg Wunsch.Ar useradd 511d6f907dcSJoerg Wunschto create a new account that duplicates an existing user id. 512d6f907dcSJoerg WunschWhile this is normally considered an error and will be rejected, the 513d6f907dcSJoerg Wunsch.Ql Fl o 5149fd0dafcSJoerg Wunschoption overrides the check for duplicates and allows the duplication of 5159fd0dafcSJoerg Wunschthe user id. 5169fd0dafcSJoerg WunschThis may be useful if you allow the same user to login under 5179fd0dafcSJoerg Wunschdifferent contexts (different group allocations, different home 5189fd0dafcSJoerg Wunschdirectory, different shell) while providing basically the same 5199fd0dafcSJoerg Wunschpermissions for access to the user's files in each account. 520d6f907dcSJoerg Wunsch.Pp 521d6f907dcSJoerg WunschThe 522d6f907dcSJoerg Wunsch.Ar useradd 523d6f907dcSJoerg Wunschcommand also has the ability to set new user and group defaults by using the 524d6f907dcSJoerg Wunsch.Ql Fl D 5259fd0dafcSJoerg Wunschoption. 526d6f907dcSJoerg WunschInstead of adding a new user, 5271dcc6ec7SPhilippe Charnier.Nm 528d6f907dcSJoerg Wunschwrites a new set of defaults to its configuration file, 529d6f907dcSJoerg Wunsch.Pa /etc/pw.conf . 530d6f907dcSJoerg WunschWhen using the 531d6f907dcSJoerg Wunsch.Ql Fl D 5329fd0dafcSJoerg Wunschoption, you must not use either 533d6f907dcSJoerg Wunsch.Ql Fl n Ar name 534d6f907dcSJoerg Wunschor 535d6f907dcSJoerg Wunsch.Ql Fl u Ar uid 536d6f907dcSJoerg Wunschor an error will result. 537d6f907dcSJoerg WunschUse of 538d6f907dcSJoerg Wunsch.Ql Fl D 5399fd0dafcSJoerg Wunschchanges the meaning of several command line switches in the 540d6f907dcSJoerg Wunsch.Ar useradd 541d6f907dcSJoerg Wunschcommand. 542d6f907dcSJoerg WunschThese are: 543d6f907dcSJoerg Wunsch.Bl -tag -width "-G grouplist" 544d6f907dcSJoerg Wunsch.It Fl D 545d6f907dcSJoerg WunschSet default values in 546d6f907dcSJoerg Wunsch.Pa /etc/pw.conf 547d6f907dcSJoerg Wunschconfiguration file, or a different named configuration file if the 548d6f907dcSJoerg Wunsch.Ql Fl C Ar config 5499fd0dafcSJoerg Wunschoption is used. 550d6f907dcSJoerg Wunsch.It Fl b Ar dir 5511dcc6ec7SPhilippe CharnierSet the root directory in which user home directories are created. 552d6f907dcSJoerg WunschThe default value for this is 5531dcc6ec7SPhilippe Charnier.Pa /home , 554d6f907dcSJoerg Wunschbut it may be set elsewhere as desired. 555d6f907dcSJoerg Wunsch.It Fl e Ar days 5561dcc6ec7SPhilippe CharnierSet the default account expiration period in days. 557d6f907dcSJoerg WunschUnlike use without 558d6f907dcSJoerg Wunsch.Ql Fl D , 559d6f907dcSJoerg Wunschthe argument must be numeric, which specifies the number of days after creation when 560d6f907dcSJoerg Wunschthe account is to expire. 561d6f907dcSJoerg WunschA value of 0 suppresses automatic calculation of the expiry date. 562d6f907dcSJoerg Wunsch.It Fl p Ar days 5631dcc6ec7SPhilippe CharnierSet the default password expiration period in days. 564d6f907dcSJoerg Wunsch.It Fl g Ar group 5651dcc6ec7SPhilippe CharnierSet the default group for new users. 566d6f907dcSJoerg WunschIf a blank group is specified using 567d6f907dcSJoerg Wunsch.Ql Fl g Ar \&"" , 568137db389SSteve Pricethen new users will be allocated their own private primary group 569137db389SSteve Pricewith the same name as their login name. 570d6f907dcSJoerg WunschIf a group is supplied, either its name or uid may be given as an argument. 571d6f907dcSJoerg Wunsch.It Fl G Ar grouplist 572137db389SSteve PriceSet the default groups in which new users are granted membership. 573d6f907dcSJoerg WunschThis is a separate set of groups from the primary group, and you should avoid 574137db389SSteve Pricenominating the same group as both primary and extra groups. 575d6f907dcSJoerg WunschIn other words, these extra groups determine membership in groups 576d6f907dcSJoerg Wunsch.Em other than 577d6f907dcSJoerg Wunschthe primary group. 578d6f907dcSJoerg Wunsch.Ar grouplist 579137db389SSteve Priceis a comma-separated list of group names or ids, and are always 580d6f907dcSJoerg Wunschstored in 581d6f907dcSJoerg Wunsch.Pa /etc/pw.conf 582d6f907dcSJoerg Wunschby their symbolic names. 5839fd0dafcSJoerg Wunsch.It Fl L Ar class 5849fd0dafcSJoerg WunschThis option sets the default login class for new users. 585d6f907dcSJoerg Wunsch.It Fl k Ar dir 5861dcc6ec7SPhilippe CharnierSet the default 587d6f907dcSJoerg Wunsch.Em skeleton 588053375e8SMike Pritcharddirectory, from which prototype shell and other initialization files are copied when 5891dcc6ec7SPhilippe Charnier.Nm 590d6f907dcSJoerg Wunschcreates a user's home directory. 591610a5778SRuslan Ermilov.It Xo 592610a5778SRuslan Ermilov.Fl u Ar min , Ns Ar max , 593610a5778SRuslan Ermilov.Fl i Ar min , Ns Ar max 594610a5778SRuslan Ermilov.Xc 5959fd0dafcSJoerg WunschThese options set the minimum and maximum user and group ids allocated for new accounts 596d6f907dcSJoerg Wunschand groups created by 597e97407b4SRuslan Ermilov.Nm . 598d6f907dcSJoerg WunschThe default values for each is 1000 minimum and 32000 maximum. 599d6f907dcSJoerg Wunsch.Ar min 600d6f907dcSJoerg Wunschand 601d6f907dcSJoerg Wunsch.Ar max 602d6f907dcSJoerg Wunschare both numbers, where max must be greater than min, and both must be between 0 603d6f907dcSJoerg Wunschand 32767. 604d6f907dcSJoerg WunschIn general, user and group ids less than 100 are reserved for use by the system, 605d6f907dcSJoerg Wunschand numbers greater than 32000 may also be reserved for special purposes (used by 606d6f907dcSJoerg Wunschsome system daemons). 607d6f907dcSJoerg Wunsch.It Fl w Ar method 608d6f907dcSJoerg WunschThe 609d6f907dcSJoerg Wunsch.Ql Fl w 6109fd0dafcSJoerg Wunschoption sets the default method used to set passwords for newly created user accounts. 611d6f907dcSJoerg Wunsch.Ar method 612d6f907dcSJoerg Wunschis one of: 613d6f907dcSJoerg Wunsch.Pp 614d6f907dcSJoerg Wunsch.Bl -tag -width random -offset indent -compact 615d6f907dcSJoerg Wunsch.It no 6161dcc6ec7SPhilippe Charnierdisable login on newly created accounts 617d6f907dcSJoerg Wunsch.It yes 6181dcc6ec7SPhilippe Charnierforce the password to be the account name 619d6f907dcSJoerg Wunsch.It none 6201dcc6ec7SPhilippe Charnierforce a blank password 621d6f907dcSJoerg Wunsch.It random 6221dcc6ec7SPhilippe Charniergenerate a random password 623d6f907dcSJoerg Wunsch.El 624d6f907dcSJoerg Wunsch.Pp 625d6f907dcSJoerg WunschThe 626d6f907dcSJoerg Wunsch.Ql \&random 627d6f907dcSJoerg Wunschor 628d6f907dcSJoerg Wunsch.Ql \&no 629d6f907dcSJoerg Wunschmethods are the most secure; in the former case, 6301dcc6ec7SPhilippe Charnier.Nm 631d6f907dcSJoerg Wunschgenerates a password and prints it to stdout, which is suitable where you issue 632d6f907dcSJoerg Wunschusers with passwords to access their accounts rather than having the user nominate 633d6f907dcSJoerg Wunschtheir own (possibly poorly chosen) password. 634d6f907dcSJoerg WunschThe 635d6f907dcSJoerg Wunsch.Ql \&no 636d6f907dcSJoerg Wunschmethod requires that the superuser use 637d6f907dcSJoerg Wunsch.Xr passwd 1 638d6f907dcSJoerg Wunschto render the account accessible with a password. 639f1d684faSDavid Nugent.It Fl y Ar path 640f1d684faSDavid NugentThis sets the pathname of the database used by NIS if you are not sharing 641f1d684faSDavid Nugentthe information from 642f1d684faSDavid Nugent.Pa /etc/master.passwd 643f1d684faSDavid Nugentdirectly with NIS. 644137db389SSteve PriceYou should only set this option for NIS servers. 645d6f907dcSJoerg Wunsch.El 646d6f907dcSJoerg Wunsch.Pp 647d6f907dcSJoerg WunschThe 648d6f907dcSJoerg Wunsch.Ar userdel 649f2e366a1SSheldon Hearncommand has only three valid options. 650f2e366a1SSheldon HearnThe 651d6f907dcSJoerg Wunsch.Ql Fl n Ar name 652d6f907dcSJoerg Wunschand 653d6f907dcSJoerg Wunsch.Ql Fl u Ar uid 6549fd0dafcSJoerg Wunschoptions have already been covered above. 6559fd0dafcSJoerg WunschThe additional option is: 6569fd0dafcSJoerg Wunsch.Bl -tag -width "-G grouplist" 657d6f907dcSJoerg Wunsch.It Fl r 658d6f907dcSJoerg WunschThis tells 6591dcc6ec7SPhilippe Charnier.Nm 660d6f907dcSJoerg Wunschto remove the user's home directory and all of its contents. 6611dcc6ec7SPhilippe Charnier.Nm Pw 662d6f907dcSJoerg Wunscherrs on the side of caution when removing files from the system. 663d6f907dcSJoerg WunschFirstly, it will not do so if the uid of the account being removed is also used by 664d6f907dcSJoerg Wunschanother account on the system, and the 'home' directory in the password file is 665d6f907dcSJoerg Wunscha valid path that commences with the character 666d6f907dcSJoerg Wunsch.Ql \&/ . 667d6f907dcSJoerg WunschSecondly, it will only remove files and directories that are actually owned by 668d6f907dcSJoerg Wunschthe user, or symbolic links owned by anyone under the user's home directory. 669d6f907dcSJoerg WunschFinally, after deleting all contents owned by the user only empty directories 670d6f907dcSJoerg Wunschwill be removed. 671053375e8SMike PritchardIf any additional cleanup work is required, this is left to the administrator. 672d6f907dcSJoerg Wunsch.El 673d6f907dcSJoerg Wunsch.Pp 674d6f907dcSJoerg WunschMail spool files and crontabs are always removed when an account is deleted as these 675d6f907dcSJoerg Wunschare unconditionally attached to the user name. 676d6f907dcSJoerg WunschJobs queued for processing by 677d6f907dcSJoerg Wunsch.Ar at 678137db389SSteve Priceare also removed if the user's uid is unique and not also used by another account on the 679137db389SSteve Pricesystem. 680d6f907dcSJoerg Wunsch.Pp 681d6f907dcSJoerg WunschThe 682d6f907dcSJoerg Wunsch.Ar usershow 683d6f907dcSJoerg Wunschcommand allows viewing of an account in one of two formats. 684d6f907dcSJoerg WunschBy default, the format is identical to the format used in 685d6f907dcSJoerg Wunsch.Pa /etc/master.passwd 686d6f907dcSJoerg Wunschwith the password field replaced with a 687d6f907dcSJoerg Wunsch.Ql \&* . 688d6f907dcSJoerg WunschIf the 6899fd0dafcSJoerg Wunsch.Ql Fl P 6909fd0dafcSJoerg Wunschoption is used, then 6911dcc6ec7SPhilippe Charnier.Nm 692d6f907dcSJoerg Wunschoutputs the account details in a more human readable form. 693d6f907dcSJoerg WunschThe 694d6f907dcSJoerg Wunsch.Ql Fl a 6959fd0dafcSJoerg Wunschoption lists all users currently on file. 6969fd0dafcSJoerg Wunsch.Pp 6979fd0dafcSJoerg WunschThe command 6989fd0dafcSJoerg Wunsch.Ar usernext 6999fd0dafcSJoerg Wunschreturns the next available user and group ids separated by a colon. 7009fd0dafcSJoerg WunschThis is normally of interest only to interactive scripts or front-ends 7019fd0dafcSJoerg Wunschthat use 702e97407b4SRuslan Ermilov.Nm . 703d6f907dcSJoerg Wunsch.Pp 704d6f907dcSJoerg Wunsch.Sh GROUP OPTIONS 705d6f907dcSJoerg WunschThe 706137db389SSteve Price.Ql Fl C 707d6f907dcSJoerg Wunschand 708d6f907dcSJoerg Wunsch.Ql Fl q 7099fd0dafcSJoerg Wunschoptions (explained at the start of the previous section) are available 7109fd0dafcSJoerg Wunschwith the group manipulation commands. 711d6f907dcSJoerg WunschOther common options to all group-related commands are: 7129fd0dafcSJoerg Wunsch.Bl -tag -width "-m newmembers" 713d6f907dcSJoerg Wunsch.It Fl n Ar name 7141dcc6ec7SPhilippe CharnierSpecify the group name. 715d6f907dcSJoerg Wunsch.It Fl g Ar gid 7161dcc6ec7SPhilippe CharnierSpecify the group numeric id. 717d6f907dcSJoerg Wunsch.Pp 7189fd0dafcSJoerg WunschAs with the account name and id fields, you will usually only need 7199fd0dafcSJoerg Wunschto supply one of these, as the group name implies the uid and vice 7209fd0dafcSJoerg Wunschversa. 7219fd0dafcSJoerg WunschYou will only need to use both when setting a specific group id 7229fd0dafcSJoerg Wunschagainst a new group or when changing the uid of an existing group. 7237ecd7a42SJoseph Koshy.It Fl M Ar memberlist 7249fd0dafcSJoerg WunschThis option provides an alternative way to add existing users to a 7259fd0dafcSJoerg Wunschnew group (in groupadd) or replace an existing membership list (in 7269fd0dafcSJoerg Wunschgroupmod). 7279fd0dafcSJoerg Wunsch.Ar memberlist 7289fd0dafcSJoerg Wunschis a comma separated list of valid and existing user names or uids. 7299fd0dafcSJoerg Wunsch.It Fl m Ar newmembers 7309fd0dafcSJoerg WunschSimilar to 731137db389SSteve Price.Ql Fl M , 7329fd0dafcSJoerg Wunschthis option allows the 7339fd0dafcSJoerg Wunsch.Em addition 734137db389SSteve Priceof existing users to a group without replacing the existing list of 7359fd0dafcSJoerg Wunschmembers. 736137db389SSteve PriceLogin names or user ids may be used, and duplicate users are 737137db389SSteve Pricesilently eliminated. 738d6f907dcSJoerg Wunsch.El 739d6f907dcSJoerg Wunsch.Pp 740d6f907dcSJoerg Wunsch.Ar groupadd 741d6f907dcSJoerg Wunschalso has a 742d6f907dcSJoerg Wunsch.Ql Fl o 743137db389SSteve Priceoption that allows allocation of an existing group id to a new group. 744d6f907dcSJoerg WunschThe default action is to reject an attempt to add a group, and this option overrides 745d6f907dcSJoerg Wunschthe check for duplicate group ids. 746d6f907dcSJoerg WunschThere is rarely any need to duplicate a group id. 747d6f907dcSJoerg Wunsch.Pp 748d6f907dcSJoerg WunschThe 749d6f907dcSJoerg Wunsch.Ar groupmod 750137db389SSteve Pricecommand adds one additional option: 751d6f907dcSJoerg Wunsch.Pp 7529fd0dafcSJoerg Wunsch.Bl -tag -width "-m newmembers" 753d6f907dcSJoerg Wunsch.It Fl l Ar name 754d6f907dcSJoerg WunschThis option allows changing of an existing group name to 755d6f907dcSJoerg Wunsch.Ql \&name . 756d6f907dcSJoerg WunschThe new name must not already exist, and any attempt to duplicate an existing group 757d6f907dcSJoerg Wunschname will be rejected. 758d6f907dcSJoerg Wunsch.El 759d6f907dcSJoerg Wunsch.Pp 760d6f907dcSJoerg WunschOptions for 761d6f907dcSJoerg Wunsch.Ar groupshow 762d6f907dcSJoerg Wunschare the same as for 763d6f907dcSJoerg Wunsch.Ar usershow , 764d6f907dcSJoerg Wunschwith the 765d6f907dcSJoerg Wunsch.Ql Fl g Ar gid 766d6f907dcSJoerg Wunschreplacing 767d6f907dcSJoerg Wunsch.Ql Fl u Ar uid 768d6f907dcSJoerg Wunschto specify the group id. 769d6f907dcSJoerg Wunsch.Pp 7709fd0dafcSJoerg WunschThe command 7719fd0dafcSJoerg Wunsch.Ar groupnext 7729fd0dafcSJoerg Wunschreturns the next available group id on standard output. 773e468afb4SDima Dorfman.Sh USER LOCKING 774e468afb4SDima Dorfman.Nm Pw 775e468afb4SDima Dorfmansupports a simple password locking mechanism for users; it works by 776e468afb4SDima Dorfmanprepending the string 777e468afb4SDima Dorfman.Ql *LOCKED* 778e468afb4SDima Dorfmanto the beginning of the password field in 779e468afb4SDima Dorfman.Pa master.passwd 780e468afb4SDima Dorfmanto prevent successful authentication. 781e468afb4SDima Dorfman.Pp 782e468afb4SDima DorfmanThe 783e468afb4SDima Dorfman.Ar lock 784e468afb4SDima Dorfmanand 785e468afb4SDima Dorfman.Ar unlock 786e468afb4SDima Dorfmancommands take a user name or uid of the account to lock or unlock, 787e468afb4SDima Dorfmanrespectively. The 788e468afb4SDima Dorfman.Ql Fl V , 789e468afb4SDima Dorfman.Ql Fl C , 790e468afb4SDima Dorfmanand 791e468afb4SDima Dorfman.Ql Fl q 792e468afb4SDima Dorfmanoptions as described above are accepted by these commands. 7939fd0dafcSJoerg Wunsch.Sh DIAGNOSTICS 7941dcc6ec7SPhilippe Charnier.Nm Pw 795137db389SSteve Pricereturns EXIT_SUCCESS on successful operation, otherwise 796137db389SSteve Price.Nm 797137db389SSteve Pricereturns one of the 7989fd0dafcSJoerg Wunschfollowing exit codes defined by 7999fd0dafcSJoerg Wunsch.Xr sysexits 3 8009fd0dafcSJoerg Wunschas follows: 8019fd0dafcSJoerg Wunsch.Bl -tag -width xxxx 8029fd0dafcSJoerg Wunsch.It EX_USAGE 8039fd0dafcSJoerg Wunsch.Bl -bullet -compact 8049fd0dafcSJoerg Wunsch.It 8051dcc6ec7SPhilippe CharnierCommand line syntax errors (invalid keyword, unknown option). 8069fd0dafcSJoerg Wunsch.El 8079fd0dafcSJoerg Wunsch.It EX_NOPERM 8089fd0dafcSJoerg Wunsch.Bl -bullet -compact 8099fd0dafcSJoerg Wunsch.It 8109fd0dafcSJoerg WunschAttempting to run one of the update modes as non-root. 8119fd0dafcSJoerg Wunsch.El 8129fd0dafcSJoerg Wunsch.It EX_OSERR 8139fd0dafcSJoerg Wunsch.Bl -bullet -compact 8149fd0dafcSJoerg Wunsch.It 8159fd0dafcSJoerg WunschMemory allocation error. 8169fd0dafcSJoerg Wunsch.It 8179fd0dafcSJoerg WunschRead error from password file descriptor. 8189fd0dafcSJoerg Wunsch.El 8199fd0dafcSJoerg Wunsch.It EX_DATAERR 8209fd0dafcSJoerg Wunsch.Bl -bullet -compact 8219fd0dafcSJoerg Wunsch.It 8229fd0dafcSJoerg WunschBad or invalid data provided or missing on the command line or 823137db389SSteve Pricevia the password file descriptor. 8249fd0dafcSJoerg Wunsch.It 8259fd0dafcSJoerg WunschAttempted to remove, rename root account or change its uid. 8269fd0dafcSJoerg Wunsch.El 8279fd0dafcSJoerg Wunsch.It EX_OSFILE 8289fd0dafcSJoerg Wunsch.Bl -bullet -compact 8299fd0dafcSJoerg Wunsch.It 8309fd0dafcSJoerg WunschSkeleton directory is invalid or does not exist. 8319fd0dafcSJoerg Wunsch.It 8329fd0dafcSJoerg WunschBase home directory is invalid or does not exist. 8339fd0dafcSJoerg Wunsch.It 834137db389SSteve PriceInvalid or non-existent shell specified. 8359fd0dafcSJoerg Wunsch.El 8369fd0dafcSJoerg Wunsch.It EX_NOUSER 8379fd0dafcSJoerg Wunsch.Bl -bullet -compact 8389fd0dafcSJoerg Wunsch.It 8399fd0dafcSJoerg WunschUser, user id, group or group id specified does not exist. 8409fd0dafcSJoerg Wunsch.It 841137db389SSteve PriceUser or group recorded, added, or modified unexpectedly disappeared. 8429fd0dafcSJoerg Wunsch.El 8439fd0dafcSJoerg Wunsch.It EX_SOFTWARE 8449fd0dafcSJoerg Wunsch.Bl -bullet -compact 8459fd0dafcSJoerg Wunsch.It 8469fd0dafcSJoerg WunschNo more group or user ids available within specified range. 8479fd0dafcSJoerg Wunsch.El 8489fd0dafcSJoerg Wunsch.It EX_IOERR 8499fd0dafcSJoerg Wunsch.Bl -bullet -compact 8509fd0dafcSJoerg Wunsch.It 8519fd0dafcSJoerg WunschUnable to rewrite configuration file. 8529fd0dafcSJoerg Wunsch.It 8539fd0dafcSJoerg WunschError updating group or user database files. 8549fd0dafcSJoerg Wunsch.It 8559fd0dafcSJoerg WunschUpdate error for passwd or group database files. 8569fd0dafcSJoerg Wunsch.El 8579fd0dafcSJoerg Wunsch.It EX_CONFIG 8589fd0dafcSJoerg Wunsch.Bl -bullet -compact 8599fd0dafcSJoerg Wunsch.It 8609fd0dafcSJoerg WunschNo base home directory configured. 8619fd0dafcSJoerg Wunsch.El 8629fd0dafcSJoerg Wunsch.El 8639fd0dafcSJoerg Wunsch.Pp 864d6f907dcSJoerg Wunsch.Sh NOTES 865d6f907dcSJoerg WunschFor a summary of options available with each command, you can use 866d6f907dcSJoerg Wunsch.Dl pw [command] help 867d6f907dcSJoerg WunschFor example, 868d6f907dcSJoerg Wunsch.Dl pw useradd help 869d6f907dcSJoerg Wunschlists all available options for the useradd operation. 870d9b711b7SDavid Nugent.Pp 8711dcc6ec7SPhilippe Charnier.Nm Pw 872137db389SSteve Priceallows 8-bit characters in the passwd GECOS field (user's full name, 873d9b711b7SDavid Nugentoffice, work and home phone number subfields), but disallows them in 874d9b711b7SDavid Nugentuser login and group names. 875137db389SSteve PriceUse 8-bit characters with caution, as connection to the Internet will 876d9b711b7SDavid Nugentrequire that your mail transport program supports 8BITMIME, and will 877d9b711b7SDavid Nugentconvert headers containing 8-bit characters to 7-bit quoted-printable 878d9b711b7SDavid Nugentformat. 879d9b711b7SDavid Nugent.Xr sendmail 8 880d9b711b7SDavid Nugentdoes support this. 881137db389SSteve PriceUse of 8-bit characters in the GECOS field should be used in 882d9b711b7SDavid Nugentconjunction with the user's default locale and character set 883d9b711b7SDavid Nugentand should not be implemented without their use. 884d9b711b7SDavid NugentUsing 8-bit characters may also affect other 885137db389SSteve Priceprograms that transmit the contents of the GECOS field over the 886137db389SSteve PriceInternet, such as 887d9b711b7SDavid Nugent.Xr fingerd 8 , 888137db389SSteve Priceand a small number of TCP/IP clients, such as IRC, where full names 889d9b711b7SDavid Nugentspecified in the passwd file may be used by default. 890d6f907dcSJoerg Wunsch.Sh FILES 891d6f907dcSJoerg Wunsch.Bl -tag -width /etc/master.passwd.new -compact 892d6f907dcSJoerg Wunsch.It Pa /etc/master.passwd 893d6f907dcSJoerg WunschThe user database 894d6f907dcSJoerg Wunsch.It Pa /etc/passwd 895d6f907dcSJoerg WunschA Version 7 format password file 8969fd0dafcSJoerg Wunsch.It Pa /etc/login.conf 8979fd0dafcSJoerg WunschThe user capabilities database 898d6f907dcSJoerg Wunsch.It Pa /etc/group 899d6f907dcSJoerg WunschThe group database 900d6f907dcSJoerg Wunsch.It Pa /etc/master.passwd.new 901d6f907dcSJoerg WunschTemporary copy of the master password file 902d6f907dcSJoerg Wunsch.It Pa /etc/passwd.new 903d6f907dcSJoerg WunschTemporary copy of the Version 7 password file 904d6f907dcSJoerg Wunsch.It Pa /etc/group.new 905d6f907dcSJoerg WunschTemporary copy of the group file 906d6f907dcSJoerg Wunsch.It Pa /etc/pw.conf 907d6f907dcSJoerg WunschPw default options file 908d6f907dcSJoerg Wunsch.El 909d6f907dcSJoerg Wunsch.Sh SEE ALSO 910d6f907dcSJoerg Wunsch.Xr chpass 1 , 911053375e8SMike Pritchard.Xr passwd 1 , 912d6f907dcSJoerg Wunsch.Xr group 5 , 913bfd34a4aSWolfram Schneider.Xr login.conf 5 , 914053375e8SMike Pritchard.Xr passwd 5 , 915053375e8SMike Pritchard.Xr pw.conf 5 , 916d6f907dcSJoerg Wunsch.Xr pwd_mkdb 8 , 917053375e8SMike Pritchard.Xr vipw 8 918d6f907dcSJoerg Wunsch.Sh HISTORY 9191dcc6ec7SPhilippe Charnier.Nm Pw 9209fd0dafcSJoerg Wunschwas written to mimic many of the options used in the SYSV 921d6f907dcSJoerg Wunsch.Em shadow 9229fd0dafcSJoerg Wunschsupport suite, but is modified for passwd and group fields specific to 923053375e8SMike Pritchardthe 924053375e8SMike Pritchard.Bx 4.4 9259fd0dafcSJoerg Wunschoperating system, and combines all of the major elements 9269fd0dafcSJoerg Wunschinto a single command. 927