README

   1 dosfstools consists of the programs mkfs.fat, fsck.fat and fatlabel to create,
   2 check and label file systems of the FAT family.  The dosfstools are licensed
   3 under the GNU GPL version 3 or later. See the file COPYING for details.
   4
   5
   6 ### Build Requirements
   7
   8 The test suite requires the tool xxd (available as part of the vim
   9 distribution).
  10
  11
  12 ### Installing
  13
  14 dosfstools are built using an autoconf/automake system, so the standard method
  15 applies:
  16
  17   ./configure
  18   make
  19   make install
  20
  21 You need to have superuser privileges in order to install into the standard
  22 system wide locations.
  23
  24 The ./configure script has an option --enable-compat-symlinks that will
  25 configure the build to symlink older names of the tools to the current ones on
  26 installation. These are dosfsck, fsck.msdos and fsck.vfat for fsck.fat, mkdosfs,
  27 mkfs.msdos and mkfs.vfat for mkfs.fat and dosfslabel for fatlabel.
  28
  29
  30 ### Running the test suite
  31
  32 The test suite can be run with "make check" after configuring. Note that if
  33 xxd isn't available, all tests will be skipped and nothing actually tested.
  34
  35 During the tests temporary files of multiple GB in size will be created, but the
  36 actual data content is not more than a few MB. The operating system and the
  37 filesystem the tests are executed on should support sparse files, otherwise the
  38 tests will be resource intensive.
  39
  40
  41 ### Building from the VCS repository
  42
  43 If you are working directly from a git clone of the official dosfstools
  44 repository, you will find that you can not run "./configure" straight away
  45 because it, like other autogenerated files for the build system, is not included
  46 in the repository.
  47
  48 First, autoconf, automake and gettext have to be installed.  Then you can run
  49 "./autogen.sh" to generate all the required files.