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