Imported Upstream version 4.0.31
[platform/upstream/mtools.git] / mattrib.1
1 '\" t
2 .TH mattrib 1 "19Jun21" mtools-4.0.31
3 .SH Name
4 mattrib - change MSDOS file attribute flags
5 '\" t
6 .de TQ
7 .br
8 .ns
9 .TP \\$1
10 ..
11
12 .tr \(is'
13 .tr \(if`
14 .tr \(pd"
15
16 .SH Note\ of\ warning
17 This manpage has been automatically generated from mtools's texinfo
18 documentation, and may not be entirely accurate or complete.  See the
19 end of this man page for details.
20 .PP
21 .SH Description
22 .PP
23 \&\fR\&\f(CWMattrib\fR is used to change MS-DOS file attribute flags. It has the
24 following syntax:
25 .PP
26 \&\fR\&\f(CWmattrib\fR [\fR\&\f(CW-a|+a\fR] [\fR\&\f(CW-h|+h\fR] [\fR\&\f(CW-r|+r\fR]
27 [\fR\&\f(CW-s|+s\fR] [\fR\&\f(CW-/\fR]  [\fR\&\f(CW-p\fR] [\fR\&\f(CW-X\fR] \fImsdosfile\fR [ \fImsdosfiles\fR \&... ]
28 .PP
29 \&\fR\&\f(CWMattrib\fR adds attribute flags to an MS-DOS file (with the
30 `\fR\&\f(CW+\fR' operator) or remove attribute flags (with the `\fR\&\f(CW-\fR'
31 operator).
32 .PP
33 \&\fR\&\f(CWMattrib\fR supports the following attribute bits:
34 .TP
35 \&\fR\&\f(CWa\fR\ 
36 Archive bit.  Used by some backup programs to indicate a new file.
37 .TP
38 \&\fR\&\f(CWr\fR\ 
39 Read-only bit.  Used to indicate a read-only file.  Files with this bit
40 set cannot be erased by \fR\&\f(CWDEL\fR nor modified.
41 .TP
42 \&\fR\&\f(CWs\fR\ 
43 System bit.  Used by MS-DOS to indicate a operating system file.
44 .TP
45 \&\fR\&\f(CWh\fR\ 
46 Hidden bit.  Used to make files hidden from \fR\&\f(CWDIR\fR.
47 .PP
48 \&\fR\&\f(CWMattrib\fR supports the following command line flags:
49 .TP
50 \&\fR\&\f(CW/\fR\ 
51 Recursive.  Recursively list the attributes of the files in the subdirectories.
52 .TP
53 \&\fR\&\f(CWX\fR\ 
54 Concise. Prints the attributes without any whitespace padding.  If
55 neither the "/" option is given, nor the \fImsdosfile\fR contains a
56 wildcard, and there is only one MS-DOS file parameter on the command
57 line, only the attribute is printed, and not the filename.  This option
58 is convenient for scripts
59 .TP
60 \&\fR\&\f(CWp\fR\ 
61 Replay mode.  Outputs a series of \fR\&\f(CWmformat\fR commands that will
62 reproduce the current situation, starting from a situation as left by
63 untarring the MS-DOS file system.  Commands are only output for
64 attribute settings that differ from the default (archive bit set for
65 files, unset for directories).  This option is intended to be used in
66 addition to tar. The \fR\&\f(CWreadonly\fR attribute is not taken into
67 account, as tar can set that one itself.
68 .PP
69 .SH See\ Also
70 Mtools' texinfo doc
71 .SH Viewing\ the\ texi\ doc
72 This manpage has been automatically generated from mtools's texinfo
73 documentation. However, this process is only approximative, and some
74 items, such as crossreferences, footnotes and indices are lost in this
75 translation process.  Indeed, these items have no appropriate
76 representation in the manpage format.  Moreover, not all information has
77 been translated into the manpage version.  Thus I strongly advise you to
78 use the original texinfo doc.  See the end of this manpage for
79 instructions how to view the texinfo doc.
80 .TP
81 * \ \ 
82 To generate a printable copy from the texinfo doc, run the following
83 commands:
84  
85 .nf
86 .ft 3
87 .in +0.3i
88     ./configure; make dvi; dvips mtools.dvi
89 .fi
90 .in -0.3i
91 .ft R
92 .PP
93  
94 \&\fR
95 .TP
96 * \ \ 
97 To generate a html copy,  run:
98  
99 .nf
100 .ft 3
101 .in +0.3i
102     ./configure; make html
103 .fi
104 .in -0.3i
105 .ft R
106 .PP
107  
108 \&\fRA premade html can be found at
109 \&\fR\&\f(CW\(ifhttp://www.gnu.org/software/mtools/manual/mtools.html\(is\fR
110 .TP
111 * \ \ 
112 To generate an info copy (browsable using emacs' info mode), run:
113  
114 .nf
115 .ft 3
116 .in +0.3i
117     ./configure; make info
118 .fi
119 .in -0.3i
120 .ft R
121 .PP
122  
123 \&\fR
124 .PP
125 The texinfo doc looks most pretty when printed or as html.  Indeed, in
126 the info version certain examples are difficult to read due to the
127 quoting conventions used in info.
128 .PP