d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pw.8: Improve argument names

Browse Source 
Arguments passed to flags like -d and -k had ambiguous names like "dir".
Change that to more descriptive names like "homedir".

Also, clarify that -u min,max is for UIDs and -i min,max for GIDs.

MFC after:	1 week
This commit is contained in:
Mateusz Piotrowski 2022-04-03 13:08:58 +02:00
parent fa556e83be
commit feb04c7b7c
1 changed files with 42 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
usr.sbin/pw/pw.8
View File

@ -24,7 +24,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd April 1, 2022 .Dd April 3, 2022
.Dt PW 8 .Dt PW 8
.Os .Os
.Sh NAME .Sh NAME
@ -39,38 +39,38 @@
.Op Fl mNoPqY .Op Fl mNoPqY
.Op Fl C Ar config .Op Fl C Ar config
.Op Fl c Ar comment .Op Fl c Ar comment
.Op Fl d Ar dir .Op Fl d Ar homedir
.Op Fl e Ar date .Op Fl e Ar accexpdate
.Op Fl G Ar grouplist .Op Fl G Ar grouplist
.Op Fl g Ar group .Op Fl g Ar group
.Op Fl H Ar fd .Op Fl H Ar fd
.Op Fl h Ar fd .Op Fl h Ar fd
.Op Fl k Ar dir .Op Fl k Ar skeldir
.Op Fl L Ar class .Op Fl L Ar class
.Op Fl M Ar mode .Op Fl M Ar mode
.Op Fl p Ar date .Op Fl p Ar passexpdate
.Op Fl s Ar shell .Op Fl s Ar shell
.Op Fl u Ar uid .Op Fl u Ar uid
.Op Fl w Ar method .Op Fl w Ar passmethod
.Nm .Nm
.Op Fl R Ar rootdir .Op Fl R Ar rootdir
.Op Fl V Ar etcdir .Op Fl V Ar etcdir
.Cm useradd .Cm useradd
.Fl D .Fl D
.Op Fl q .Op Fl q
.Op Fl b Ar dir .Op Fl b Ar basehome
.Op Fl C Ar config .Op Fl C Ar config
.Op Fl e Ar days .Op Fl e Ar accexpdays
.Op Fl G Ar grouplist .Op Fl G Ar grouplist
.Op Fl g Ar group .Op Fl g Ar group
.Op Fl i Ar min , Ns Ar max .Op Fl i Ar mingid , Ns Ar maxgid
.Op Fl k Ar dir .Op Fl k Ar skeldir
.Op Fl p Ar days .Op Fl p Ar passexpdays
.Op Fl s Ar shell .Op Fl s Ar shell
.Op Fl M Ar mode .Op Fl M Ar mode
.Op Fl u Ar min , Ns Ar max .Op Fl u Ar minuid , Ns Ar maxuid
.Op Fl w Ar method .Op Fl w Ar passmethod
.Op Fl y Ar path .Op Fl y Ar nispasswd
.Nm .Nm
.Op Fl R Ar rootdir .Op Fl R Ar rootdir
.Op Fl V Ar etcdir .Op Fl V Ar etcdir
@ -85,9 +85,9 @@
.Op Fl mNPqY .Op Fl mNPqY
.Op Fl C Ar config .Op Fl C Ar config
.Op Fl c Ar comment .Op Fl c Ar comment
.Op Fl d Ar dir .Op Fl d Ar homedir
.Op Fl e Ar date .Op Fl e Ar accexpdate
.Op Fl k Ar dir .Op Fl k Ar skeldir
.Op Fl G Ar grouplist .Op Fl G Ar grouplist
.Op Fl g Ar group .Op Fl g Ar group
.Op Fl H Ar fd .Op Fl H Ar fd
@ -95,9 +95,9 @@
.Op Fl L Ar class .Op Fl L Ar class
.Op Fl l Ar newname .Op Fl l Ar newname
.Op Fl M Ar mode .Op Fl M Ar mode
.Op Fl p Ar date .Op Fl p Ar passexpdate
.Op Fl s Ar shell .Op Fl s Ar shell
.Op Fl w Ar method .Op Fl w Ar passmethod
.Nm .Nm
.Op Fl R Ar rootdir .Op Fl R Ar rootdir
.Op Fl V Ar etcdir .Op Fl V Ar etcdir
@ -295,7 +295,7 @@ database files.
If separate passwd and group files are being used by If separate passwd and group files are being used by
.Tn NIS , .Tn NIS ,
then use the then use the
.Fl y Ar path .Fl y Ar nispasswd
option to specify the location of the option to specify the location of the
.Tn NIS .Tn NIS
passwd database so that passwd database so that
@ -371,7 +371,7 @@ and the colon
.Ql \&: .Ql \&:
character also cannot be used as this is the field separator for the passwd character also cannot be used as this is the field separator for the passwd
file itself. file itself.
.It Fl d Ar dir .It Fl d Ar homedir
This option sets the account's home directory. This option sets the account's home directory.
Normally, Normally,
this is only used if the home directory is to be different from the this is only used if the home directory is to be different from the
@ -380,7 +380,7 @@ default determined from
- normally - normally
.Pa /home .Pa /home
with the account name as a subdirectory. with the account name as a subdirectory.
.It Fl e Ar date .It Fl e Ar accexpdate
Set the account's expiration date. Set the account's expiration date.
Format of the date is either a UNIX time in decimal, or a date in Format of the date is either a UNIX time in decimal, or a date in
.Ql dd-mmm-yy[yy] .Ql dd-mmm-yy[yy]
@ -395,7 +395,7 @@ is a decimal,
octal (leading 0) or hexadecimal (leading 0x) digit followed by the octal (leading 0) or hexadecimal (leading 0x) digit followed by the
number of Minutes, Hours, Days, Weeks, Months or Years from the current date at number of Minutes, Hours, Days, Weeks, Months or Years from the current date at
which the expiration date is to be set. which the expiration date is to be set.
.It Fl p Ar date .It Fl p Ar passexpdate
Set the account's password expiration date. Set the account's password expiration date.
This field is similar to the account expiration date option, except that it This field is similar to the account expiration date option, except that it
applies to forced password changes. applies to forced password changes.
@ -468,7 +468,7 @@ If omitted, it is derived from the parent process'
This option is only useful in combination with the This option is only useful in combination with the
.Fl m .Fl m
flag. flag.
.It Fl k Ar dir .It Fl k Ar skeldir
Set the Set the
.Ar skeleton .Ar skeleton
directory, from which basic startup and configuration files are copied when directory, from which basic startup and configuration files are copied when
@ -581,27 +581,27 @@ Set default values in
configuration file, or a different named configuration file if the configuration file, or a different named configuration file if the
.Fl C Ar config .Fl C Ar config
option is used. option is used.
.It Fl b Ar dir .It Fl b Ar basehome
Set the root directory in which user home directories are created. Set the root directory in which user home directories are created.
The default value for this is The default value for this is
.Pa /home , .Pa /home ,
but it may be set elsewhere as desired. but it may be set elsewhere as desired.
.It Fl e Ar days .It Fl e Ar accexpdays
Set the default account expiration period in days. Set the default account expiration period in days.
When When
.Fl D .Fl D
is used, the is used, the
.Ar days .Ar accexpdays
argument is interpreted differently. argument is interpreted differently.
It must be numeric and represents the number of days after creation It must be numeric and represents the number of days after creation
that the account expires. that the account expires.
A value of 0 suppresses automatic calculation of the expiry date. A value of 0 suppresses automatic calculation of the expiry date.
.It Fl p Ar days .It Fl p Ar passexpdays
Set the default password expiration period in days. Set the default password expiration period in days.
When When
.Fl D .Fl D
is used, the is used, the
.Ar days .Ar passexpdays
argument is interpreted differently. argument is interpreted differently.
It must be numeric and represents the number of days after creation It must be numeric and represents the number of days after creation
that the account expires. that the account expires.
@ -627,7 +627,7 @@ stored in
by their symbolic names. by their symbolic names.
.It Fl L Ar class .It Fl L Ar class
This option sets the default login class for new users. This option sets the default login class for new users.
.It Fl k Ar dir .It Fl k Ar skeldir
Set the default Set the default
.Em skeleton .Em skeleton
directory, directory,
@ -638,28 +638,33 @@ See description of
.Fl k .Fl k
for naming conventions of these files. for naming conventions of these files.
.It Xo .It Xo
.Fl u Ar min Ns Cm \&, Ns Ar max , .Fl u Ar minuid Ns Cm \&, Ns Ar maxuid ,
.Fl i Ar min Ns Cm \&, Ns Ar max .Fl i Ar mingid Ns Cm \&, Ns Ar maxgid
.Xc .Xc
Set the minimum and maximum user and group ids allocated for new Set the minimum and maximum user and group ids allocated for new
accounts and groups created by accounts and groups created by
.Nm . .Nm .
The default values for each is 1000 minimum and 32000 maximum. The default values for each is 1000 minimum and 32000 maximum.
.Ar min .Ar minuid
and and
.Ar max .Ar maxuid
are both numbers, where max must be greater than min, are both numbers, where max must be greater than min,
and both must be between 0 and 32767. and both must be between 0 and 32767
.Po the same applies to
.Ar mingid
and
.Ar maxgid
.Pc .
In general, In general,
user and group ids less than 100 are reserved for use by the system, user and group ids less than 100 are reserved for use by the system,
and numbers greater than 32000 may also be reserved for special purposes and numbers greater than 32000 may also be reserved for special purposes
.Pq used by some system daemons . .Pq used by some system daemons .
.It Fl w Ar method .It Fl w Ar passmethod
The The
.Fl w .Fl w
option selects the default method used to set passwords for newly created user option selects the default method used to set passwords for newly created user
accounts. accounts.
.Ar method .Ar passmethod
is one of: is one of:
.Pp .Pp
.Bl -tag -width random -offset indent -compact .Bl -tag -width random -offset indent -compact