From 18794c820f109e6de2e16af0f058b562b0492cbc Mon Sep 17 00:00:00 2001 From: Matt Mower Date: Wed, 11 Nov 2015 16:22:45 -0600 Subject: Update dosfstools * Version 3.0.28 * Update filenames in source * Remove unnecessary symlink to fsck * Commit "Recode short filenames from DOS codepage (default 437)." has been reverted since we do not have access to iconv * Commits cherry-picked on top of 3.0.28: - mkfs.fat: fix incorrect int type - Prevent out of bound array read in date_dos2unix() Change-Id: I50310235c62ec2e6bc90afcd10f2814d3afb5113 --- dosfstools/manpages/en/fatlabel.8 | 65 ++++++++++++ dosfstools/manpages/en/fsck.fat.8 | 206 ++++++++++++++++++++++++++++++++++++++ dosfstools/manpages/en/mkfs.fat.8 | 178 ++++++++++++++++++++++++++++++++ 3 files changed, 449 insertions(+) create mode 100644 dosfstools/manpages/en/fatlabel.8 create mode 100644 dosfstools/manpages/en/fsck.fat.8 create mode 100644 dosfstools/manpages/en/mkfs.fat.8 (limited to 'dosfstools/manpages/en') diff --git a/dosfstools/manpages/en/fatlabel.8 b/dosfstools/manpages/en/fatlabel.8 new file mode 100644 index 000000000..c00a79517 --- /dev/null +++ b/dosfstools/manpages/en/fatlabel.8 @@ -0,0 +1,65 @@ +.\" fatlabel.8 - manpage for fatlabel +.\" +.\" Copyright (C) 2006-2014 Daniel Baumann +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.\" The complete text of the GNU General Public License +.\" can be found in /usr/share/common-licenses/GPL-3 file. +.\" +.\" +.TH FATLABEL 8 2015\-05\-16 3.0.28 "dosfstools" +.SH NAME +\fBfatlabel\fR \- set or get MS\-DOS filesystem label +.\" ---------------------------------------------------------------------------- +.SH SYNOPSIS +\fBfatlabel\fR \fIDEVICE\fR [\fILABEL\fR] +.\" ---------------------------------------------------------------------------- +.SH DESCRIPTION +\fBfatlabel\fR set or gets a MS\-DOS filesystem label from a given device. +.PP +If \fILABEL\fR is omitted, then the label name of the specified device is +written on the standard output. +A label can't be longer than 11 bytes. +.\" ---------------------------------------------------------------------------- +.SH OPTIONS +.IP "\fB\-h\fR, \fB\-\-help\fR" 4 +Displays a help message. +.IP "\fB\-V\fR, \fB\-\-version\fR" 4 +Shows version. +.\" ---------------------------------------------------------------------------- +.SH SEE ALSO +\fBfsck.fat\fR(8) +.br +\fBmkfs.fat\fR(8) +.\" ---------------------------------------------------------------------------- +.SH HOMEPAGE +The home for the \fBdosfstools\fR project is its +.UR https://github.com/dosfstools/dosfstools +GitHub project page +.UE . +.\" ---------------------------------------------------------------------------- +.SH AUTHORS +\fBdosfstools\fR were written by +.MT werner.almesberger@\:lrc.di.epfl.ch +Werner Almesberger +.ME , +.MT Roman.Hodek@\:informatik.\:uni-erlangen.de +Roman Hodek +.ME , +and others. +The current maintainer is +.MT aeb@\:debian.org +Andreas Bombe +.ME . diff --git a/dosfstools/manpages/en/fsck.fat.8 b/dosfstools/manpages/en/fsck.fat.8 new file mode 100644 index 000000000..f2d44d080 --- /dev/null +++ b/dosfstools/manpages/en/fsck.fat.8 @@ -0,0 +1,206 @@ +.\" fsck.fat.8 - manpage for fsck.fat +.\" +.\" Copyright (C) 2006-2014 Daniel Baumann +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.\" The complete text of the GNU General Public License +.\" can be found in /usr/share/common-licenses/GPL-3 file. +.\" +.\" +.TH FSCK.FAT 8 2015\-05\-16 3.0.28 "dosfstools" +.SH NAME +\fBfsck.fat\fR \- check and repair MS\-DOS filesystems +.\" ---------------------------------------------------------------------------- +.SH SYNOPSIS +\fBfsck.fat\fR [\fIOPTIONS\fR] \fIDEVICE\fR +.\" ---------------------------------------------------------------------------- +.SH DESCRIPTION +\fBfsck.fat\fR verifies the consistency of MS\-DOS filesystems and optionally +tries to repair them. +.PP +The following filesystem problems can be corrected (in this order): +.IP "*" 4 +FAT contains invalid cluster numbers. +Cluster is changed to EOF. +.IP "*" 4 +File's cluster chain contains a loop. +The loop is broken. +.IP "*" 4 +Bad clusters (read errors). +The clusters are marked bad and they are removed from files owning them. +This check is optional. +.IP "*" 4 +Directories with a large number of bad entries (probably corrupt). +The directory can be deleted. +.IP "*" 4 +Files . and .. are non\-directories. +They can be deleted or renamed. +.IP "*" 4 +Directories . and .. in root directory. +They are deleted. +.IP "*" 4 +Bad filenames. +They can be renamed. +.IP "*" 4 +Duplicate directory entries. +They can be deleted or renamed. +.IP "*" 4 +Directories with non\-zero size field. +Size is set to zero. +.IP "*" 4 +Directory . does not point to parent directory. +The start pointer is adjusted. +.IP "*" 4 +Directory .. does not point to parent of parent directory. +The start pointer is adjusted. +.IP "*" 4 +Start cluster number of a file is invalid. +The file is truncated. +.IP "*" 4 +File contains bad or free clusters. +The file is truncated. +.IP "*" 4 +File's cluster chain is longer than indicated by the size fields. +The file is truncated. +.IP "*" 4 +Two or more files share the same cluster(s). +All but one of the files are truncated. +If the file being truncated is a directory file that has already been read, the +filesystem check is restarted after truncation. +.IP "*" 4 +File's cluster chain is shorter than indicated by the size fields. +The file is truncated. +.IP "*" 4 +Clusters are marked as used but are not owned by a file. +They are marked as free. +.PP +Additionally, the following problems are detected, but not repaired: +.IP "*" 4 +Invalid parameters in boot sector +.IP "*" 4 +Absence of . and .. entries in non\-root directories +.PP +When \fBfsck.fat\fR checks a filesystem, it accumulates all changes in memory +and performs them only after all checks are complete. +This can be disabled with the \fB\-w\fR option. +.\" ---------------------------------------------------------------------------- +.SH OPTIONS +.IP "\fB\-a\fR" 4 +Automatically repair the filesystem. +No user intervention is necessary. +Whenever there is more than one method to solve a problem, the least +destructive approach is used. +.IP "\fB\-A\fR" 4 +Use Atari variation of the MS\-DOS filesystem. +This is default if \fBfsck.fat\fR is run on an Atari, then this option turns +off Atari format. +There are some minor differences in Atari format: +Some boot sector fields are interpreted slightly different, and the special FAT +entries for end\-of\-file and bad cluster can be different. +Under MS\-DOS 0xfff8 is used for EOF and Atari employs 0xffff by default, but +both systems recognize all values from 0xfff8...0xffff as end\-of\-file. +MS\-DOS uses only 0xfff7 for bad clusters, where on Atari values 0xfff0...0xfff7 +are for this purpose (but the standard value is still 0xfff7). +.IP "\fB-b\fR" 4 +Make read-only boot sector check. +.IP "\fB\-d\fR \fIPATH\fR" 4 +Delete the specified file. +If more than one file with that name exist, the first one is deleted. +This option can be given more than once. +.IP "\fB\-f\fR" 4 +Salvage unused cluster chains to files. +By default, unused clusters are added to the free disk space except in auto mode +(\fB\-a\fR). +.IP "\fB\-l\fR" 4 +List path names of files being processed. +.IP "\fB\-n\fR" 4 +No\-operation mode: non\-interactively check for errors, but don't write +anything to the filesystem. +.IP "\fB\-p\fR" 4 +Same as \fB\-a\fR, for compatibility with other *fsck. +.IP "\fB\-r\fR" 4 +Interactively repair the filesystem. +The user is asked for advice whenever there is more than one approach to fix an +inconsistency. +This is the default mode and the option is only retained for backwards +compatibility. +.IP "\fB\-t\fR" 4 +Mark unreadable clusters as bad. +.IP "\fB\-u\fR \fIPATH\fR" 4 +Try to undelete the specified file. +\fBfsck.fat\fR tries to allocate a chain of contiguous unallocated clusters +beginning with the start cluster of the undeleted file. +This option can be given more than once. +.IP "\fB\-v\fR" 4 +Verbose mode. +Generates slightly more output. +.IP "\fB\-V\fR" 4 +Perform a verification pass. +The filesystem check is repeated after the first run. +The second pass should never report any fixable errors. +It may take considerably longer than the first pass, because the first pass may +have generated long list of modifications that have to be scanned for each disk +read. +.IP "\fB\-w\fR" 4 +Write changes to disk immediately. +.IP "\fB\-y\fR" 4 +Same as \fB\-a\fR (automatically repair filesystem) for compatibility with other +fsck tools. +.\" ---------------------------------------------------------------------------- +.SH "EXIT STATUS" +.IP "0" 4 +No recoverable errors have been detected. +.IP "1" 4 +Recoverable errors have been detected or \fBfsck.fat\fR has discovered an +internal inconsistency. +.IP "2" 4 +Usage error. +\fBfsck.fat\fR did not access the filesystem. +.\" ---------------------------------------------------------------------------- +.SH FILES +.IP "fsck0000.rec, fsck0001.rec, ..." 4 +When recovering from a corrupted filesystem, \fBfsck.fat\fR dumps recovered data +into files named 'fsckNNNN.rec' in the top level directory of the filesystem. +.\" ---------------------------------------------------------------------------- +.SH BUGS +Does not create . and .. files where necessary. +Does not remove entirely empty directories. +Should give more diagnostic messages. +Undeleting files should use a more sophisticated algorithm. +.\" ---------------------------------------------------------------------------- +.SH SEE ALSO +\fBfatlabel\fR(8) +.br +\fBmkfs.fat\fR(8) +.\" ---------------------------------------------------------------------------- +.SH HOMEPAGE +The home for the \fBdosfstools\fR project is its +.UR https://github.com/dosfstools/dosfstools +GitHub project page +.UE . +.\" ---------------------------------------------------------------------------- +.SH AUTHORS +\fBdosfstools\fR were written by +.MT werner.almesberger@\:lrc.di.epfl.ch +Werner Almesberger +.ME , +.MT Roman.Hodek@\:informatik.\:uni-erlangen.de +Roman Hodek +.ME , +and others. +The current maintainer is +.MT aeb@\:debian.org +Andreas Bombe +.ME . diff --git a/dosfstools/manpages/en/mkfs.fat.8 b/dosfstools/manpages/en/mkfs.fat.8 new file mode 100644 index 000000000..5a5086efc --- /dev/null +++ b/dosfstools/manpages/en/mkfs.fat.8 @@ -0,0 +1,178 @@ +.\" mkfs.fat.8 - manpage for fs.fatck +.\" +.\" Copyright (C) 2006-2014 Daniel Baumann +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.\" The complete text of the GNU General Public License +.\" can be found in /usr/share/common-licenses/GPL-3 file. +.\" +.\" +.TH MKFS.FAT 8 2015\-05\-16 3.0.28 "dosfstools" +.SH NAME +\fBmkfs.fat\fR \- create an MS-DOS filesystem under Linux +.\" ---------------------------------------------------------------------------- +.SH SYNOPSIS +\fBmkfs.fat\fR [\fIOPTIONS\fR] \fIDEVICE\fR [\fIBLOCK-COUNT\fR] +.\" ---------------------------------------------------------------------------- +.SH DESCRIPTION +\fBmkfs.fat\fR is used to create an MS-DOS filesystem under Linux on a device +(usually a disk partition). +\fIDEVICE\fR is the special file corresponding to the device (e.g. /dev/sdXX). +\fIBLOCK-COUNT\fR is the number of blocks on the device. +If omitted, \fBmkfs.fat\fR automatically determines the filesystem size. +.\" ---------------------------------------------------------------------------- +.SH OPTIONS +.IP "\fB\-a\fR" 4 +Normally, for any filesystem except very small ones, \fBmkfs.fat\fR will align +all the data structures to cluster size, to make sure that as long as the +partition is properly aligned, so will all the data structures in the +filesystem. +This option disables alignment; this may provide a handful of additional +clusters of storage at the expense of a significant performance degradation on +RAIDs, flash media or large-sector hard disks. +.IP "\fB \-A\fR" 4 +Use Atari variation of the MS-DOS filesystem. +This is default if \fBmkfs.fat\fR is run on an Atari, then this option turns off +Atari format. +There are some differences when using Atari format: +If not directed otherwise by the user, \fBmkfs.fat\fR will always use 2 sectors +per cluster, since GEMDOS doesn't like other values very much. +It will also obey the maximum number of sectors GEMDOS can handle. +Larger filesystems are managed by raising the logical sector size. +Under Atari format, an Atari-compatible serial number for the filesystem is +generated, and a 12 bit FAT is used only for filesystems that have one of the +usual floppy sizes (720k, 1.2M, 1.44M, 2.88M), a 16 bit FAT otherwise. +This can be overridden with the \fB\-F\fR option. +Some PC-specific boot sector fields aren't written, and a boot message (option +\fB\-m\fR) is ignored. +.IP "\fB\-b\fR \fISECTOR-OF-BACKUP\fR" 4 +Selects the location of the backup boot sector for FAT32. +Default depends on number of reserved sectors, but usually is sector 6. +The backup must be within the range of reserved sectors. +.IP "\fB\-c" 4 +Check the device for bad blocks before creating the filesystem. +.IP "\fB\-C\fR" 4 +Create the file given as \fIDEVICE\fR on the command line, and write the +to-be-created filesystem to it. +This can be used to create the new filesystem in a file instead of on a real +device, and to avoid using \fBdd\fR in advance to create a file of appropriate +size. +With this option, the \fIBLOCK-COUNT\fR must be given, because otherwise the +intended size of the filesystem wouldn't be known. +The file created is a sparse file, which actually only contains the meta-data +areas (boot sector, FATs, and root directory). +The data portions won't be stored on the disk, but the file nevertheless will +have the correct size. +The resulting file can be copied later to a floppy disk or other device, or +mounted through a loop device. +.IP "\fB\-D\fR \fIDRIVE-NUMBER\fR" 4 +Specify the BIOS drive number to be stored in the FAT boot sector. +This value is usually 0x80 for hard disks and 0x00 for floppy devices or +partitions to be used for floppy emulation. +.IP "\fB\-f\fR \fINUMBER-OF-FATS\fR" 4 +Specify the number of file allocation tables in the filesystem. +The default is 2. +.IP "\fB\-F\fR \fIFAT-SIZE\fR" 4 +Specifies the type of file allocation tables used (12, 16 or 32 bit). +If nothing is specified, \fBmkfs.fat\fR will automatically select between 12, 16 +and 32 bit, whatever fits better for the filesystem size. +.IP "\fB\-h\fR \fINUMBER-OF-HIDDEN-SECTORS\fR" 4 +Select the number of hidden sectors in the volume. +Apparently some digital cameras get indigestion if you feed them a CF card +without such hidden sectors, this option allows you to satisfy them. +.IP "\fB\-i\fR \fIVOLUME-ID\fR" 4 +Sets the volume ID of the newly created filesystem; \fIVOLUME-ID\fR is a 32-bit +hexadecimal number (for example, 2e24ec82). +The default is a number which depends on the filesystem creation time. +.IP "\fB\-I\fR" 4 +It is typical for fixed disk devices to be partitioned so, by default, you are +not permitted to create a filesystem across the entire device. +\fBmkfs.fat\fR will complain and tell you that it refuses to work. +This is different when using MO disks. +One doesn't always need partitions on MO disks. +The filesystem can go directly to the whole disk. +Under other OSes this is known as the 'superfloppy' format. +This switch will force \fBmkfs.fat\fR to work properly. +.IP "\fB\-l\fR \fIFILENAME\fR" 4 +Read the bad blocks list from \fIFILENAME\fR. +.IP "\fB\-m\fR \fIMESSAGE-FILE\fR" 4 +Sets the message the user receives on attempts to boot this filesystem without +having properly installed an operating system. +The message file must not exceed 418 bytes once line feeds have been converted +to carriage return-line feed combinations, and tabs have been expanded. +If the filename is a hyphen (-), the text is taken from standard input. +.IP "\fB\-M\fR \fIFAT-MEDIA-TYPE\fR" 4 +Specify the media type to be stored in the FAT boot sector. +This value is usually 0xF8 for hard disks and is 0xF0 or a value from 0xF9 to +0xFF for floppies or partitions to be used for floppy emulation. +.IP "\fB\-n\fR \fIVOLUME-NAME\fR" 4 +Sets the volume name (label) of the filesystem. +The volume name can be up to 11 characters long. +The default is no label. +.IP "\fB\-r\fR \fIROOT-DIR-ENTRIES\fR" 4 +Select the number of entries available in the root directory. +The default is 112 or 224 for floppies and 512 for hard disks. +.IP "\fB\-R\fR \fINUMBER-OF-RESERVED-SECTORS\fR" 4 +Select the number of reserved sectors. +With FAT32 format at least 2 reserved sectors are needed, the default is 32. +Otherwise the default is 1 (only the boot sector). +.IP "\fB\-s\fR \fISECTORS-PER-CLUSTER\fR" 4 +Specify the number of disk sectors per cluster. +Must be a power of 2, i.e. 1, 2, 4, 8, ... 128. +.IP "\fB\-S\fR \fILOGICAL-SECTOR-SIZE\fR" 4 +Specify the number of bytes per logical sector. +Must be a power of 2 and greater than or equal to 512, i.e. 512, 1024, 2048, +4096, 8192, 16384, or 32768. +.IP "\fB\-v\fR" 4 +Verbose execution. +.IP "\fB\-\-invariant\fR" 4 +Use constants for normally randomly generated or time based data such as +volume ID and creation time. +Multiple runs of \fBmkfs.fat\fR on the same device create identical results +with this option. +Its main purpose is testing \fBmkfs.fat\fR. +.IP "\fB\-\-help\fR" 4 +Display option summary and exit. +.\" ---------------------------------------------------------------------------- +.SH BUGS +\fBmkfs.fat\fR can not create boot-able filesystems. +This isn't as easy as you might think at first glance for various reasons and +has been discussed a lot already. +\fBmkfs.fat\fR simply will not support it ;) +.\" ---------------------------------------------------------------------------- +.SH SEE ALSO +\fBfatlabel\fR(8) +.br +\fBfsck.fat\fR(8) +.\" ---------------------------------------------------------------------------- +.SH HOMEPAGE +The home for the \fBdosfstools\fR project is its +.UR https://github.com/dosfstools/dosfstools +GitHub project page +.UE . +.\" ---------------------------------------------------------------------------- +.SH AUTHORS +\fBdosfstools\fR were written by +.MT werner.almesberger@\:lrc.di.epfl.ch +Werner Almesberger +.ME , +.MT Roman.Hodek@\:informatik.\:uni-erlangen.de +Roman Hodek +.ME , +and others. +The current maintainer is +.MT aeb@\:debian.org +Andreas Bombe +.ME . -- cgit v1.2.3