diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2003-06-15 06:40:16 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2003-06-15 06:40:16 +0000 |
commit | 7292f7ad65633848de2da67302fa2729e6b32dae (patch) | |
tree | 67904ad36bbe1effc8a7dc9d2c0fc6eb90c239f0 /usr.sbin/user | |
parent | 0c5b29877b2f3704f5cb0d6c66c9ac14ede8714f (diff) |
small mdoc fixes;
ok millert@
Diffstat (limited to 'usr.sbin/user')
-rw-r--r-- | usr.sbin/user/group.8 | 5 | ||||
-rw-r--r-- | usr.sbin/user/groupadd.8 | 7 | ||||
-rw-r--r-- | usr.sbin/user/groupdel.8 | 5 | ||||
-rw-r--r-- | usr.sbin/user/groupinfo.8 | 16 | ||||
-rw-r--r-- | usr.sbin/user/groupmod.8 | 7 | ||||
-rw-r--r-- | usr.sbin/user/user.8 | 13 | ||||
-rw-r--r-- | usr.sbin/user/useradd.8 | 35 | ||||
-rw-r--r-- | usr.sbin/user/userdel.8 | 23 | ||||
-rw-r--r-- | usr.sbin/user/userinfo.8 | 16 | ||||
-rw-r--r-- | usr.sbin/user/usermgmt.conf.5 | 11 | ||||
-rw-r--r-- | usr.sbin/user/usermod.8 | 31 |
11 files changed, 90 insertions, 79 deletions
diff --git a/usr.sbin/user/group.8 b/usr.sbin/user/group.8 index 106c7c372ad..3b9a2e52ec0 100644 --- a/usr.sbin/user/group.8 +++ b/usr.sbin/user/group.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: group.8,v 1.11 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: group.8,v 1.12 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: group.8,v 1.10 2003/02/25 10:36:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -89,5 +89,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupadd.8 b/usr.sbin/user/groupadd.8 index ee254467070..eafad44754a 100644 --- a/usr.sbin/user/groupadd.8 +++ b/usr.sbin/user/groupadd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: groupadd.8,v 1.10 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: groupadd.8,v 1.11 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: groupadd.8,v 1.9 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -51,7 +51,7 @@ The options are as follows: .It Fl g Ar gid gives the numeric group identifier to be used for the new group. .It Fl o -allow the new group to have a gid which is already in use for another group. +allow the new group to have a GID which is already in use for another group. .It Fl v enables verbose mode - explain the commands as they are executed. .El @@ -74,5 +74,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupdel.8 b/usr.sbin/user/groupdel.8 index 8064e879b91..d68b4813374 100644 --- a/usr.sbin/user/groupdel.8 +++ b/usr.sbin/user/groupdel.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: groupdel.8,v 1.10 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: groupdel.8,v 1.11 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: groupdel.8,v 1.9 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -69,5 +69,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupinfo.8 b/usr.sbin/user/groupinfo.8 index 6b7dd9bbb4f..e60827e3bfd 100644 --- a/usr.sbin/user/groupinfo.8 +++ b/usr.sbin/user/groupinfo.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: groupinfo.8,v 1.9 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: groupinfo.8,v 1.10 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: groupinfo.8,v 1.3 2000/10/03 19:32:23 bjh21 Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -50,21 +50,22 @@ The following command line options are recognised: .Bl -tag -width Ds .It Fl e return 0 if the group exists, and non-zero if the -group does not exist, on the system. No information is -displayed. This form of the command is useful for +group does not exist, on the system. +No information is displayed. +This form of the command is useful for scripts which need to check whether a particular group -name or gid is already in use on the system. +name or GID is already in use on the system. .It Fl v perform any actions in a verbose manner. .El .Pp The .Ar group -argument may either be a group's name, or a gid. +argument may either be a group's name, or a GID. .Pp The .Nm -utility exits 0 if the group name or gid exists, and non-zero if it does not. +utility exits 0 if the group name or GID exists, and non-zero if it does not. .Sh FILES .Bl -tag -width /etc/usermgmt.conf -compact .It Pa /etc/usermgmt.conf @@ -81,5 +82,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/groupmod.8 b/usr.sbin/user/groupmod.8 index fbcbdc2579f..55aae451467 100644 --- a/usr.sbin/user/groupmod.8 +++ b/usr.sbin/user/groupmod.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: groupmod.8,v 1.12 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: groupmod.8,v 1.13 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: groupmod.8,v 1.10 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -54,7 +54,7 @@ gives the numeric group identifier to be used for the new group. .It Fl n Ar newname gives the new name which the group shall have. .It Fl o -allow the new group to have a gid which is already in use for another group. +allow the new group to have a GID which is already in use for another group. .It Fl v enables verbose mode - explain the commands as they are executed. .El @@ -77,5 +77,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/user.8 b/usr.sbin/user/user.8 index 266ad5b05f5..30747804319 100644 --- a/usr.sbin/user/user.8 +++ b/usr.sbin/user/user.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: user.8,v 1.10 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: user.8,v 1.11 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: user.8,v 1.9 2001/06/05 11:31:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -39,6 +39,7 @@ .Nd manage user login information on the system .Sh SYNOPSIS .Nm user +.Bk -words .Cm add .Fl D .Op Fl b Ar base-dir @@ -47,7 +48,9 @@ .Op Fl g Ar gid/name/=uid .Op Fl L Ar login-class .Op Fl r Ar low..high +.Ek .Nm user +.Bk -words .Cm add .Op Fl mov .Op Fl G Ar secondary-group @@ -64,6 +67,7 @@ .Op Fl s Ar shell .Op Fl u Ar uid .Ar user +.Ek .Nm user .Cm del .Fl D @@ -77,6 +81,7 @@ .Op Fl ev .Ar user .Nm user +.Bk -words .Cm mod .Op Fl mov .Op Fl G Ar secondary-group @@ -91,6 +96,7 @@ .Op Fl s Ar shell .Op Fl u Ar uid .Ar user +.Ek .Sh DESCRIPTION The .Nm @@ -113,7 +119,7 @@ utility exits 0 on success, and \*(Gt0 if an error occurs. Skeleton files for new user .It Pa /etc/usermgmt.conf Configuration file for -.Nm , +.Nm user , .Xr group 8 and those backend commands .El @@ -135,5 +141,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/useradd.8 b/usr.sbin/user/useradd.8 index 2ef92950b23..027abffe2b8 100644 --- a/usr.sbin/user/useradd.8 +++ b/usr.sbin/user/useradd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: useradd.8,v 1.16 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: useradd.8,v 1.17 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: useradd.8,v 1.26 2003/02/25 10:36:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -39,6 +39,7 @@ .Nd add a user to the system .Sh SYNOPSIS .Nm useradd +.Bk -words .Fl D .Op Fl b Ar base-dir .Op Fl e Ar expiry-time @@ -51,7 +52,9 @@ .Fl r Ar low Ns Li .. Ns Ar high .Oc .Op Fl s Ar shell +.Ek .Nm useradd +.Bk -words .Op Fl mov .Op Fl G Ar secondary-group[,group,...] .Op Fl b Ar base-dir @@ -70,6 +73,7 @@ .Op Fl s Ar shell .Op Fl u Ar uid .Ar user +.Ek .Sh DESCRIPTION The .Nm useradd @@ -87,7 +91,7 @@ the time of password expiry, the time of account expiry, primary group, the skeleton directory, -the range from which the uid will be allocated, +the range from which the UID will be allocated, and default login shell can be provided in the .Pa /etc/usermgmt.conf @@ -150,9 +154,9 @@ for more information on user login classes. .It Xo .Fl r Ar low Ns Li .. Ns Ar high .Xc -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. +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 default login shell for new users. .El @@ -199,7 +203,7 @@ option above. gives the group name or identifier to be used for the new user's primary group. If this is .Ql =uid , -then a uid and gid will be picked which are both unique +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. @@ -207,13 +211,14 @@ to describe the new group. gives the skeleton directory in which to find files with which to populate the new user's home directory. .It Fl L Ar login-class -This option sets the login class for the user being created. See +This option sets the login class for the user being created. +See .Xr login.conf 5 for more information on user login classes. .It Fl m create a new home directory for the new user. .It Fl o -allow the new user to have a uid which is already in use for another user. +allow the new user to have a UID which is already in use for another user. .It Fl p Ar password specifies an already-encrypted password for the new user. This password can then be changed by using the @@ -225,7 +230,7 @@ the account will be disabled by default. .It Fl s Ar shell specifies the login shell for the new user. .It Fl u Ar uid -specifies a uid for the new user. +specifies a UID for the new user. Boundaries for this value can be preset for all users by using the .Ar range @@ -240,10 +245,11 @@ Once the information has been verified, .Nm uses .Xr pwd_mkdb 8 -to update the user database. This is run in the background, and, -at very large sites could take several minutes. Until this update -is completed, the password file is unavailable for other updates -and the new information is not available to programs. +to update the user database. +This is run in the background, and, +at very large sites could take several minutes. +Until this update is completed, the password file is unavailable for other +updates and the new information is not available to programs. .Pp The .Nm @@ -273,5 +279,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/userdel.8 b/usr.sbin/user/userdel.8 index b5c28e54306..54cb761f77e 100644 --- a/usr.sbin/user/userdel.8 +++ b/usr.sbin/user/userdel.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: userdel.8,v 1.9 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: userdel.8,v 1.10 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: userdel.8,v 1.24 2003/02/25 10:36:21 wiz Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -72,7 +72,8 @@ of the command, .Fl D will set the default to be the new value. .It Fl p Ar preserve-value -sets the preservation value. If this value is one of +sets the preservation value. +If this value is one of .Ql true , .Ql yes , or a non-zero number, then the user login information will be preserved. @@ -91,14 +92,16 @@ password to an one, and by setting the user's shell to the .Xr nologin 8 -program. This option can be helpful in preserving a user's +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. This value can also be set in the .Pa /etc/usermgmt.conf file, using the .Ql preserve -field. If the field has any of the values +field. +If the field has any of the values .Ql true , .Ql yes , or a non-zero number, then user information preservation will take place. @@ -113,10 +116,11 @@ Once the information has been verified, .Nm uses .Xr pwd_mkdb 8 -to update the user database. This is run in the background, and, -at very large sites could take several minutes. Until this update -is completed, the password file is unavailable for other updates -and the new information is not available to programs. +to update the user database. +This is run in the background, and, +at very large sites could take several minutes. +Until this update is completed, the password file is unavailable for other +updates and the new information is not available to programs. .Pp The .Nm @@ -139,5 +143,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/userinfo.8 b/usr.sbin/user/userinfo.8 index 8a78e6d05aa..53351d6d914 100644 --- a/usr.sbin/user/userinfo.8 +++ b/usr.sbin/user/userinfo.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: userinfo.8,v 1.9 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: userinfo.8,v 1.10 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: userinfo.8,v 1.8 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -50,21 +50,22 @@ The following command line options are recognised: .Bl -tag -width Ds .It Fl e return 0 if the user exists, and non-zero if the -user does not exist, on the system. No information is -displayed. This form of the command is useful for +user does not exist, on the system. +No information is displayed. +This form of the command is useful for scripts which need to check whether a particular user -name or uid is already in use on the system. +name or UID is already in use on the system. .It Fl v perform any actions in a verbose manner. .El .Pp The .Ar user -argument may either be a user's name, or a uid. +argument may either be a user's name, or a UID. .Pp The .Nm -utility exits 0 if the user name or uid exists, and non-zero if it does not. +utility exits 0 if the user name or UID exists, and non-zero if it does not. .Sh FILES .Bl -tag -width /etc/usermgmt.conf -compact .It Pa /etc/usermgmt.conf @@ -81,5 +82,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . diff --git a/usr.sbin/user/usermgmt.conf.5 b/usr.sbin/user/usermgmt.conf.5 index 6d449f71707..a171453d878 100644 --- a/usr.sbin/user/usermgmt.conf.5 +++ b/usr.sbin/user/usermgmt.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: usermgmt.conf.5,v 1.1 2003/06/08 23:05:10 millert Exp $ +.\" $OpenBSD: usermgmt.conf.5,v 1.2 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: usermgmt.conf.5,v 1.3 2002/10/02 13:49:11 grant Exp $ .\" .\" Copyright (c) 2002 The NetBSD Foundation, Inc. @@ -82,11 +82,12 @@ A value of 0 can be used to disable this feature. sets the default primary group for new users. If this is .Ql =uid , -then a uid and gid will be picked which are both unique +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. It has the format: -.br +to describe the new group. +It has the format: +.Pp .Bd -ragged -offset indent -compact .Ic group .Ar gid | name | Li =uid @@ -107,7 +108,7 @@ or a non-zero number, then the user login information will be preserved when removing a user with .Xr userdel 8 . .It Ic range -specifies the uid boundaries for new users. +specifies the UID boundaries for new users. If unspecified, the default is .Dq 1000..60000 . It has the format: diff --git a/usr.sbin/user/usermod.8 b/usr.sbin/user/usermod.8 index ca4cfa90d21..5d166391d4f 100644 --- a/usr.sbin/user/usermod.8 +++ b/usr.sbin/user/usermod.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: usermod.8,v 1.14 2003/06/08 23:32:23 millert Exp $ +.\" $OpenBSD: usermod.8,v 1.15 2003/06/15 06:40:15 jmc Exp $ .\" $NetBSD: usermod.8,v 1.17 2003/02/14 16:11:37 grant Exp $ .\" .\" Copyright (c) 1999 Alistair G. Crooks. All rights reserved. @@ -92,8 +92,8 @@ 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. +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 the @@ -113,7 +113,7 @@ option. 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 +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. @@ -127,10 +127,11 @@ 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 +this option sets the login class for the user being created. +See .Xr login.conf 5 -for more information on user login classes. This value can be preset -for all users by using the +for more information on user login classes. +This value can be preset for all users by using the .Ar class field in the .Pa /etc/usermgmt.conf @@ -158,7 +159,7 @@ and .Fl l is needed. .It Fl o -allows duplicate uids to be given. +allows duplicate UIDs to be given. .It Fl p Ar password specifies an already-encrypted password for the user. This password can then be changed by using the @@ -185,7 +186,7 @@ See .Xr usermgmt.conf 5 for more details. .It Fl u Ar uid -specifies a new uid for the user. +specifies a new UID for the user. Boundaries for this value can be preset for all users by using the .Ar range @@ -203,10 +204,11 @@ Once the information has been verified, .Nm uses .Xr pwd_mkdb 8 -to update the user database. This is run in the background, and, -at very large sites could take several minutes. Until this update -is completed, the password file is unavailable for other updates -and the new information is not available to programs. +to update the user database. +This is run in the background, and, +at very large sites could take several minutes. +Until this update is completed, the password file is unavailable for other +updates and the new information is not available to programs. .Pp The .Nm @@ -230,5 +232,4 @@ utility first appeared in The .Nm utility was written by -.An Alistair G. Crooks -.Aq agc@NetBSD.org . +.An Alistair G. Crooks Aq agc@NetBSD.org . |