diff options
author | Todd C. Miller <millert@cvs.openbsd.org> | 2003-06-08 23:32:24 +0000 |
---|---|---|
committer | Todd C. Miller <millert@cvs.openbsd.org> | 2003-06-08 23:32:24 +0000 |
commit | 64c8c0b80b36cb1063d59e19328b3154ed758fdb (patch) | |
tree | a96631b71d24e4d4b26e3b5bc62a603bf85b81f5 /usr.sbin/user | |
parent | 85ee4e2e635b294f1c4f5b90834769f97672432f (diff) |
Sync man pages w/ NetBSD version
Diffstat (limited to 'usr.sbin/user')
-rw-r--r-- | usr.sbin/user/group.8 | 22 | ||||
-rw-r--r-- | usr.sbin/user/groupadd.8 | 10 | ||||
-rw-r--r-- | usr.sbin/user/groupdel.8 | 10 | ||||
-rw-r--r-- | usr.sbin/user/groupinfo.8 | 9 | ||||
-rw-r--r-- | usr.sbin/user/groupmod.8 | 10 | ||||
-rw-r--r-- | usr.sbin/user/user.8 | 35 | ||||
-rw-r--r-- | usr.sbin/user/useradd.8 | 169 | ||||
-rw-r--r-- | usr.sbin/user/userdel.8 | 37 | ||||
-rw-r--r-- | usr.sbin/user/userinfo.8 | 11 | ||||
-rw-r--r-- | usr.sbin/user/usermod.8 | 110 |
10 files changed, 216 insertions, 207 deletions
diff --git a/usr.sbin/user/group.8 b/usr.sbin/user/group.8 index eb28f53453c..106c7c372ad 100644 --- a/usr.sbin/user/group.8 +++ b/usr.sbin/user/group.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: group.8,v 1.10 2002/11/22 04:38:54 millert Exp $ -.\" $NetBSD: group.8,v 1.5 2000/10/03 19:32:23 bjh21 Exp $ +.\" $OpenBSD: group.8,v 1.11 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: group.8,v 1.10 2003/02/25 10:36:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -38,17 +38,21 @@ .Nm group .Nd manage group information on the system .Sh SYNOPSIS -.Nm group add +.Nm group +.Cm add .Op Fl ov .Op Fl g Ar gid .Ar group -.Nm group del +.Nm group +.Cm del .Op Fl v .Ar group -.Nm group info +.Nm group +.Cm info .Op Fl ev .Ar group -.Nm group mod +.Nm group +.Cm mod .Op Fl ov .Op Fl g Ar gid .Op Fl n Ar newname @@ -68,7 +72,7 @@ For a full explanation of the options, please see the relevant manual page. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh SEE ALSO .Xr group 5 , .Xr groupadd 8 , @@ -84,4 +88,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupadd.8 b/usr.sbin/user/groupadd.8 index 2453cbac96d..ee254467070 100644 --- a/usr.sbin/user/groupadd.8 +++ b/usr.sbin/user/groupadd.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: groupadd.8,v 1.9 2002/11/22 04:38:54 millert Exp $ -.\" $NetBSD: groupadd.8,v 1.5 2000/10/03 19:32:23 bjh21 Exp $ +.\" $OpenBSD: groupadd.8,v 1.10 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: groupadd.8,v 1.9 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -58,7 +58,7 @@ enables verbose mode - explain the commands as they are executed. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh SEE ALSO .Xr group 5 , .Xr groupdel 8 , @@ -73,4 +73,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupdel.8 b/usr.sbin/user/groupdel.8 index 2b724f20a94..8064e879b91 100644 --- a/usr.sbin/user/groupdel.8 +++ b/usr.sbin/user/groupdel.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: groupdel.8,v 1.9 2002/11/22 04:38:54 millert Exp $ -.\" $NetBSD: groupdel.8,v 1.5 2000/02/28 05:10:56 enami Exp $ +.\" $OpenBSD: groupdel.8,v 1.10 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: groupdel.8,v 1.9 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -53,7 +53,7 @@ enables verbose mode - explain the commands as they are executed. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh SEE ALSO .Xr group 5 , .Xr groupadd 8 , @@ -68,4 +68,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupinfo.8 b/usr.sbin/user/groupinfo.8 index 755158caf31..6b7dd9bbb4f 100644 --- a/usr.sbin/user/groupinfo.8 +++ b/usr.sbin/user/groupinfo.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: groupinfo.8,v 1.8 2001/09/18 01:50:44 millert Exp $ +.\" $OpenBSD: groupinfo.8,v 1.9 2003/06/08 23:32:23 millert Exp $ .\" $NetBSD: groupinfo.8,v 1.3 2000/10/03 19:32:23 bjh21 Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -70,7 +70,8 @@ utility exits 0 if the group name or gid exists, and non-zero if it does not. .It Pa /etc/usermgmt.conf .El .Sh SEE ALSO -.Xr passwd 5 +.Xr passwd 5 , +.Xr usermgmt.conf 5 .Sh HISTORY The .Nm @@ -79,4 +80,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupmod.8 b/usr.sbin/user/groupmod.8 index d9a3ab2f6b7..fbcbdc2579f 100644 --- a/usr.sbin/user/groupmod.8 +++ b/usr.sbin/user/groupmod.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: groupmod.8,v 1.11 2003/03/11 02:02:29 tedu Exp $ -.\" $NetBSD: groupmod.8,v 1.5 2000/10/03 19:32:23 bjh21 Exp $ +.\" $OpenBSD: groupmod.8,v 1.12 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: groupmod.8,v 1.10 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -61,7 +61,7 @@ enables verbose mode - explain the commands as they are executed. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh SEE ALSO .Xr group 5 , .Xr groupadd 8 , @@ -76,4 +76,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/user.8 b/usr.sbin/user/user.8 index ee7d9ed3f2e..266ad5b05f5 100644 --- a/usr.sbin/user/user.8 +++ b/usr.sbin/user/user.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: user.8,v 1.9 2001/09/18 01:50:44 millert Exp $ +.\" $OpenBSD: user.8,v 1.10 2003/06/08 23:32:23 millert Exp $ .\" $NetBSD: user.8,v 1.9 2001/06/05 11:31:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -38,22 +38,24 @@ .Nm user .Nd manage user login information on the system .Sh SYNOPSIS -.Nm user add +.Nm user +.Cm add .Fl D .Op Fl b Ar base-dir .Op Fl e Ar expiry-time -.Op Fl f Ar inactive-secs +.Op Fl f Ar inactive-time .Op Fl g Ar gid/name/=uid .Op Fl L Ar login-class .Op Fl r Ar low..high -.Nm user add +.Nm user +.Cm add .Op Fl mov .Op Fl G Ar secondary-group .Op Fl b Ar base-dir .Op Fl c Ar comment .Op Fl d Ar home-dir .Op Fl e Ar expiry-time -.Op Fl f Ar inactive-secs +.Op Fl f Ar inactive-time .Op Fl g Ar gid/name/=uid .Op Fl k Ar skel-dir .Op Fl L Ar login-class @@ -62,22 +64,26 @@ .Op Fl s Ar shell .Op Fl u Ar uid .Ar user -.Nm user del +.Nm user +.Cm del .Fl D .Op Fl p Ar preserve-value -.Nm user del +.Nm user +.Cm del .Op Fl prv .Ar user -.Nm user info +.Nm user +.Cm info .Op Fl ev .Ar user -.Nm user mod +.Nm user +.Cm mod .Op Fl mov .Op Fl G Ar secondary-group .Op Fl c Ar comment .Op Fl d Ar home-dir .Op Fl e Ar expiry-time -.Op Fl f Ar inactive-secs +.Op Fl f Ar inactive-time .Op Fl g Ar gid/name/=uid .Op Fl L Ar login-class .Op Fl l Ar new-login @@ -100,14 +106,14 @@ For a full explanation of the options, please see the relevant manual page. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh FILES .Bl -tag -width /etc/usermgmt.conf -compact .It Pa /etc/skel/.[A-z]* Skeleton files for new user .It Pa /etc/usermgmt.conf Configuration file for -.Xr user 8 , +.Nm , .Xr group 8 and those backend commands .El @@ -115,6 +121,7 @@ and those backend commands .Xr chpass 1 , .Xr group 5 , .Xr passwd 5 , +.Xr usermgmt.conf 5 , .Xr useradd 8 , .Xr userdel 8 , .Xr userinfo 8 , @@ -127,4 +134,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/useradd.8 b/usr.sbin/user/useradd.8 index a50c0316894..2ef92950b23 100644 --- a/usr.sbin/user/useradd.8 +++ b/usr.sbin/user/useradd.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: useradd.8,v 1.15 2003/05/14 06:42:09 jsyn Exp $ -.\" $NetBSD: useradd.8,v 1.10 2001/02/21 12:16:07 agc Exp $ +.\" $OpenBSD: useradd.8,v 1.16 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: useradd.8,v 1.26 2003/02/25 10:36:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -42,7 +42,7 @@ .Fl D .Op Fl b Ar base-dir .Op Fl e Ar expiry-time -.Op Fl f Ar password-change-secs +.Op Fl f Ar inactive-time .Oo .Fl g Ar gid | name | Li =uid Oc .Op Fl L Ar login-class @@ -58,7 +58,7 @@ .Op Fl c Ar comment .Op Fl d Ar home-dir .Op Fl e Ar expiry-time -.Op Fl f Ar password-change-secs +.Op Fl f Ar inactive-time .Oo .Fl g Ar gid | name | Li =uid Oc .Op Fl k Ar skel-dir @@ -77,21 +77,24 @@ utility adds a user to the system, creating and populating a home directory if necessary. Any skeleton files will be provided for the new user if they exist in the -.Pa /etc/skel -directory. +.Ar skel-dir +directory (see the +.Fl k +option). Default values for the base directory, the time of password expiry, -seconds until password change, +the time of account expiry, primary group, the skeleton directory, the range from which the uid will be allocated, and default login shell can be provided in the .Pa /etc/usermgmt.conf -file. +file, which, if running as root, is created using the built-in defaults if +it does not exist. .Pp -The first format of the command shown above (utilising the +The first form of the command shown above (using the .Fl D option) sets and displays the defaults for the @@ -104,40 +107,46 @@ without any further options, will show the current defaults which will be used by the .Nm -utility. Together with one of the options shown for the first version +utility. +Together with one of the options shown for the first version of the command, .Fl D will set the default to be the new value. +See +.Xr usermgmt.conf 5 +for more information. .It Fl b Ar base-dir -sets the base directory. This is the directory to which the user name -is added, which will be created if the +sets the base directory. +This is the directory to which the user directory is added, +which will be created if the .Fl m option is specified and no .Fl d option is specified. .It Fl e Ar expiry-time -sets the time at which the current password will expire for new users. -.It Fl f Ar password-change-secs -provides the number of seconds since the epoch (UTC) at -which the current password must be changed. This -can be used to implement password aging. -A value of -0 can be used to switch off this feature. -The default value for this field is 0. -See -.Xr passwd 5 -for more details. +sets the default time at which the current password will expire for new +users. +It should be entered in the form +.Dq month day year , +where month is the month name (the first three characters are +sufficient), day is the day of the month, and year is the year. +Time in seconds since the epoch (UTC) is also valid. +A value of 0 can be used to disable this feature. +.It Fl f Ar inactive-time +sets the default time at which new user accounts will expire. +Also see the +.Fl e +option above. .It Fl g Ar gid | groupname | Li =uid -sets the default group for any user added using the -.Nm -command. +sets the default group for new users. .It Fl k Ar skel-dir sets the skeleton directory in which to find files with which to populate new users' home directories. .It Fl L Ar login-class -This option sets the login class for the user being created. See +sets the default login class for new users. +See .Xr login.conf 5 -for more information on login classes. +for more information on user login classes. .It Xo .Fl r Ar low Ns Li .. Ns Ar high .Xc @@ -145,27 +154,23 @@ sets the low and high bounds of uid ranges for new users. A new user can only be created if there are uids which can be assigned from one of the free ranges. .It Fl s Ar shell -sets the login shell for new users. +sets the default login shell for new users. .El .Pp In the second form of the command, -after setting any defaults, and then values from that file, -the command line options are processed: +after setting any defaults, and then reading values from +.Pa /etc/usermgmt.conf , +the following command line options are processed: .Bl -tag -width Ds .It Fl G Ar secondary-group[,group,...] -is the secondary groups to which the user will be added in the +are the secondary groups to which the user will be added in the .Pa /etc/group file. .It Fl b Ar base-directory is the base directory name, in which the user's new home -directory will be created, should the -m option be specified. -This value can be preset for all users -by using the -.Ar base_dir -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic base_dir Ar path-to-base-dir +directory will be created, should the +.Fl m +option be specified. .It Fl c Ar comment is the comment field (also, for historical reasons known as the GECOS field) which will be added for the user, and typically will include @@ -173,23 +178,23 @@ the username, and, perhaps, contact information for the user. .It Fl d Ar home-directory is the home directory which will be created and populated for the user, should the -m option be specified. -.It Fl e Ar secs-to-expiry -provides the number of seconds since the epoch (UTC) at -which the current password change expire. This -can be used to implement password aging. -A value of -0 can be used to switch off this feature. -The default value for this field is 0. +.It Fl e Ar expiry-time +sets the time at which the current password will expire for new +users. +It should be entered in the form +.Dq month day year , +where month is the month name (the first three characters are +sufficient), day is the day of the month, and year is the year. +Time in seconds since the epoch (UTC) is also valid. +A value of 0 can be used to disable this feature. See .Xr passwd 5 for more details. -This value can be preset for all users -by using the -.Ar expire -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic expire Ar secs-to-expiry +.It Fl f Ar inactive-time +sets the time at which new user accounts will expire. +Also see the +.Fl e +option above. .It Fl g Ar gid | name | Li =uid gives the group name or identifier to be used for the new user's primary group. If this is @@ -198,36 +203,13 @@ then a uid and gid will be picked which are both unique and the same, and a line added to .Pa /etc/group to describe the new group. -This value can be preset for all users -by using the -.Ar gid -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.br \" XXX This shouldn't be needed -- mdoc bug? --bjh21 -.Bd -ragged -offset indent -compact -.Ic group -.Ar gid | name | Li =uid -.Ed .It Fl k Ar skeleton directory gives the skeleton directory in which to find files with which to populate the new user's home directory. -This value can be preset for all users by using the -.Ar skel_dir -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic skel_dir Ar path-to-skeleton-dir .It Fl L Ar login-class This option sets the login class for the user being created. See .Xr login.conf 5 -for more information on login classes. This value can be preset -for all users by using the -.Ar class -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic class Ar login-class +for more information on user login classes. .It Fl m create a new home directory for the new user. .It Fl o @@ -237,24 +219,11 @@ specifies an already-encrypted password for the new user. This password can then be changed by using the .Xr chpass 1 utility. -This value can be preset for all users -by using the -.Ar password -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic password Ar encrypted-password -.Pp -If this option is not specified, the account will be disabled by default. +If this option is not specified, and no default exists in +.Pa /etc/usermgmt.conf , +the account will be disabled by default. .It Fl s Ar shell specifies the login shell for the new user. -This value can be preset for all users -by using the -.Ar shell -field in the -.Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic shell Ar login-shell .It Fl u Ar uid specifies a uid for the new user. Boundaries for this value can be preset for all users @@ -262,10 +231,7 @@ by using the .Ar range field in the .Pa /etc/usermgmt.conf -file - they have the format: -.Bd -unfilled -offset indent -compact -.Ic range Ar starting-uid Ns Li .. Ns Ar ending-uid -.Ed +file. .It Fl v enables verbose mode - explain the commands as they are executed. .El @@ -281,7 +247,7 @@ and the new information is not available to programs. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh FILES .Bl -tag -width /etc/usermgmt.conf -compact .It Pa /etc/usermgmt.conf @@ -293,6 +259,7 @@ utility exits 0 on success, and >0 if an error occurs. .Xr group 5 , .Xr login.conf 5 , .Xr passwd 5 , +.Xr usermgmt.conf 5 , .Xr pwd_mkdb 8 , .Xr user 8 , .Xr userdel 8 , @@ -305,4 +272,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/userdel.8 b/usr.sbin/user/userdel.8 index 74ffc597ffb..b5c28e54306 100644 --- a/usr.sbin/user/userdel.8 +++ b/usr.sbin/user/userdel.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: userdel.8,v 1.8 2001/09/18 01:50:44 millert Exp $ -.\" $NetBSD: userdel.8,v 1.5 2000/03/13 23:22:55 soren Exp $ +.\" $OpenBSD: userdel.8,v 1.9 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: userdel.8,v 1.24 2003/02/25 10:36:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -48,10 +48,16 @@ The .Nm utility removes a user from the system, optionally -removing that user's home diretory and any subdirectories. +removing that user's home directory and any subdirectories. .Pp -The first format of the command shown above (utilising the -D option) -sets and displays the defaults for the +Default values are taken from the information provided in the +.Pa /etc/usermgmt.conf +file, which, if running as root, is created using the built-in defaults if +it does not exist. +.Pp +The first form of the command shown above (using the +.Fl D +option) sets and displays the defaults for the .Nm utility. .Bl -tag -width Ds @@ -60,7 +66,8 @@ without any further options, .Fl D will show the current defaults which will be used by the .Nm -utility. Together with one of the options shown for the first version +utility. +Together with one of the options shown for the first version of the command, .Fl D will set the default to be the new value. @@ -71,7 +78,10 @@ sets the preservation value. If this value is one of or a non-zero number, then the user login information will be preserved. .El .Pp -The following command line options are recognised: +In the second form of the command, +after setting any defaults, and then reading values from +.Pa /etc/usermgmt.conf , +the following command line options are processed: .Bl -tag -width Ds .It Fl p preserve the user information in the password file, @@ -79,8 +89,8 @@ but do not allow the user to login, by switching the password to an .Dq impossible one, and by setting the -user's shell to the -.Xr false 1 +user's shell to the +.Xr nologin 8 program. This option can be helpful in preserving a user's files for later use by members of that person's group after the user has moved on. @@ -110,14 +120,15 @@ and the new information is not available to programs. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh FILES .Bl -tag -width /etc/usermgmt.conf -compact .It Pa /etc/usermgmt.conf .El .Sh SEE ALSO -.Xr false 1 , .Xr passwd 5 , +.Xr usermgmt.conf 5 , +.Xr nologin 8 , .Xr pwd_mkdb 8 .Sh HISTORY The @@ -127,4 +138,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/userinfo.8 b/usr.sbin/user/userinfo.8 index f2fea9d2a1a..8a78e6d05aa 100644 --- a/usr.sbin/user/userinfo.8 +++ b/usr.sbin/user/userinfo.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: userinfo.8,v 1.8 2001/09/18 01:50:44 millert Exp $ -.\" $NetBSD: userinfo.8,v 1.4 2000/10/03 19:32:23 bjh21 Exp $ +.\" $OpenBSD: userinfo.8,v 1.9 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: userinfo.8,v 1.8 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -70,7 +70,8 @@ utility exits 0 if the user name or uid exists, and non-zero if it does not. .It Pa /etc/usermgmt.conf .El .Sh SEE ALSO -.Xr passwd 5 +.Xr passwd 5 , +.Xr usermgmt.conf 5 .Sh HISTORY The .Nm @@ -79,4 +80,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . diff --git a/usr.sbin/user/usermod.8 b/usr.sbin/user/usermod.8 index 2556945032f..ca4cfa90d21 100644 --- a/usr.sbin/user/usermod.8 +++ b/usr.sbin/user/usermod.8 @@ -1,5 +1,5 @@ -.\" $OpenBSD: usermod.8,v 1.13 2003/02/14 23:20:36 jmc Exp $ -.\" $NetBSD: usermod.8,v 1.10 2001/02/21 12:16:07 agc Exp $ +.\" $OpenBSD: usermod.8,v 1.14 2003/06/08 23:32:23 millert Exp $ +.\" $NetBSD: usermod.8,v 1.17 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. .\" @@ -45,7 +45,7 @@ .Op Fl c Ar comment .Op Fl d Ar home-dir .Op Fl e Ar expiry-time -.Op Fl f Ar password-change-secs +.Op Fl f Ar inactive-time .Oo .Fl g Ar gid | name | Li =uid .Oc @@ -60,13 +60,15 @@ The .Nm utility modifies user login information on the system. -Default values for the user are taken from the information -provided in the +.Pp +Default values are taken from the information provided in the .Pa /etc/usermgmt.conf -file. +file, which, if running as root, is created using the built-in defaults if +it does not exist. .Pp -After setting any defaults, and then values from that file, -the command line options are processed: +After setting any defaults, and then reading values from +.Pa /etc/usermgmt.conf , +the following command line options are processed: .Bl -tag -width Ds .It Fl G Ar secondary-group[,group,...] are the secondary groups the user will be a member of in the @@ -84,33 +86,31 @@ without populating it; if the option is specified, tries to move the old home directory to .Ar home-directory . .It Fl e Ar expiry-time -provides the date at which the account expires. This should be given -in a standard time format (%c). This is unset by default. -This value can be preset for all users by using the +sets the time at which the current password expires. +This can be used to implement password aging. +It should be entered in the form +.Dq month day year , +where month is the month name (the first three characters are +sufficient), day is the day of the month, and year is the year. +Time in seconds since the epoch (UTC) is also valid. A value of +0 can be used to disable this feature. +This value can be preset for all users using the .Ar expire -field in /etc/usermgmt.conf file - it has the format: -.D1 Ic expire Ar expiry-time -.It Fl f Ar password-change-secs -provides the number of seconds since the epoch (UTC) at -which the current password must be changed. This -can be used to implement password aging. -A value of -0 can be used to switch off this feature. -The default value for this field is 0. -See -.Xr passwd 5 -for more details. -This value can be preset for all users -by using the -.Ar inactive field in the .Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic inactive Ar password-change-secs +file. +See +.Xr usermgmt.conf 5 +for more details. +.It Fl f Ar inactive-time +sets the time at which the account expires. +See the +.Fl e +option. .It Xo .Fl g Ar gid | name | Li =uid .Xc -gives the group name or identifier to be used for the new user's primary group. +gives the group name or identifier to be used for the user's primary group. If this is .Ql =uid , then a uid and gid will be picked which are both unique @@ -122,12 +122,10 @@ by using the .Ar gid field in the .Pa /etc/usermgmt.conf -file - it has the format: -.br \" XXX Shouldn't be necessary -- mdoc bug? --bjh21 -.Bd -ragged -offset indent -compact -.Ic group -.Ar gid | name | Li =uid -.Ed +file. +See +.Xr usermgmt.conf 5 +for more details. .It Fl L Ar login-class this option sets the login class for the user being created. See .Xr login.conf 5 @@ -136,12 +134,9 @@ for all users by using the .Ar class field in the .Pa /etc/usermgmt.conf -file - it has the format: -.br \" XXX skip empty line? - HF -.Bd -ragged -offset indent -compact -.Ic class -.Ar login-class -.Ed +file. +.Xr usermgmt.conf 5 +for more details. .It Fl l Ar new-user gives the new user name. It must consist of alphanumeric characters, or the characters @@ -165,7 +160,7 @@ is needed. .It Fl o allows duplicate uids to be given. .It Fl p Ar password -specifies an already-encrypted password for the new user. +specifies an already-encrypted password for the user. This password can then be changed by using the .Xr chpass 1 utility. @@ -174,17 +169,21 @@ by using the .Ar password field in the .Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic password Ar encrypted-password +file. +See +.Xr usermgmt.conf 5 +for more details. .It Fl s Ar shell -specifies the login shell for the new user. +specifies the login shell for the user. This value can be preset for all users by using the .Ar shell field in the .Pa /etc/usermgmt.conf -file - it has the format: -.D1 Ic shell Ar login-shell +file. +See +.Xr usermgmt.conf 5 +for more details. .It Fl u Ar uid specifies a new uid for the user. Boundaries for this value can be preset for all users @@ -192,12 +191,10 @@ by using the .Ar range field in the .Pa /etc/usermgmt.conf -file - they have the format: -.br \" XXX -.Bd -ragged -offset indent -compact -.Ic range -.Ar starting-uid Ns Li .. Ns Ar ending_uid -.Ed +file. +See +.Xr usermgmt.conf 5 +for more details. .It Fl v enables verbose mode - explain the commands as they are executed. .El @@ -213,7 +210,7 @@ and the new information is not available to programs. .Pp The .Nm -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success, and \*(Gt0 if an error occurs. .Sh FILES .Bl -tag -width /etc/usermgmt.conf -compact .It Pa /etc/usermgmt.conf @@ -222,6 +219,7 @@ utility exits 0 on success, and >0 if an error occurs. .Xr chpass 1 , .Xr group 5 , .Xr passwd 5 , +.Xr usermgmt.conf 5 , .Xr pwd_mkdb 8 .Sh HISTORY The @@ -231,4 +229,6 @@ utility first appeared in .Sh AUTHORS The .Nm -utility was written by Alistair G. Crooks (agc@netbsd.org). +utility was written by +.An Alistair G. Crooks +.Aq agc@NetBSD.org . |