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