Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / usr.bin / fdformat / fdformat.1
blob768b62bb906604bfeb60e46c8944872c7afd75fc
1 .\"     $NetBSD: fdformat.1,v 1.16 2006/07/22 08:36:14 wiz Exp $
2 .\"
3 .\" Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by John Kohl.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd July 22, 2006
31 .Dt FDFORMAT 1
32 .Os
33 .Sh NAME
34 .Nm fdformat
35 .Nd format a floppy diskette
36 .Sh SYNOPSIS
37 .Nm
38 .Bk -words
39 .Op Fl f Ar device
40 .Ek
41 .Bk -words
42 .Op Fl t Ar type
43 .Ek
44 .Op Fl n
45 .Bk -words
46 .Op Fl B Ar nbps
47 .Ek
48 .Bk -words
49 .Op Fl S Ar nspt
50 .Ek
51 .Bk -words
52 .Op Fl T Ar ntrk
53 .Ek
54 .Bk -words
55 .Op Fl C Ar ncyl
56 .Ek
57 .Bk -words
58 .Op Fl P Ar stepspercyl
59 .Ek
60 .Bk -words
61 .Op Fl G Ar gaplen
62 .Ek
63 .Bk -words
64 .Op Fl F Ar fillbyte
65 .Ek
66 .Bk -words
67 .Op Fl X Ar xfer_rate
68 .Ek
69 .Bk -words
70 .Op Fl I Ar interleave
71 .Ek
72 .Sh DESCRIPTION
73 The
74 .Nm
75 utility formats a floppy diskette.
76 With no arguments, it formats the default floppy device with the default
77 density parameters (as provided by the floppy diskette device driver).
78 .Pp
79 As the each track of the floppy diskette is formatted, it is read to
80 verify the format was successful.
81 .Pp
82 The
83 .Nm
84 utility does not create a filesystem of any kind.
85 Use tools like
86 .Xr newfs 8 ,
87 .Xr newfs_msdos 8 ,
89 .Xr mformat 1
90 (part of the pkgsrc/sysutils/mtools package) depending on what filesystem
91 type you want to use on the floppy disk to do so.
92 .Pp
93 Available command-line flags are:
94 .Bl -tag -width indent -compact
95 .It Fl f Ar device
96 Format the floppy using
97 .Ar device
98 instead of the default
99 .Pa /dev/rfd0a .
100 .It Fl t Ar type
101 Format the floppy using parameters for the diskette named
102 .Ar type
104 .Pa /etc/floppytab
105 instead of the device default parameters.
106 .It Fl n
107 Do not verify each track as it is read.
108 .It Fl B Ar nbps
109 Set the number of bytes per sector for the formatted diskette.
110 .It Fl S Ar nspt
111 Set the number of sectors per track for the formatted diskette.
112 .It Fl T Ar ntrk
113 Set the number of tracks (heads) per cylinder for the formatted diskette.
114 .It Fl C Ar ncyl
115 Set the number of cylinders for the formatted diskette.
116 .It Fl P Ar stepspercyl
117 Set the number of motor steps per cylinder for the formatted diskette.
118 .It Fl G Ar gaplen
119 Set the sector gap length for the formatted diskette.
120 .It Fl F Ar fillbyte
121 Set the fill byte for the formatted diskette.
122 .It Fl X Ar xfer_rate
123 Set the bit transfer rate for the formatted diskette.
124 .It Fl I Ar interleave
125 Set the interleave factor for the formatted diskette.
127 .Sh SEE ALSO
128 .Xr fdc 4
129 (amiga, i386 and sparc ports)
130 .Sh HISTORY
133 utility appeared in
134 .Nx 1.3 .
135 .Sh BUGS
136 Some floppy drive units have physical
137 diskette format sensors which automatically select a diskette
138 density for reading.
139 Such drives can format at alternate densities, but
140 they cannot successfully verify the formatted diskette except at the
141 diskette's normal density.