Imported Upstream version 4.0.18
[platform/upstream/mtools.git] / mlabel.1
1 '\" t
2 .TH mlabel 1 "09Jan13" mtools-4.0.18
3 .SH Name
4 mlabel - make an MSDOS volume label
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 The \fR\&\f(CWmlabel\fR command adds a volume label to a disk. Its syntax is:
24 .ft I
25 .nf
26 \&\fR\&\f(CWmlabel\fR [\fR\&\f(CW-vcsn\fR] [\fR\&\f(CW-N\fR \fIserial\fR] \fIdrive\fR:[\fInew_label\fR]
27 .fi
28 .ft R
29  
30 .PP
31 \&\fR\&\f(CWMlabel\fR displays the current volume label, if present. If
32 \&\fInew_label\fR is not given, and if neither the \fR\&\f(CWc\fR nor the
33 \&\fR\&\f(CWs\fR options are set, it prompts the user for a new volume label.
34 To delete an existing volume label, press return at the prompt.
35 .PP
36 The label is limited to 11 single-byte characters,
37 e.g. \fR\&\f(CWName1234567\fR.
38 .PP
39 Reasonable care is taken to create a valid MS-DOS volume label.  If an
40 invalid label is specified, \fR\&\f(CWmlabel\fR changes the label (and
41 displays the new label if the verbose mode is set). \fR\&\f(CWMlabel\fR
42 returns 0 on success or 1 on failure.
43 .PP
44 Mlabel supports the following options:
45 .TP
46 \&\fR\&\f(CWc\fR\ 
47 Clears an existing label, without prompting the user
48 .TP
49 \&\fR\&\f(CWs\fR\ 
50 Shows the existing label, without prompting the user.
51 .TP
52 \&\fR\&\f(CWn\ \fR\ 
53 Assigns a new (random) serial number to the disk
54 .TP
55 \&\fR\&\f(CWN\ \fIserial\fR\&\f(CW\fR\ 
56 Sets the supplied serial number. The serial number should be supplied as
57 an 8 digit hexadecimal number, without spaces
58 .PP
59 .SH See\ Also
60 Mtools' texinfo doc
61 .SH Viewing\ the\ texi\ doc
62 This manpage has been automatically generated from mtools's texinfo
63 documentation. However, this process is only approximative, and some
64 items, such as crossreferences, footnotes and indices are lost in this
65 translation process.  Indeed, these items have no appropriate
66 representation in the manpage format.  Moreover, not all information has
67 been translated into the manpage version.  Thus I strongly advise you to
68 use the original texinfo doc.  See the end of this manpage for
69 instructions how to view the texinfo doc.
70 .TP
71 * \ \ 
72 To generate a printable copy from the texinfo doc, run the following
73 commands:
74  
75 .nf
76 .ft 3
77 .in +0.3i
78     ./configure; make dvi; dvips mtools.dvi
79 .fi
80 .in -0.3i
81 .ft R
82 .PP
83  
84 \&\fR
85 .TP
86 * \ \ 
87 To generate a html copy,  run:
88  
89 .nf
90 .ft 3
91 .in +0.3i
92     ./configure; make html
93 .fi
94 .in -0.3i
95 .ft R
96 .PP
97  
98 \&\fRA premade html can be found at
99 \&\fR\&\f(CW\(ifhttp://www.gnu.org/software/mtools/manual/mtools.html\(is\fR
100 .TP
101 * \ \ 
102 To generate an info copy (browsable using emacs' info mode), run:
103  
104 .nf
105 .ft 3
106 .in +0.3i
107     ./configure; make info
108 .fi
109 .in -0.3i
110 .ft R
111 .PP
112  
113 \&\fR
114 .PP
115 The texinfo doc looks most pretty when printed or as html.  Indeed, in
116 the info version certain examples are difficult to read due to the
117 quoting conventions used in info.
118 .PP