Imported Upstream version 4.0.20
[platform/upstream/mtools.git] / mtools.info
1 This is mtools.info, produced by makeinfo version 6.3 from mtools.texi.
2
3 This manual is for Mtools (version 4.0.20, November 2018), which is a
4 collection of tools to allow Unix systems to manipulate MS-DOS files.
5
6    Copyright (C) 2007, 2009 Free Software Foundation, Inc.  Copyright
7 (C) 1996-2005,2007-2011,2013 Alain Knaff.
8
9      Permission is granted to copy, distribute and/or modify this
10      document under the terms of the GNU Free Documentation License,
11      Version 1.3 or any later version published by the Free Software
12      Foundation; with no Invariant Sections, with no Front-Cover Texts,
13      and with no Back-Cover Texts.  A copy of the license is included in
14      the section entitled "GNU Free Documentation License".
15 INFO-DIR-SECTION DOS
16 START-INFO-DIR-ENTRY
17 * Mtools: (mtools).        Mtools: utilities to access DOS disks in Unix.
18 END-INFO-DIR-ENTRY
19
20 \1f
21 File: mtools.info,  Node: Top,  Next: Location,  Prev: (dir),  Up: (dir)
22
23 Mtools doc
24 **********
25
26 This is mtools' documentation.
27
28 Introduction
29 ************
30
31 Mtools is a collection of tools to allow Unix systems to manipulate
32 MS-DOS files: read, write, and move around files on an MS-DOS file
33 system (typically a floppy disk).  Where reasonable, each program
34 attempts to emulate the MS-DOS equivalent command.  However, unnecessary
35 restrictions and oddities of DOS are not emulated.  For instance, it is
36 possible to move subdirectories from one subdirectory to another.
37
38    Mtools is sufficient to give access to MS-DOS file systems.  For
39 instance, commands such as 'mdir a:' work on the 'a:' floppy without any
40 preliminary mounting or initialization (assuming the default
41 '/etc/mtools.conf' works on your machine).  With mtools, one can change
42 floppies too without unmounting and mounting.
43
44    This manual is for Mtools (version 4.0.20, November 2018), which is a
45 collection of tools to allow Unix systems to manipulate MS-DOS files.
46
47    Copyright (C) 2007, 2009 Free Software Foundation, Inc.  Copyright
48 (C) 1996-2005,2007-2011,2013 Alain Knaff.
49
50      Permission is granted to copy, distribute and/or modify this
51      document under the terms of the GNU Free Documentation License,
52      Version 1.3 or any later version published by the Free Software
53      Foundation; with no Invariant Sections, with no Front-Cover Texts,
54      and with no Back-Cover Texts.  A copy of the license is included in
55      the section entitled "GNU Free Documentation License".
56
57 * Menu:
58
59 * Location::          Where to find mtools and early bug fixes
60 * Common features::   Common features of all mtools commands
61 * Configuration::     How to configure mtools for your environment
62 * Commands::          The available mtools commands
63 * Compiling mtools::  Architecture specific compilation flags
64 * Porting mtools::    Porting mtools to architectures which are not
65                       yet supported
66
67 * Command Index::     Command Index
68 * Variable Index::    Variable Index
69 * Concept Index::     Concept Index
70
71 \1f
72 File: mtools.info,  Node: Location,  Next: Common features,  Prev: Top,  Up: Top
73
74 1 Where to get mtools
75 *********************
76
77 Mtools can be found at the following places (and their mirrors):
78      http://ftp.gnu.org/gnu/mtools/mtools-4.0.20.tar.gz
79      http://mtools.linux.lu/mtools-4.0.20.tar.gz
80      ftp://www.tux.org/pub/knaff/mtools/mtools-4.0.20.tar.gz
81      ftp://ibiblio.unc.edu/pub/Linux/utils/disk-management/mtools-4.0.20.tar.gz
82
83    Before reporting a bug, make sure that it has not yet been fixed in
84 the Alpha patches which can be found at:
85      http://ftp.gnu.org/gnu/mtools/
86      http://mtools.linux.lu/
87      ftp://www.tux.org/pub/knaff/mtools
88
89    These patches are named 'mtools-'VERSION'-'DDMM'.taz', where version
90 stands for the base version, DD for the day and MM for the month.  Due
91 to a lack of space, I usually leave only the most recent patch.
92
93    There is an mtools mailing list at mtools @ tux.org .  Please send
94 all bug reports to this list.  You may subscribe to the list by sending
95 a message with 'subscribe mtools @ tux.org' in its body to majordomo @
96 tux.org .  (N.B. Please remove the spaces around the "@" both times.  I
97 left them there in order to fool spambots.)  Announcements of new mtools
98 versions will also be sent to the list, in addition to the Linux
99 announce newsgroups.  The mailing list is archived at
100 http://lists.gnu.org/pipermail/info-mtools/
101
102 \1f
103 File: mtools.info,  Node: Common features,  Next: Configuration,  Prev: Location,  Up: Top
104
105 2 Common features of all mtools commands
106 ****************************************
107
108 * Menu:
109
110 * arguments::              What the command line parameters of mtools
111                            mean
112 * drive letters::          Which drives are defined by default
113 * directory::              Current working directory
114 * long names::             VFAT-style long filenames
115 * name clashes::           Name clash handling, and associated command
116                            line options
117 * case sensitivity::       Case sensitivity
118 * high capacity formats::  How to fit more data on your floppies
119 * exit codes::             Exit codes
120 * bugs::                   Happens to everybody
121
122 \1f
123 File: mtools.info,  Node: arguments,  Next: drive letters,  Prev: Common features,  Up: Common features
124
125 2.1 Options and filenames
126 =========================
127
128 MS-DOS filenames are composed of a drive letter followed by a colon, a
129 subdirectory, and a filename.  Only the filename part is mandatory, the
130 drive letter and the subdirectory are optional.  Filenames without a
131 drive letter refer to Unix files.  Subdirectory names can use either the
132 ''/'' or ''\'' separator.  The use of the ''\'' separator or wildcards
133 requires the names to be enclosed in quotes to protect them from the
134 shell.  However, wildcards in Unix filenames should not be enclosed in
135 quotes, because here we *want* the shell to expand them.
136
137    The regular expression "pattern matching" routines follow the
138 Unix-style rules.  For example, ''*'' matches all MS-DOS files in lieu
139 of ''*.*''.  The archive, hidden, read-only and system attribute bits
140 are ignored during pattern matching.
141
142    All options use the '-' (minus) as their first character, not '/' as
143 you'd expect in MS-DOS.
144
145    Most mtools commands allow multiple filename parameters, which
146 doesn't follow MS-DOS conventions, but which is more user-friendly.
147
148    Most mtools commands allow options that instruct them how to handle
149 file name clashes.  *Note name clashes::, for more details on these.
150 All commands accept the '-V' flags which prints the version, and most
151 accept the '-v' flag, which switches on verbose mode.  In verbose mode,
152 these commands print out the name of the MS-DOS files upon which they
153 act, unless stated otherwise.  *Note Commands::, for a description of
154 the options which are specific to each command.
155
156 \1f
157 File: mtools.info,  Node: drive letters,  Next: directory,  Prev: arguments,  Up: Common features
158
159 2.2 Drive letters
160 =================
161
162 The meaning of the drive letters depends on the target architectures.
163 However, on most target architectures, drive A is the first floppy
164 drive, drive B is the second floppy drive (if available), drive J is a
165 Jaz drive (if available), and drive Z is a Zip drive (if available).  On
166 those systems where the device name is derived from the SCSI id, the Jaz
167 drive is assumed to be at SCSI target 4, and the Zip at SCSI target 5
168 (factory default settings).  On Linux, both drives are assumed to be the
169 second drive on the SCSI bus (/dev/sdb).  The default settings can be
170 changes using a configuration file (*note Configuration::).
171
172    The drive letter : (colon) has a special meaning.  It is used to
173 access image files which are directly specified on the command line
174 using the '-i' options.
175
176    Example:
177       mcopy -i my-image-file.bin ::file1 ::file2 .
178
179    This copies 'file1' and 'file2' from the image file
180 ('my-image-file.bin') to the '/tmp' directory.
181
182    You can also supply an offset within the image file by including
183 '@@'OFFSET into the file name.
184
185    Example:
186       mcopy -i my-image-file.bin@@1M ::file1 ::file2 .
187
188    This looks for the image at the offset of 1M in the file, rather than
189 at its beginning.
190
191 \1f
192 File: mtools.info,  Node: directory,  Next: long names,  Prev: drive letters,  Up: Common features
193
194 2.3 Current working directory
195 =============================
196
197 The 'mcd' command (*note mcd::) is used to establish the device and the
198 current working directory (relative to the MS-DOS file system),
199 otherwise the default is assumed to be 'A:/'.  However, unlike MS-DOS,
200 there is only one working directory for all drives, and not one per
201 drive.
202
203 \1f
204 File: mtools.info,  Node: long names,  Next: name clashes,  Prev: directory,  Up: Common features
205
206 2.4 VFAT-style long file names
207 ==============================
208
209 This version of mtools supports VFAT style long filenames.  If a Unix
210 filename is too long to fit in a short DOS name, it is stored as a VFAT
211 long name, and a companion short name is generated.  This short name is
212 what you see when you examine the disk with a pre-7.0 version of DOS.
213 The following table shows some examples of short names:
214
215      Long name       MS-DOS name     Reason for the change
216      ---------       ----------      ---------------------
217      thisisatest     THISIS~1        filename too long
218      alain.knaff     ALAIN~1.KNA     extension too long
219      prn.txt         PRN~1.TXT       PRN is a device name
220      .abc            ABC~1           null filename
221      hot+cold        HOT_CO~1        illegal character
222
223    As you see, the following transformations happen to derive a short
224 name:
225    * Illegal characters are replaced by underscores.  The illegal
226      characters are ';+=[]',\"*\\<>/?:|'.
227    * Extra dots, which cannot be interpreted as a main name/extension
228      separator are removed
229    * A '~'N number is generated,
230    * The name is shortened so as to fit in the 8+3 limitation
231
232    The initial Unix-style file name (whether long or short) is also
233 called the "primary" name, and the derived short name is also called the
234 "secondary" name.
235
236    Example:
237       mcopy /etc/motd a:Reallylongname
238    Mtools creates a VFAT entry for Reallylongname, and uses REALLYLO as
239 a short name.  Reallylongname is the primary name, and REALLYLO is the
240 secondary name.
241       mcopy /etc/motd a:motd
242    Motd fits into the DOS filename limits.  Mtools doesn't need to
243 derivate another name.  Motd is the primary name, and there is no
244 secondary name.
245
246    In a nutshell: The primary name is the long name, if one exists, or
247 the short name if there is no long name.
248
249    Although VFAT is much more flexible than FAT, there are still names
250 that are not acceptable, even in VFAT. There are still some illegal
251 characters left ('\"*\\<>/?:|'), and device names are still reserved.
252
253      Unix name       Long name       Reason for the change
254      ---------       ----------      ---------------------
255      prn             prn-1           PRN is a device name
256      ab:c            ab_c-1          illegal character
257
258    As you see, the following transformations happen if a long name is
259 illegal:
260    * Illegal characters are replaces by underscores,
261    * A '-'N number is generated,
262
263 \1f
264 File: mtools.info,  Node: name clashes,  Next: case sensitivity,  Prev: long names,  Up: Common features
265
266 2.5 Name clashes
267 ================
268
269 When writing a file to disk, its long name or short name may collide
270 with an already existing file or directory.  This may happen for all
271 commands which create new directory entries, such as 'mcopy', 'mmd',
272 'mren', 'mmove'.  When a name clash happens, mtools asks you what it
273 should do.  It offers several choices:
274
275 'overwrite'
276      Overwrites the existing file.  It is not possible to overwrite a
277      directory with a file.
278 'rename'
279      Renames the newly created file.  Mtools prompts for the new
280      filename
281 'autorename'
282      Renames the newly created file.  Mtools chooses a name by itself,
283      without prompting
284 'skip'
285      Gives up on this file, and moves on to the next (if any)
286
287    To chose one of these actions, type its first letter at the prompt.
288 If you use a lower case letter, the action only applies for this file
289 only, if you use an upper case letter, the action applies to all files,
290 and you won't be prompted again.
291
292    You may also chose actions (for all files) on the command line, when
293 invoking mtools:
294
295 '-D o'
296      Overwrites primary names by default.
297 '-D O'
298      Overwrites secondary names by default.
299 '-D r'
300      Renames primary name by default.
301 '-D R'
302      Renames secondary name by default.
303 '-D a'
304      Autorenames primary name by default.
305 '-D A'
306      Autorenames secondary name by default.
307 '-D s'
308      Skip primary name by default.
309 '-D S'
310      Skip secondary name by default.
311 '-D m'
312      Ask user what to do with primary name.
313 '-D M'
314      Ask user what to do with secondary name.
315
316    Note that for command line switches lower/upper differentiates
317 between primary/secondary name whereas for interactive choices,
318 lower/upper differentiates between just-this-time/always.
319
320    The primary name is the name as displayed in Windows 95 or Windows
321 NT: i.e.  the long name if it exists, and the short name otherwise.  The
322 secondary name is the "hidden" name, i.e.  the short name if a long name
323 exists.
324
325    By default, the user is prompted if the primary name clashes, and the
326 secondary name is autorenamed.
327
328    If a name clash occurs in a Unix directory, mtools only asks whether
329 to overwrite the file, or to skip it.
330
331 \1f
332 File: mtools.info,  Node: case sensitivity,  Next: high capacity formats,  Prev: name clashes,  Up: Common features
333
334 2.6 Case sensitivity of the VFAT file system
335 ============================================
336
337 The VFAT file system is able to remember the case of the filenames.
338 However, filenames which differ only in case are not allowed to coexist
339 in the same directory.  For example if you store a file called
340 LongFileName on a VFAT file system, mdir shows this file as
341 LongFileName, and not as Longfilename.  However, if you then try to add
342 LongFilename to the same directory, it is refused, because case is
343 ignored for clash checks.
344
345    The VFAT file system allows to store the case of a filename in the
346 attribute byte, if all letters of the filename are the same case, and if
347 all letters of the extension are the same case too.  Mtools uses this
348 information when displaying the files, and also to generate the Unix
349 filename when mcopying to a Unix directory.  This may have unexpected
350 results when applied to files written using an pre-7.0 version of DOS:
351 Indeed, the old style filenames map to all upper case.  This is
352 different from the behavior of the old version of mtools which used to
353 generate lower case Unix filenames.
354
355 \1f
356 File: mtools.info,  Node: high capacity formats,  Next: exit codes,  Prev: case sensitivity,  Up: Common features
357
358 2.7 high capacity formats
359 =========================
360
361 Mtools supports a number of formats which allow to store more data on
362 disk as usual.  Due to different operating system abilities, these
363 formats are not supported on all operating systems.  Mtools recognizes
364 these formats transparently where supported.
365
366    In order to format these disks, you need to use an operating system
367 specific tool.  For Linux, suitable floppy tools can be found in the
368 'fdutils' package at the following locations~:
369      ftp://www.tux.org/pub/knaff/fdutils/.
370      ftp://ibiblio.unc.edu/pub/Linux/utils/disk-management/fdutils-*
371
372    See the manual pages included in that package for further detail: Use
373 'superformat' to format all formats except XDF, and use 'xdfcopy' to
374 format XDF.
375
376 * Menu:
377
378 * more sectors::      Putting more sectors per track on the disk
379 * bigger sectors::    Use bigger sectors to save header space
380 * 2m::                Use a standard first track
381 * XDF::               OS/2's eXtended density format
382
383 \1f
384 File: mtools.info,  Node: more sectors,  Next: bigger sectors,  Prev: high capacity formats,  Up: high capacity formats
385
386 2.7.1 More sectors
387 ------------------
388
389 The oldest method of fitting more data on a disk is to use more sectors
390 and more cylinders.  Although the standard format uses 80 cylinders and
391 18 sectors (on a 3 1/2 high density disk), it is possible to use up to
392 83 cylinders (on most drives) and up to 21 sectors.  This method allows
393 to store up to 1743K on a 3 1/2 HD disk.  However, 21 sector disks are
394 twice as slow as the standard 18 sector disks because the sectors are
395 packed so close together that we need to interleave them.  This problem
396 doesn't exist for 20 sector formats.
397
398    These formats are supported by numerous DOS shareware utilities such
399 as 'fdformat' and 'vgacopy'.  In his infinite hubris, Bill Gate$
400 believed that he invented this, and called it 'DMF disks', or 'Windows
401 formatted disks'.  But in reality, it has already existed years before!
402 Mtools supports these formats on Linux, on SunOS and on the DELL Unix
403 PC.
404
405 \1f
406 File: mtools.info,  Node: bigger sectors,  Next: 2m,  Prev: more sectors,  Up: high capacity formats
407
408 2.7.2 Bigger sectors
409 --------------------
410
411 By using bigger sectors it is possible to go beyond the capacity which
412 can be obtained by the standard 512-byte sectors.  This is because of
413 the sector header.  The sector header has the same size, regardless of
414 how many data bytes are in the sector.  Thus, we save some space by
415 using _fewer_, but bigger sectors.  For example, 1 sector of 4K only
416 takes up header space once, whereas 8 sectors of 512 bytes have also 8
417 headers, for the same amount of useful data.
418
419    This method allows to store up to 1992K on a 3 1/2 HD disk.
420
421    Mtools supports these formats only on Linux.
422
423 \1f
424 File: mtools.info,  Node: 2m,  Next: XDF,  Prev: bigger sectors,  Up: high capacity formats
425
426 2.7.3 2m
427 --------
428
429 The 2m format was originally invented by Ciriaco Garcia de Celis.  It
430 also uses bigger sectors than usual in order to fit more data on the
431 disk.  However, it uses the standard format (18 sectors of 512 bytes
432 each) on the first cylinder, in order to make these disks easier to
433 handle by DOS. Indeed this method allows to have a standard sized boot
434 sector, which contains a description of how the rest of the disk should
435 be read.
436
437    However, the drawback of this is that the first cylinder can hold
438 less data than the others.  Unfortunately, DOS can only handle disks
439 where each track contains the same amount of data.  Thus 2m hides the
440 fact that the first track contains less data by using a "shadow FAT".
441 (Usually, DOS stores the FAT in two identical copies, for additional
442 safety.  XDF stores only one copy, but tells DOS that it stores two.
443 Thus the space that would be taken up by the second FAT copy is saved.)
444 This also means that you should *never use a 2m disk to store anything
445 else than a DOS file system*.
446
447    Mtools supports these formats only on Linux.
448
449 \1f
450 File: mtools.info,  Node: XDF,  Prev: 2m,  Up: high capacity formats
451
452 2.7.4 XDF
453 ---------
454
455 XDF is a high capacity format used by OS/2.  It can hold 1840 K per
456 disk.  That's lower than the best 2m formats, but its main advantage is
457 that it is fast: 600 milliseconds per track.  That's faster than the 21
458 sector format, and almost as fast as the standard 18 sector format.  In
459 order to access these disks, make sure mtools has been compiled with XDF
460 support, and set the 'use_xdf' variable for the drive in the
461 configuration file.  *Note Compiling mtools::, and *note miscellaneous
462 variables::, for details on how to do this.  Fast XDF access is only
463 available for Linux kernels which are more recent than 1.1.34.
464
465    Mtools supports this format only on Linux.
466
467    *Caution / Attention distributors*: If mtools is compiled on a Linux
468 kernel more recent than 1.3.34, it won't run on an older kernel.
469 However, if it has been compiled on an older kernel, it still runs on a
470 newer kernel, except that XDF access is slower.  It is recommended that
471 distribution authors only include mtools binaries compiled on kernels
472 older than 1.3.34 until 2.0 comes out.  When 2.0 will be out, mtools
473 binaries compiled on newer kernels may (and should) be distributed.
474 Mtools binaries compiled on kernels older than 1.3.34 won't run on any
475 2.1 kernel or later.
476
477 \1f
478 File: mtools.info,  Node: exit codes,  Next: bugs,  Prev: high capacity formats,  Up: Common features
479
480 2.8 Exit codes
481 ==============
482
483 All the Mtools commands return 0 on success, 1 on utter failure, or 2 on
484 partial failure.  All the Mtools commands perform a few sanity checks
485 before going ahead, to make sure that the disk is indeed an MS-DOS disk
486 (as opposed to, say an ext2 or MINIX disk).  These checks may reject
487 partially corrupted disks, which might otherwise still be readable.  To
488 avoid these checks, set the MTOOLS_SKIP_CHECK environmental variable or
489 the corresponding configuration file variable (*note global variables::)
490
491 \1f
492 File: mtools.info,  Node: bugs,  Prev: exit codes,  Up: Common features
493
494 2.9 Bugs
495 ========
496
497 An unfortunate side effect of not guessing the proper device (when
498 multiple disk capacities are supported) is an occasional error message
499 from the device driver.  These can be safely ignored.
500
501    The fat checking code chokes on 1.72 Mb disks mformatted with
502 pre-2.0.7 mtools.  Set the environmental variable
503 MTOOLS_FAT_COMPATIBILITY (or the corresponding configuration file
504 variable, *note global variables::) to bypass the fat checking.
505
506 \1f
507 File: mtools.info,  Node: Configuration,  Next: Commands,  Prev: Common features,  Up: Top
508
509 3 How to configure mtools for your environment
510 **********************************************
511
512 3.1 Description
513 ===============
514
515 This sections explains the syntax of the configurations files for
516 mtools.  The configuration files are called '/etc/mtools.conf' and
517 '~/.mtoolsrc'.  If the environmental variable 'MTOOLSRC' is set, its
518 contents is used as the filename for a third configuration file.  These
519 configuration files describe the following items:
520
521    * Global configuration flags and variables
522    * Per drive flags and variables
523
524 * Menu:
525
526 * configuration file location::  Where mtools looks for its configuration files
527 * general syntax::        The layout of the configuration files
528 * default values::        Why you don't need a configuration file in most cases
529 * global variables::      Variables that are independent of the drive
530 * per drive variables::   Variables that are specific to a given drive
531 * parsing order::         Location of configuration files and parsing order
532 * old style configuration::      Backwards compatibility
533
534 \1f
535 File: mtools.info,  Node: configuration file location,  Next: general syntax,  Prev: Configuration,  Up: Configuration
536
537 3.2 Location of the configuration files
538 =======================================
539
540 '/etc/mtools.conf' is the system-wide configuration file, and
541 '~/.mtoolsrc' is the user's private configuration file.
542
543    On some systems, the system-wide configuration file is called
544 '/etc/default/mtools.conf' instead.
545
546 \1f
547 File: mtools.info,  Node: general syntax,  Next: default values,  Prev: configuration file location,  Up: Configuration
548
549 3.2.1 General configuration file syntax
550 ---------------------------------------
551
552 The configuration files is made up of sections.  Each section starts
553 with a keyword identifying the section followed by a colon.  Then follow
554 variable assignments and flags.  Variable assignments take the following
555 form:
556      name=value
557    Flags are lone keywords without an equal sign and value following
558 them.  A section either ends at the end of the file or where the next
559 section begins.
560
561    Lines starting with a hash ('#') are comments.  Newline characters
562 are equivalent to whitespace (except where ending a comment).  The
563 configuration file is case insensitive, except for item enclosed in
564 quotes (such as filenames).
565
566 \1f
567 File: mtools.info,  Node: default values,  Next: global variables,  Prev: general syntax,  Up: Configuration
568
569 3.3 Default values
570 ==================
571
572 For most platforms, mtools contains reasonable compiled-in defaults for
573 physical floppy drives.  Thus, you usually don't need to bother with the
574 configuration file, if all you want to do with mtools is to access your
575 floppy drives.  On the other hand, the configuration file is needed if
576 you also want to use mtools to access your hard disk partitions and
577 DOSEMU image files.
578
579 \1f
580 File: mtools.info,  Node: global variables,  Next: per drive variables,  Prev: default values,  Up: Configuration
581
582 3.4 Global variables
583 ====================
584
585 Global flags may be set to 1 or to 0.
586
587    The following global flags are recognized:
588
589 'MTOOLS_SKIP_CHECK'
590      If this is set to 1, mtools skips most of its sanity checks.  This
591      is needed to read some Atari disks which have been made with the
592      earlier ROMs, and which would not be recognized otherwise.
593 'MTOOLS_FAT_COMPATIBILITY'
594      If this is set to 1, mtools skips the fat size checks.  Some disks
595      have a bigger FAT than they really need to.  These are rejected if
596      this option is not set.
597 'MTOOLS_LOWER_CASE'
598      If this is set to 1, mtools displays all-upper-case short filenames
599      as lowercase.  This has been done to allow a behavior which is
600      consistent with older versions of mtools which didn't know about
601      the case bits.
602 'MTOOLS_NO_VFAT'
603      If this is set to 1, mtools won't generate VFAT entries for
604      filenames which are mixed-case, but otherwise legal dos filenames.
605      This is useful when working with DOS versions which can't grok VFAT
606      long names, such as FreeDOS.
607 'MTOOLS_DOTTED_DIR'
608      In a wide directory, prints the short name with a dot instead of
609      spaces separating the basename and the extension.
610 'MTOOLS_NAME_NUMERIC_TAIL'
611      If this is set to one (default), generate numeric tails for all
612      long names (~1).  If set to zero, only generate numeric tails if
613      otherwise a clash would have happened.
614 'MTOOLS_TWENTY_FOUR_HOUR_CLOCK'
615      If 1, uses the European notation for times (twenty four hour
616      clock), else uses the UK/US notation (am/pm)
617 'MTOOLS_LOCK_TIMEOUT'
618      How long, in seconds, to wait for a locked device to become free.
619      Defaults to 30.
620
621    Example: Inserting the following line into your configuration file
622 instructs mtools to skip the sanity checks:
623        MTOOLS_SKIP_CHECK=1
624
625    Global variables may also be set via the environment:
626        export MTOOLS_SKIP_CHECK=1
627
628    Global string variables may be set to any value:
629 'MTOOLS_DATE_STRING'
630      The format used for printing dates of files.  By default, is
631      dd-mm-yyyy.
632
633 \1f
634 File: mtools.info,  Node: per drive variables,  Next: parsing order,  Prev: global variables,  Up: Configuration
635
636 3.5 Per drive flags and variables
637 =================================
638
639 * Menu:
640
641 * general information::   What a drive description looks like
642 * location information::  Where is the drive data physically stored
643 * geometry description::  Describes the physical characteristics of
644                           the media
645 * open flags::            Flags passed to the open system call when the
646                           device is opened
647 * miscellaneous variables::        Variables which don't fit in either category
648 * miscellaneous flags::           Switch variables, which can be enabled or disabled
649 * multiple descriptions:: How to supply several descriptions for a
650                           drive, to be tried one after the other.
651
652 \1f
653 File: mtools.info,  Node: general information,  Next: location information,  Prev: per drive variables,  Up: per drive variables
654
655 3.5.1 General information
656 -------------------------
657
658 Per drive flags and values may be described in a drive section.  A drive
659 section starts with 'drive' "DRIVELETTER" :
660
661    Then follow variable-value pairs and flags.
662
663    This is a sample drive description:
664        drive a:
665          file="/dev/fd0" use_xdf=1
666
667 \1f
668 File: mtools.info,  Node: location information,  Next: geometry description,  Prev: general information,  Up: per drive variables
669
670 3.5.2 Location information
671 --------------------------
672
673 For each drive, you need to describe where its data is physically stored
674 (image file, physical device, partition, offset).
675
676 'file'
677      The name of the file or device holding the disk image.  This is
678      mandatory.  The file name should be enclosed in quotes.
679
680 'partition'
681      Tells mtools to treat the drive as a partitioned device, and to use
682      the given partition.  Only primary partitions are accessible using
683      this method, and they are numbered from 1 to 4.  For logical
684      partitions, use the more general 'offset' variable.  The
685      'partition' variable is intended for removable media such as
686      Syquest disks, ZIP drives, and magneto-optical disks.  Although
687      traditional DOS sees Syquest disks and magneto-optical disks as
688      'giant floppy disks' which are unpartitioned, OS/2 and Windows NT
689      treat them like hard disks, i.e.  partitioned devices.  The
690      'partition' flag is also useful DOSEMU hdimages.  It is not
691      recommended for hard disks for which direct access to partitions is
692      available through mounting.
693
694 'offset'
695      Describes where in the file the MS-DOS file system starts.  This is
696      useful for logical partitions in DOSEMU hdimages, and for ATARI ram
697      disks.  By default, this is zero, meaning that the file system
698      starts right at the beginning of the device or file.
699
700 \1f
701 File: mtools.info,  Node: geometry description,  Next: open flags,  Prev: location information,  Up: per drive variables
702
703 3.5.3 Disk Geometry Configuration
704 ---------------------------------
705
706 Geometry information describes the physical characteristics about the
707 disk.  Its has three purposes:
708
709 formatting
710      The geometry information is written into the boot sector of the
711      newly made disk.  However, you may also describe the geometry
712      information on the command line.  *Note mformat::, for details.
713 filtering
714      On some Unixes there are device nodes which only support one
715      physical geometry.  For instance, you might need a different node
716      to access a disk as high density or as low density.  The geometry
717      is compared to the actual geometry stored on the boot sector to
718      make sure that this device node is able to correctly read the disk.
719      If the geometry doesn't match, this drive entry fails, and the next
720      drive entry bearing the same drive letter is tried.  *Note multiple
721      descriptions::, for more details on supplying several descriptions
722      for one drive letter.
723
724      If no geometry information is supplied in the configuration file,
725      all disks are accepted.  On Linux (and on SPARC) there exist device
726      nodes with configurable geometry ('/dev/fd0', '/dev/fd1' etc), and
727      thus filtering is not needed (and ignored) for disk drives.
728      (Mtools still does do filtering on plain files (disk images) in
729      Linux: this is mainly intended for test purposes, as I don't have
730      access to a Unix which would actually need filtering).
731
732      If you do not need filtering, but want still a default geometry for
733      mformatting, you may switch off filtering using the 'mformat_only'
734      flag.
735
736      If you want filtering, you should supply the 'filter' flag.  If you
737      supply a geometry, you must supply one of both flags.
738
739 initial geometry
740      On devices that support it (usually floppy devices), the geometry
741      information is also used to set the initial geometry.  This initial
742      geometry is applied while reading the boot sector, which contains
743      the real geometry.  If no geometry information is supplied in the
744      configuration file, or if the 'mformat_only' flag is supplied, no
745      initial configuration is done.
746
747      On Linux, initial geometry is not really needed, as the
748      configurable devices are able to auto-detect the disk type
749      accurately enough (for most common formats) to read the boot
750      sector.
751
752    Wrong geometry information may lead to very bizarre errors.  That's
753 why I strongly recommend that you add the 'mformat_only' flag to your
754 drive description, unless you really need filtering or initial geometry.
755
756    The following geometry related variables are available:
757
758 'cylinders'
759 'tracks'
760      The number of cylinders.  ('cylinders' is the preferred form,
761      'tracks' is considered obsolete)
762 'heads'
763      The number of heads (sides).
764 'sectors'
765      The number of sectors per track.
766
767    Example: the following drive section describes a 1.44M drive:
768
769        drive a:
770            file="/dev/fd0H1440"
771            fat_bits=12
772            cylinders=80 heads=2 sectors=18
773            mformat_only
774
775    The following shorthand geometry descriptions are available:
776
777 '1.44m'
778      high density 3 1/2 disk.  Equivalent to: 'fat_bits=12 cylinders=80
779      heads=2 sectors=18'
780 '1.2m'
781      high density 5 1/4 disk.  Equivalent to: 'fat_bits=12 cylinders=80
782      heads=2 sectors=15'
783 '720k'
784      double density 3 1/2 disk.  Equivalent to: 'fat_bits=12
785      cylinders=80 heads=2 sectors=9'
786 '360k'
787      double density 5 1/4 disk.  Equivalent to: 'fat_bits=12
788      cylinders=40 heads=2 sectors=9'
789
790    The shorthand format descriptions may be amended.  For example, '360k
791 sectors=8' describes a 320k disk and is equivalent to: 'fat_bits=12
792 cylinders=40 heads=2 sectors=8'
793
794 \1f
795 File: mtools.info,  Node: open flags,  Next: miscellaneous variables,  Prev: geometry description,  Up: per drive variables
796
797 3.5.4 Open Flags
798 ----------------
799
800 Moreover, the following flags are available:
801
802 'sync'
803      All i/o operations are done synchronously
804 'nodelay'
805      The device or file is opened with the O_NDELAY flag.  This is
806      needed on some non-Linux architectures.
807 'exclusive'
808      The device or file is opened with the O_EXCL flag.  On Linux, this
809      ensures exclusive access to the floppy drive.  On most other
810      architectures, and for plain files it has no effect at all.
811
812 \1f
813 File: mtools.info,  Node: miscellaneous variables,  Next: miscellaneous flags,  Prev: open flags,  Up: per drive variables
814
815 3.5.5 General Purpose Drive Variables
816 -------------------------------------
817
818 The following general purpose drive variables are available.  Depending
819 to their type, these variables can be set to a string (precmd) or an
820 integer (all others)
821
822 'fat_bits'
823      The number of FAT bits.  This may be 12 or 16.  This is very rarely
824      needed, as it can almost always be deduced from information in the
825      boot sector.  On the contrary, describing the number of fat bits
826      may actually be harmful if you get it wrong.  You should only use
827      it if mtools gets the auto-detected number of fat bits wrong, or if
828      you want to mformat a disk with a weird number of fat bits.
829 'codepage'
830      Describes the DOS code page used for short filenames.  This is a
831      number between 1 and 999.  By default, code page 850 is used.  The
832      reason for this is because this code page contains most of the
833      characters that are also available in ISO-Latin-1.  You may also
834      specify a global code page for all drives by using the global
835      'default_codepage' parameter (outside of any drive description).
836      This parameters exists starting at version 4.0.0
837 'precmd'
838      On some variants of Solaris, it is necessary to call 'volcheck -v'
839      before opening a floppy device, in order for the system to notice
840      that there is indeed a disk in the drive.  'precmd="volcheck -v"'
841      in the drive clause establishes the desired behavior.
842
843 'blocksize'
844      This parameter represents a default block size to be always used on
845      this device.  All I/O is done with multiples of this block size,
846      independently of the sector size registered in the file system's
847      boot sector.  This is useful for character devices whose sector
848      size is not 512, such as for example CD-ROM drives on Solaris.
849
850    Only the 'file' variable is mandatory.  The other parameters may be
851 left out.  In that case a default value or an auto-detected value is
852 used.
853
854 \1f
855 File: mtools.info,  Node: miscellaneous flags,  Next: multiple descriptions,  Prev: miscellaneous variables,  Up: per drive variables
856
857 3.5.6 General Purpose Drive Flags
858 ---------------------------------
859
860 A flag can either be set to 1 (enabled) or 0 (disabled).  If the value
861 is omitted, it is enabled.  For example, 'scsi' is equivalent to
862 'scsi=1'
863
864 'nolock'
865      Instruct mtools to not use locking on this drive.  This is needed
866      on systems with buggy locking semantics.  However, enabling this
867      makes operation less safe in cases where several users may access
868      the same drive at the same time.
869
870 'scsi'
871      When set to 1, this option tells mtools to use raw SCSI I/O instead
872      of the standard read/write calls to access the device.  Currently,
873      this is supported on HP-UX, Solaris and SunOS. This is needed
874      because on some architectures, such as SunOS or Solaris, PC media
875      can't be accessed using the 'read' and 'write' system calls,
876      because the OS expects them to contain a Sun specific "disk label".
877
878      As raw SCSI access always uses the whole device, you need to
879      specify the "partition" flag in addition
880
881      On some architectures, such as Solaris, mtools needs root
882      privileges to be able to use the 'scsi' option.  Thus mtools should
883      be installed setuid root on Solaris if you want to access Zip/Jaz
884      drives.  Thus, if the 'scsi' flag is given, 'privileged' is
885      automatically implied, unless explicitly disabled by 'privileged=0'
886
887      Mtools uses its root privileges to open the device, and to issue
888      the actual SCSI I/O calls.  Moreover, root privileges are only used
889      for drives described in a system-wide configuration file such as
890      '/etc/mtools.conf', and not for those described in '~/.mtoolsrc' or
891      '$MTOOLSRC'.
892
893 'privileged'
894      When set to 1, this instructs mtools to use its setuid and setgid
895      privileges for opening the given drive.  This option is only valid
896      for drives described in the system-wide configuration files (such
897      as '/etc/mtools.conf', not '~/.mtoolsrc' or '$MTOOLSRC').
898      Obviously, this option is also a no op if mtools is not installed
899      setuid or setgid.  This option is implied by 'scsi=1', but again
900      only for drives defined in system-wide configuration files.
901      Privileged may also be set explicitly to 0, in order to tell mtools
902      not to use its privileges for a given drive even if 'scsi=1' is
903      set.
904
905      Mtools only needs to be installed setuid if you use the
906      'privileged' or 'scsi' drive variables.  If you do not use these
907      options, mtools works perfectly well even when not installed setuid
908      root.
909
910 'vold'
911
912      Instructs mtools to interpret the device name as a vold identifier
913      rather than as a filename.  The vold identifier is translated into
914      a real filename using the 'media_findname()' and
915      'media_oldaliases()' functions of the 'volmgt' library.  This flag
916      is only available if you configured mtools with the
917      '--enable-new-vold' option before compilation.
918
919 'swap'
920
921      Consider the media as a word-swapped Atari disk.
922
923 'use_xdf'
924      If this is set to a non-zero value, mtools also tries to access
925      this disk as an XDF disk.  XDF is a high capacity format used by
926      OS/2.  This is off by default.  *Note XDF::, for more details.
927 'mformat_only'
928      Tells mtools to use the geometry for this drive only for
929      mformatting and not for filtering.
930
931 'filter'
932      Tells mtools to use the geometry for this drive both for
933      mformatting and filtering.
934
935 'remote'
936      Tells mtools to connect to floppyd (*note floppyd::).
937
938 \1f
939 File: mtools.info,  Node: multiple descriptions,  Prev: miscellaneous flags,  Up: per drive variables
940
941 3.5.7 Supplying multiple descriptions for a drive
942 -------------------------------------------------
943
944 It is possible to supply multiple descriptions for a drive.  In that
945 case, the descriptions are tried in order until one is found that fits.
946 Descriptions may fail for several reasons:
947
948   1. because the geometry is not appropriate,
949   2. because there is no disk in the drive,
950   3. or because of other problems.
951
952    Multiple definitions are useful when using physical devices which are
953 only able to support one single disk geometry.  Example:
954        drive a: file="/dev/fd0H1440" 1.44m
955        drive a: file="/dev/fd0H720" 720k
956
957    This instructs mtools to use /dev/fd0H1440 for 1.44m (high density)
958 disks and /dev/fd0H720 for 720k (double density) disks.  On Linux, this
959 feature is not really needed, as the /dev/fd0 device is able to handle
960 any geometry.
961
962    You may also use multiple drive descriptions to access both of your
963 physical drives through one drive letter:
964
965        drive z: file="/dev/fd0"
966        drive z: file="/dev/fd1"
967
968    With this description, 'mdir z:' accesses your first physical drive
969 if it contains a disk.  If the first drive doesn't contain a disk,
970 mtools checks the second drive.
971
972    When using multiple configuration files, drive descriptions in the
973 files parsed last override descriptions for the same drive in earlier
974 files.  In order to avoid this, use the 'drive+' or '+drive' keywords
975 instead of 'drive'.  The first adds a description to the end of the list
976 (i.e.  it will be tried last), and the first adds it to the start of the
977 list.
978
979 \1f
980 File: mtools.info,  Node: parsing order,  Next: old style configuration,  Prev: per drive variables,  Up: Configuration
981
982 3.6 Location of configuration files and parsing order
983 =====================================================
984
985 The configuration files are parsed in the following order:
986   1. compiled-in defaults
987   2. '/etc/mtools.conf'
988   3. '~/.mtoolsrc'.
989   4. '$MTOOLSRC' (file pointed by the 'MTOOLSRC' environmental variable)
990
991    Options described in the later files override those described in the
992 earlier files.  Drives defined in earlier files persist if they are not
993 overridden in the later files.  For instance, drives A and B may be
994 defined in '/etc/mtools.conf' and drives C and D may be defined in
995 '~/.mtoolsrc' However, if '~/.mtoolsrc' also defines drive A, this new
996 description would override the description of drive A in
997 '/etc/mtools.conf' instead of adding to it.  If you want to add a new
998 description to a drive already described in an earlier file, you need to
999 use either the '+drive' or 'drive+' keyword.
1000
1001 \1f
1002 File: mtools.info,  Node: old style configuration,  Prev: parsing order,  Up: Configuration
1003
1004 3.7 Backwards compatibility with old configuration file syntax
1005 ==============================================================
1006
1007 The syntax described herein is new for version 'mtools-3.0'.  The old
1008 line-oriented syntax is still supported.  Each line beginning with a
1009 single letter is considered to be a drive description using the old
1010 syntax.  Old style and new style drive sections may be mixed within the
1011 same configuration file, in order to make upgrading easier.  Support for
1012 the old syntax will be phased out eventually, and in order to discourage
1013 its use, I purposefully omit its description here.
1014
1015 \1f
1016 File: mtools.info,  Node: Commands,  Next: Compiling mtools,  Prev: Configuration,  Up: Top
1017
1018 4 Command list
1019 **************
1020
1021 This section describes the available mtools commands, and the command
1022 line parameters that each of them accepts.  Options which are common to
1023 all mtools commands are not described here, *note arguments:: for a
1024 description of those.
1025
1026 * Menu:
1027
1028 * floppyd::           floppy daemon to run on your X server box
1029 * floppyd_installtest:: small utility to check for the presence of floppyd
1030 * mattrib::           change MS-DOS file attribute flags
1031 * mbadblocks::        tests a floppy disk, and marks the bad blocks in the FAT
1032 * mcat::              same as cat. Only useful with floppyd.
1033 * mcd::               change MS-DOS directory
1034 * mclasserase::       erase memory card
1035 * mcopy::             copy MS-DOS files to/from Unix
1036 * mdel::              delete an MS-DOS file
1037 * mdeltree::          recursively delete an MS-DOS directory
1038 * mdir::              display an MS-DOS directory
1039 * mdu::               list space occupied by directory and its contents
1040 * mformat::           add an MS-DOS file system to a low-level formatted floppy disk
1041 * minfo::             get information about an MS-DOS file system.
1042 * mlabel::            make an MS-DOS volume label
1043 * mkmanifest::        makes a list of short name equivalents
1044 * mmd::               make an MS-DOS subdirectory
1045 * mmount::            mount an MS-DOS disk
1046 * mpartition::        create an MS-DOS as a partition
1047 * mrd::               remove an MS-DOS subdirectory
1048 * mmove::             move or rename an MS-DOS file or subdirectory
1049 * mren::              rename an existing MS-DOS file
1050 * mshortname::        shows the short name of a file
1051 * mshowfat::          shows the FAT map of a file
1052 * mtoolstest::        tests and displays the configuration
1053 * mtype::             display contents of an MS-DOS file
1054 * mzip::              zip disk specific commands
1055
1056 \1f
1057 File: mtools.info,  Node: floppyd,  Next: floppyd_installtest,  Prev: Commands,  Up: Commands
1058
1059 4.1 Floppyd
1060 ===========
1061
1062 'Floppyd' is used as a server to grant access to the floppy drive to
1063 clients running on a remote machine, just as an X server grants access
1064 to the display to remote clients.  It has the following syntax:
1065
1066    'floppyd' ['-d'] ['-l'] ['-s' PORT] ['-r' USER] ['-b' IPADDR] ['-x'
1067 DISPLAY] DEVICENAMES
1068
1069    'floppyd' is always associated with an X server.  It runs on the same
1070 machine as its X server, and listens on port 5703 and above.
1071
1072 4.1.1 Authentication
1073 --------------------
1074
1075 'floppyd' authenticates remote clients using the 'Xauthority' protocol.
1076 Xhost authentication is not supported.  Each floppyd is associated with
1077 an X server.  When a remote client attempts to connect to floppyd, it
1078 sends floppyd the X authority record corresponding to floppyd's X
1079 server.  Floppyd in turn then tries to open up a connection to the X
1080 server in order to verify the authenticity of the xauth record.  If the
1081 connection to the X server succeeds, the client is granted access.
1082 'DISPLAY'.
1083
1084    *Caution*: In order to make authentication work correctly, the local
1085 host should *not* be listed in the 'xhost' list of allowed hosts.
1086 Indeed, hosts listed in 'xhost' do not need a correct 'Xauthority'
1087 cookie to connect to the X server.  As 'floppyd' runs on the same host
1088 as the X server, all its probe connection would succeed even for clients
1089 who supplied a bad cookie.  This means that your floppy drive would be
1090 open to the world, i.e.  a huge security hole.  If your X server does
1091 not allow you to remove 'localhost:0' and ':0' from the 'xhost' list,
1092 you can prevent floppyd from probing those display names with the '-l'
1093 option.
1094
1095 4.1.2 Command line options
1096 --------------------------
1097
1098 'd'
1099      Daemon mode.  Floppyd runs its own server loop.  Do not supply this
1100      if you start floppyd from 'inetd.conf'
1101 's PORT'
1102      Port number for daemon mode.  Default is 5703 + DISPLAYNUMBER.
1103      This flag implies daemon mode.  For example, for display
1104      'hitchhiker:5', the port would be 5708.
1105 'b IPADDR'
1106      Bind address (for multi homed hosts).  This flag implies daemon
1107      mode
1108 'r USER'
1109      Run the server under as the given user
1110 'x DISPLAY'
1111      X display to use for authentication.  By default, this is taken
1112      from the 'DISPLAY' variable.  If neither the 'x' attribute is
1113      present nor 'DISPLAY' is set, floppyd uses ':0.0'.
1114
1115    DEVICENAMES is a list of device nodes to be opened.  Default is
1116 '/dev/fd0'.  Multiple devices are only supported on mtools versions
1117 newer than 3.9.11.
1118
1119 4.1.3 Connecting to floppyd
1120 ---------------------------
1121
1122 In order to use floppyd, add the flag 'remote' to the device description
1123 in your '~/.mtoolsrc' file.  If the flag 'remote' is given, the 'file'
1124 parameter of the device description is taken to be a remote address.
1125 It's format is the following:
1126 HOSTNAME':'DISPLAYNUMBER['/'[BASEPORT]['/'DRIVE]].  When using this
1127 entry, mtools connects to port BASEPORT+DISPLAYNUMBER at HOSTNAME.  By
1128 default BASEPORT is 5703.  The drive parameter is to distinguish among
1129 multiple drives associated with a single display (only mtools versions
1130 more recent than 3.9.11)
1131
1132 4.1.4 Examples:
1133 ---------------
1134
1135 The following starts a floppy daemon giving access to '/dev/fd0',
1136 listening on the default port 5703, tied to the default X servers:
1137
1138      floppyd -d /dev/fd0
1139
1140    Each of the following starts a floppy daemon giving access to
1141 '/dev/fd1', tied to the :1 local X servers, and listening on port 5704.
1142 We assume that the local host is named 'hitchhiker'.
1143
1144      floppyd -d /dev/fd0
1145      floppyd -d -x :1 -p 5704 /dev/fd0
1146
1147    If you want to start floppyd by 'inetd' instead of running it as a
1148 daemon, insert the following lines into '/etc/services':
1149      # floppy daemon
1150      floppyd-0    5703/tcp    # floppy daemon for X server :0
1151      floppyd-1    5704/tcp    # floppy daemon for X server :1
1152
1153    And insert the following into '/etc/inetd.conf' (assuming that you
1154 have defined a user named floppy in your '/etc/passwd'):
1155
1156      # floppy daemon
1157      floppyd-0 stream  tcp  wait  floppy  /usr/sbin/floppyd floppyd /dev/fd0
1158      floppyd-1 stream  tcp  wait  floppy  /usr/sbin/floppyd floppyd -x :1 /dev/fd0
1159
1160    Note that you need to supply the X display names for the second
1161 floppyd.  This is because the port is opened by inetd.conf, and hence
1162 floppyd cannot know its number to interfere the display number.
1163
1164    On the client side, insert the following into your '~/.mtoolsrc' to
1165 define a drive letter accessing floppy drive in your X terminal:
1166      drive x: file="$DISPLAY" remote
1167
1168    If your X terminal has more than one drive, you may access the
1169 additional drives as follows:
1170      drive y: file="$DISPLAY//1" remote
1171      drive z: file="$DISPLAY//2" remote
1172
1173 \1f
1174 File: mtools.info,  Node: floppyd_installtest,  Next: mattrib,  Prev: floppyd,  Up: Commands
1175
1176 4.2 Floppyd_installtest
1177 =======================
1178
1179 'Floppyd_installtest' is used to check for the presence of a running
1180 floppyd daemon.  This is useful, if you have a small front-end script to
1181 mtools, which decides whether to use floppyd or not.
1182
1183    'floppyd_installtest' ['-f'] Connect-String
1184
1185    If the '-f' option is specified, 'floppyd_installtest' does a full
1186 X-Cookie authentication and complains if this does not work.
1187
1188    The connect-String has the format described in the floppyd-section:
1189 HOSTNAME':'DISPLAYNUMBER['/'BASEPORT]
1190
1191 \1f
1192 File: mtools.info,  Node: mattrib,  Next: mbadblocks,  Prev: floppyd_installtest,  Up: Commands
1193
1194 4.3 Mattrib
1195 ===========
1196
1197 'Mattrib' is used to change MS-DOS file attribute flags.  It has the
1198 following syntax:
1199
1200    'mattrib' ['-a|+a'] ['-h|+h'] ['-r|+r'] ['-s|+s'] ['-/'] ['-p']
1201 ['-X'] MSDOSFILE [ MSDOSFILES ... ]
1202
1203    'Mattrib' adds attribute flags to an MS-DOS file (with the ''+''
1204 operator) or remove attribute flags (with the ''-'' operator).
1205
1206    'Mattrib' supports the following attribute bits:
1207
1208 'a'
1209      Archive bit.  Used by some backup programs to indicate a new file.
1210 'r'
1211      Read-only bit.  Used to indicate a read-only file.  Files with this
1212      bit set cannot be erased by 'DEL' nor modified.
1213 's'
1214      System bit.  Used by MS-DOS to indicate a operating system file.
1215 'h'
1216      Hidden bit.  Used to make files hidden from 'DIR'.
1217
1218    'Mattrib' supports the following command line flags:
1219 '/'
1220      Recursive.  Recursively list the attributes of the files in the
1221      subdirectories.
1222 'X'
1223      Concise.  Prints the attributes without any whitespace padding.  If
1224      neither the "/" option is given, nor the MSDOSFILE contains a
1225      wildcard, and there is only one MS-DOS file parameter on the
1226      command line, only the attribute is printed, and not the filename.
1227      This option is convenient for scripts
1228 'p'
1229      Replay mode.  Outputs a series of mformat commands that will
1230      reproduce the current situation, starting from a situation as left
1231      by untarring the MS-DOS file system.  Commands are only output for
1232      attribute settings that differ from the default (archive bit set
1233      for files, unset for directories).  This option is intended to be
1234      used in addition to tar.  The 'readonly' attribute is not taken
1235      into account, as tar can set that one itself.
1236
1237 \1f
1238 File: mtools.info,  Node: mbadblocks,  Next: mcat,  Prev: mattrib,  Up: Commands
1239
1240 4.4 Mbadblocks
1241 ==============
1242
1243 The 'mbadblocks' command is used to mark some clusters on an MS-DOS
1244 filesystem bad.  It has the following syntax:
1245
1246    'mbadblocks' ['-s' SECTORLIST|'-c' CLUSTERLIST|-w] DRIVE':'
1247
1248    If no command line flags are supplied, 'Mbadblocks' scans an MS-DOS
1249 filesystem for bad blocks by simply trying to read them and flag them if
1250 read fails.  All blocks that are unused are scanned, and if detected bad
1251 are marked as such in the FAT.
1252
1253    This command is intended to be used right after 'mformat'.  It is not
1254 intended to salvage data from bad disks.
1255
1256 4.4.1 Command line options
1257 --------------------------
1258
1259 'c FILE'
1260      Use a list of bad clusters, rather than scanning for bad clusters
1261      itself.
1262 's FILE'
1263      Use a list of bad sectors (counted from beginning of filesystem),
1264      rather than trying for bad clusters itself.
1265 'w'
1266      Write a random pattern to each cluster, then read it back and flag
1267      cluster as bad if mismatch.  Only free clusters are tested in such
1268      a way, so any file data is preserved.
1269
1270 4.4.2 Bugs
1271 ----------
1272
1273 'Mbadblocks' should (but doesn't yet :-( ) also try to salvage bad
1274 blocks which are in use by reading them repeatedly, and then mark them
1275 bad.
1276
1277 \1f
1278 File: mtools.info,  Node: mcat,  Next: mcd,  Prev: mbadblocks,  Up: Commands
1279
1280 4.5 Mcat
1281 ========
1282
1283 The 'mcat' command is used to copy an entire disk image from or to the
1284 floppy device.  It uses the following syntax:
1285
1286    'mcat' ['-w'] DRIVE':'
1287
1288    'Mcat' performs the same task as the Unix 'cat' command.  It is
1289 included into the mtools package, since 'cat' cannot access remote
1290 floppy devices offered by the mtools floppy daemon.  Now it is possible
1291 to create boot floppies remotely.
1292
1293    The default operation is reading.  The output is written to stdout.
1294
1295    If the '-w' option is specified, mcat reads a disk-image from stdin
1296 and writes it to the given device.  *Use this carefully!*  Because of
1297 the low-level nature of this command, it will happily destroy any data
1298 written before on the disk without warning!
1299
1300 \1f
1301 File: mtools.info,  Node: mcd,  Next: mclasserase,  Prev: mcat,  Up: Commands
1302
1303 4.6 Mcd
1304 =======
1305
1306 The 'mcd' command is used to change the mtools working directory on the
1307 MS-DOS disk.  It uses the following syntax:
1308
1309      mcd [MSDOSDIRECTORY]
1310
1311    Without arguments, 'mcd' reports the current device and working
1312 directory.  Otherwise, 'mcd' changes the current device and current
1313 working directory relative to an MS-DOS file system.
1314
1315    The environmental variable 'MCWD' may be used to locate the file
1316 where the device and current working directory information is stored.
1317 The default is '$HOME/.mcwd'.  Information in this file is ignored if
1318 the file is more than 6 hours old.
1319
1320    'Mcd' returns 0 on success or 1 on failure.
1321
1322    Unlike MS-DOS versions of 'CD', 'mcd' can be used to change to
1323 another device.  It may be wise to remove old '.mcwd' files at logout.
1324
1325 \1f
1326 File: mtools.info,  Node: mclasserase,  Next: mcopy,  Prev: mcd,  Up: Commands
1327
1328 4.7 Mclasserase
1329 ===============
1330
1331 The 'mclasserase' command is used to wipe memory cards by overwriting it
1332 three times: first with '0xff', then with '0x00', then with '0xff'
1333 again.  The command uses the following syntax:
1334
1335      mclasserase [-d] MSDOSDRIVE
1336
1337    MS-DOS drive is optional, if none is specified, use 'A:'.  If more
1338 than one drive are specified, all but the last are ignored.
1339
1340    'Mclasserase' accepts the following command line options:
1341
1342 'd'
1343      Stop after each erase cycle, for testing purposes
1344 'p'
1345      Not yet implemented
1346
1347    'Mclasserase' returns 0 on success or -1 on failure.
1348
1349 \1f
1350 File: mtools.info,  Node: mcopy,  Next: mdel,  Prev: mclasserase,  Up: Commands
1351
1352 4.8 Mcopy
1353 =========
1354
1355 The 'mcopy' command is used to copy MS-DOS files to and from Unix.  It
1356 uses the following syntax:
1357
1358      mcopy [-bspanvmQT] [-D CLASH_OPTION] SOURCEFILE TARGETFILE
1359      mcopy [-bspanvmQT] [-D CLASH_OPTION] SOURCEFILE [ SOURCEFILES... ] TARGETDIRECTORY
1360      mcopy [-tnvm] MSDOSSOURCEFILE
1361
1362    'Mcopy' copies the specified file to the named file, or copies
1363 multiple files to the named directory.  The source and target can be
1364 either MS-DOS or Unix files.
1365
1366    The use of a drive letter designation on the MS-DOS files, 'a:' for
1367 example, determines the direction of the transfer.  A missing drive
1368 designation implies a Unix file whose path starts in the current
1369 directory.  If a source drive letter is specified with no attached file
1370 name (e.g.  'mcopy a: .'), all files are copied from that drive.
1371
1372    If only a single, MS-DOS source parameter is provided (e.g.  "mcopy
1373 a:foo.exe"), an implied destination of the current directory (''.'') is
1374 assumed.
1375
1376    A filename of ''-'' means standard input or standard output,
1377 depending on its position on the command line.
1378
1379    'Mcopy' accepts the following command line options:
1380
1381 't'
1382      Text file transfer.  Mcopy translates incoming carriage return/line
1383      feeds to line feeds when copying from MS-DOS to Unix, and
1384      vice-versa when copying from Unix to MS-DOS.
1385 'b'
1386      Batch mode.  Optimized for huge recursive copies, but less secure
1387      if a crash happens during the copy.
1388 's'
1389      Recursive copy.  Also copies directories and their contents
1390 'p'
1391      Preserves the attributes of the copied files
1392 'Q'
1393      When mcopying multiple files, quits as soon as one copy fails (for
1394      example due to lacking storage space on the target disk)
1395 'a'
1396      Text (ASCII) file transfer.  'ASCII' translates incoming carriage
1397      return/line feeds to line feeds.
1398 'T'
1399      Text (ASCII) file transfer with character set conversion.  Differs
1400      from '-a' in the 'ASCII' also translates incoming PC-8 characters
1401      to ISO-8859-1 equivalents as far as possible.  When reading DOS
1402      files, untranslatable characters are replaced by ''#''; when
1403      writing DOS files, untranslatable characters are replaced by ''.''.
1404 'n'
1405      No confirmation when overwriting Unix files.  'ASCII' doesn't warn
1406      the user when overwriting an existing Unix file.  If the target
1407      file already exists, and the '-n' option is not in effect, 'mcopy'
1408      asks whether to overwrite the file or to rename the new file (*note
1409      name clashes::) for details).  In order to switch off confirmation
1410      for DOS files, use '-o'.
1411 'm'
1412      Preserve the file modification time.
1413 'v'
1414      Verbose.  Displays the name of each file as it is copied.
1415
1416 4.8.1 Bugs
1417 ----------
1418
1419 Unlike MS-DOS, the '+' operator (append) from MS-DOS is not supported.
1420 However, you may use 'mtype' to produce the same effect:
1421      mtype a:file1 a:file2 a:file3 >unixfile
1422      mtype a:file1 a:file2 a:file3 | mcopy - a:msdosfile
1423
1424 \1f
1425 File: mtools.info,  Node: mdel,  Next: mdeltree,  Prev: mcopy,  Up: Commands
1426
1427 4.9 Mdel
1428 ========
1429
1430 The 'mdel' command is used to delete an MS-DOS file.  Its syntax is:
1431
1432      'mdel' ['-v'] MSDOSFILE [ MSDOSFILES ...  ]
1433
1434    'Mdel' deletes files on an MS-DOS file system.
1435
1436    'Mdel' asks for verification prior to removing a read-only file.
1437
1438 \1f
1439 File: mtools.info,  Node: mdeltree,  Next: mdir,  Prev: mdel,  Up: Commands
1440
1441 4.10 Mdeltree
1442 =============
1443
1444 The 'mdeltree' command is used to delete an MS-DOS file.  Its syntax is:
1445
1446      'mdeltree' ['-v'] MSDOSDIRECTORY [MSDOSDIRECTORIES...]
1447
1448    'Mdeltree' removes a directory and all the files and subdirectories
1449 it contains from an MS-DOS file system.  An error occurs if the
1450 directory to be removed does not exist.
1451
1452 \1f
1453 File: mtools.info,  Node: mdir,  Next: mdu,  Prev: mdeltree,  Up: Commands
1454
1455 4.11 Mdir
1456 =========
1457
1458 The 'mdir' command is used to display an MS-DOS directory.  Its syntax
1459 is:
1460
1461    'mdir' ['-/'] ['-f'] ['-w'] ['-a'] ['-b'] MSDOSFILE [ MSDOSFILES...]
1462
1463    'Mdir' displays the contents of MS-DOS directories, or the entries
1464 for some MS-DOS files.
1465
1466    'Mdir' supports the following command line options:
1467
1468 '/'
1469      Recursive output, just like MS-DOS' '-s' option
1470 'w'
1471      Wide output.  With this option, 'mdir' prints the filenames across
1472      the page without displaying the file size or creation date.
1473 'a'
1474      Also list hidden files.
1475 'f'
1476      Fast.  Do not try to find out free space.  On larger disks, finding
1477      out the amount of free space takes up some non trivial amount of
1478      time, as the whole FAT must be read in and scanned.  The '-f' flag
1479      bypasses this step.  This flag is not needed on FAT32 file systems,
1480      which store the size explicitly.
1481 'b'
1482      Concise listing.  Lists each directory name or filename, one per
1483      line (including the filename extension).  This switch displays no
1484      heading information and no summary.  Only a newline separated list
1485      of pathnames is displayed.
1486
1487    An error occurs if a component of the path is not a directory.
1488
1489 \1f
1490 File: mtools.info,  Node: mdu,  Next: mformat,  Prev: mdir,  Up: Commands
1491
1492 4.12 Mdu
1493 ========
1494
1495 'Mdu' is used to list the space occupied by a directory, its
1496 subdirectories and its files.  It is similar to the 'du' command on
1497 Unix.  The unit used are clusters.  Use the minfo command to find out
1498 the cluster size.
1499
1500    'mdu' ['-a'] [ MSDOSFILES ... ]
1501
1502 'a'
1503      All files.  List also the space occupied for individual files.
1504 's'
1505      Only list the total space, don't give details for each
1506      subdirectory.
1507
1508 \1f
1509 File: mtools.info,  Node: mformat,  Next: mkmanifest,  Prev: mdu,  Up: Commands
1510
1511 4.13 Mformat
1512 ============
1513
1514 The 'mformat' command is used to add an MS-DOS file system to a
1515 low-level formatted diskette.  Its syntax is:
1516
1517      'mformat' ['-t' CYLINDERS|'-T' TOT_SECTORS] ['-h' HEADS] ['-s' SECTORS]
1518        ['-f' SIZE] ['-1'] ['-4'] ['-8']
1519        ['-v' VOLUME_LABEL]
1520        ['-F'] ['-S' SIZECODE]
1521        ['-M' SOFTWARE_SECTOR_SIZE]
1522        ['-N' SERIAL_NUMBER] ['-a']
1523        ['-C'] ['-H' HIDDEN_SECTORS] ['-I' FSVERSION]
1524        ['-r' ROOT_SECTORS] ['-L' FAT_LEN]
1525        ['-B' BOOT_SECTOR] ['-k']
1526        ['-m' MEDIA_DESCRIPTOR]
1527        ['-K' BACKUP_BOOT]
1528        ['-R' NB_RESERVED_SECTORS]
1529        ['-c' CLUSTERS_PER_SECTOR]
1530        ['-d' FAT_COPIES]
1531        ['-X'] ['-2' SECTORS_ON_TRACK_0] ['-3']
1532        ['-0' RATE_ON_TRACK_0] ['-A' RATE_ON_OTHER_TRACKS]
1533        DRIVE:
1534
1535    'Mformat' adds a minimal MS-DOS file system (boot sector, FAT, and
1536 root directory) to a diskette that has already been formatted by a Unix
1537 low-level format.
1538
1539    The following options are supported: (The S, 2, 1 and M options may
1540 not exist if this copy of mtools has been compiled without the USE_2M
1541 option)
1542
1543    The following options are the same as for MS-DOS's format command:
1544
1545 'v'
1546      Specifies the volume label.  A volume label identifies the disk and
1547      can be a maximum of 11 characters.  If you omit the -v switch,
1548      mformat will assign no label to the disk.
1549 'f'
1550      Specifies the size of the DOS file system to format.  Only a
1551      certain number of predefined sizes are supported by this flag; for
1552      others use the -h/-t/-s flags.  The following sizes are supported:
1553      160
1554           160K, single-sided, 8 sectors per track, 40 cylinders (for 5
1555           1/4 DD)
1556      180
1557           160K, single-sided, 9 sectors per track, 40 cylinders (for 5
1558           1/4 DD)
1559      320
1560           320K, double-sided, 8 sectors per track, 40 cylinders (for 5
1561           1/4 DD)
1562      360
1563           360K, double-sided, 9 sectors per track, 40 cylinders (for 5
1564           1/4 DD)
1565      720
1566           720K, double-sided, 9 sectors per track, 80 cylinders (for 3
1567           1/2 DD)
1568      1200
1569           1200K, double-sided, 15 sectors per track, 80 cylinders (for 5
1570           1/4 HD)
1571      1440
1572           1440K, double-sided, 18 sectors per track, 80 cylinders (for 3
1573           1/2 HD)
1574      2880
1575           2880K, double-sided, 36 sectors per track, 80 cylinders (for 3
1576           1/2 ED)
1577
1578 't'
1579      Specifies the number of tracks on the disk.
1580 'T'
1581      Specifies the number of total sectors on the disk.  Only one of
1582      these 2 options may be specified (tracks or total sectors)
1583 'h'
1584      The number of heads (sides).
1585 's'
1586      Specifies the number of sectors per track.  If the 2m option is
1587      given, number of 512-byte sector equivalents on generic tracks
1588      (i.e.  not head 0 track 0).  If the 2m option is not given, number
1589      of physical sectors per track (which may be bigger than 512 bytes).
1590
1591 '1'
1592      Formats a single side (equivalent to -h 1)
1593
1594 '4'
1595      Formats a 360K double-sided disk (equivalent to -f 360).  When used
1596      together with -the 1 switch, this switch formats a 180K disk
1597
1598 '8'
1599      Formats a disk with 8 sectors per track.
1600
1601    MS-DOS format's 'q', 'u' and 'b' options are not supported, and 's'
1602 has a different meaning.
1603
1604    The following options are specific to mtools:
1605
1606 'F'
1607      Format the partition as FAT32.
1608
1609 'S'
1610      The size code.  The size of the sector is 2 ^ (sizecode + 7).
1611 'X'
1612      formats the disk as an XDF disk.  *Note XDF::, for more details.
1613      The disk has first to be low-level formatted using the xdfcopy
1614      utility included in the fdutils package.  XDF disks are used for
1615      instance for OS/2 install disks.
1616 '2'
1617      2m format.  The parameter to this option describes the number of
1618      sectors on track 0, head 0.  This option is recommended for sectors
1619      bigger than normal.
1620 '3'
1621      don't use a 2m format, even if the current geometry of the disk is
1622      a 2m geometry.
1623 '0'
1624      Data transfer rate on track 0
1625 'A'
1626      Data transfer rate on tracks other than 0
1627 'M'
1628      software sector size.  This parameter describes the sector size in
1629      bytes used by the MS-DOS file system.  By default it is the
1630      physical sector size.
1631 'N'
1632      Uses the requested serial number, instead of generating one
1633      automatically
1634 'a'
1635      If this option is given, an Atari style serial number is generated.
1636      Ataris store their serial number in the OEM label.
1637 'C'
1638      creates the disk image file to install the MS-DOS file system on
1639      it.  Obviously, this is useless on physical devices such as
1640      floppies and hard disk partitions, but is interesting for image
1641      files.
1642 'H'
1643      number of hidden sectors.  This parameter is useful for formatting
1644      hard disk partition, which are not aligned on track boundaries
1645      (i.e.  first head of first track doesn't belong to the partition,
1646      but contains a partition table).  In that case the number of hidden
1647      sectors is in general the number of sectors per cylinder.  This is
1648      untested.
1649 'I'
1650      Sets the fsVersion id when formatting a FAT32 drive.  In order to
1651      find this out, run minfo on an existing FAT32 drive, and mail me
1652      about it, so I can include the correct value in future versions of
1653      mtools.
1654 'c'
1655      Sets the size of a cluster (in sectors).  If this cluster size
1656      would generate a FAT that too big for its number of bits, mtools
1657      automatically increases the cluster size, until the FAT is small
1658      enough.  If no cluster size is specified explicitly, mtools uses a
1659      default value as described in section "Number of sectors per
1660      cluster" below.
1661 'd'
1662      Sets the number of FAT copies.  Default is 2.  This setting can
1663      also be specified using the 'MTOOLS_NFATS' environment variable.
1664 'r'
1665      Sets the size of the root directory (in sectors).  Only applicable
1666      to 12 and 16 bit FATs.  This setting can also be specified using
1667      the 'MTOOLS_DIR_LEN' environment variable.
1668 'L'
1669      Sets the length of the FAT.
1670 'B'
1671      Use the boot sector stored in the given file or device, instead of
1672      using its own.  Only the geometry fields are updated to match the
1673      target disks parameters.
1674 'k'
1675      Keep the existing boot sector as much as possible.  Only the
1676      geometry fields and other similar file system data are updated to
1677      match the target disks parameters.
1678 'K'
1679      Sets the sector number where the backup of the boot sector should
1680      be stored (only relevant on FAT32).
1681 'R'
1682      Sets the number of reserved sectors for this filesystem.  This must
1683      be at least 1 for non-FAT32 disks, and at least 3 for FAT disks (in
1684      order to accomodate the boot sector, the info sector and the backup
1685      boot sector).
1686
1687 'm'
1688      Use a non-standard media descriptor byte for this disk.  The media
1689      descriptor is stored at position 21 of the boot sector, and as
1690      first byte in each FAT copy.  Using this option may confuse DOS or
1691      older mtools version, and may make the disk unreadable.  Only use
1692      if you know what you are doing.
1693
1694    To format a diskette at a density other than the default, you must
1695 supply (at least) those command line parameters that are different from
1696 the default.
1697
1698    'Mformat' returns 0 on success or 1 on failure.
1699
1700    It doesn't record bad block information to the Fat, use 'mbadblocks'
1701 for that.
1702
1703 4.13.1 Number of sectors per cluster
1704 ------------------------------------
1705
1706 If the user indicates no cluster size, mformat figures out a default
1707 value for it.
1708
1709    For FAT32 it uses the following table to determine the number of
1710 sectors per cluster, depending on the total number of sectors on the
1711 filesystem.
1712
1713    more than 32*1024*1024*2: 64 sectors
1714 between 16*1024*1024*2 and 32*1024*1024*2: 32 sectors
1715 between 8*1024*1024*2 and 16*1024*1024*2: 16 sectors
1716 between 260*1024*2 and 81024*1024*2: 1 sectors
1717
1718    This is derived from information on page 20 of Microsoft's
1719 'fatgen103' document, which currently can be found at the following
1720 address:
1721
1722    'https://staff.washington.edu/dittrich/misc/fatgen103.pdf'
1723
1724    For FAT12 and FAT16, mformat uses an iterative approach, where it
1725 starts with a set value, which it doubles until it is able to fill up
1726 the disk using that cluster size and a number of cluster less than the
1727 maximum allowed.
1728
1729    The starting value is 1 for disks with one head or less than 2000
1730 sectors, and 2 for disks with more than one head, and more than 2000
1731 sectors.
1732
1733    The number of sectors per cluster cannot go beyond 128.
1734
1735 \1f
1736 File: mtools.info,  Node: mkmanifest,  Next: minfo,  Prev: mformat,  Up: Commands
1737
1738 4.14 Mkmanifest
1739 ===============
1740
1741 The 'mkmanifest' command is used to create a shell script (packing list)
1742 to restore Unix filenames.  Its syntax is:
1743
1744    'mkmanifest' [ FILES ]
1745
1746    'Mkmanifest' creates a shell script that aids in the restoration of
1747 Unix filenames that got clobbered by the MS-DOS filename restrictions.
1748 MS-DOS filenames are restricted to 8 character names, 3 character
1749 extensions, upper case only, no device names, and no illegal characters.
1750
1751    The mkmanifest program is compatible with the methods used in 'pcomm,
1752 arc,' and 'mtools' to change perfectly good Unix filenames to fit the
1753 MS-DOS restrictions.  This command is only useful if the target system
1754 which will read the diskette cannot handle VFAT long names.
1755
1756 4.14.1 Example
1757 --------------
1758
1759 You want to copy the following Unix files to a MS-DOS diskette (using
1760 the 'mcopy' command).
1761
1762        very_long_name
1763        2.many.dots
1764        illegal:
1765        good.c
1766        prn.dev
1767        Capital
1768
1769    'ASCII' converts the names to:
1770
1771        very_lon
1772        2xmany.dot
1773        illegalx
1774        good.c
1775        xprn.dev
1776        capital
1777
1778    The command:
1779      mkmanifest very_long_name 2.many.dots illegal: good.c prn.dev Capital >manifest
1780    would produce the following:
1781        mv very_lon very_long_name
1782        mv 2xmany.dot 2.many.dots
1783        mv illegalx illegal:
1784        mv xprn.dev prn.dev
1785        mv capital Capital
1786
1787    Notice that "good.c" did not require any conversion, so it did not
1788 appear in the output.
1789
1790    Suppose I've copied these files from the diskette to another Unix
1791 system, and I now want the files back to their original names.  If the
1792 file "manifest" (the output captured above) was sent along with those
1793 files, it could be used to convert the filenames.
1794
1795 4.14.2 Bugs
1796 -----------
1797
1798 The short names generated by 'mkmanifest' follow the old convention
1799 (from mtools-2.0.7) and not the one from Windows 95 and mtools-3.0.
1800
1801 \1f
1802 File: mtools.info,  Node: minfo,  Next: mlabel,  Prev: mkmanifest,  Up: Commands
1803
1804 4.15 Minfo
1805 ==========
1806
1807 The 'minfo' command prints the parameters of a MS-DOS file system, such
1808 as number of sectors, heads and cylinders.  It also prints an mformat
1809 command line which can be used to create a similar MS-DOS file system on
1810 another media.  However, this doesn't work with 2m or XDF media, and
1811 with MS-DOS 1.0 file systems
1812      'minfo' DRIVE:
1813
1814    Minfo supports the following option:
1815 'v'
1816      Prints a hexdump of the boot sector, in addition to the other
1817      information
1818
1819 \1f
1820 File: mtools.info,  Node: mlabel,  Next: mmd,  Prev: minfo,  Up: Commands
1821
1822 4.16 Mlabel
1823 ===========
1824
1825 The 'mlabel' command adds a volume label to a disk.  Its syntax is:
1826      'mlabel' ['-vcsn'] ['-N' SERIAL] DRIVE:[NEW_LABEL]
1827
1828    'Mlabel' displays the current volume label, if present.  If NEW_LABEL
1829 is not given, and if neither the 'c' nor the 's' options are set, it
1830 prompts the user for a new volume label.  To delete an existing volume
1831 label, press return at the prompt.
1832
1833    The label is limited to 11 single-byte characters, e.g.
1834 'Name1234567'.
1835
1836    Reasonable care is taken to create a valid MS-DOS volume label.  If
1837 an invalid label is specified, 'mlabel' changes the label (and displays
1838 the new label if the verbose mode is set).  'Mlabel' returns 0 on
1839 success or 1 on failure.
1840
1841    Mlabel supports the following options:
1842 'c'
1843      Clears an existing label, without prompting the user
1844 's'
1845      Shows the existing label, without prompting the user.
1846 'n'
1847      Assigns a new (random) serial number to the disk
1848 'N SERIAL'
1849      Sets the supplied serial number.  The serial number should be
1850      supplied as an 8 digit hexadecimal number, without spaces
1851
1852 \1f
1853 File: mtools.info,  Node: mmd,  Next: mmount,  Prev: mlabel,  Up: Commands
1854
1855 4.17 Mmd
1856 ========
1857
1858 The 'mmd' command is used to make an MS-DOS subdirectory.  Its syntax
1859 is:
1860
1861    'mmd' ['-D' CLASH_OPTION] MSDOSDIRECTORY [ MSDOSDIRECTORIES... ]
1862
1863    'Mmd' makes a new directory on an MS-DOS file system.  An error
1864 occurs if the directory already exists.
1865
1866 \1f
1867 File: mtools.info,  Node: mmount,  Next: mmove,  Prev: mmd,  Up: Commands
1868
1869 4.18 Mmount
1870 ===========
1871
1872 The 'mmount' command is used to mount an MS-DOS disk.  It is only
1873 available on Linux, as it is only useful if the OS kernel allows to
1874 configure the disk geometry.  Its syntax is:
1875
1876    'mmount' MSDOSDRIVE [MOUNTARGS]
1877
1878    'Mmount' reads the boot sector of an MS-DOS disk, configures the
1879 drive geometry, and finally mounts it passing 'mountargs' to 'mount. '
1880 If no mount arguments are specified, the name of the device is used.  If
1881 the disk is write protected, it is automatically mounted read only.
1882
1883 \1f
1884 File: mtools.info,  Node: mmove,  Next: mpartition,  Prev: mmount,  Up: Commands
1885
1886 4.19 Mmove
1887 ==========
1888
1889 The 'mmove' command is used to moves or renames an existing MS-DOS file
1890 or subdirectory.
1891      'mmove' ['-v'] ['-D' CLASH_OPTION] SOURCEFILE TARGETFILE
1892      'mmove' ['-v']  ['-D' CLASH_OPTION] SOURCEFILE [ SOURCEFILES... ] TARGETDIRECTORY
1893    'Mmove' moves or renames an existing MS-DOS file or subdirectory.
1894 Unlike the MS-DOS version of 'MOVE', 'mmove' is able to move
1895 subdirectories.  Files or directories can only be moved within one file
1896 system.  Data cannot be moved from MS-DOS to Unix or vice-versa.  If you
1897 omit the drive letter from the target file or directory, the same letter
1898 as for the source is assumed.  If you omit the drive letter from all
1899 parameters, drive a: is assumed by default.
1900
1901 \1f
1902 File: mtools.info,  Node: mpartition,  Next: mrd,  Prev: mmove,  Up: Commands
1903
1904 4.20 Mpartition
1905 ===============
1906
1907 The 'mpartition' command is used to create MS-DOS file systems as
1908 partitions.  This is intended to be used on non-Linux systems, i.e.
1909 systems where fdisk and easy access to SCSI devices are not available.
1910 This command only works on drives whose partition variable is set.
1911
1912      'mpartition' '-p' DRIVE
1913      'mpartition' '-r' DRIVE
1914      'mpartition' '-I' ['-B' BOOTSECTOR] DRIVE
1915      'mpartition' '-a' DRIVE
1916      'mpartition' '-d' DRIVE
1917      'mpartition' '-c' ['-s' SECTORS] ['-h' HEADS]
1918      ['-t' CYLINDERS] ['-v' ['-T' TYPE] ['-b'
1919      BEGIN] ['-l' length] ['-f']
1920
1921
1922    Mpartition supports the following operations:
1923
1924 'p'
1925      Prints a command line to recreate the partition for the drive.
1926      Nothing is printed if the partition for the drive is not defined,
1927      or an inconsistency has been detected.  If verbose ('-v') is also
1928      set, prints the current partition table.
1929 'r'
1930      Removes the partition described by DRIVE.
1931 'I'
1932      Initializes the partition table, and removes all partitions.
1933 'c'
1934      Creates the partition described by DRIVE.
1935 'a'
1936      "Activates" the partition, i.e.  makes it bootable.  Only one
1937      partition can be bootable at a time.
1938 'd'
1939      "Deactivates" the partition, i.e.  makes it unbootable.
1940
1941    If no operation is given, the current settings are printed.
1942
1943    For partition creations, the following options are available:
1944 's SECTORS'
1945      The number of sectors per track of the partition (which is also the
1946      number of sectors per track for the whole drive).
1947 'h HEADS'
1948      The number of heads of the partition (which is also the number of
1949      heads for the whole drive).  By default, the geometry information
1950      (number of sectors and heads) is figured out from neighboring
1951      partition table entries, or guessed from the size.
1952 't CYLINDERS'
1953      The number of cylinders of the partition (not the number of
1954      cylinders of the whole drive.
1955 'b BEGIN'
1956      The starting offset of the partition, expressed in sectors.  If
1957      begin is not given, mpartition lets the partition begin at the
1958      start of the disk (partition number 1), or immediately after the
1959      end of the previous partition.
1960 'l LENGTH'
1961      The size (length) of the partition, expressed in sectors.  If end
1962      is not given, mpartition figures out the size from the number of
1963      sectors, heads and cylinders.  If these are not given either, it
1964      gives the partition the biggest possible size, considering disk
1965      size and start of the next partition.
1966
1967    The following option is available for all operation which modify the
1968 partition table:
1969 'f'
1970      Usually, before writing back any changes to the partition,
1971      mpartition performs certain consistency checks, such as checking
1972      for overlaps and proper alignment of the partitions.  If any of
1973      these checks fails, the partition table is not changes.  The '-f'
1974      allows you to override these safeguards.
1975
1976    The following options are available for all operations:
1977 'v'
1978      Together with '-p' prints the partition table as it is now (no
1979      change operation), or as it is after it is modified.
1980 'vv'
1981      If the verbosity flag is given twice, mpartition will print out a
1982      hexdump of the partition table when reading it from and writing it
1983      to the device.
1984
1985    The following option is available for partition table initialization:
1986 'B BOOTSECTOR'
1987      Reads the template master boot record from file BOOTSECTOR.
1988
1989 4.20.1 Choice of partition type
1990 -------------------------------
1991
1992 Mpartition proceeds as follows to pick a type for the partition:
1993
1994    - FAT32 partitions are assigned type 0x0C ("'Win95 FAT32, LBA'")
1995
1996    - For all others, if the partition fits entirely within the 65536
1997      sector of the disk, assign 0x01 ("'DOS FAT12, CHS'") for FAT12
1998      partition and 0x04 ("'DOS FAT16, CHS'") for FAT16 partitions
1999
2000    - If not covered by the above, assign 0x06 ("'DOS BIG FAT16 CHS'") if
2001      partition fits entirely within the first 1024 cylinders (CHS mode)
2002
2003    - All remaining cases get 0x0E ("'Win95 BIG FAT16, LBA'")
2004
2005    If number of fat bits is not known (not specified in drive's
2006 definition), then FAT12 is assumed for all drives with less than 4096
2007 sectors, and FAT16 for those with more than 4096 sectors.
2008
2009    This corresponds more or less to the definitions outlined at
2010 'https://en.wikipedia.org/wiki/Partition_type#List_of_partition_IDs' and
2011 'https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-2000-server/cc977219(v=technet.10)',
2012 with two notable differences:
2013
2014    - If fat bits are unknown, the reference documents consider drives
2015      with less than 32680 sectors to be FAT12.  Mtools uses 4096 sectors
2016      as the cutoff point, as older versions of DOS only support FAT12 on
2017      disks with less than 4096 sectors (and these older versions are the
2018      ones which would be most likely to use FAT12 in the first place).
2019
2020    - The reference documents use a 8GB (wikipedia) or a 4GB (Microsoft)
2021      cutoff between 0x06 ('DOS BIG FAT16 CHS') and 0x0E. Mtools uses
2022      1024 cylinders.  This is because any partition beyond 1024
2023      cylinders must be LBA and cannot be CHS. 8GB works out to be the
2024      biggest capacity which can be represented as CHS (63 sectors, 255
2025      heads and 1024 cylinders).  4GB is the capacity limit for windows
2026      2000, so it makes sense that a documentation for windows 2000 would
2027      specify this as the upper limit for any partition type.
2028
2029 \1f
2030 File: mtools.info,  Node: mrd,  Next: mren,  Prev: mpartition,  Up: Commands
2031
2032 4.21 Mrd
2033 ========
2034
2035 The 'mrd' command is used to remove an MS-DOS subdirectory.  Its syntax
2036 is:
2037
2038      'mrd' ['-v'] MSDOSDIRECTORY [ MSDOSDIRECTORIES... ]
2039
2040    'Mrd' removes a directory from an MS-DOS file system.  An error
2041 occurs if the directory does not exist or is not empty.
2042
2043 \1f
2044 File: mtools.info,  Node: mren,  Next: mshortname,  Prev: mrd,  Up: Commands
2045
2046 4.22 Mren
2047 =========
2048
2049 The 'mren' command is used to rename or move an existing MS-DOS file or
2050 subdirectory.  Its syntax is:
2051
2052      'mren' ['-voOsSrRA'] SOURCEFILE TARGETFILE
2053
2054    'Mren' renames an existing file on an MS-DOS file system.
2055
2056    In verbose mode, 'Mren' displays the new filename if the name
2057 supplied is invalid.
2058
2059    If the first syntax is used (only one source file), and if the target
2060 name doesn't contain any slashes or colons, the file (or subdirectory)
2061 is renamed in the same directory, instead of being moved to the current
2062 'mcd' directory as would be the case with 'mmove'.  Unlike the MS-DOS
2063 version of 'REN', 'mren' can be used to rename directories.
2064
2065 \1f
2066 File: mtools.info,  Node: mshortname,  Next: mshowfat,  Prev: mren,  Up: Commands
2067
2068 4.23 Mshortname
2069 ===============
2070
2071 The 'mshortname' command is used to display the short name of a file.
2072 Syntax:
2073
2074      'mshortname' FILES
2075
2076    The shortname is displayed as it is stored in raw format on disk,
2077 without any character set conversion.
2078
2079 \1f
2080 File: mtools.info,  Node: mshowfat,  Next: mtoolstest,  Prev: mshortname,  Up: Commands
2081
2082 4.24 Mshowfat
2083 =============
2084
2085 The 'mshowfat' command is used to display the FAT entries for a file.
2086 Syntax:
2087
2088      'mshowfat' ['-o' OFFSET] FILES
2089
2090    If no offset is given, a list of all clusters occupied by the file is
2091 printed.  If an offset is given, only the number of the cluster
2092 containing that offset is printed.
2093
2094 \1f
2095 File: mtools.info,  Node: mtoolstest,  Next: mtype,  Prev: mshowfat,  Up: Commands
2096
2097 4.25 Mtoolstest
2098 ===============
2099
2100 The 'mtoolstest' command is used to tests the mtools configuration
2101 files.  To invoke it, just type 'mtoolstest' without any arguments.
2102 'Mtoolstest' reads the mtools configuration files, and prints the
2103 cumulative configuration to 'stdout'.  The output can be used as a
2104 configuration file itself (although you might want to remove redundant
2105 clauses).  You may use this program to convert old-style configuration
2106 files into new style configuration files.
2107
2108 \1f
2109 File: mtools.info,  Node: mtype,  Next: mzip,  Prev: mtoolstest,  Up: Commands
2110
2111 4.26 Mtype
2112 ==========
2113
2114 The 'mtype' command is used to display contents of an MS-DOS file.  Its
2115 syntax is:
2116
2117      'mtype' ['-ts'] MSDOSFILE [ MSDOSFILES... ]
2118
2119    'Mtype' displays the specified MS-DOS file on the screen.
2120
2121    In addition to the standard options, 'Mtype' allows the following
2122 command line options:
2123
2124 't'
2125      Text file viewing.  'Mtype' translates incoming carriage
2126      return/line feeds to line feeds.
2127 's'
2128      'Mtype' strips the high bit from the data.
2129
2130    The 'mcd' command may be used to establish the device and the current
2131 working directory (relative to MS-DOS), otherwise the default is 'A:/'.
2132
2133    'Mtype' returns 0 on success, 1 on utter failure, or 2 on partial
2134 failure.
2135
2136    Unlike the MS-DOS version of 'TYPE', 'mtype' allows multiple
2137 arguments.
2138
2139 \1f
2140 File: mtools.info,  Node: mzip,  Prev: mtype,  Up: Commands
2141
2142 4.27 Mzip
2143 =========
2144
2145 The 'mzip' command is used to issue ZIP disk specific commands on Linux,
2146 Solaris or HP-UX. Its syntax is:
2147
2148      'mzip' ['-epqrwx']
2149
2150    'Mzip' allows the following command line options:
2151
2152 'e'
2153      Ejects the disk.
2154 'f'
2155      Force eject even if the disk is mounted (must be given in addition
2156      to '-e').
2157 'r'
2158      Write protect the disk.
2159 'w'
2160      Remove write protection.
2161 'p'
2162      Password write protect.
2163 'x'
2164      Password protect
2165 'u'
2166      Temporarily unprotect the disk until it is ejected.  The disk
2167      becomes writable, and reverts back to its old state when ejected.
2168 'q'
2169      Queries the status
2170
2171    To remove the password, set it to one of the password-less modes '-r'
2172 or '-w': mzip will then ask you for the password, and unlock the disk.
2173 If you have forgotten the password, you can get rid of it by low-level
2174 formatting the disk (using your SCSI adapter's BIOS setup).
2175
2176    The ZipTools disk shipped with the drive is also password protected.
2177 On MS-DOS or on a Mac, this password is automatically removed once the
2178 ZipTools have been installed.  From various articles posted to Usenet, I
2179 learned that the password for the tools disk is 'APlaceForYourStuff'(1).
2180 Mzip knows about this password, and tries it first, before prompting you
2181 for a password.  Thus 'mzip -w z:' unlocks the tools disk(2).  The tools
2182 disk is formatted in a special way so as to be usable both in a PC and
2183 in a Mac.  On a PC, the Mac file system appears as a hidden file named
2184 'partishn.mac'.  You may erase it to reclaim the 50 Megs of space taken
2185 up by the Mac file system.
2186
2187 4.27.1 Bugs
2188 -----------
2189
2190 This command is a big kludge.  A proper implementation would take a
2191 rework of significant parts of mtools, but unfortunately I don't have
2192 the time for this right now.  The main downside of this implementation
2193 is that it is inefficient on some architectures (several successive
2194 calls to mtools, which defeats mtools' caching).
2195
2196    ---------- Footnotes ----------
2197
2198    (1) To see the articles, search for 'APlaceForYourStuff' using Google
2199 Groups
2200
2201    (2) I didn't know about this yet when I bought my own Zip drive.
2202 Thus I ended up reformatting my tools disk, and hence I haven't had the
2203 opportunity to test the password yet.  If anybody still has their tools
2204 disk with the original password, could you try it out?  Thanks in
2205 advance
2206
2207 \1f
2208 File: mtools.info,  Node: Compiling mtools,  Next: Porting mtools,  Prev: Commands,  Up: Top
2209
2210 5 Architecture specific compilation flags
2211 *****************************************
2212
2213 To compile mtools, first invoke './configure' before 'make'.  In
2214 addition to the standard 'autoconfigure' flags, there are two
2215 architecture specific flags available.
2216
2217 './configure --enable-xdf'
2218 './configure --disable-xdf'
2219      Enables support for XDF disks.  This is on by default.  *Note
2220      XDF::, for details.
2221 './configure --enable-vold'
2222 './configure --disable-vold'
2223      Enables support for vold on Solaris.  When used in conjunction with
2224      vold, mtools should use different device nodes than for direct
2225      access.
2226
2227 './configure --enable-new-vold'
2228 './configure --disable-new-vold'
2229      Enables new support for vold on Solaris.  This is supposed to work
2230      more smoothly than the old support.
2231
2232 './configure --enable-floppyd'
2233 './configure --disable-floppyd'
2234      Enables support for floppyd.  By default, floppyd support is
2235      enabled as long as the necessary X includes and libraries are
2236      available.
2237
2238 \1f
2239 File: mtools.info,  Node: Porting mtools,  Next: Command Index,  Prev: Compiling mtools,  Up: Top
2240
2241 6 Porting mtools to architectures which are not supported yet
2242 *************************************************************
2243
2244 This chapter is only interesting for those who want to port mtools to an
2245 architecture which is not yet supported.  For most common systems,
2246 default drives are already defined.  If you want to add default drives
2247 for a still unsupported system, run configuration.guess, to see which
2248 identification autoconf uses for that system.  This identification is of
2249 the form cpu-vendor-os (for example sparc-sun-sunos).  The cpu and the
2250 OS parts are passed to the compiler as preprocessor flags.  The OS part
2251 is passed to the compiler in three forms.
2252   1. The complete OS name, with dots replaced by underscores.  SCO3.2v2
2253      would yield sco3_2v2
2254   2. The base OS name.  SCO3.2v2 would yield Sco
2255   3. The base OS name plus its major version.  SCO3.2v2 would yield Sco3
2256
2257    All three versions are passed, if they are different.
2258
2259    To define the devices, use the entries for the systems that are
2260 already present as templates.  In general, they have the following form:
2261
2262      #if (defined (my_cpu) && defined(my_os))
2263      #define predefined_devices
2264      struct device devices[] = {
2265              { "/dev/first_drive", 'drive_letter', drive_description},
2266              ...
2267              { "/dev/last_drive", 'drive_letter', drive_description}
2268      }
2269      #define INIT_NOOP
2270      #endif
2271
2272    "/dev/first_drive" is the name of the device or image file
2273 representing the drive.  Drive_letter is a letter ranging from a to z
2274 giving access to the drive.  Drive_description describes the type of the
2275 drive:
2276 'ED312'
2277      extra density (2.88M) 3 1/2 disk
2278 'HD312'
2279      high density 3 1/2 disk
2280 'DD312'
2281      double density 3 1/2 disk
2282 'HD514'
2283      high density 5 1/4 disk
2284 'DD514'
2285      double density 5 1/4 disk
2286 'DDsmall'
2287      8 sector double density 5 1/4 disk
2288 'SS514'
2289      single sided double density 5 1/4 disk
2290 'SSsmall'
2291      single sided 8 sector double density 5 1/4 disk
2292 'GENFD'
2293      generic floppy drive (12 bit FAT)
2294 'GENHD'
2295      generic hard disk (16 bit FAT)
2296 'GEN'
2297      generic device (all parameters match)
2298 'ZIPJAZ(flags)'
2299      generic ZIP drive using normal access.  This uses partition 4.
2300      'Flags' are any special flags to be passed to open.
2301 'RZIPJAZ(flags)'
2302      generic ZIP drive using raw SCSI access.  This uses partition 4.
2303      'Flags' are any special flags to be passed to open.
2304 'REMOTE'
2305      the remote drive used for floppyd.  Unlike the other items, this
2306      macro also includes the file name ($DISPLAY) and the drive letter
2307      (X)
2308
2309    Entries may be described in more detail:
2310       fat_bits,open_flags,cylinders,heads,sectors,DEF_ARG
2311    or, if you need to describe an offset (file system doesn't start at
2312 beginning of file system)
2313       fat_bits, open_flags, cylinders, heads, sectors, offset, DEF_ARG0
2314
2315 'fat_bits'
2316      is either 12, 16 or 0.  0 means that the device accepts both types
2317      of FAT.
2318 'open_flags'
2319      may include flags such as O_NDELAY, or O_RDONLY, which might be
2320      necessary to open the device.  0 means no special flags are needed.
2321 'cylinders,heads,sectors'
2322      describe the geometry of the disk.  If cylinders is 0, the heads
2323      and sectors parameters are ignored, and the drive accepts any
2324      geometry.
2325 'offset'
2326      is used if the DOS file system doesn't begin at the start of the
2327      device or image file.  This is mostly useful for Atari Ram disks
2328      (which contain their device driver at the beginning of the file) or
2329      for DOS emulator images (which may represent a partitioned device.
2330
2331    Definition of defaults in the devices file should only be done if
2332 these same devices are found on a large number of hosts of this type.
2333 In that case, could you also let me know about your new definitions, so
2334 that I can include them into the next release.  For purely local file, I
2335 recommend that you use the '/etc/mtools.conf' and '~/.mtoolsrc'
2336 configuration files.
2337
2338    However, the devices files also allows to supply geometry setting
2339 routines.  These are necessary if you want to access high capacity
2340 disks.
2341
2342    Two routines should be supplied:
2343
2344   1. Reading the current parameters
2345           static inline int get_parameters(int fd, struct generic_floppy_struct *floppy)
2346
2347      This probes the current configured geometry, and return it in the
2348      structure generic_floppy_struct (which must also be declared).  Fd
2349      is an open file descriptor for the device, and buf is an already
2350      filled in stat structure, which may be useful.  This routine should
2351      return 1 if the probing fails, and 0 otherwise.
2352
2353   2. Setting new parameters
2354           static inline int set_parameters(int fd, struct generic_floppy_struct *floppy)
2355                                            struct stat *buf)
2356      This configures the geometry contained in floppy on the file
2357      descriptor fd.  Buf is the result of a stat call (already filled
2358      in).  This should return 1 if the new geometry cannot be
2359      configured, and 0 otherwise.
2360
2361    A certain number of preprocessor macros should also be supplied:
2362
2363 'TRACKS(floppy)'
2364      refers to the track field in the floppy structure
2365 'HEADS(floppy)'
2366      refers to the heads field in the floppy structure
2367 'SECTORS(floppy)'
2368      refers to the sectors per track field in the floppy structure
2369 'SECTORS_PER_DISK(floppy)'
2370      refers to the sectors per disk field in the floppy structure (if
2371      applicable, otherwise leave undefined)
2372
2373 'BLOCK_MAJOR'
2374      major number of the floppy device, when viewed as a block device
2375
2376 'CHAR_MAJOR'
2377      major number of the floppy device, when viewed as a character
2378      device (a.k.a.  "raw" device, used for fsck) (leave this undefined,
2379      if your OS doesn't have raw devices)
2380
2381    For the truly high capacity formats (XDF, 2m, etc), there is no clean
2382 and documented interface yet.
2383
2384 \1f
2385 File: mtools.info,  Node: Command Index,  Next: Variable Index,  Prev: Porting mtools,  Up: Top
2386
2387 Command Index
2388 *************
2389
2390 \1f
2391 File: mtools.info,  Node: Variable Index,  Next: Concept Index,  Prev: Command Index,  Up: Top
2392
2393 Variable index
2394 **************
2395
2396 \0\b[index\0\b]
2397 * Menu:
2398
2399 * cylinders:                             geometry description. (line 60)
2400 * drive:                                 general information.  (line  6)
2401 * exclusive:                             open flags.           (line  6)
2402 * fat_bits:                              miscellaneous variables.
2403                                                                (line 11)
2404 * file:                                  location information. (line 10)
2405 * filter:                                miscellaneous flags.  (line 78)
2406 * heads:                                 geometry description. (line 63)
2407 * mformat_only:                          miscellaneous flags.  (line 74)
2408 * MTOOLSRC:                              Configuration.        (line  9)
2409 * MTOOLS_DOTTED_DIR:                     global variables.     (line  6)
2410 * MTOOLS_FAT_COMPATIBILITY:              global variables.     (line  6)
2411 * MTOOLS_LOCK_TIMEOUT:                   global variables.     (line  6)
2412 * MTOOLS_LOWER_CASE:                     global variables.     (line  6)
2413 * MTOOLS_NAME_NUMERIC_TAIL:              global variables.     (line  6)
2414 * MTOOLS_NO_VFAT:                        global variables.     (line  6)
2415 * MTOOLS_SKIP_CHECK:                     global variables.     (line  6)
2416 * MTOOLS_TWENTY_FOUR_HOUR_CLOCK:         global variables.     (line  6)
2417 * nodelay:                               open flags.           (line  6)
2418 * sectors:                               geometry description. (line 65)
2419 * sync:                                  open flags.           (line  6)
2420 * tracks:                                geometry description. (line 60)
2421 * use_xdf:                               miscellaneous flags.  (line 70)
2422
2423 \1f
2424 File: mtools.info,  Node: Concept Index,  Prev: Variable Index,  Up: Top
2425
2426 Concept index
2427 *************
2428
2429 \0\b[index\0\b]
2430 * Menu:
2431
2432 * 2m:                                    2m.                   (line  6)
2433 * ALPHA patches:                         Location.             (line  6)
2434 * APlaceForYourStuff:                    mzip.                 (line  6)
2435 * Archive bit:                           mattrib.              (line  6)
2436 * Atari:                                 miscellaneous flags.  (line 66)
2437 * Atari Ram disk:                        location information. (line 28)
2438 * Backwards compatibility:               old style configuration.
2439                                                                (line  6)
2440 * Bad blocks:                            mbadblocks.           (line  6)
2441 * bigger sectors:                        bigger sectors.       (line  6)
2442 * blocksize:                             miscellaneous variables.
2443                                                                (line 32)
2444 * bugs:                                  Location.             (line  6)
2445 * Case sensitivity:                      case sensitivity.     (line  6)
2446 * Changing file attributes:              mattrib.              (line  6)
2447 * character devices:                     miscellaneous variables.
2448                                                                (line 32)
2449 * Checking configuration file:           mtoolstest.           (line  6)
2450 * Clusters of a file:                    mshowfat.             (line  6)
2451 * Command list:                          Commands.             (line  6)
2452 * Compile time configuration:            Compiling mtools.     (line  6)
2453 * Compiled-in defaults:                  Porting mtools.       (line  6)
2454 * Concatenating MS-DOS files:            mcopy.                (line  6)
2455 * Configuration file:                    default values.       (line  6)
2456 * Configuration file name:               configuration file location.
2457                                                                (line  6)
2458 * Configuration file name (parsing order): parsing order.      (line  6)
2459 * Configuration file parsing order:      parsing order.        (line  6)
2460 * Configuration file syntax:             general syntax.       (line  6)
2461 * Configuration file, old syntax:        old style configuration.
2462                                                                (line  6)
2463 * Configuration files:                   Configuration.        (line  9)
2464 * Configuration of disk geometry:        geometry description. (line  6)
2465 * Copying an entire disk image:          mcat.                 (line  9)
2466 * Copying MS-DOS files:                  mcopy.                (line  6)
2467 * CR/LF conversions:                     mcopy.                (line  6)
2468 * Creating a directory:                  mmd.                  (line  6)
2469 * Current working directory:             directory.            (line  6)
2470 * Current working directory (changing the): mcd.               (line  6)
2471 * Default configuration:                 default values.       (line  6)
2472 * Default directory:                     directory.            (line  6)
2473 * Default directory (changing the):      mcd.                  (line  6)
2474 * Default values:                        default values.       (line  6)
2475 * Deleting a directory:                  mrd.                  (line  6)
2476 * deleting an MS-DOS directory recursively: mdeltree.          (line  6)
2477 * deleting MS-DOS files:                 mdel.                 (line  6)
2478 * Description of disk geometry:          geometry description. (line  6)
2479 * diffs:                                 Location.             (line  6)
2480 * Directory:                             directory.            (line  6)
2481 * Directory (changing):                  mcd.                  (line  6)
2482 * Directory creation:                    mmd.                  (line  6)
2483 * Directory listing:                     mdir.                 (line  6)
2484 * Directory removing:                    mrd.                  (line  6)
2485 * disable locking:                       miscellaneous flags.  (line 11)
2486 * Disk Geometry:                         geometry description. (line  6)
2487 * Disk image:                            mcat.                 (line  9)
2488 * Disk label:                            mlabel.               (line  6)
2489 * DMF disks:                             more sectors.         (line  6)
2490 * DOSEMU hard disk image:                location information. (line 14)
2491 * Drive configuration:                   per drive variables.  (line  6)
2492 * Drive configuration, example:          general information.  (line  6)
2493 * Drive description:                     per drive variables.  (line  6)
2494 * Drive description, example:            general information.  (line  6)
2495 * Drive independent configuration variables: global variables. (line  6)
2496 * du:                                    mdu.                  (line  6)
2497 * Duplicate file names:                  name clashes.         (line  6)
2498 * Ejecting a Zip/Jaz disk:               mzip.                 (line  6)
2499 * Environmental variables:               global variables.     (line  6)
2500 * Erasing a directory:                   mrd.                  (line  6)
2501 * erasing an MS-DOS directory recursively: mdeltree.           (line  6)
2502 * erasing MS-DOS files:                  mdel.                 (line  6)
2503 * exclusive access to a drive:           open flags.           (line  6)
2504 * Executing commands before opening the device: miscellaneous variables.
2505                                                                (line 26)
2506 * Fat:                                   mshowfat.             (line  6)
2507 * fdformat:                              more sectors.         (line  6)
2508 * File name of device node:              location information. (line 10)
2509 * File system creation:                  mformat.              (line  6)
2510 * Filenames:                             arguments.            (line  6)
2511 * floppyd:                               floppyd.              (line  6)
2512 * Floppyd cat:                           mcat.                 (line  9)
2513 * floppyd_installtest:                   floppyd_installtest.  (line  6)
2514 * Format of disk:                        geometry description. (line  6)
2515 * Formats, high capacity:                high capacity formats.
2516                                                                (line  6)
2517 * Formatting disks:                      mformat.              (line  6)
2518 * FreeDOS:                               global variables.     (line  6)
2519 * getting parameters of a MS-DOS file system: minfo.           (line  6)
2520 * Global configuration variables:        global variables.     (line  6)
2521 * Hdimage:                               location information. (line  6)
2522 * Hidden files:                          mattrib.              (line  6)
2523 * High capacity formats:                 high capacity formats.
2524                                                                (line  6)
2525 * High capacity formats, mounting:       mmount.               (line  6)
2526 * High density disk:                     geometry description. (line  6)
2527 * Image file:                            location information. (line 10)
2528 * Initializing disks:                    mformat.              (line  6)
2529 * Jaz disk (utilities):                  mzip.                 (line  6)
2530 * Jaz disks (partitioning them):         mpartition.           (line  6)
2531 * Jaz disks (partitions):                location information. (line 14)
2532 * Jaz disks (raw SCSI access):           miscellaneous flags.  (line 17)
2533 * Labeling a disk:                       mlabel.               (line  6)
2534 * Linux enhancements (High Capacity Formats): high capacity formats.
2535                                                                (line  6)
2536 * Linux enhancements (mmount):           mmount.               (line  6)
2537 * List of available commands:            Commands.             (line  6)
2538 * Listing a directory:                   mdir.                 (line  6)
2539 * Listing space occupied by directories and files: mdu.        (line  6)
2540 * Location of configuration files:       configuration file location.
2541                                                                (line  6)
2542 * Location of configuration files (parsing order): parsing order.
2543                                                                (line  6)
2544 * locking (disabling it):                miscellaneous flags.  (line 11)
2545 * Long file name:                        long names.           (line  6)
2546 * Low density disk:                      geometry description. (line  6)
2547 * Magneto-optical disks:                 location information. (line 14)
2548 * mailing list:                          Location.             (line  6)
2549 * Making a directory:                    mmd.                  (line  6)
2550 * Marking blocks as bad:                 mbadblocks.           (line  6)
2551 * mattrib:                               mattrib.              (line  6)
2552 * mbadblocks:                            mbadblocks.           (line  6)
2553 * mcat:                                  mcat.                 (line  9)
2554 * mcd:                                   mcd.                  (line  6)
2555 * mcd (introduction):                    directory.            (line  6)
2556 * mclasserase:                           mclasserase.          (line  6)
2557 * mcopy:                                 mcopy.                (line  6)
2558 * Mcwd file:                             mcd.                  (line  6)
2559 * mdel:                                  mdel.                 (line  6)
2560 * mdeltree:                              mdeltree.             (line  6)
2561 * mdir:                                  mdir.                 (line  6)
2562 * mdu:                                   mdu.                  (line  6)
2563 * Memory Card:                           mclasserase.          (line  6)
2564 * mformat:                               mformat.              (line  6)
2565 * mformat (geometry used for):           geometry description. (line  6)
2566 * mformat parameters:                    minfo.                (line  6)
2567 * minfo:                                 minfo.                (line  6)
2568 * mkmanifest:                            mkmanifest.           (line  6)
2569 * mlabel:                                mlabel.               (line  6)
2570 * mmd:                                   mmd.                  (line  6)
2571 * mmount:                                mmount.               (line  6)
2572 * mmove:                                 mmove.                (line  6)
2573 * Mounting a disk:                       mmount.               (line  6)
2574 * Moving files (mmove):                  mmove.                (line  6)
2575 * Moving files (mren):                   mren.                 (line  6)
2576 * mpartition:                            mpartition.           (line  6)
2577 * mrd:                                   mrd.                  (line  6)
2578 * mren:                                  mren.                 (line  6)
2579 * mshortname:                            mshortname.           (line  6)
2580 * mshowfat:                              mshowfat.             (line  6)
2581 * mtoolstest:                            mtoolstest.           (line  6)
2582 * mzip:                                  mzip.                 (line  6)
2583 * Name clashes:                          name clashes.         (line  6)
2584 * Name of configuration files:           configuration file location.
2585                                                                (line  6)
2586 * Name of configuration files (parsing order): parsing order.  (line  6)
2587 * Name of device node:                   location information. (line 10)
2588 * Occupation of space by directories and files: mdu.           (line  6)
2589 * Odd formats:                           high capacity formats.
2590                                                                (line  6)
2591 * Old configuration file syntax:         old style configuration.
2592                                                                (line  6)
2593 * open flags:                            open flags.           (line  6)
2594 * Options:                               arguments.            (line  6)
2595 * OS/2 (layout of removable media):      location information. (line 14)
2596 * OS/2 (XDF disks):                      XDF.                  (line  6)
2597 * Overwriting files:                     name clashes.         (line  6)
2598 * packing list:                          mkmanifest.           (line  6)
2599 * Parsing order:                         parsing order.        (line  6)
2600 * Partitioned image file:                location information. (line 14)
2601 * partitions (creating):                 mpartition.           (line  6)
2602 * password protected Zip disks:          mzip.                 (line  6)
2603 * patches:                               Location.             (line  6)
2604 * Physically erase:                      mclasserase.          (line  6)
2605 * plain floppy: device xxx busy:         miscellaneous flags.  (line 11)
2606 * Porting:                               Porting mtools.       (line  6)
2607 * Primary file name (long names):        long names.           (line  6)
2608 * Primary file name (name clashes):      name clashes.         (line  6)
2609 * Ram disk:                              location information. (line 28)
2610 * raw device:                            miscellaneous variables.
2611                                                                (line 32)
2612 * Read errors:                           mbadblocks.           (line  6)
2613 * Read-only files (changing the attribute): mattrib.           (line  6)
2614 * Read-only files (listing them):        mdir.                 (line  6)
2615 * Reading MS-DOS files:                  mcopy.                (line  6)
2616 * recursively removing an MS-DOS directory: mdeltree.          (line  6)
2617 * remote floppy access:                  floppyd.              (line  6)
2618 * remote floppy access <1>:              floppyd_installtest.  (line  6)
2619 * Removable media:                       location information. (line 14)
2620 * Removing a directory:                  mrd.                  (line  6)
2621 * removing an MS-DOS directory recursively: mdeltree.          (line  6)
2622 * removing MS-DOS files:                 mdel.                 (line  6)
2623 * Renaming files (mmove):                mmove.                (line  6)
2624 * Renaming files (mren):                 mren.                 (line  6)
2625 * SCSI devices:                          miscellaneous flags.  (line 17)
2626 * Secondary file name (long names):      long names.           (line  6)
2627 * Secondary file name (name clashes):    name clashes.         (line  6)
2628 * setgid installation:                   miscellaneous flags.  (line 40)
2629 * setuid installation:                   miscellaneous flags.  (line 40)
2630 * setuid installation (needed for raw SCSI I/O): miscellaneous flags.
2631                                                                (line 17)
2632 * Solaris (compile time configuration of vold): Compiling mtools.
2633                                                                (line  6)
2634 * Solaris (Raw access to SCSI devices such as Zip & Jaz): miscellaneous flags.
2635                                                                (line 17)
2636 * Solaris (volcheck):                    miscellaneous variables.
2637                                                                (line 26)
2638 * Solaris (vold):                        miscellaneous flags.  (line 57)
2639 * Space occupied by directories and files: mdu.                (line  6)
2640 * Special formats:                       high capacity formats.
2641                                                                (line  6)
2642 * Subdirectory creation:                 mmd.                  (line  6)
2643 * Subdirectory removing:                 mrd.                  (line  6)
2644 * SunOS (Raw access to SCSI devices such as Zip & Jaz): miscellaneous flags.
2645                                                                (line 17)
2646 * synchronous writing:                   open flags.           (line  6)
2647 * Syntax of the configuration file:      general syntax.       (line  6)
2648 * Syquest disks:                         location information. (line 14)
2649 * Syquest disks (raw SCSI access):       miscellaneous flags.  (line 17)
2650 * System files:                          mattrib.              (line  6)
2651 * Testing configuration file for correctness: mtoolstest.      (line  6)
2652 * Text files:                            mcopy.                (line  6)
2653 * Tools disk (Zip and Jaz drives):       mzip.                 (line  6)
2654 * Verifying configuration file:          mtoolstest.           (line  6)
2655 * VFAT-style file names:                 long names.           (line  6)
2656 * vgacopy:                               more sectors.         (line  6)
2657 * Vold (compile time configuration):     Compiling mtools.     (line  6)
2658 * Vold (mediamgr):                       miscellaneous flags.  (line 57)
2659 * Weird formats:                         high capacity formats.
2660                                                                (line  6)
2661 * Windows 95 (DMF disks):                more sectors.         (line  6)
2662 * Windows 95-style file names:           long names.           (line  6)
2663 * Windows NT (layout of removable media): location information.
2664                                                                (line 14)
2665 * Wordswapped:                           miscellaneous flags.  (line 66)
2666 * Working directory:                     directory.            (line  6)
2667 * Working directory <1>:                 mcd.                  (line  6)
2668 * Write protecting a Zip/Jaz disk:       mzip.                 (line  6)
2669 * Writing MS-DOS files:                  mcopy.                (line  6)
2670 * X terminal:                            floppyd.              (line  6)
2671 * X terminal <1>:                        floppyd_installtest.  (line  6)
2672 * XDF disks:                             XDF.                  (line  6)
2673 * XDF disks (compile time configuration): Compiling mtools.    (line  6)
2674 * XDF disks (how to configure):          miscellaneous flags.  (line 70)
2675 * Zip disk (utilities):                  mzip.                 (line  6)
2676 * Zip disks (partitioning them):         mpartition.           (line  6)
2677 * Zip disks (partitions):                location information. (line 14)
2678 * Zip disks (raw SCSI access):           miscellaneous flags.  (line 17)
2679 * ZipTools disk:                         mzip.                 (line  6)
2680
2681
2682 \1f
2683 Tag Table:
2684 Node: Top\7f872
2685 Node: Location\7f2960
2686 Node: Common features\7f4349
2687 Node: arguments\7f5113
2688 Node: drive letters\7f6774
2689 Node: directory\7f8128
2690 Node: long names\7f8574
2691 Node: name clashes\7f11120
2692 Node: case sensitivity\7f13404
2693 Node: high capacity formats\7f14638
2694 Node: more sectors\7f15756
2695 Node: bigger sectors\7f16811
2696 Node: 2m\7f17537
2697 Node: XDF\7f18719
2698 Node: exit codes\7f20062
2699 Node: bugs\7f20700
2700 Node: Configuration\7f21233
2701 Node: configuration file location\7f22370
2702 Node: general syntax\7f22794
2703 Node: default values\7f23625
2704 Node: global variables\7f24153
2705 Node: per drive variables\7f26346
2706 Node: general information\7f27181
2707 Node: location information\7f27623
2708 Node: geometry description\7f29152
2709 Node: open flags\7f33013
2710 Node: miscellaneous variables\7f33613
2711 Node: miscellaneous flags\7f35689
2712 Node: multiple descriptions\7f39319
2713 Node: parsing order\7f40993
2714 Node: old style configuration\7f42024
2715 Node: Commands\7f42723
2716 Node: floppyd\7f44645
2717 Node: floppyd_installtest\7f49438
2718 Node: mattrib\7f50069
2719 Node: mbadblocks\7f51862
2720 Node: mcat\7f53156
2721 Node: mcd\7f53970
2722 Node: mclasserase\7f54831
2723 Node: mcopy\7f55507
2724 Node: mdel\7f58521
2725 Node: mdeltree\7f58860
2726 Node: mdir\7f59279
2727 Node: mdu\7f60555
2728 Node: mformat\7f61061
2729 Node: mkmanifest\7f69571
2730 Node: minfo\7f71545
2731 Node: mlabel\7f72115
2732 Node: mmd\7f73268
2733 Node: mmount\7f73617
2734 Node: mmove\7f74216
2735 Node: mpartition\7f75023
2736 Node: mrd\7f80536
2737 Node: mren\7f80894
2738 Node: mshortname\7f81643
2739 Node: mshowfat\7f81973
2740 Node: mtoolstest\7f82382
2741 Node: mtype\7f82954
2742 Node: mzip\7f83805
2743 Ref: mzip-Footnote-1\7f85830
2744 Ref: mzip-Footnote-2\7f85911
2745 Node: Compiling mtools\7f86198
2746 Node: Porting mtools\7f87297
2747 Node: Command Index\7f93201
2748 Node: Variable Index\7f93329
2749 Node: Concept Index\7f95152
2750 \1f
2751 End Tag Table