Imported Upstream version 4.0.35
[platform/upstream/mtools.git] / mtools.info
index 76c945e..3e6b80d 100644 (file)
@@ -1,6 +1,6 @@
-This is mtools.info, produced by makeinfo version 6.3 from mtools.texi.
+This is mtools.info, produced by makeinfo version 6.5 from mtools.texi.
 
-This manual is for Mtools (version 4.0.23, December 2018), which is a
+This manual is for Mtools (version 4.0.35, August 2021), which is a
 collection of tools to allow Unix systems to manipulate MS-DOS files.
 
    Copyright (C) 2007, 2009 Free Software Foundation, Inc.  Copyright
@@ -25,6 +25,18 @@ Mtools doc
 
 This is mtools' documentation.
 
+* Menu:
+
+* Location::
+* Common features::
+* Configuration::
+* Commands::
+* Compiling mtools::
+* Porting mtools::
+* Command Index::
+* Variable Index::
+* Concept Index::
+
 Introduction
 ************
 
@@ -41,7 +53,7 @@ preliminary mounting or initialization (assuming the default
 '/etc/mtools.conf' works on your machine).  With mtools, one can change
 floppies too without unmounting and mounting.
 
-   This manual is for Mtools (version 4.0.23, December 2018), which is a
+   This manual is for Mtools (version 4.0.35, August 2021), which is a
 collection of tools to allow Unix systems to manipulate MS-DOS files.
 
    Copyright (C) 2007, 2009 Free Software Foundation, Inc.  Copyright
@@ -75,29 +87,19 @@ File: mtools.info,  Node: Location,  Next: Common features,  Prev: Top,  Up: Top
 *********************
 
 Mtools can be found at the following places (and their mirrors):
-     http://ftp.gnu.org/gnu/mtools/mtools-4.0.23.tar.gz
-     http://mtools.linux.lu/mtools-4.0.23.tar.gz
-     ftp://www.tux.org/pub/knaff/mtools/mtools-4.0.23.tar.gz
-     ftp://ibiblio.unc.edu/pub/Linux/utils/disk-management/mtools-4.0.23.tar.gz
-
-   Before reporting a bug, make sure that it has not yet been fixed in
-the Alpha patches which can be found at:
-     http://ftp.gnu.org/gnu/mtools/
-     http://mtools.linux.lu/
-     ftp://www.tux.org/pub/knaff/mtools
+     http://ftp.gnu.org/gnu/mtools/mtools-4.0.35.tar.gz
 
    These patches are named 'mtools-'VERSION'-'DDMM'.taz', where version
 stands for the base version, DD for the day and MM for the month.  Due
 to a lack of space, I usually leave only the most recent patch.
 
-   There is an mtools mailing list at mtools @ tux.org .  Please send
-all bug reports to this list.  You may subscribe to the list by sending
-a message with 'subscribe mtools @ tux.org' in its body to majordomo @
-tux.org .  (N.B. Please remove the spaces around the "@" both times.  I
-left them there in order to fool spambots.)  Announcements of new mtools
-versions will also be sent to the list, in addition to the Linux
-announce newsgroups.  The mailing list is archived at
-http://lists.gnu.org/pipermail/info-mtools/
+   There is an mtools mailing list at info-mtools @ gnu.org .  Please
+send all bug reports to this list.  You may subscribe to the list at
+https://lists.gnu.org/mailman/listinfo/info-mtools.  (N.B. Please remove
+the spaces around the "@".  I left them there in order to fool
+spambots.)  Announcements of new mtools versions will also be sent to
+the list, in addition to the Linux announce newsgroups.  The mailing
+list is archived at http://lists.gnu.org/pipermail/info-mtools/
 
 \1f
 File: mtools.info,  Node: Common features,  Next: Configuration,  Prev: Location,  Up: Top
@@ -342,15 +344,15 @@ LongFileName, and not as Longfilename.  However, if you then try to add
 LongFilename to the same directory, it is refused, because case is
 ignored for clash checks.
 
-   The VFAT file system allows to store the case of a filename in the
-attribute byte, if all letters of the filename are the same case, and if
-all letters of the extension are the same case too.  Mtools uses this
-information when displaying the files, and also to generate the Unix
-filename when mcopying to a Unix directory.  This may have unexpected
-results when applied to files written using an pre-7.0 version of DOS:
-Indeed, the old style filenames map to all upper case.  This is
-different from the behavior of the old version of mtools which used to
-generate lower case Unix filenames.
+   The VFAT file system allows you to store the case of a filename in
+the attribute byte, if all letters of the filename are the same case,
+and if all letters of the extension are the same case too.  Mtools uses
+this information when displaying the files, and also to generate the
+Unix filename when mcopying to a Unix directory.  This may have
+unexpected results when applied to files written using an pre-7.0
+version of DOS: Indeed, the old style filenames map to all upper case.
+This is different from the behavior of the old version of mtools which
+used to generate lower case Unix filenames.
 
 \1f
 File: mtools.info,  Node: high capacity formats,  Next: exit codes,  Prev: case sensitivity,  Up: Common features
