From nobody Mon Apr 11 10:16:10 2022 X-Original-To: dev-commits-src-branches@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 03AB91AA94AE; Mon, 11 Apr 2022 10:16:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KcPrq47DNz3s8b; Mon, 11 Apr 2022 10:16:11 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1649672171; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=lgI7s6HzAy+L8k37wj7jw1aJwRB941PAt7p3E34zCow=; b=D46bniWNkWNJ6Efd678DRt/DIxnxIiIgN2QV4QiitW8apj6UOlpbXl3FFObf4xuKXcBblR ezkBwWoo/5DFjNz0nYWzDxBHK+dT1+wJAGo7+FYQrSAKJ+mJkVvgUMcH3uyktsMN0xIG2/ q2T6c8veE1ke/ovX10NfEZ3i6rwqP90olgR9WRy0cLyIU7nsgYsz7v7E+Bu31a11RzPVf7 hWTRvyozGy+GcoVUw5cctQK/I5yL0AUErIY/PY+884LhNWuuJM5N9YKbAqgpVVsMhbOSZS IaQdqkc/OTmJkjc4YUZH6FA9iDmUqRuTzklPnZpOAol3a2kpbJ+J/KT0BcO5+A== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id DFA4920CCA; Mon, 11 Apr 2022 10:16:10 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 23BAGA0M046592; Mon, 11 Apr 2022 10:16:10 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 23BAGAAY046591; Mon, 11 Apr 2022 10:16:10 GMT (envelope-from git) Date: Mon, 11 Apr 2022 10:16:10 GMT Message-Id: <202204111016.23BAGAAY046591@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: e2f9c338d2ac - stable/12 - pw.8: Improve argument names List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-branches@freebsd.org X-BeenThere: dev-commits-src-branches@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/stable/12 X-Git-Reftype: branch X-Git-Commit: e2f9c338d2acc7b45797c6576e7a949cd51b7ef8 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1649672171; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=lgI7s6HzAy+L8k37wj7jw1aJwRB941PAt7p3E34zCow=; b=Fz6SpTNaQ1MrQF6Z4MgC/aIik8oQAQlc980CGNEGlAbBBBQOKKuNsjJOkQnXhqQsHyYF+b 00jbpPcun4IhCsEnwmwrHqCdWtu0JtWcz5EH6HhP5LpKVqonu/sJbDgRq3dqsHDfeFi6Bo B0wTv+3EX3iJtgOx6D/7pnXm9BmmLL5TLUNiWSgObgosf7yS+DXE0skddu9KcLFq+4/j+0 72BXv1e+SiN40LemRJ1efOhadNn0UXFLHoB/2v8SkEPCHff7xyqR5AS3iWPHzFe+sEawJi Lq/QX0JGWvRoq87IN8pFL+YdEQhxQKlguf1SzMz2nRihYvW5K58DJjSyvYIpCw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1649672171; a=rsa-sha256; cv=none; b=UPB5A5A6Hp8N5ZX7eSaem0oa9oORAX17t612LXR+IwI0AB1Wio8gt6k6plDOB7ICN4rOFG jwMB7RxtZZ0ke9cU82n2E+bXcFy1Aq5g5wFHuxGNbSJvwWUXqBpKd9jT0ZUxSbFhxar8ZS fQpTPSm2I0pqudV8EYyp17wllK/oOQOVyNewFRw33hTSa6SJlyGwDew+SfK6w2V9hnXcyU mw6bQ3SYY5z3R0zGPrH/p2Lr1RjvwEufACxae70qnEdX9JfRoKYgtl6cm449hE5u1+AUxl G9HGRM+rLT9ZjVg5JrFU7VYX30fEDAQlauCV/egGwqL0V60pD2AdFzQBTGVWIw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch stable/12 has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=e2f9c338d2acc7b45797c6576e7a949cd51b7ef8 commit e2f9c338d2acc7b45797c6576e7a949cd51b7ef8 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-04-03 11:08:58 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2022-04-11 10:16:05 +0000 pw.8: Improve argument names 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 (cherry picked from commit feb04c7b7c91a7042dd123773693e9f71114c3c8) --- usr.sbin/pw/pw.8 | 79 ++++++++++++++++++++++++++++++-------------------------- 1 file changed, 42 insertions(+), 37 deletions(-) diff --git a/usr.sbin/pw/pw.8 b/usr.sbin/pw/pw.8 index 5ca9b155da35..7fd15f9447e3 100644 --- a/usr.sbin/pw/pw.8 +++ b/usr.sbin/pw/pw.8 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 1, 2022 +.Dd April 3, 2022 .Dt PW 8 .Os .Sh NAME @@ -39,38 +39,38 @@ .Op Fl mNoPqY .Op Fl C Ar config .Op Fl c Ar comment -.Op Fl d Ar dir -.Op Fl e Ar date +.Op Fl d Ar homedir +.Op Fl e Ar accexpdate .Op Fl G Ar grouplist .Op Fl g Ar group .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 M Ar mode -.Op Fl p Ar date +.Op Fl p Ar passexpdate .Op Fl s Ar shell .Op Fl u Ar uid -.Op Fl w Ar method +.Op Fl w Ar passmethod .Nm .Op Fl R Ar rootdir .Op Fl V Ar etcdir .Cm useradd .Fl D .Op Fl q -.Op Fl b Ar dir +.Op Fl b Ar basehome .Op Fl C Ar config -.Op Fl e Ar days +.Op Fl e Ar accexpdays .Op Fl G Ar grouplist .Op Fl g Ar group -.Op Fl i Ar min , Ns Ar max -.Op Fl k Ar dir -.Op Fl p Ar days +.Op Fl i Ar mingid , Ns Ar maxgid +.Op Fl k Ar skeldir +.Op Fl p Ar passexpdays .Op Fl s Ar shell .Op Fl M Ar mode -.Op Fl u Ar min , Ns Ar max -.Op Fl w Ar method -.Op Fl y Ar path +.Op Fl u Ar minuid , Ns Ar maxuid +.Op Fl w Ar passmethod +.Op Fl y Ar nispasswd .Nm .Op Fl R Ar rootdir .Op Fl V Ar etcdir @@ -85,9 +85,9 @@ .Op Fl mNPqY .Op Fl C Ar config .Op Fl c Ar comment -.Op Fl d Ar dir -.Op Fl e Ar date -.Op Fl k Ar dir +.Op Fl d Ar homedir +.Op Fl e Ar accexpdate +.Op Fl k Ar skeldir .Op Fl G Ar grouplist .Op Fl g Ar group .Op Fl H Ar fd @@ -95,9 +95,9 @@ .Op Fl L Ar class .Op Fl l Ar newname .Op Fl M Ar mode -.Op Fl p Ar date +.Op Fl p Ar passexpdate .Op Fl s Ar shell -.Op Fl w Ar method +.Op Fl w Ar passmethod .Nm .Op Fl R Ar rootdir .Op Fl V Ar etcdir @@ -295,7 +295,7 @@ database files. If separate passwd and group files are being used by .Tn NIS , then use the -.Fl y Ar path +.Fl y Ar nispasswd option to specify the location of the .Tn NIS passwd database so that @@ -371,7 +371,7 @@ and the colon .Ql \&: character also cannot be used as this is the field separator for the passwd file itself. -.It Fl d Ar dir +.It Fl d Ar homedir This option sets the account's home directory. Normally, this is only used if the home directory is to be different from the @@ -380,7 +380,7 @@ default determined from - normally .Pa /home with the account name as a subdirectory. -.It Fl e Ar date +.It Fl e Ar accexpdate Set the account's expiration date. Format of the date is either a UNIX time in decimal, or a date in .Ql dd-mmm-yy[yy] @@ -395,7 +395,7 @@ is a decimal, 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 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. This field is similar to the account expiration date option, except that it 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 .Fl m flag. -.It Fl k Ar dir +.It Fl k Ar skeldir Set the .Ar skeleton 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 .Fl C Ar config option is used. -.It Fl b Ar dir +.It Fl b Ar basehome Set the root directory in which user home directories are created. The default value for this is .Pa /home , 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. When .Fl D is used, the -.Ar days +.Ar accexpdays argument is interpreted differently. It must be numeric and represents the number of days after creation that the account expires. 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. When .Fl D is used, the -.Ar days +.Ar passexpdays argument is interpreted differently. It must be numeric and represents the number of days after creation that the account expires. @@ -627,7 +627,7 @@ stored in by their symbolic names. .It Fl L Ar class This option sets the default login class for new users. -.It Fl k Ar dir +.It Fl k Ar skeldir Set the default .Em skeleton directory, @@ -638,28 +638,33 @@ See description of .Fl k for naming conventions of these files. .It Xo -.Fl u Ar min Ns Cm \&, Ns Ar max , -.Fl i Ar min Ns Cm \&, Ns Ar max +.Fl u Ar minuid Ns Cm \&, Ns Ar maxuid , +.Fl i Ar mingid Ns Cm \&, Ns Ar maxgid .Xc Set the minimum and maximum user and group ids allocated for new accounts and groups created by .Nm . The default values for each is 1000 minimum and 32000 maximum. -.Ar min +.Ar minuid and -.Ar max +.Ar maxuid 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, 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 .Pq used by some system daemons . -.It Fl w Ar method +.It Fl w Ar passmethod The .Fl w option selects the default method used to set passwords for newly created user accounts. -.Ar method +.Ar passmethod is one of: .Pp .Bl -tag -width random -offset indent -compact