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