Imported Upstream version 2.17
[debian/cpmtools] / mkfs.cpm.1.in
1 .TH MKFS.CPM 1 "@UPDATED@" "CP/M tools" "User commands"
2 .SH NAME \"{{{roff}}}\"{{{
3 mkfs.cpm \- make a CP/M file system
4 .\"}}}
5 .SH SYNOPSIS \"{{{
6 .ad l
7 .B mkfs.cpm
8 .RB [ \-f
9 .IR format ]
10 .RB [ \-b
11 .IR boot ]
12 .RB [ \-L
13 .IR label ]
14 .I image
15 .ad b
16 .\"}}}
17 .SH DESCRIPTION \"{{{
18 \fBmkfs.cpm\fP makes a CP/M file system on an image file or device.
19 .\"}}}
20 .SH OPTIONS \"{{{
21 .IP "\fB\-f\fP \fIformat\fP"
22 Use the given CP/M disk \fIformat\fP instead of the default format.
23 .IP "\fB\-b\fP \fIbootblock\fP"
24 Write the contents of the file \fIbootblock\fP to the system tracks
25 instead of filling them with 0xe5.  This option can be used up to four
26 times.  The file contents (typically boot block, CCP, BDOS and BIOS)
27 are written to sequential sectors, padding with 0xe5 if needed.
28 .IP "\fB\-L\fP \fIlabel\fP"
29 Label the file system.  This is only supported by CP/M Plus.
30 .\"}}}
31 .SH "RETURN VALUE" \"{{{
32 Upon successful completion, exit code 0 is returned.
33 .\"}}}
34 .SH ERRORS \"{{{
35 Any errors are indicated by exit code 1.
36 .\"}}}
37 .SH ENVIRONMENT \"{{{
38 CPMTOOLSFMT     Default format
39 .\"}}}
40 .SH FILES \"{{{
41 @DATADIR@/diskdefs      CP/M disk format definitions
42 .\"}}}
43 .SH AUTHORS \"{{{
44 This program is copyright 1997\(en2012 Michael Haardt
45 <michael@moria.de>.  The Windows port is copyright 2000, 2001, 2011 John Elliott
46 <jce@seasip.demon.co.uk>.
47 .PP
48 This program is free software; you can redistribute it and/or modify
49 it under the terms of the GNU General Public License as published by
50 the Free Software Foundation; either version 3 of the License, or
51 (at your option) any later version.
52 .PP
53 This program is distributed in the hope that it will be useful,
54 but WITHOUT ANY WARRANTY; without even the implied warranty of
55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
56 GNU General Public License for more details.
57 .PP
58 You should have received a copy of the GNU General Public License along
59 with this program.  If not, write to the Free Software Foundation, Inc.,
60 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
61 .\"}}}
62 .SH "SEE ALSO" \"{{{
63 .IR fsck.cpm (1),
64 .IR cpmls (1),
65 .IR mkfs (1),
66 .IR cpm (5)
67 .\"}}}