@@ -358,16 +360,15 @@ File: mtools.info,  Node: high capacity formats,  Next: exit codes,  Prev: case
 2.7 high capacity formats
 =========================
 
-Mtools supports a number of formats which allow to store more data on
-disk as usual.  Due to different operating system abilities, these
+Mtools supports a number of formats which allow storage of more data on
+disk than usual.  Due to different operating system abilities, these
 formats are not supported on all operating systems.  Mtools recognizes
 these formats transparently where supported.
 
    In order to format these disks, you need to use an operating system
 specific tool.  For Linux, suitable floppy tools can be found in the
 'fdutils' package at the following locations~:
-     ftp://www.tux.org/pub/knaff/fdutils/.
-     ftp://ibiblio.unc.edu/pub/Linux/utils/disk-management/fdutils-*
+     http://www.fdutils.linux.lu/.
 
    See the manual pages included in that package for further detail: Use
 'superformat' to format all formats except XDF, and use 'xdfcopy' to
@@ -416,7 +417,7 @@ using _fewer_, but bigger sectors.  For example, 1 sector of 4K only
 takes up header space once, whereas 8 sectors of 512 bytes have also 8
 headers, for the same amount of useful data.
 
-   This method allows to store up to 1992K on a 3 1/2 HD disk.
+   This method permits storage of up to 1992K on a 3 1/2 HD disk.
 
    Mtools supports these formats only on Linux.
 
@@ -430,9 +431,9 @@ The 2m format was originally invented by Ciriaco Garcia de Celis.  It
 also uses bigger sectors than usual in order to fit more data on the
 disk.  However, it uses the standard format (18 sectors of 512 bytes
 each) on the first cylinder, in order to make these disks easier to
-handle by DOS. Indeed this method allows to have a standard sized boot
-sector, which contains a description of how the rest of the disk should
-be read.
+handle by DOS. Indeed this method allows you to have a standard sized
+boot sector, which contains a description of how the rest of the disk
+should be read.
 
    However, the drawback of this is that the first cylinder can hold
 less data than the others.  Unfortunately, DOS can only handle disks
@@ -509,6 +510,15 @@ File: mtools.info,  Node: Configuration,  Next: Commands,  Prev: Common features
 3 How to configure mtools for your environment
 **********************************************
 
+* Menu:
+
+* configuration file location::
+* default values::
+* global variables::
+* per drive variables::
+* parsing order::
+* old style configuration::
+
 3.1 Description
 ===============
 
@@ -543,6 +553,10 @@ File: mtools.info,  Node: configuration file location,  Next: general syntax,  P
    On some systems, the system-wide configuration file is called
 '/etc/default/mtools.conf' instead.
 
+* Menu:
+
+* general syntax::
+
 \1f
 File: mtools.info,  Node: general syntax,  Next: default values,  Prev: configuration file location,  Up: Configuration
 
@@ -834,6 +848,34 @@ integer (all others)
      specify a global code page for all drives by using the global
      'default_codepage' parameter (outside of any drive description).
      This parameters exists starting at version 4.0.0
+
+'data_map'
+     Remaps data from image file.  This is useful for image files which
+     might need additional zero-filled sectors to be inserted.  Such is
+     the case for instance for IBM 3174 floppy images.  These images
+     represent floppy disks with fewer sectors on their first cylinder.
+     These missing sectors are not stored in the image, but are still
+     counted in the filesystem layout.  The data_map allows to fake
+     these missing sectors for the upper layers of mtools.  A data_map
+     is a comma-separated sequence of source type and size.  Source type
+     may be 'zero' for zero-filled sectors created by map, 'skip' for
+     data in raw image to be ignored (skipped), and nothing for data to
+     be used as is (copied) from the raw image.  Datamap is
+     automatically complemented by an implicit last element of data to
+     be used as is from current offset to end of file.  Each size is a
+     number followed by a unit: 's' for a 512 byte sector, 'K' for
+     Kbytes, 'M' for megabytes, 'G' for gigabytes, and nothing for
+     single bytes.
+
+     Example:
+
+     'data_map=1s,zero31s,28s,skip1s' would be a map for use with IBM
+     3174 floppy images.  First sector ('1s', boot sector) is used as
+     is.  Then follow 31 fake zero-filled sectors ('zero31s'), then the
+     next 28 sectors from image ('28s') are used as is (they contain FAT
+     and root directory), then one sector from image is skipped
+     ('skip1s'), and finally the rest of image is used as is (implicit)
+
 'precmd'
      On some variants of Solaris, it is necessary to call 'volcheck -v'
      before opening a floppy device, in order for the system to notice
