Cygwin: Various minor fixes to utils documentation

* Drop duplicate 'Options:' headers (mkgroup, mkpassword)
* Add missing indication that MACHINE is optional with -L (mkgroup, mkpassword)
* Tweak some <refpurpose> which try to be a synopsis, rather than a decription (passwd, ssp)
* Drop some stray '\n' in setfacl options
* Move 'Original Author' note in ssp to an AUTHORS section
* Use <para> to improve formatting of tzset manpage
This commit is contained in:
Jon Turney 2021-06-14 21:18:49 +01:00
parent fb01286fab
commit be4a8b91ff
No known key found for this signature in database
GPG Key ID: C7C86F0370285C81
1 changed files with 26 additions and 23 deletions

View File

@ -1167,13 +1167,11 @@ mkgroup [OPTION]...
<refsect1 id="mkgroup-options"> <refsect1 id="mkgroup-options">
<title>Options</title> <title>Options</title>
<screen> <screen>
Options:
-l,--local [machine] Print local group accounts of \"machine\", -l,--local [machine] Print local group accounts of \"machine\",
from local machine if no machine specified. from local machine if no machine specified.
Automatically adding machine prefix for local Automatically adding machine prefix for local
machine depends on settings in /etc/nsswitch.conf. machine depends on settings in /etc/nsswitch.conf.
-L,--Local machine Ditto, but generate groupname with machine prefix. -L,--Local [machine] Ditto, but generate groupname with machine prefix.
-d,--domain [domain] Print domain groups, -d,--domain [domain] Print domain groups,
from current domain if no domain specified. from current domain if no domain specified.
-c,--current Print current group. -c,--current Print current group.
@ -1271,13 +1269,11 @@ mkpasswd [OPTIONS]...
<refsect1 id="mkpasswd-options"> <refsect1 id="mkpasswd-options">
<title>Options</title> <title>Options</title>
<screen> <screen>
Options:
-l,--local [machine] Print local user accounts of \"machine\", -l,--local [machine] Print local user accounts of \"machine\",
from local machine if no machine specified. from local machine if no machine specified.
Automatically adding machine prefix for local Automatically adding machine prefix for local
machine depends on settings in /etc/nsswitch.conf. machine depends on settings in /etc/nsswitch.conf.
-L,--Local machine Ditto, but generate username with machine prefix. -L,--Local [machine] Ditto, but generate username with machine prefix.
-d,--domain [domain] Print domain accounts, -d,--domain [domain] Print domain accounts,
from current domain if no domain specified. from current domain if no domain specified.
-c,--current Print current user. -c,--current Print current user.
@ -1637,7 +1633,7 @@ D: on /d type fat (binary,user,noumount)
<refnamediv> <refnamediv>
<refname>passwd</refname> <refname>passwd</refname>
<refpurpose>Change USER's password or password attributes.</refpurpose> <refpurpose>Change password or password attributes</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
@ -2111,19 +2107,19 @@ setfacl [-n] {[-bk]|[-x acl_entries] [-m acl_entries]} FILE...
<refsect1 id="setfacl-options"> <refsect1 id="setfacl-options">
<title>Options</title> <title>Options</title>
<screen> <screen>
-b, --remove-all remove all extended ACL entries\n" -b, --remove-all remove all extended ACL entries
-x, --delete delete one or more specified ACL entries\n" -x, --delete delete one or more specified ACL entries
-f, --set-file set ACL entries for FILE to ACL entries read\n" -f, --set-file set ACL entries for FILE to ACL entries read
from ACL_FILE\n" from ACL_FILE
-k, --remove-default remove all default ACL entries\n" -k, --remove-default remove all default ACL entries
-m, --modify modify one or more specified ACL entries\n" -m, --modify modify one or more specified ACL entries
-n, --no-mask don't recalculate the effective rights mask\n" -n, --no-mask don't recalculate the effective rights mask
--mask do recalculate the effective rights mask\n" --mask do recalculate the effective rights mask
-s, --set set specified ACL entries on FILE\n" -s, --set set specified ACL entries on FILE
-V, --version print version and exit\n" -V, --version print version and exit
-h, --help this help text\n" -h, --help this help text
At least one of (-b, -x, -f, -k, -m, -s) must be specified\n" At least one of (-b, -x, -f, -k, -m, -s) must be specified
</screen> </screen>
</refsect1> </refsect1>
@ -2285,9 +2281,17 @@ Other options:
<refmiscinfo class="manual">Cygwin Utilities</refmiscinfo> <refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
</refmeta> </refmeta>
<refentryinfo>
<author>
<firstname>DJ</firstname>
<surname>Delorie</surname>
<contrib>Original Author</contrib>
</author>
</refentryinfo>
<refnamediv> <refnamediv>
<refname>ssp</refname> <refname>ssp</refname>
<refpurpose>Single-step profile COMMAND</refpurpose> <refpurpose>The Single Step Profiler</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
@ -2320,9 +2324,6 @@ Example: ssp 0x401000 0x403000 hello.exe
<refsect1 id="ssp-desc"> <refsect1 id="ssp-desc">
<title>Description</title> <title>Description</title>
<para> SSP - The Single Step Profiler </para>
<para> Original Author: DJ Delorie </para>
<para> The SSP is a program that uses the Win32 debug API to run a program <para> The SSP is a program that uses the Win32 debug API to run a program
one ASM instruction at a time. It records the location of each one ASM instruction at a time. It records the location of each
@ -2576,6 +2577,7 @@ Options:
<refsect1 id="tzset-desc"> <refsect1 id="tzset-desc">
<title>Description</title> <title>Description</title>
<para>
Use tzset to set your TZ variable. In POSIX-compatible shells like bash, Use tzset to set your TZ variable. In POSIX-compatible shells like bash,
dash, mksh, or zsh: dash, mksh, or zsh:
<screen> <screen>
@ -2585,6 +2587,7 @@ export TZ=$(tzset)
<screen> <screen>
setenv TZ `tzset` setenv TZ `tzset`
</screen> </screen>
</para>
<para>The <command>tzset</command> tool reads the current timezone from <para>The <command>tzset</command> tool reads the current timezone from
Windows and generates a POSIX-compatible timezone information for the TZ Windows and generates a POSIX-compatible timezone information for the TZ