Debian Codegraph @

upstream/debian-unstable/man1/mtools.1

raw
1 '\" t
2 .TH mtools 1 "14Jun25" mtools-4.0.49
3 .SH Name
4 mtools - utilities to access DOS disks in Unix.
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 .PP
17 .SH Introduction
18 Mtools is a collection of tools to allow Unix systems to manipulate
19 MS-DOS files: read, write, and move around files on an MS-DOS
20 file system (typically a floppy disk). Where reasonable, each program
21 attempts to emulate the MS-DOS equivalent command. However,
22 unnecessary restrictions and oddities of DOS are not emulated. For
23 instance, it is possible to move subdirectories from one subdirectory
24 to another.
25 .PP
26 Mtools is sufficient to give access to MS-DOS file systems. For
27 instance, commands such as \fR\&\f(CWmdir a:\fR work on the \fR\&\f(CWa:\fR floppy
28 without any preliminary mounting or initialization (assuming the default
29 \&\fR\&\f(CW\(if/etc/mtools.conf\(is\fR works on your machine). With mtools, one can
30 change floppies too without unmounting and mounting.
31 .PP
32 .SH Where\ to\ get\ mtools
33 .PP
34 Mtools can be found at the following places (and their mirrors):
35
36 .nf
37 .ft 3
38 .in +0.3i
39 http://ftp.gnu.org/gnu/mtools/mtools-4.0.49.tar.gz
40 .fi
41 .in -0.3i
42 .ft R
43 .PP
44
45 \&\fR
46 .PP
47 These patches are named
48 \&\fR\&\f(CWmtools-\fR\fIversion\fR\fR\&\f(CW-\fR\fIddmm\fR\fR\&\f(CW.taz\fR, where version
49 stands for the base version, \fIdd\fR for the day and \fImm\fR for the
50 month. Due to a lack of space, I usually leave only the most recent
51 patch.
52 .PP
53 There is an mtools mailing list at info-mtools @ gnu.org . Please
54 send all bug reports to this list. You may subscribe to the list at
55 https://lists.gnu.org/mailman/listinfo/info-mtools. (N.B. Please
56 remove the spaces around the "@". I left them there in order to fool
57 spambots.) Announcements of new mtools versions will also be sent to
58 the list, in addition to the Linux announce newsgroups. The mailing
59 list is archived at http://lists.gnu.org/pipermail/info-mtools/
60 .PP
61 .SH Common\ features\ of\ all\ mtools\ commands
62 .PP
63 .SS Options\ and\ filenames
64 MS-DOS filenames are composed of a drive letter followed by a colon, a
65 subdirectory, and a filename. Only the filename part is mandatory, the
66 drive letter and the subdirectory are optional. Filenames without a
67 drive letter refer to Unix files. Subdirectory names can use either the
68 \&'\fR\&\f(CW/\fR' or '\fR\&\f(CW\e\fR' separator. The use of the '\fR\&\f(CW\e\fR' separator
69 or wildcards requires the names to be enclosed in quotes to protect them
70 from the shell. However, wildcards in Unix filenames should not be
71 enclosed in quotes, because here we \fBwant\fR the shell to expand
72 them.
73 .PP
74 The regular expression "pattern matching" routines follow the Unix-style
75 rules. For example, `\fR\&\f(CW*\fR' matches all MS-DOS files in lieu of
76 `\fR\&\f(CW*.*\fR'. The archive, hidden, read-only and system attribute bits
77 are ignored during pattern matching.
78 .PP
79 All options use the \fR\&\f(CW-\fR (minus) as their first character, not
80 \&\fR\&\f(CW/\fR as you'd expect in MS-DOS.
81 .PP
82 Most mtools commands allow multiple filename parameters, which
83 doesn't follow MS-DOS conventions, but which is more user-friendly.
84 .PP
85 Most mtools commands allow options that instruct them how to handle
86 file name clashes. See section name clashes, for more details on these.
87 .PP
88 All commands accept the \fR\&\f(CW-i\fR flag which allows to specify an
89 image file (See section drive letters).
90 .PP
91 All commands accept the \fR\&\f(CW-V\fR flag which prints the version, and
92 most accept the \fR\&\f(CW-v\fR flag, which switches on verbose mode. In
93 verbose mode, these commands print out the name of the MS-DOS files
94 upon which they act, unless stated otherwise. See section Commands, for a
95 description of the options which are specific to each command.
96 .PP
97 .SS Drive\ letters
98 .PP
99 The meaning of the drive letters depends on the target architectures.
100 However, on most target architectures, drive A is the first floppy
101 drive, drive B is the second floppy drive (if available), drive J is a
102 Jaz drive (if available), and drive Z is a Zip drive (if available). On
103 those systems where the device name is derived from the SCSI id, the Jaz
104 drive is assumed to be at SCSI target 4, and the Zip at SCSI target 5
105 (factory default settings). On Linux, both drives are assumed to be the
106 second drive on the SCSI bus (/dev/sdb). The default settings can be
107 changes using a configuration file (see section Configuration).
108 .PP
109 The drive letter : (colon) has a special meaning. It is used to access
110 image files which are directly specified on the command line using the
111 \&\fR\&\f(CW-i\fR options.
112 .PP
113 Example:
114
115 .nf
116 .ft 3
117 .in +0.3i
118 mcopy -i my-image-file.bin ::file1 ::file2 .
119 .fi
120 .in -0.3i
121 .ft R
122 .PP
123
124 \&\fR
125 .PP
126 This copies \fR\&\f(CWfile1\fR and \fR\&\f(CWfile2\fR from the image file
127 (\fR\&\f(CWmy-image-file.bin\fR) to the \fR\&\f(CW/tmp\fR directory.
128 .PP
129 You can also supply an offset within the image file by including
130 \&\fR\&\f(CW@@\fR\fIoffset\fR into the file name.
131 .PP
132 Example:
133
134 .nf
135 .ft 3
136 .in +0.3i
137 mcopy -i my-image-file.bin@@1M ::file1 ::file2 .
138 .fi
139 .in -0.3i
140 .ft R
141 .PP
142
143 \&\fR
144 .PP
145 This looks for the image at the offset of 1M in the file, rather than
146 at its beginning.
147 .PP
148 .SS Sizes\ and\ offsets
149 .PP
150 Certain commands, such as \fR\&\f(CWmformat\fR, allow you to specify a hard
151 disk size.
152 .PP
153 The size is a number, followed by an optional unit suffix.
154 .PP
155 The number is interpreted as a hexadecimal number if it starts with
156 \&\fR\&\f(CW0x\fR, as an octal number if it starts with the digit \fR\&\f(CW0\fR, or
157 as a decimal number if it starts with any other digit.
158 .PP
159 The following units are supported:
160 .TP
161 * \ \
162 \&\fR\&\f(CWS\fR sectors (of 512 bytes)
163 .TP
164 * \ \
165 \&\fR\&\f(CWK\fR Kilobytes
166 .TP
167 * \ \
168 \&\fR\&\f(CWM\fR Megabytes
169 .TP
170 * \ \
171 \&\fR\&\f(CWG\fR Gigabytes
172 .TP
173 * \ \
174 \&\fR\&\f(CWT\fR Terabytes
175 .PP
176 If no unit is specified, the default depends on context. Mformat's
177 \&\fR\&\f(CWT\fR option, and mpartition's \fR\&\f(CWl\fR option assume sectors,
178 whereas all other places (mshowfat's \fR\&\f(CWo\fR option, \fR\&\f(CWoffset\fR
179 drive config option and \fR\&\f(CWdata_map\fR drive config option) assume
180 bytes.
181 .PP
182 .SS Current\ working\ directory
183 .PP
184 The \fR\&\f(CWmcd\fR command (\(ifmcd\(is) is used to establish the device and
185 the current working directory (relative to the MS-DOS file system),
186 otherwise the default is assumed to be \fR\&\f(CWA:/\fR. However, unlike
187 MS-DOS, there is only one working directory for all drives, and not one
188 per drive. Moreover, if you set drive \fR\&\f(CW::/\fR, mtools does not
189 remember the associated image file, but only the fact that you are
190 working on an image file at all.
191 .PP
192 .SS VFAT-style\ long\ file\ names
193 .PP
194 This version of mtools supports VFAT style long filenames. If a Unix
195 filename is too long to fit in a short DOS name, it is stored as a
196 VFAT long name, and a companion short name is generated. This short
197 name is what you see when you examine the disk with a pre-7.0 version
198 of DOS.
199 The following table shows some examples of short names:
200 .PP
201
202 .nf
203 .ft 3
204 .in +0.3i
205 Long name MS-DOS name Reason for the change
206 --------- ---------- ---------------------
207 thisisatest THISIS~1 filename too long
208 alain.knaff ALAIN~1.KNA extension too long
209 prn.txt PRN~1.TXT PRN is a device name
210 \&\&.abc ABC~1 null filename
211 hot+cold HOT_CO~1 illegal character
212 .fi
213 .in -0.3i
214 .ft R
215 .PP
216
217 \&\fR
218 .PP
219 As you see, the following transformations happen to derive a short
220 name:
221 .TP
222 * \ \
223 Illegal characters are replaced by underscores. The illegal characters
224 are \fR\&\f(CW;+=[]',\e"*\e\e<>/?:|\fR.
225 .TP
226 * \ \
227 Extra dots, which cannot be interpreted as a main name/extension
228 separator are removed
229 .TP
230 * \ \
231 A \fR\&\f(CW~\fR\fIn\fR number is generated,
232 .TP
233 * \ \
234 The name is shortened so as to fit in the 8+3 limitation
235 .PP
236 The initial Unix-style file name (whether long or short) is also called
237 the \fIprimary\fR name, and the derived short name is also called the
238 \&\fIsecondary\fR name.
239 .PP
240 Example:
241
242 .nf
243 .ft 3
244 .in +0.3i
245 mcopy /etc/motd a:Reallylongname
246 .fi
247 .in -0.3i
248 .ft R
249 .PP
250
251 \&\fR Mtools creates a VFAT entry for Reallylongname, and uses REALLYLO as
252 a short name. Reallylongname is the primary name, and REALLYLO is the
253 secondary name.
254
255 .nf
256 .ft 3
257 .in +0.3i
258 mcopy /etc/motd a:motd
259 .fi
260 .in -0.3i
261 .ft R
262 .PP
263
264 \&\fR Motd fits into the DOS filename limits. Mtools doesn't need to
265 derivate another name. Motd is the primary name, and there is no
266 secondary name.
267 .PP
268 In a nutshell: The primary name is the long name, if one exists, or
269 the short name if there is no long name.
270 .PP
271 Although VFAT is much more flexible than FAT, there are still names
272 that are not acceptable, even in VFAT. There are still some illegal
273 characters left (\fR\&\f(CW\e"*\e\e<>/?:|\fR), and device names are still
274 reserved.
275 .PP
276
277 .nf
278 .ft 3
279 .in +0.3i
280 Unix name Long name Reason for the change
281 --------- ---------- ---------------------
282 prn prn-1 PRN is a device name
283 ab:c ab_c-1 illegal character
284 .fi
285 .in -0.3i
286 .ft R
287 .PP
288
289 \&\fR
290 .PP
291 As you see, the following transformations happen if a long name is
292 illegal:
293 .TP
294 * \ \
295 Illegal characters are replaces by underscores,
296 .TP
297 * \ \
298 A \fR\&\f(CW-\fR\fIn\fR number is generated,
299 .PP
300 .SS Name\ clashes
301 .PP
302 When writing a file to disk, its long name or short name may collide
303 with an already existing file or directory. This may happen for all
304 commands which create new directory entries, such as \fR\&\f(CWmcopy\fR,
305 \&\fR\&\f(CWmmd\fR, \fR\&\f(CWmren\fR, \fR\&\f(CWmmove\fR. When a name clash happens, mtools
306 asks you what it should do. It offers several choices:
307 .TP
308 \&\fR\&\f(CWoverwrite\fR\
309 Overwrites the existing file. It is not possible to overwrite a
310 directory with a file.
311 .TP
312 \&\fR\&\f(CWrename\fR\
313 Renames the newly created file. Mtools prompts for the new filename
314 .TP
315 \&\fR\&\f(CWautorename\fR\
316 Renames the newly created file. Mtools chooses a name by itself, without
317 prompting
318 .TP
319 \&\fR\&\f(CWskip\fR\
320 Gives up on this file, and moves on to the next (if any)
321 .PP
322 To chose one of these actions, type its first letter at the prompt. If
323 you use a lower case letter, the action only applies for this file only,
324 if you use an upper case letter, the action applies to all files, and
325 you won't be prompted again.
326 .PP
327 You may also chose actions (for all files) on the command line, when
328 invoking mtools:
329 .TP
330 \&\fR\&\f(CW-D\ o\fR\
331 Overwrites primary names by default.
332 .TP
333 \&\fR\&\f(CW-D\ O\fR\
334 Overwrites secondary names by default.
335 .TP
336 \&\fR\&\f(CW-D\ r\fR\
337 Renames primary name by default.
338 .TP
339 \&\fR\&\f(CW-D\ R\fR\
340 Renames secondary name by default.
341 .TP
342 \&\fR\&\f(CW-D\ a\fR\
343 Autorenames primary name by default.
344 .TP
345 \&\fR\&\f(CW-D\ A\fR\
346 Autorenames secondary name by default.
347 .TP
348 \&\fR\&\f(CW-D\ s\fR\
349 Skip primary name by default.
350 .TP
351 \&\fR\&\f(CW-D\ S\fR\
352 Skip secondary name by default.
353 .TP
354 \&\fR\&\f(CW-D\ m\fR\
355 Ask user what to do with primary name.
356 .TP
357 \&\fR\&\f(CW-D\ M\fR\
358 Ask user what to do with secondary name.
359 .PP
360 Note that for command line switches lower/upper differentiates between
361 primary/secondary name whereas for interactive choices, lower/upper
362 differentiates between just-this-time/always.
363 .PP
364 The primary name is the name as displayed in Windows 95 or Windows NT:
365 i.e. the long name if it exists, and the short name otherwise. The
366 secondary name is the "hidden" name, i.e. the short name if a long name
367 exists.
368 .PP
369 By default, the user is prompted if the primary name clashes, and the
370 secondary name is autorenamed.
371 .PP
372 If a name clash occurs in a Unix directory, mtools only asks whether
373 to overwrite the file, or to skip it.
374 .PP
375 .SS Case\ sensitivity\ of\ the\ VFAT\ file\ system
376 .PP
377 The VFAT file system is able to remember the case of the
378 filenames. However, filenames which differ only in case are not allowed
379 to coexist in the same directory. For example if you store a file called
380 LongFileName on a VFAT file system, mdir shows this file as LongFileName,
381 and not as Longfilename. However, if you then try to add LongFilename to
382 the same directory, it is refused, because case is ignored for clash
383 checks.
384 .PP
385 The VFAT file system allows you to store the case of a filename in the
386 attribute byte, if all letters of the filename are the same case, and if
387 all letters of the extension are the same case too. Mtools uses this
388 information when displaying the files, and also to generate the Unix
389 filename when mcopying to a Unix directory. This may have unexpected
390 results when applied to files written using an pre-7.0 version of DOS:
391 Indeed, the old style filenames map to all upper case. This is different
392 from the behavior of the old version of mtools which used to generate
393 lower case Unix filenames.
394 .PP
395 .SS high\ capacity\ formats
396 .PP
397 Mtools supports a number of formats which allow storage of more data on
398 disk than usual. Due to different operating system abilities, these
399 formats are not supported on all operating systems. Mtools recognizes
400 these formats transparently where supported.
401 .PP
402 In order to format these disks, you need to use an operating system
403 specific tool. For Linux, suitable floppy tools can be found in the
404 \&\fR\&\f(CWfdutils\fR package at the following locations~:
405
406 .nf
407 .ft 3
408 .in +0.3i
409 \&\fR\&\f(CWhttp://www.fdutils.linux.lu/.
410 .fi
411 .in -0.3i
412 .ft R
413 .PP
414
415 \&\fR
416 .PP
417 See the manual pages included in that package for further detail: Use
418 \&\fR\&\f(CWsuperformat\fR to format all formats except XDF, and use
419 \&\fR\&\f(CWxdfcopy\fR to format XDF.
420 .PP
421 .SS \ \ More\ sectors
422 .PP
423 The oldest method of fitting more data on a disk is to use more sectors
424 and more cylinders. Although the standard format uses 80 cylinders and
425 18 sectors (on a 3 1/2 high density disk), it is possible to use up to
426 83 cylinders (on most drives) and up to 21 sectors. This method allows
427 to store up to 1743K on a 3 1/2 HD disk. However, 21 sector disks are
428 twice as slow as the standard 18 sector disks because the sectors are
429 packed so close together that we need to interleave them. This problem
430 doesn't exist for 20 sector formats.
431 .PP
432 These formats are supported by numerous DOS shareware utilities such as
433 \&\fR\&\f(CWfdformat\fR and \fR\&\f(CWvgacopy\fR. In his infinite hubris, Bill Gate$
434 believed that he invented this, and called it \fR\&\f(CW\(ifDMF disks\(is\fR, or
435 \&\fR\&\f(CW\(ifWindows formatted disks\(is\fR. But in reality, it has already existed
436 years before! Mtools supports these formats on Linux, on SunOS and on
437 the DELL Unix PC.
438 .PP
439 .SS \ \ Bigger\ sectors
440 By using bigger sectors it is possible to go beyond the capacity which
441 can be obtained by the standard 512-byte sectors. This is because of the
442 sector header. The sector header has the same size, regardless of how
443 many data bytes are in the sector. Thus, we save some space by using
444 \&\fIfewer\fR, but bigger sectors. For example, 1 sector of 4K only takes
445 up header space once, whereas 8 sectors of 512 bytes have also 8
446 headers, for the same amount of useful data.
447 .PP
448 This method permits storage of up to 1992K on a 3 1/2 HD disk.
449 .PP
450 Mtools supports these formats only on Linux.
451 .PP
452 .SS \ \ 2m
453 .PP
454 The 2m format was originally invented by Ciriaco Garcia de Celis. It
455 also uses bigger sectors than usual in order to fit more data on the
456 disk. However, it uses the standard format (18 sectors of 512 bytes
457 each) on the first cylinder, in order to make these disks easier to
458 handle by DOS. Indeed this method allows you to have a standard sized
459 boot sector, which contains a description of how the rest of the disk
460 should be read.
461 .PP
462 However, the drawback of this is that the first cylinder can hold less
463 data than the others. Unfortunately, DOS can only handle disks where
464 each track contains the same amount of data. Thus 2m hides the fact that
465 the first track contains less data by using a \fIshadow
466 FAT\fR. (Usually, DOS stores the FAT in two identical copies, for
467 additional safety. XDF stores only one copy, but tells DOS that it
468 stores two. Thus the space that would be taken up by the second FAT copy
469 is saved.) This also means that you should \fBnever use a 2m disk
470 to store anything else than a DOS file system\fR.
471 .PP
472 Mtools supports these formats only on Linux.
473 .PP
474 .SS \ \ XDF
475 .PP
476 XDF is a high capacity format used by OS/2. It can hold 1840 K per
477 disk. That's lower than the best 2m formats, but its main advantage is
478 that it is fast: 600 milliseconds per track. That's faster than the 21
479 sector format, and almost as fast as the standard 18 sector format. In
480 order to access these disks, make sure mtools has been compiled with XDF
481 support, and set the \fR\&\f(CWuse_xdf\fR variable for the drive in the
482 configuration file. See section Compiling mtools, and \(ifmiscellaneous variables\(is,
483 for details on how to do this. Fast XDF access is only available for
484 Linux kernels which are more recent than 1.1.34.
485 .PP
486 Mtools supports this format only on Linux.
487 .PP
488 \&\fBCaution / Attention distributors\fR: If mtools is compiled on a
489 Linux kernel more recent than 1.3.34, it won't run on an older
490 kernel. However, if it has been compiled on an older kernel, it still
491 runs on a newer kernel, except that XDF access is slower. It is
492 recommended that distribution authors only include mtools binaries
493 compiled on kernels older than 1.3.34 until 2.0 comes out. When 2.0 will
494 be out, mtools binaries compiled on newer kernels may (and should) be
495 distributed. Mtools binaries compiled on kernels older than 1.3.34 won't
496 run on any 2.1 kernel or later.
497 .PP
498 .SS Exit\ codes
499 All the Mtools commands return 0 on success, 1 on utter failure, or 2
500 on partial failure. All the Mtools commands perform a few sanity
501 checks before going ahead, to make sure that the disk is indeed an
502 MS-DOS disk (as opposed to, say an ext2 or MINIX disk). These checks
503 may reject partially corrupted disks, which might otherwise still be
504 readable. To avoid these checks, set the MTOOLS_SKIP_CHECK
505 environmental variable or the corresponding configuration file variable
506 (see section global variables)
507 .SS Bugs
508 An unfortunate side effect of not guessing the proper device (when
509 multiple disk capacities are supported) is an occasional error message
510 from the device driver. These can be safely ignored.
511 .PP
512 The fat checking code chokes on 1.72 Mb disks mformatted with pre-2.0.7
513 mtools. Set the environmental variable MTOOLS_FAT_COMPATIBILITY (or the
514 corresponding configuration file variable, \(ifglobal variables\(is) to
515 bypass the fat checking.
516 .PP
517 .SS Credits
518 .PP
519 Original code (versions through 2.0.7?) of mtools was developped by
520 Emmet P. Gray (Texas, USA).
521 .PP
522 David C. Niemi contributed VFAT support and helped maintain mtools.
523 .PP
524 The packaging process of mtools uses a modified version of Beverly
525 A. Erlebacher's texi2roff tool to convert the texi documentation into
526 man pages.
527 .PP
528 .SH See also
529 floppyd_installtest
530 mattrib
531 mbadblocks
532 mcd
533 mcopy
534 mdel
535 mdeltree
536 mdir
537 mdoctorfat
538 mdu
539 mformat
540 minfo
541 mkmanifest
542 mlabel
543 mmd
544 mmount
545 mmove
546 mrd
547 mren
548 mshortname
549 mshowfat
550 mtoolstest
551 mtype