@@ -1226,7 +1268,7 @@ operator) or remove attribute flags (with the ''-'' operator).
      command line, only the attribute is printed, and not the filename.
      This option is convenient for scripts
 'p'
-     Replay mode.  Outputs a series of mformat commands that will
+     Replay mode.  Outputs a series of 'mformat' commands that will
      reproduce the current situation, starting from a situation as left
      by untarring the MS-DOS file system.  Commands are only output for
      attribute settings that differ from the default (archive bit set
@@ -1405,9 +1447,9 @@ depending on its position on the command line.
      No confirmation when overwriting Unix files.  'ASCII' doesn't warn
      the user when overwriting an existing Unix file.  If the target
      file already exists, and the '-n' option is not in effect, 'mcopy'
-     asks whether to overwrite the file or to rename the new file (*note
-     name clashes::) for details).  In order to switch off confirmation
-     for DOS files, use '-o'.
+     asks whether to overwrite the file or to rename the new file (see
+     *note name clashes::) for details).  In order to switch off
+     confirmation for DOS files, use '-o'.
 'm'
      Preserve the file modification time.
 'v'
@@ -1870,8 +1912,8 @@ File: mtools.info,  Node: mmount,  Next: mmove,  Prev: mmd,  Up: Commands
 ===========
 
 The 'mmount' command is used to mount an MS-DOS disk.  It is only
-available on Linux, as it is only useful if the OS kernel allows to
-configure the disk geometry.  Its syntax is:
+available on Linux, as it is only useful if the OS kernel allows
+configuration of the disk geometry.  Its syntax is:
 
    'mmount' MSDOSDRIVE [MOUNTARGS]
 
@@ -1886,8 +1928,8 @@ File: mtools.info,  Node: mmove,  Next: mpartition,  Prev: mmount,  Up: Commands
 4.19 Mmove
 ==========
 
-The 'mmove' command is used to moves or renames an existing MS-DOS file
-or subdirectory.
+The 'mmove' command is used to move or rename an existing MS-DOS file or
+subdirectory.
      'mmove' ['-v'] ['-D' CLASH_OPTION] SOURCEFILE TARGETFILE
      'mmove' ['-v']  ['-D' CLASH_OPTION] SOURCEFILE [ SOURCEFILES... ] TARGETDIRECTORY
    'Mmove' moves or renames an existing MS-DOS file or subdirectory.
@@ -1954,12 +1996,12 @@ This command only works on drives whose partition variable is set.
      cylinders of the whole drive.
 'b BEGIN'
      The starting offset of the partition, expressed in sectors.  If
-     begin is not given, mpartition lets the partition begin at the
+     begin is not given, 'mpartition' lets the partition begin at the
      start of the disk (partition number 1), or immediately after the
      end of the previous partition.
 'l LENGTH'
      The size (length) of the partition, expressed in sectors.  If end
-     is not given, mpartition figures out the size from the number of
+     is not given, 'mpartition' figures out the size from the number of
      sectors, heads and cylinders.  If these are not given either, it
      gives the partition the biggest possible size, considering disk
      size and start of the next partition.
@@ -1970,7 +2012,7 @@ partition table:
      Usually, before writing back any changes to the partition,
      mpartition performs certain consistency checks, such as checking
      for overlaps and proper alignment of the partitions.  If any of
-     these checks fails, the partition table is not changes.  The '-f'
+     these checks fails, the partition table is not changed.  The '-f'
      allows you to override these safeguards.
 
    The following options are available for all operations:
@@ -1978,7 +2020,7 @@ partition table:
      Together with '-p' prints the partition table as it is now (no
      change operation), or as it is after it is modified.
 'vv'
-     If the verbosity flag is given twice, mpartition will print out a
+     If the verbosity flag is given twice, 'mpartition' will print out a
      hexdump of the partition table when reading it from and writing it
      to the device.
 
@@ -1993,9 +2035,9 @@ Mpartition proceeds as follows to pick a type for the partition:
 
    - FAT32 partitions are assigned type 0x0C ("'Win95 FAT32, LBA'")
 
