Debian Codegraph @

upstream/debian-unstable/man8/fatlabel.8

raw
1 .\" fatlabel.8 - manpage for fatlabel
2 .\"
3 .\" Copyright (C) 2006-2014 Daniel Baumann <[email protected]>
4 .\" Copyright (C) 2017 Andreas Bombe <[email protected]>
5 .\" Copyright (C) 2017-2021 Pali Rohár <[email protected]>
6 .\"
7 .\" This program is free software: you can redistribute it and/or modify
8 .\" it under the terms of the GNU General Public License as published by
9 .\" the Free Software Foundation, either version 3 of the License, or
10 .\" (at your option) any later version.
11 .\"
12 .\" This program is distributed in the hope that it will be useful,
13 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
14 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 .\" GNU General Public License for more details.
16 .\"
17 .\" You should have received a copy of the GNU General Public License
18 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
19 .\"
20 .\" The complete text of the GNU General Public License
21 .\" can be found in /usr/share/common-licenses/GPL-3 file.
22 .\"
23 .\"
24 .TH FATLABEL 8 2021-01-31 "dosfstools 4.2"
25 .SH NAME
26 fatlabel \- set or get MS-DOS filesystem label or volume ID
27 .\" ----------------------------------------------------------------------------
28 .SH SYNOPSIS
29 \fBfatlabel\fP [\fIOPTIONS\fP] \fIDEVICE\fP [\fINEW\fP]
30 .\" ----------------------------------------------------------------------------
31 .SH DESCRIPTION
32 \fBfatlabel\fP will display or change the volume label or volume ID on the
33 MS-DOS filesystem located on \fIDEVICE\fP.
34 By default it works in label mode.
35 It can be switched to volume ID mode with the option \fB\-i\fP or
36 \fB\-\-volume\-id\fP.
37 .PP
38 If \fINEW\fP is omitted, then the existing label or volume ID is written to the
39 standard output.
40 A label can't be longer than 11 bytes and should be in all upper case for best
41 compatibility.
42 An empty string or a label consisting only of white space is not allowed.
43 A volume ID must be given as a hexadecimal number (no leading "0x" or
44 similar) and must fit into 32 bits.
45 .\" ----------------------------------------------------------------------------
46 .SH OPTIONS
47 .IP "\fB\-i\fP, \fB\-\-volume\-id\fP" 4
48 Switch to volume ID mode.
49 .IP "\fB\-r\fP, \fB\-\-reset\fP" 4
50 Remove label in label mode or generate new ID in volume ID mode.
51 .IP "\fB-c\fP \fIPAGE\fP, \fB\-\-codepage\fP=\fIPAGE\fP" 4
52 Use DOS codepage \fIPAGE\fP to encode/decode label.
53 By default codepage 850 is used.
54 .IP "\fB\-h\fP, \fB\-\-help\fP" 4
55 Display a help message and terminate.
56 .IP "\fB\-V\fP, \fB\-\-version\fP" 4
57 Show version number and terminate.
58 .\" ----------------------------------------------------------------------------
59 .SH COMPATIBILITY and BUGS
60 For historic reasons FAT label is stored in two different locations: in the boot
61 sector and as a special volume label entry in the root directory.
62 MS-DOS 5.00, MS-DOS 6.22, MS-DOS 7.10, Windows 98, Windows XP and also
63 Windows 10 read FAT label only from the root directory.
64 Absence of the volume label in the root directory is interpreted as empty or
65 none label, even if boot sector contains some valid label.
66
67 When Windows XP or Windows 10 system changes a FAT label it stores it only in
68 the root directory \(em letting boot sector unchanged.
69 Which leads to problems when a label is removed on Windows.
70 Old label is still stored in the boot sector but is removed from the root
71 directory.
72
73 \fBdosfslabel\fP prior to the version 3.0.7 operated only with FAT labels stored
74 in the boot sector, completely ignoring a volume label in the root directory.
75
76 \fBdosfslabel\fP in versions 3.0.7\(en3.0.15 reads FAT labels from the root
77 directory and in case of absence, it fallbacks to a label stored in the boot
78 sector.
79 Change operation resulted in updating a label in the boot sector and
80 \fIsometimes\fP also in the root directory due to the bug.
81 That bug was fixed in \fBdosfslabel\fP version 3.0.16 and since this version
82 \fBdosfslabel\fP updates label in both location.
83
84 Since version 4.2, \fBfatlabel\fP reads a FAT label only from the root directory
85 (like MS-DOS and Windows systems), but changes a FAT label in both locations.
86 In version 4.2 was fixed handling of empty labels and labels which starts with a
87 byte 0xE5.
88 Also in this version was added support for non-ASCII labels according to the
89 specified DOS codepage and were added checks if a new label is valid.
90
91 It is strongly suggested to not use \fBdosfslabel\fP prior to version 3.0.16.
92 .\" ----------------------------------------------------------------------------
93 .SH DOS CODEPAGES
94 MS-DOS and Windows systems use DOS (OEM) codepage for encoding and decoding FAT
95 label.
96 In Windows systems DOS codepage is global for all running applications and
97 cannot be configured explicitly.
98 It is set implicitly by option \fILanguage for non-Unicode programs\fP available
99 in \fIRegional and Language Options\fP via \fIControl Panel\fP.
100 Default DOS codepage for fatlabel is 850.
101 See following mapping table between DOS codepage and Language for non-Unicode
102 programs:
103 .TS
104 tab(:);
105 c lx.
106 \fBCodepage\fP:\fBLanguage\fP
107 437:T{
108 English (India), English (Malaysia), English (Republic of the Philippines),
109 English (Singapore), English (South Africa), English (United States),
110 English (Zimbabwe), Filipino, Hausa, Igbo, Inuktitut, Kinyarwanda, Kiswahili,
111 Yoruba
112 T}
113 720:Arabic, Dari, Persian, Urdu, Uyghur
114 737:Greek
115 775:Estonian, Latvian, Lithuanian
116 850:T{
117 Afrikaans, Alsatian, Basque, Breton, Catalan, Corsican, Danish, Dutch,
118 English (Australia), English (Belize), English (Canada), English (Caribbean),
119 English (Ireland), English (Jamaica), English (New Zealand),
120 English (Trinidad and Tobago), English (United Kingdom), Faroese, Finnish,
121 French, Frisian, Galician, German, Greenlandic, Icelandic, Indonesian, Irish,
122 isiXhosa, isiZulu, Italian, K'iche, Lower Sorbian, Luxembourgish, Malay,
123 Mapudungun, Mohawk, Norwegian, Occitan, Portuguese, Quechua, Romansh, Sami,
124 Scottish Gaelic, Sesotho sa Leboa, Setswana, Spanish, Swedish, Tamazight,
125 Upper Sorbian, Welsh, Wolof
126 T}
127 852:T{
128 Albanian, Bosnian (Latin), Croatian, Czech, Hungarian, Polish, Romanian,
129 Serbian (Latin), Slovak, Slovenian, Turkmen
130 T}
131 855:Bosnian (Cyrillic), Serbian (Cyrillic)
132 857:Azeri (Latin), Turkish, Uzbek (Latin)
133 862:Hebrew
134 866:T{
135 Azeri (Cyrillic), Bashkir, Belarusian, Bulgarian, Kyrgyz, Macedonian, Mongolian,
136 Russian, Tajik, Tatar, Ukrainian, Uzbek (Cyrillic), Yakut
137 T}
138 874:Thai
139 932:Japanese
140 936:Chinese (Simplified)
141 949:Korean
142 950:Chinese (Traditional)
143 1258:Vietnamese
144 .TE
145 .\" ----------------------------------------------------------------------------
146 .SH SEE ALSO
147 .BR fsck.fat (8),
148 .BR mkfs.fat (8)
149 .\" ----------------------------------------------------------------------------
150 .SH HOMEPAGE
151 The home for the \fBdosfstools\fP project is its
152 .UR https://github.com/dosfstools/dosfstools
153 GitHub project page
154 .UE .
155 .\" ----------------------------------------------------------------------------
156 .SH AUTHORS
157 \fBdosfstools\fP were written by
158 .MT werner.almesberger@\:lrc.di.epfl.ch
159 Werner Almesberger
160 .ME ,
161 .MT Roman.Hodek@\:informatik.\:uni-erlangen.de
162 Roman Hodek
163 .ME ,
164 and others.
165 Current maintainers are
166 .MT aeb@\:debian.org
167 Andreas Bombe
168 .ME
169 and
170 .MT pali.rohar@\:gmail.com
171 Pali Rohár
172 .ME .