winsup/doc: Some preparatory XML fixes

Remove the inconsistent .exe suffix in strace and umount usage lines.

Tidy up some trailing whitespace.

Tabs inside <screen> are not consistently formatted by all formatters, replace
with spaces.

Remove pointlesss and incorrect date

2015-06-12  Jon Turney  <jon.turney@dronecode.org.uk>

	* cygwin-ug-net.xml: Remove incorrect unused date.
	* utils.xml : Remove .exe suffix inconsistently added in a few
	places.  Tidy up some trailing whitespace.

Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
This commit is contained in:
Jon TURNEY 2015-06-16 10:17:19 +01:00
parent 2ef3009068
commit 7177456cf0
3 changed files with 34 additions and 29 deletions

View File

@ -1,3 +1,9 @@
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* cygwin-ug-net.xml: Remove incorrect unused date.
* utils.xml : Remove .exe suffix inconsistently added in a few
places. Tidy up some trailing whitespace.
2015-06-12 Jon Turney <jon.turney@dronecode.org.uk> 2015-06-12 Jon Turney <jon.turney@dronecode.org.uk>
* xidepend: Fix to handle relative pathnames. * xidepend: Fix to handle relative pathnames.

View File

@ -4,7 +4,6 @@
<book id="cygwin-ug-net" xmlns:xi="http://www.w3.org/2001/XInclude"> <book id="cygwin-ug-net" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo> <bookinfo>
<date>2009-03-18</date>
<title>Cygwin User's Guide</title> <title>Cygwin User's Guide</title>
<xi:include href="legal.xml"/> <xi:include href="legal.xml"/>
</bookinfo> </bookinfo>

View File

