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