Imported Upstream version 4.0.35
[platform/upstream/mtools.git] / mtools.info
index 997da78..3e6b80d 100644 (file)
@@ -1,6 +1,6 @@
 This is mtools.info, produced by makeinfo version 6.5 from mtools.texi.
 
-This manual is for Mtools (version 4.0.24, March 2020), 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
@@ -53,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.24, March 2020), 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
@@ -87,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.24.tar.gz
-     http://mtools.linux.lu/mtools-4.0.24.tar.gz
-     ftp://www.tux.org/pub/knaff/mtools/mtools-4.0.24.tar.gz
-     ftp://ibiblio.unc.edu/pub/Linux/utils/disk-management/mtools-4.0.24.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
@@ -378,8 +368,7 @@ 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
@@ -859,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
@@ -1251,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
@@ -1430,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'
@@ -1911,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.
@@ -1979,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.
@@ -1995,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:
@@ -2003,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.
 
@@ -2018,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)
@@ -2465,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)
@@ -2527,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)
@@ -2633,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)
@@ -2659,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.
@@ -2706,71 +2723,71 @@ Concept index
 
 \1f
 Tag Table:
-Node: Top\7f869
-Node: Location\7f3123
-Node: Common features\7f4512
-Node: arguments\7f5276
-Node: drive letters\7f6937
-Node: directory\7f8291
-Node: long names\7f8737
-Node: name clashes\7f11283
-Node: case sensitivity\7f13567
-Node: high capacity formats\7f14804
-Node: more sectors\7f15926
-Node: bigger sectors\7f16981
-Node: 2m\7f17710
-Node: XDF\7f18896
-Node: exit codes\7f20239
-Node: bugs\7f20877
-Node: Configuration\7f21410
-Node: configuration file location\7f22699
-Node: general syntax\7f23152
-Node: default values\7f23983
-Node: global variables\7f24511
-Node: per drive variables\7f26704
-Node: general information\7f27539
-Node: location information\7f27981
-Node: geometry description\7f29510
-Node: open flags\7f33371
-Node: miscellaneous variables\7f33971
-Node: miscellaneous flags\7f36047
-Node: multiple descriptions\7f39677
-Node: parsing order\7f41351
-Node: old style configuration\7f42382
-Node: Commands\7f43081
-Node: floppyd\7f45003
-Node: floppyd_installtest\7f49796
-Node: mattrib\7f50427
-Node: mbadblocks\7f52220
-Node: mcat\7f53514
-Node: mcd\7f54328
-Node: mclasserase\7f55189
-Node: mcopy\7f55865
-Node: mdel\7f58879
-Node: mdeltree\7f59218
-Node: mdir\7f59637
-Node: mdu\7f60913
-Node: mformat\7f61419
-Node: mkmanifest\7f69930
-Node: minfo\7f71904
-Node: mlabel\7f72474
-Node: mmd\7f73627
-Node: mmount\7f73976
-Node: mmove\7f74579
-Node: mpartition\7f75386
-Node: mrd\7f80899
-Node: mren\7f81257
-Node: mshortname\7f82006
-Node: mshowfat\7f82336
-Node: mtoolstest\7f82745
-Node: mtype\7f83317
-Node: mzip\7f84168
-Ref: mzip-Footnote-1\7f86193
-Ref: mzip-Footnote-2\7f86274
-Node: Compiling mtools\7f86561
-Node: Porting mtools\7f87660
-Node: Command Index\7f93568
-Node: Variable Index\7f93696
-Node: Concept Index\7f95519
+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