@ -265,9 +265,9 @@ are unable to find another Cygwin DLL.
<screen> <screen>
Usage: cygpath (-d|-m|-u|-w|-t TYPE) [-f FILE] [OPTION]... NAME... Usage: cygpath (-d|-m|-u|-w|-t TYPE) [-f FILE] [OPTION]... NAME...
cygpath [-c HANDLE] cygpath [-c HANDLE]
cygpath [-ADHOPSW] cygpath [-ADHOPSW]
cygpath [-F ID] cygpath [-F ID]
Convert Unix and Windows format paths, or output system path information Convert Unix and Windows format paths, or output system path information
@ -518,7 +518,7 @@ Other options:
Usage: getfacl [-adn] FILE [FILE2...] Usage: getfacl [-adn] FILE [FILE2...]
Display file and directory access control lists (ACLs). Display file and directory access control lists (ACLs).
-a, --access display the file access control list -a, --access display the file access control list
-d, --default display the default access control list -d, --default display the default access control list
-h, --help print help explaining the command line options -h, --help print help explaining the command line options
@ -928,7 +928,7 @@ groups on domain controllers and domain member machines.
of your current account apply. The <literal>-l/-L</literal> when used of your current account apply. The <literal>-l/-L</literal> when used
with a machine name, tries to contact that machine to enumerate local with a machine name, tries to contact that machine to enumerate local
groups of other machines, typically outside of domains. This scenario groups of other machines, typically outside of domains. This scenario
cannot be covered by Cygwin's account automatism. If you want to use cannot be covered by Cygwin's account automatism. If you want to use
the <literal>-L</literal> option, but you don't like the default the <literal>-L</literal> option, but you don't like the default
domain/group separator from <filename>/etc/nsswitch.conf</filename>, domain/group separator from <filename>/etc/nsswitch.conf</filename>,
you can specify another separator using the <literal>-S</literal> option, you can specify another separator using the <literal>-S</literal> option,
@ -1025,7 +1025,7 @@ on domain controllers and domain member machines.
<para>For very simple needs, an entry for the current user can be created <para>For very simple needs, an entry for the current user can be created
by using the option <literal>-c</literal>.</para> by using the option <literal>-c</literal>.</para>
<para>The <literal>-o</literal> option allows for special cases (such as <para>The <literal>-o</literal> option allows for special cases (such as
multiple domains) where the UIDs might match otherwise. The multiple domains) where the UIDs might match otherwise. The
<literal>-p</literal> option causes <command>mkpasswd</command> to use <literal>-p</literal> option causes <command>mkpasswd</command> to use
@ -1144,22 +1144,22 @@ D: on /d type fat (binary,user,noumount)
implement real POSIX permissions (default). implement real POSIX permissions (default).
binary - Files default to binary mode (default). binary - Files default to binary mode (default).
bind - Allows to remount part of the file hierarchy somewhere else. bind - Allows to remount part of the file hierarchy somewhere else.
Different from other mount calls, the first argument Different from other mount calls, the first argument
specifies an absolute POSIX path, rather than a Win32 path. specifies an absolute POSIX path, rather than a Win32 path.
This POSIX path is remounted to the POSIX path specified as This POSIX path is remounted to the POSIX path specified as
the second parameter. The conversion to a Win32 path is done the second parameter. The conversion to a Win32 path is done
within Cygwin immediately at the time of the call. Note that within Cygwin immediately at the time of the call. Note that
symlinks are ignored while performing this path conversion. symlinks are ignored while performing this path conversion.
cygexec - Treat all files below mount point as cygwin executables. cygexec - Treat all files below mount point as cygwin executables.
dos - Always convert leading spaces and trailing dots and spaces to dos - Always convert leading spaces and trailing dots and spaces to
characters in the UNICODE private use area. This allows to use characters in the UNICODE private use area. This allows to use
broken filesystems which only allow DOS filenames, even if they broken filesystems which only allow DOS filenames, even if they
are not recognized as such by Cygwin. are not recognized as such by Cygwin.
exec - Treat all files below mount point as executable. exec - Treat all files below mount point as executable.
ihash - Always fake inode numbers rather than using the ones returned ihash - Always fake inode numbers rather than using the ones returned
by the filesystem. This allows to use broken filesystems which by the filesystem. This allows to use broken filesystems which
don't return unambiguous inode numbers, even if they are not don't return unambiguous inode numbers, even if they are not
recognized as such by Cygwin. recognized as such by Cygwin.
noacl - Ignore ACLs and fake POSIX permissions. noacl - Ignore ACLs and fake POSIX permissions.
nosuid - No suid files are allowed (currently unimplemented) nosuid - No suid files are allowed (currently unimplemented)
notexec - Treat all files below mount point as not executable. notexec - Treat all files below mount point as not executable.
@ -1168,7 +1168,7 @@ D: on /d type fat (binary,user,noumount)
posix=1 - Switch on case sensitivity for paths under this mount point posix=1 - Switch on case sensitivity for paths under this mount point
(default). (default).
sparse - Switch on support for sparse files. This option only makes sparse - Switch on support for sparse files. This option only makes
sense on NTFS and then only if you really need sparse files. sense on NTFS and then only if you really need sparse files.
text - Files default to CRLF text mode line endings. text - Files default to CRLF text mode line endings.
</screen> </screen>
@ -1336,7 +1336,7 @@ Other options:
If no option is given, change USER's password. If no user name is given, If no option is given, change USER's password. If no user name is given,
operate on current user. System operations must not be mixed with user operate on current user. System operations must not be mixed with user
operations. Don't specify a USER when triggering a system operation. operations. Don't specify a USER when triggering a system operation.
Don't specify a user or any other option together with the -R option. Don't specify a user or any other option together with the -R option.
Non-Admin users can only store their password if cygserver is running. Non-Admin users can only store their password if cygserver is running.
@ -1590,7 +1590,7 @@ remote host in either \\hostname or hostname: format and prefix is any of:
You can use forward slash ('/') as a separator instead of backslash, in You can use forward slash ('/') as a separator instead of backslash, in
that case backslash is treated as escape character that case backslash is treated as escape character
Example: regtool.exe get '\user\software\Microsoft\Clock\iFormat' Example: regtool get '\user\software\Microsoft\Clock\iFormat'
</screen> </screen>
<para>The <command>regtool</command> program allows shell scripts to access <para>The <command>regtool</command> program allows shell scripts to access
@ -1706,7 +1706,7 @@ Modify file and directory access control lists (ACLs)
-f, --file set ACL entries for FILE to ACL entries read -f, --file set ACL entries for FILE to ACL entries read
from a ACL_FILE from a ACL_FILE
-k, --remove-default -k, --remove-default
remove all default ACL entries remove all default ACL entries
-m, --modify modify one or more specified ACL entries -m, --modify modify one or more specified ACL entries
-r, --replace replace mask entry with maximum permissions -r, --replace replace mask entry with maximum permissions
needed for the file group class needed for the file group class
@ -1759,7 +1759,7 @@ At least one of (-b, -d, -f, -k, -m, -s) must be specified
<screen> <screen>
u[ser]:uid[:] u[ser]:uid[:]
g[roup]:gid[:] g[roup]:gid[:]
m[ask][:] m[ask][:]
d[efault]:u[ser][:uid] d[efault]:u[ser][:uid]
d[efault]:g[roup][:gid] d[efault]:g[roup][:gid]
d[efault]:m[ask][:] d[efault]:m[ask][:]
@ -1995,8 +1995,8 @@ $ ssp <literal>-v</literal> <literal>-s</literal> <literal>-l</literal> <literal
<title>strace</title> <title>strace</title>
<screen> <screen>
Usage: strace.exe [OPTIONS] &lt;command-line&gt; Usage: strace [OPTIONS] &lt;command-line&gt;
Usage: strace.exe [OPTIONS] -p &lt;pid&gt; Usage: strace [OPTIONS] -p &lt;pid&gt;
Trace system calls and signals Trace system calls and signals
@ -2013,7 +2013,7 @@ Trace system calls and signals
-q, --quiet toggle "quiet" flag. Defaults to on if "-p", -q, --quiet toggle "quiet" flag. Defaults to on if "-p",
off otherwise. off otherwise.
-S, --flush-period=PERIOD flush buffered strace output every PERIOD secs -S, --flush-period=PERIOD flush buffered strace output every PERIOD secs
-t, --timestamp use an absolute hh:mm:ss timestamp insted of -t, --timestamp use an absolute hh:mm:ss timestamp insted of
the default microsecond timestamp. Implies -d the default microsecond timestamp. Implies -d
-T, --toggle toggle tracing in a process already being -T, --toggle toggle tracing in a process already being
traced. Requires -p &lt;pid&gt; traced. Requires -p &lt;pid&gt;
@ -2034,7 +2034,7 @@ Trace system calls and signals
uhoh 0x000008 (_STRACE_UHOH) Unusual or weird phenomenon. uhoh 0x000008 (_STRACE_UHOH) Unusual or weird phenomenon.
syscall 0x000010 (_STRACE_SYSCALL) System calls. syscall 0x000010 (_STRACE_SYSCALL) System calls.
startup 0x000020 (_STRACE_STARTUP) argc/envp printout at startup. startup 0x000020 (_STRACE_STARTUP) argc/envp printout at startup.
debug 0x000040 (_STRACE_DEBUG) Info to help debugging. debug 0x000040 (_STRACE_DEBUG) Info to help debugging.
paranoid 0x000080 (_STRACE_PARANOID) Paranoid info. paranoid 0x000080 (_STRACE_PARANOID) Paranoid info.
termios 0x000100 (_STRACE_TERMIOS) Info for debugging termios stuff. termios 0x000100 (_STRACE_TERMIOS) Info for debugging termios stuff.
select 0x000200 (_STRACE_SELECT) Info on ugly select internals. select 0x000200 (_STRACE_SELECT) Info on ugly select internals.
@ -2103,7 +2103,7 @@ In csh-compatible shells like tcsh:
<title>umount</title> <title>umount</title>
<screen> <screen>
Usage: umount.exe [OPTION] [&lt;posixpath&gt;] Usage: umount [OPTION] [&lt;posixpath&gt;]
Unmount filesystems Unmount filesystems