godzil/dosfstools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modernizing dosfsck manpage.

Browse Source 
Signed-off-by: Daniel Baumann <mail@daniel-baumann.ch>
This commit is contained in:
Daniel Baumann 2010-03-14 16:33:47 +01:00
parent 807ed80283
commit 5aa7ec4f2d
1 changed files with 89 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

209
man/dosfsck.8
View File

@ -1,147 +1,112 @@
.TH DOSFSCK 8 "December 31 1997" "Linux" "MAINTENANCE COMMANDS"
.TH DOSFSCK 8 "2010\-01\-31" "3.0.9" "check and repair MS\-DOS filesystems"
.SH NAME
dosfsck \- check and repair MS-DOS file systems
\fBdosfsck\fR \- check and repair MS\-DOS filesystems
.SH SYNOPSIS
.ad l
.B dosfsck|fsck.msdos|fsck.vfat
.RB [ \-aAflnrtvVwy ]
.RB [ \-d\ \fIpath\fB\ \-d\ \fI...\fB ]
.RB [ \-u\ \fIpath\fB\ \-u\ \fI...\fB ]
.I device
.ad b
\fBdosfsck\fR|\fBfsck.msdos\fR|\fBfsck.vfat\fR [\-aAflnrtvVwy] [\-d \fIPATH\fR \-d\ \fI...\fR] [\-u\ \fIPATH\fR \-u \fI...\fR] \fIDEVICE\fR
.SH DESCRIPTION
.B dosfsck
verifies the consistency of MS-DOS file systems and optionally tries to
repair them. The following file system problems can be corrected (in this
order):
.IP \-
\fBdosfsck\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.
.PD 0
.IP \-
.IP "*" 4
File's cluster chain contains a loop. The loop is broken.
.IP \-
Bad clusters (read errors). The clusters are marked bad and they are
removed from files owning them. This check is optional.
.IP \-
Directories with a large number of bad entries (probably corrupt). The
directory can be deleted.
.IP \-
Files . and .. are non-directories. They can be deleted or renamed.
.IP \-
.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 \-
.IP "*" 4
Bad filenames. They can be renamed.
.IP \-
.IP "*" 4
Duplicate directory entries. They can be deleted or renamed.
.IP \-
Directories with non-zero size field. Size is set to zero.
.IP \-
Directory . does not point to parent directory. The start pointer is
adjusted.
.IP \-
Directory .. does not point to parent of parent directory. The start pointer
is adjusted.
.IP \-
.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 \-
.IP "*" 4
File contains bad or free clusters. The file is truncated.
.IP \-
File's cluster chain is longer than indicated by the size fields. The file
is truncated.
.IP \-
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 file system check is restarted after truncation.
.IP \-
File's cluster chain is shorter than indicated by the size fields. The file
is truncated.
.IP \-
Clusters are marked as used but are not owned by a file. They are marked
as free.
.PD
.LP
.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 \-
.IP "*" 4
Invalid parameters in boot sector.
.PD 0
.IP \-
Absence of . and .. entries in non-root directories
.PD
.LP
When \fBdosfsck\fP checks a file system, it accumulates all changes in memory
and performs them only after all checks are complete. This can be disabled
with the \fB\-w\fP option.
.IP "*" 4
Absence of . and .. entries in non\-root directories
.PP
When \fBdosfsck\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\fP
Automatically repair the file system. 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\fP
Use Atari variation of the MS-DOS filesystem. This is default if
\fBdosfsck\fP 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\-d\fP
Delete the specified file. If more that one file with that name exists, the
first one is deleted.
.IP \fB\-f\fP
Salvage unused cluster chains to files. By default, unused clusters are
added to the free disk space except in auto mode (\fB-a\fP).
.IP \fB\-l\fP
.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 \fBdosfsck\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\-d\fR" 4
Delete the specified file. If more that one file with that name exists, the first one is deleted.
.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\fP
No-operation mode: non-interactively check for errors, but don't write
.IP "\fB\-n\fR" 4
No\-operation mode: non\-interactively check for errors, but don't write
anything to the filesystem.
.IP \fB\-r\fP
.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.
.IP \fB\-t\fP
.IP "\fB\-t\fR" 4
Mark unreadable clusters as bad.
.IP \fB-u\fP
Try to undelete the specified file. \fBdosfsck\fP tries to allocate a chain
of contiguous unallocated clusters beginning with the start cluster of the
undeleted file.
.IP \fB\-v\fP
.IP "\fB\-u\fR" 4
Try to undelete the specified file. \fBdosfsck\fR tries to allocate a chain of contiguous unallocated clusters beginning with the start cluster of the undeleted file.
.IP "\fB\-v\fR" 4
Verbose mode. Generates slightly more output.
.IP \fB\-V\fP
Perform a verification pass. The file system 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\fP
.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\fP
Same as \fB\-a\fP (automatically repair filesystem) for compatibility
with other fsck tools.
.LP
If \fB\-a\fP and \fB\-r\fP are absent, the file system is only checked,
but not repaired.
.IP "\fB\-y\fR" 4
Same as \fB\-a\fR (automatically repair filesystem) for compatibility with other fsck tools.
.PP
\fBNote:\fR If \fB\-a\fR and \fB\-r\fR are absent, the filesystem is only checked, but not repaired.
.SH "EXIT STATUS"
.IP 0
.IP "0" 4
No recoverable errors have been detected.
.IP 1
Recoverable errors have been detected or \fBdosfsck\fP has discovered an
internal inconsistency.
.IP 2
Usage error. \fBdosfsck\fP did not access the file system.
.IP "1" 4
Recoverable errors have been detected or \fBdosfsck\fR has discovered an internal inconsistency.
.IP "2" 4
Usage error. \fBdosfsck\fR did not access the filesystem.
.SH FILES
.IP "fsck0000.rec, fsck0001.rec, ..."
When recovering from a corrupted file system, dosfsck dumps recovered data
into files named 'fsckNNNN.rec' in the top level directory of the file system.
.IP "fsck0000.rec, fsck0001.rec, ..." 4
When recovering from a corrupted filesystem, \fBdosfsck\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"
.\"fs(5)
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
\fBdosfslabel\fR(8)
.br
\fBmkdosfs\fR(8)
.SH HOMEPAGE
More information about \fBdosfsck\fR and \fBdosfstools\fR can be found at <\fIhttp://www.daniel\-baumann.ch/software/dosfstools/\fR>.
.SH AUTHORS
Werner Almesberger <werner.almesberger@lrc.di.epfl.ch>
Extensions (FAT32, VFAT) by and current maintainer:
Roman Hodek <roman@hodek.net>
\fBdosfstools\fR were written by Werner Almesberger <\fIwerner.almesberger@lrc.di.epfl.ch\fR>, Roman Hodek <\fIRoman.Hodek@informatik.uni-erlangen.de\fR>, and others. The current maintainer is Daniel Baumann <\fIdaniel@debian.org\fR>.