-   - For all others, if the partition fits entirely within the 65536
-     sector of the disk, assign 0x01 ("'DOS FAT12, CHS'") for FAT12
-     partition and 0x04 ("'DOS FAT16, CHS'") for FAT16 partitions
+   - For all others, if the partition fits entirely within the first
+     65536 sectors of the disk, assign 0x01 ("'DOS FAT12, CHS'") for
+     FAT12 partition and 0x04 ("'DOS FAT16, CHS'") for FAT16 partitions
 
    - If not covered by the above, assign 0x06 ("'DOS BIG FAT16 CHS'") if
      partition fits entirely within the first 1024 cylinders (CHS mode)
@@ -2335,7 +2377,7 @@ that I can include them into the next release.  For purely local file, I
 recommend that you use the '/etc/mtools.conf' and '~/.mtoolsrc'
 configuration files.
 
-   However, the devices files also allows to supply geometry setting
+   However, the devices files also allows you to supply geometry setting
 routines.  These are necessary if you want to access high capacity
 disks.
 
@@ -2405,7 +2447,7 @@ Variable index
 * filter:                                miscellaneous flags.  (line 78)
 * heads:                                 geometry description. (line 63)
 * mformat_only:                          miscellaneous flags.  (line 74)
-* MTOOLSRC:                              Configuration.        (line  9)
+* MTOOLSRC:                              Configuration.        (line 18)
 * MTOOLS_DOTTED_DIR:                     global variables.     (line  6)
 * MTOOLS_FAT_COMPATIBILITY:              global variables.     (line  6)
 * MTOOLS_LOCK_TIMEOUT:                   global variables.     (line  6)
@@ -2440,12 +2482,12 @@ Concept index
 * Bad blocks:                            mbadblocks.           (line  6)
 * bigger sectors:                        bigger sectors.       (line  6)
 * blocksize:                             miscellaneous variables.
-                                                               (line 32)
+                                                               (line 60)
 * bugs:                                  Location.             (line  6)
 * Case sensitivity:                      case sensitivity.     (line  6)
 * Changing file attributes:              mattrib.              (line  6)
 * character devices:                     miscellaneous variables.
-                                                               (line 32)
+                                                               (line 60)
 * Checking configuration file:           mtoolstest.           (line  6)
 * Clusters of a file:                    mshowfat.             (line  6)
 * Command list:                          Commands.             (line  6)
@@ -2460,7 +2502,7 @@ Concept index
 * Configuration file syntax:             general syntax.       (line  6)
 * Configuration file, old syntax:        old style configuration.
                                                                (line  6)
-* Configuration files:                   Configuration.        (line  9)
+* Configuration files:                   Configuration.        (line 18)
 * Configuration of disk geometry:        geometry description. (line  6)
 * Copying an entire disk image:          mcat.                 (line  9)
 * Copying MS-DOS files:                  mcopy.                (line  6)
@@ -2502,7 +2544,7 @@ Concept index
 * erasing MS-DOS files:                  mdel.                 (line  6)
 * exclusive access to a drive:           open flags.           (line  6)
 * Executing commands before opening the device: miscellaneous variables.
-                                                               (line 26)
+                                                               (line 54)
 * Fat:                                   mshowfat.             (line  6)
 * fdformat:                              more sectors.         (line  6)
 * File name of device node:              location information. (line 10)
@@ -2608,7 +2650,7 @@ Concept index
 * Primary file name (name clashes):      name clashes.         (line  6)
 * Ram disk:                              location information. (line 28)
 * raw device:                            miscellaneous variables.
-                                                               (line 32)
+                                                               (line 60)
 * Read errors:                           mbadblocks.           (line  6)
 * Read-only files (changing the attribute): mattrib.           (line  6)
 * Read-only files (listing them):        mdir.                 (line  6)
@@ -2634,7 +2676,7 @@ Concept index
 * Solaris (Raw access to SCSI devices such as Zip & Jaz): miscellaneous flags.
                                                                (line 17)
 * Solaris (volcheck):                    miscellaneous variables.
-                                                               (line 26)
+                                                               (line 54)
 * Solaris (vold):                        miscellaneous flags.  (line 57)
 * Space occupied by directories and files: mdu.                (line  6)
 * Special formats:                       high capacity formats.
@@ -2681,71 +2723,71 @@ Concept index
 
 \1f
 Tag Table:
-Node: Top\7f872
-Node: Location\7f2960
-Node: Common features\7f4349
-Node: arguments\7f5113
-Node: drive letters\7f6774
-Node: directory\7f8128
-Node: long names\7f8574
-Node: name clashes\7f11120
-Node: case sensitivity\7f13404
-Node: high capacity formats\7f14638
-Node: more sectors\7f15756
-Node: bigger sectors\7f16811
-Node: 2m\7f17537
-Node: XDF\7f18719
-Node: exit codes\7f20062
-Node: bugs\7f20700
-Node: Configuration\7f21233
-Node: configuration file location\7f22370
-Node: general syntax\7f22794
-Node: default values\7f23625
-Node: global variables\7f24153
-Node: per drive variables\7f26346
-Node: general information\7f27181
-Node: location information\7f27623
-Node: geometry description\7f29152
-Node: open flags\7f33013
-Node: miscellaneous variables\7f33613
-Node: miscellaneous flags\7f35689
-Node: multiple descriptions\7f39319
-Node: parsing order\7f40993
-Node: old style configuration\7f42024
-Node: Commands\7f42723
-Node: floppyd\7f44645
-Node: floppyd_installtest\7f49438
-Node: mattrib\7f50069
-Node: mbadblocks\7f51862
-Node: mcat\7f53156
-Node: mcd\7f53970
-Node: mclasserase\7f54831
-Node: mcopy\7f55507
-Node: mdel\7f58521
-Node: mdeltree\7f58860
-Node: mdir\7f59279
-Node: mdu\7f60555
-Node: mformat\7f61061
-Node: mkmanifest\7f69572
-Node: minfo\7f71546
-Node: mlabel\7f72116
-Node: mmd\7f73269
-Node: mmount\7f73618
-Node: mmove\7f74217
-Node: mpartition\7f75024
-Node: mrd\7f80537
-Node: mren\7f80895
-Node: mshortname\7f81644
-Node: mshowfat\7f81974
-Node: mtoolstest\7f82383
-Node: mtype\7f82955
-Node: mzip\7f83806
-Ref: mzip-Footnote-1\7f85831
-Ref: mzip-Footnote-2\7f85912
-Node: Compiling mtools\7f86199
-Node: Porting mtools\7f87298
-Node: Command Index\7f93202
-Node: Variable Index\7f93330
-Node: Concept Index\7f95153
+Node: Top\7f870
+Node: Location\7f3125
+Node: Common features\7f4063
+Node: arguments\7f4827
+Node: drive letters\7f6488
+Node: directory\7f7842
+Node: long names\7f8288
+Node: name clashes\7f10834
+Node: case sensitivity\7f13118
+Node: high capacity formats\7f14355
+Node: more sectors\7f15400
+Node: bigger sectors\7f16455
+Node: 2m\7f17184
+Node: XDF\7f18370
+Node: exit codes\7f19713
+Node: bugs\7f20351
+Node: Configuration\7f20884
+Node: configuration file location\7f22173
+Node: general syntax\7f22626
+Node: default values\7f23457
+Node: global variables\7f23985
+Node: per drive variables\7f26178
+Node: general information\7f27013
+Node: location information\7f27455
+Node: geometry description\7f28984
+Node: open flags\7f32845
+Node: miscellaneous variables\7f33445
+Node: miscellaneous flags\7f37035
+Node: multiple descriptions\7f40665
+Node: parsing order\7f42339
+Node: old style configuration\7f43370
+Node: Commands\7f44069
+Node: floppyd\7f45991
+Node: floppyd_installtest\7f50784
+Node: mattrib\7f51415
+Node: mbadblocks\7f53210
+Node: mcat\7f54504
+Node: mcd\7f55318
+Node: mclasserase\7f56179
+Node: mcopy\7f56855
+Node: mdel\7f59873
+Node: mdeltree\7f60212
+Node: mdir\7f60631
+Node: mdu\7f61907
+Node: mformat\7f62413
+Node: mkmanifest\7f70924
+Node: minfo\7f72898
+Node: mlabel\7f73468
+Node: mmd\7f74621
+Node: mmount\7f74970
+Node: mmove\7f75573
+Node: mpartition\7f76378
+Node: mrd\7f81904
+Node: mren\7f82262
+Node: mshortname\7f83011
+Node: mshowfat\7f83341
+Node: mtoolstest\7f83750
+Node: mtype\7f84322
+Node: mzip\7f85173
+Ref: mzip-Footnote-1\7f87198
+Ref: mzip-Footnote-2\7f87279
+Node: Compiling mtools\7f87566
+Node: Porting mtools\7f88665
+Node: Command Index\7f94573
+Node: Variable Index\7f94701
+Node: Concept Index\7f96524
 \1f
 End Tag Table