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