4
0
mirror of git://sourceware.org/git/newlib-cygwin.git synced 2025-01-19 04:49:25 +08:00

Cygwin: Add documentation for chattr and lsattr

Signed-off-by: Corinna Vinschen <corinna@vinschen.de>
This commit is contained in:
Corinna Vinschen 2018-12-26 11:22:06 +01:00
parent 0d4b39d37b
commit 66cd1cbaf8

View File

@ -13,6 +13,70 @@
identically. All of the Cygwin command-line utilities support the
<literal>--help</literal> and <literal>--version</literal> options. </para>
<refentry id="chattr">
<refmeta>
<refentrytitle>chattr</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
</refmeta>
<refnamediv>
<refname>chattr</refname>
<refpurpose>Change file attributes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<screen>
chattr [-RVfhv] [+-=mode]... [file]...
</screen>
</refsynopsisdiv>
<refsect1 id="chattr-options">
<title>Options</title>
<screen>
-R, --recursive recursively list attributes of directories and their
contents
-V, --verbose Be verbose during operation
-f, --force suppress error messages
-h, --help this help text
-v, --version display the program version
</screen>
</refsect1>
<refsect1 id="chattr-desc">
<title>Description</title>
<para>The <command>chattr</command> program allows to change file
attributes, namely DOS attributes, as well as making files sparse,
encrypt or compress them on FS level, or setting directories'
case sensitivity.
</para>
<para>The format of 'mode' is {+-=}[acCehnrsSt]</para>
<para>The operator '+' causes the selected attributes to be added to the
existing attributes of the files; '-' causes them to be removed; and
'=' causes them to be the only attributes that the files have.</para>
<para>Supported attributes:</para>
<screen>
'r', 'Readonly': file is read-only
'h', 'Hidden': file or directory is hidden
's', 'System': file or directory that the operating system uses
'a', 'Archive': file or directory has the archive marker set
't', 'Temporary': file is being used for temporary storage
'S', 'Sparse': file is sparse
'c', 'Compressed': file or directory is compressed
'n', 'Notindexed': file or directory is not to be indexed by the
content indexing service
'e', 'Encrypted': file is encrypted
'C', 'Casesensitive': directory is handled case sensitive
(Windows 10 1803 or later, local NTFS only,
WSL must be installed)
</screen>
</refsect1>
</refentry>
<refentry id="cygcheck">
<refmeta>
<refentrytitle>cygcheck</refentrytitle>
@ -951,6 +1015,71 @@ bash$ locale noexpr
</refsect1>
</refentry>
<refentry id="lsattr">
<refmeta>
<refentrytitle>lsattr</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">Cygwin Utilities</refmiscinfo>
</refmeta>
<refnamediv>
<refname>lsattr</refname>
<refpurpose>List file attributes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<screen>
lsattr [-RVadhln] [file]...
</screen>
</refsynopsisdiv>
<refsect1 id="lsattr-options">
<title>Options</title>
<screen>
-R, --recursive recursively list attributes of directories and their
contents
-V, --version display the program version
-a, --all list all files in directories, including files that
start with '.'
-d, --directory list directories like other files, rather than listing
their contents.
-l, --long print options using long names instead of single
character abbreviations
-n, --no-headers don't print directory headers when recursing
-h, --help this help text
</screen>
</refsect1>
<refsect1 id="lsattr-desc">
<title>Description</title>
<para>The <command>lsattr</command> program allows to list file
attributes, namely DOS attributes, file sparseness, FS level
encryption and compression state, as well as directories'
case sensitivity setting.
</para>
<para>Supported attributes:</para>
<screen>
'r', 'Readonly': file is read-only, directory is system-marked
'h', 'Hidden': file or directory is hidden
's', 'System': file or directory that the operating system uses
'a', 'Archive': file or directory has the archive marker set
't', 'Temporary': file is being used for temporary storage
'S', 'Sparse': file is sparse
'r', 'Reparse': file or directory that has a reparse point
'c', 'Compressed': file or directory is compressed
'o', 'Offline': the data of a file is moved to offline storage
'n', 'Notindexed': file or directory is not to be indexed by the
content indexing service
'e', 'Encrypted': file is encrypted
'C', 'Casesensitive': directory is handled case sensitive
(Windows 10 1803 or later, local NTFS only,
WSL must be installed)
</screen>
</refsect1>
</refentry>
<refentry id="minidumper">
<refmeta>
<refentrytitle>minidumper</refentrytitle>