New upstream version 2.20
[debian/cpmtools] / fsck.cpm.1
1 .TH FSCK.CPM 1 "October 25, 2014" "CP/M tools" "User commands"
2 .SH NAME ..\"{{{roff}}}\"{{{
3 fsck.cpm \- check a CP/M file system
4 .\"}}}
5 .SH SYNOPSIS .\"{{{
6 .ad l
7 .B fsck.cpm
8 .RB [ \-f
9 .IR format ]
10 .RB [ \-n ]
11 .I image
12 .ad b
13 .\"}}}
14 .SH DESCRIPTION .\"{{{
15 \fBfsck.cpm\fP is used to check and repair a CP/M file system.  After
16 reading the directory, it makes two passes.  The first pass checks extent
17 fields for range and format violations (bad status, extent number, last
18 record byte count, file name, extension, block number, record count,
19 size of \&.COM files, time stamp format, invalid password characters,
20 invalid time stamp mode).  The second pass checks extent connectivity
21 (multiple allocated blocks and duplicate directory entries).
22 .P
23 \fBfsck.cpm\fP can not yet repair all errors.
24 .\"}}}
25 .SH OPTIONS .\"{{{
26 .IP "\fB\-f\fP \fIformat\fP"
27 Use the given CP/M disk \fIformat\fP instead of the default format.
28 .IP "\fB\-T\fP \fIlibdsk-type\fP"
29 libdsk driver type, e.g. \fBtele\fP for Teledisk images or \fBraw\fP for raw images 
30 (requires building cpmtools with support for libdsk).
31 .IP "\fB\-n\fP"
32 Open the file system read-only and do not repair any errors.
33 .\"}}}
34 .SH "RETURN VALUE" .\"{{{
35 Upon successful completion, exit code 0 is returned.
36 .\"}}}
37 .SH ERRORS .\"{{{
38 Any errors are indicated by exit code 1.
39 .\"}}}
40 .SH FILES .\"{{{
41 ${prefix}/share/diskdefs        CP/M disk format definitions
42 .\"}}}
43 .SH ENVIRONMENT \"{{{
44 CPMTOOLSFMT     Default format
45 .\"}}}
46 .SH DIAGNOSTICS .\"{{{
47 .IP "\fIimage\fP: \fIused\fP/\fItotal\fP files (\fIn\fP.\fIn\fP% non-contiguos), \fIused\fP/\fItotal\fP blocks"
48 No inconsistencies could be found.  The number of used files actually
49 is the number of used extents.  Since a file may use more than
50 one extent, this may be greather than the actual number of files, but a
51 correct measure would not reflect how many files could still be created
52 at most.  A file is considered fragmented, if sequential data blocks
53 pointed to by the same extent do not have sequential block numbers.
54 The number of used blocks includes the blocks used for system tracks
55 and the directory.
56 .\"}}}
57 .SH AUTHORS .\"{{{
58 This program is copyright 1997\(en2012 Michael Haardt
59 <michael@moria.de>.  The Windows port is copyright 2000, 2001, 2011 John Elliott
60 <jce@seasip.demon.co.uk>.
61 .PP
62 This program is free software; you can redistribute it and/or modify
63 it under the terms of the GNU General Public License as published by
64 the Free Software Foundation; either version 3 of the License, or
65 (at your option) any later version.
66 .PP
67 This program is distributed in the hope that it will be useful,
68 but WITHOUT ANY WARRANTY; without even the implied warranty of
69 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
70 GNU General Public License for more details.
71 .PP
72 You should have received a copy of the GNU General Public License along
73 with this program.  If not, write to the Free Software Foundation, Inc.,
74 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
75 .\"}}}
76 .SH "SEE ALSO" .\"{{{
77 .IR fsck (8),
78 .IR mkfs.cpm (1),
79 .IR cpm (5)
80 .\"}}}