Debian Codegraph @

upstream/debian-unstable/man1/superformat.1

raw
1 .TH superformat 1 "27Jan21" fdutils-5.6
2 .SH Name
3 superformat - format floppies
4 '\" t
5 .de TQ
6 .br
7 .ns
8 .TP \\$1
9 ..
10
11 .tr \(is'
12 .tr \(if`
13 .tr \(pd"
14
15 .SH Note
16 This manpage has been automatically generated from fdutils's texinfo
17 documentation. However, this process is only approximative, and some
18 items, such as cross-references, footnotes and indices are lost in this
19 translation process. Indeed, these items have no appropriate
20 representation in the manpage format. Moreover, only the items specific
21 to each command have been translated, and the general information about
22 fdutils has been dropped in the manpage version. Thus I strongly advise
23 you to use the original texinfo doc.
24 .TP
25 * \ \
26 To generate a printable copy from the texinfo doc, run the following
27 commands:
28
29 .nf
30 .ft 3
31 .in +0.3i
32 ./configure; make dvi; dvips fdutils.dvi
33 .fi
34 .in -0.3i
35 .ft R
36
37 \&\fR
38 .TP
39 * \ \
40 To generate a HTML copy, run:
41
42 .nf
43 .ft 3
44 .in +0.3i
45 ./configure; make html
46 .fi
47 .in -0.3i
48 .ft R
49
50 \&\fRA pre-made HTML can be found at:
51 \&\fR\&\f(CW\(ifhttp://www.tux.org/pub/knaff/fdutils\(is\fR
52 .TP
53 * \ \
54 To generate an info copy (browsable using emacs' info mode), run:
55
56 .nf
57 .ft 3
58 .in +0.3i
59 ./configure; make info
60 .fi
61 .in -0.3i
62 .ft R
63
64 \&\fR
65 .PP
66 The texinfo doc looks most pretty when printed or as HTML. Indeed, in
67 the info version certain examples are difficult to read due to the
68 quoting conventions used in info.
69 .SH Description
70 .PP
71
72 .nf
73 .ft 3
74 .in +0.3i
75 \&\fR\&\f(CWsuperformat [\fR\&\f(CW\-D \fIdos\-drive\fR\&\f(CW] [\fR\&\f(CW\-v \fIverbosity\-level\fR\&\f(CW] [\fR\&\f(CW\-b \fIbegin\-track\fR\&\f(CW]
76 [\fR\&\f(CW\-e \fIend\-track\fR\&\f(CW] [\fR\&\f(CW\-\-superverify] [\fR\&\f(CW\-\-dosverify]
77 [\fR\&\f(CW\-\-noverify] [\fR\&\f(CW\-\-verify_later] [\fR\&\f(CW\-\-first\-sector\-number \fIn\fR\&\f(CW] [\fR\&\f(CW\-\-zero\-based]
78 [\fR\&\f(CW\-G \fIformat\-gap\fR\&\f(CW] [\fR\&\f(CW\-F \fIfinal\-gap\fR\&\f(CW] [\fR\&\f(CW\-i \fIinterleave\fR\&\f(CW] [\fR\&\f(CW\-c \fIchunksize\fR\&\f(CW]
79 [\fR\&\f(CW\-g \fIgap\fR\&\f(CW] [\fR\&\f(CW\-\-absolute\-skew \fIabsolute\-skew\fR\&\f(CW] [\fR\&\f(CW\-\-head\-skew \fIhead\-skew\fR\&\f(CW]
80 [\fR\&\f(CW\-\-track\-skew \fItrack\-skew\fR\&\f(CW] [\fR\&\f(CW\-\-biggest\-last] \fIdrive\fR\&\f(CW [\fImedia\-description\fR\&\f(CW]
81 .fi
82 .in -0.3i
83 .ft R
84
85 \&\fR
86 .PP
87 \&\fR\&\f(CWsuperformat\fR is used to format disks with a capacity of up to
88 1992K HD or 3984K ED. See section Extended formats, for a detailed
89 description of these formats. See section Media description, for a detailed
90 description of the syntax for the media description. If no media
91 description is given, superformat formats a disk in the highest
92 available density for that drive, using standard parameters (i.e. no
93 extra capacity formats).
94 .PP
95 When the disk is formatted, \fR\&\f(CWsuperformat\fR automatically invokes
96 \&\fR\&\f(CWmformat\fR in order to put an MS-DOS filesystem on it. You may
97 ignore this filesystem, if you don't need it.
98 .PP
99 Superformat allows one to format 2m formats. Be aware, however, that these
100 \&\fR\&\f(CW2m\fR formats were specifically designed to hold an MS-DOS
101 filesystem, and that they take advantage of the fact that the MS-DOS
102 filesystem uses redundant sectors on the first track (the FAT, which is
103 represented twice). The second copy of the FAT is \fInot\fR represented
104 on the disk.
105 .PP
106 High capacity formats are sensitive to the exact rotation speed of the
107 drive and the resulting difference in raw capacity. That's why
108 \&\fR\&\f(CWsuperformat\fR performs a measurement of the disks raw capacity
109 before proceeding with the formatting. This measurement is rather time
110 consuming, and can be avoided by storing the relative deviation of the
111 drive capacity into the drive definition file file. See section Drive
112 descriptions, for more details on this file. The line to be inserted
113 into the drive definition file is printed by superformat after
114 performing its measurement. However, this line depends on the drive and
115 the controller. Do not copy it to other computers. Remove it before
116 installing another drive or upgrade your floppy controller. Swap the
117 drive numbers if you swap the drives in your computer.
118 .PP
119 .SH Common\ Options
120 Many options have a long and a short form.
121 .TP
122 \&\fR\&\f(CW\-h\fR\
123 .TQ
124 \&\fR\&\f(CW\-\-help\fR
125 Print the help.
126 .TP
127 \&\fR\&\f(CW\-D\ \fIdrive\fR\&\f(CW\fR\
128 .TQ
129 \&\fR\&\f(CW\-\-dosdrive\ \fIdos\-drive\fR\&\f(CW\fR
130 Selects DOS drive letter for \fR\&\f(CWmformat\fR (for example \fR\&\f(CWa:\fR or
131 \&\fR\&\f(CWb:\fR). The colon may be omitted. The default is derived from the
132 minor device number. If the drive letter cannot be guessed, and is not
133 given on the command line, \fR\&\f(CWmformat\fR is skipped.
134 .TP
135 \&\fR\&\f(CW\-v\ \fIverbosity\-level\fR\&\f(CW\fR\
136 .TQ
137 \&\fR\&\f(CW\-\-verbosity\ \fIverbosity\-level\fR\&\f(CW\fR
138 Sets the verbosity level. 1 prints a dot for each formatted track. 2
139 prints a changing sign for each formatted track (\- for formatting the
140 first head, = for formatting the second head, x for verifying the
141 first head, and + for verifying the second head). 3 prints a complete
142 line listing head and track. 6 and 9 print debugging information.
143 .TP
144 \&\fR\&\f(CW\-\-superverify\fR\
145 Verifies the disk by first reading the track, than writing a pattern of
146 U's, and then reading it again. This is useful as some errors only show
147 up after the disk has once been written. However, this is also slower.
148 .TP
149 \&\fR\&\f(CW\-B\fR\
150 .TQ
151 \&\fR\&\f(CW\-\-dosverify\fR
152 Verifies the disk using the \fR\&\f(CWmbadblocks\fR program.
153 \&\fR\&\f(CWmbadblocks\fR marks the bad sectors as bad in the FAT. The
154 advantage of this is that disks which are only partially bad can still
155 be used for MS-DOS filesystems.
156 .TP
157 \&\fR\&\f(CW\-V\fR\
158 .TQ
159 \&\fR\&\f(CW\-\-verify_later\fR
160 Verifies the whole disk at the end of the formatting process instead
161 of at each track. Verifying the disk at each track has the advantage
162 of detecting errors early on.
163 .TP
164 \&\fR\&\f(CW\-f\fR\
165 .TQ
166 \&\fR\&\f(CW\-\-noverify\fR
167 Skips the verification altogether.
168 .TP
169 \&\fR\&\f(CW\-\-print\-drive\-deviation\fR\
170 Does not format, but prints the drive deviation. If file /etc/driveprm
171 exists and provides a deviation for the drive, nothing is printed and
172 the disk is not formatted.
173 .PP
174 .SH Advanced\ Options
175 Usually, superformat uses sensible default values for these options,
176 which you normally don't need to override. They are intended for expert
177 users. Most of them should only be needed in cases where the hardware
178 or superformat itself has bugs.
179 .IP
180 .TP
181 \&\fR\&\f(CW\-b\ \fIbegin\-track\fR\&\f(CW\fR\
182 .TQ
183 \&\fR\&\f(CW\-\-begin_track\ \ \fIbegin\-track\fR\&\f(CW\fR
184 Describes the track where to begin formatting. This is useful if the
185 previous formatting failed halfway through. The default is 0.
186 .TP
187 \&\fR\&\f(CW\-e\ \fIend\-track\fR\&\f(CW\fR\
188 .TQ
189 \&\fR\&\f(CW\-\-end_track\ \fIend\-track\fR\&\f(CW\fR
190 Describes where to stop formatting. \fIend_track\fR is the last track to
191 be formatted plus one. This is mainly useful for testing purposes. By
192 default, this is the same as the total number of tracks. When the
193 formatting stops, the final skew is displayed (to be used as absolute
194 skew when you'll continue).
195 .TP
196 \&\fR\&\f(CW\-S\ \fIsizecode\fR\&\f(CW\fR\
197 .TQ
198 \&\fR\&\f(CW\-\-sizecode\ \fIsizecode\fR\&\f(CW\fR
199 Set the sector size to be used. The sector size is 128 * (2 ^
200 \&\fIsizecode\fR). Sector sizes below 512 bytes are not supported, thus
201 sizecode must be at least 2. By default 512 is assumed, unless you ask
202 for more sectors than would fit with 512 bytes.
203 .TP
204 \&\fR\&\f(CW\-\-stretch\ \fIstretch\fR\&\f(CW\fR\
205 Set the stretch factor. The stretch factor describes how many physical
206 tracks to skip to get to the next logical track (2 ^ \fIstretch\fR). On
207 double density 5 1/4 disks, the tracks are further apart from each
208 other.
209 .TP
210 \&\fR\&\f(CW\-G\ \fIfmt\-gap\fR\&\f(CW\fR\
211 .TQ
212 \&\fR\&\f(CW\-\-format_gap\ \fIfmt\-gap\fR\&\f(CW\fR
213 Set the formatting gap. The formatting gap tells how far the sectors
214 are away from each other. By default, this is chosen so as to evenly
215 distribute the sectors along the track.
216 .TP
217 \&\fR\&\f(CW\-F\ \fIfinal\-gap\fR\&\f(CW\fR\
218 .TQ
219 \&\fR\&\f(CW\-\-final_gap\ \fIfinal\-gap\fR\&\f(CW\fR
220 Set the formatting gap to be used after the last sector.
221 .TP
222 \&\fR\&\f(CW\-i\ \fIinterleave\fR\&\f(CW\fR\
223 .TQ
224 \&\fR\&\f(CW\-\-interleave\ \fIinterleave\fR\&\f(CW\fR
225 Set the sector interleave factor.
226 .TP
227 \&\fR\&\f(CW\-c\ \fIchunksize\fR\&\f(CW\fR\
228 .TQ
229 \&\fR\&\f(CW\-\-chunksize\ \fIchunksize\fR\&\f(CW\fR
230 Set the size of the chunks. The chunks are small auxiliary sectors
231 used during formatting. They are used to handle heterogeneous sector
232 sizes (i.e. not all sectors have the same size) and negative
233 formatting gaps.
234 .TP
235 \&\fR\&\f(CW\-\-biggest\-last\fR\
236 For MSS formats, make sure that the biggest sector is last on the track.
237 This makes the format more reliable on drives which are out of spec.
238 .TP
239 \&\fR\&\f(CW\-\-first\-sector\-number\ \fIn\fR\&\f(CW\fR\
240 Formats the disk with sector numbers starting at \fIn\fR, rather than
241 1. Certain CP/M boxes or Music synthesizers use this format.
242 .TP
243 \&\fR\&\f(CW\-\-zero\-based\fR\
244 Shorthand for \fR\&\f(CW\-\-first\-sector\-number 0\fR
245 .PP
246 .SH Sector\ skewing\ options
247 .PP
248 In order to maximize the user data transfer rate, the sectors are
249 arranged in such a way that sector 1 of the new track/head comes under
250 the head at the very moment when the drive is ready to read from that
251 track, after having read the previous track. Thus the first sector of
252 the second track is not necessarily near the first sector of the first
253 track. The skew value describes for each track how far sector number
254 1 is away from the index mark. This skew value changes for each head
255 and track. The amount of this change depends on how fast the disk
256 spins, and on how much time is needed to change the head or the track.
257 .TP
258 \&\fR\&\f(CW\-\-absolute_skew\ \fIabsolute\-skew\fR\&\f(CW\fR\
259 .IP
260 Set the absolute skew. This skew value is used for the first formatted
261 track. It is expressed in raw bytes.
262 .TP
263 \&\fR\&\f(CW\-\-head_skew\ \fIhead\-skew\fR\&\f(CW\fR\
264 .IP
265 Set the head skew. This is the skew added for passing from head 0 to
266 head 1. It is expressed in raw bytes.
267 .TP
268 \&\fR\&\f(CW\-\-track_skew\ \fItrack\-skew\fR\&\f(CW\fR\
269 .IP
270 Set the track skew. This is the skew added for seeking to the next
271 track. It is expressed in raw bytes.
272 .PP
273 Example: (absolute skew=3, head skew=1, track skew=2)
274 .PP
275
276 .nf
277 .ft 3
278 .in +0.3i
279 track 0 head 0: 4,5,6,1,2,3 (skew=3)
280 track 0 head 1: 3,4,5,6,1,2 (skew=4)
281 \&\&
282 track 1 head 0: 1,2,3,4,5,6 (skew=0)
283 track 1 head 1: 6,1,2,3,4,5 (skew=1)
284 \&\&
285 track 2 head 0: 4,5,6,1,2,3 (skew=3)
286 track 2 head 1: 3,4,5,6,1,2 (skew=4)
287 .fi
288 .in -0.3i
289 .ft R
290
291 \&\fR
292 .PP
293 N.B. For simplicity's sake, this example expresses skews in units of
294 sectors. In reality, superformat expects the skews to be expressed in
295 raw bytes.
296 .PP
297 .SH Media description
298 Please see the Media description section in the full fdutils
299 documentation:
300 .TQ
301 - Texinfo documentation (info fdutils)
302 .TQ
303 - HTML documentation in /usr/share/doc/fdutils/Fdutils.html
304 .TQ
305 - or DVI documentation in /usr/share/doc/fdutils/Fdutils.dvi.gz
306 .PP
307 .SH Examples
308 In all the examples of this section, we assume that drive 0 is a 3 1/2
309 and drive 1 a 5 1/4.
310 .PP
311 The following example shows how to format a 1440K disk in drive 0:
312
313 .nf
314 .ft 3
315 .in +0.3i
316 superformat /dev/fd0 hd
317 .fi
318 .in -0.3i
319 .ft R
320
321 \&\fR
322 .PP
323 The following example shows how to format a 1200K disk in drive 1:
324
325 .nf
326 .ft 3
327 .in +0.3i
328 superformat /dev/fd1 hd
329 .fi
330 .in -0.3i
331 .ft R
332
333 \&\fR
334 .PP
335 The following example shows how to format a 1440K disk in drive 1:
336
337 .nf
338 .ft 3
339 .in +0.3i
340 superformat /dev/fd1 hd sect=18
341 .fi
342 .in -0.3i
343 .ft R
344
345 \&\fR
346 .PP
347 The following example shows how to format a 720K disk in drive 0:
348
349 .nf
350 .ft 3
351 .in +0.3i
352 superformat /dev/fd0 dd
353 .fi
354 .in -0.3i
355 .ft R
356
357 \&\fR
358 .PP
359 The following example shows how to format a 1743K disk in drive 0 (83
360 cylinders times 21 sectors):
361
362 .nf
363 .ft 3
364 .in +0.3i
365 superformat /dev/fd0 sect=21 cyl=83
366 .fi
367 .in -0.3i
368 .ft R
369
370 \&\fR
371 .PP
372 The following example shows how to format a 1992K disk in drive 0 (83
373 cylinders times 2 heads times 12 KB per track)
374
375 .nf
376 .ft 3
377 .in +0.3i
378 superformat /dev/fd0 tracksize=12KB cyl=83 mss
379 .fi
380 .in -0.3i
381 .ft R
382
383 \&\fR
384 .PP
385 The following example shows how to format a 1840K disk in drive 0. It
386 will have 5 2048-byte sectors, one 1024-byte sector, and one 512-byte
387 sector per track:
388
389 .nf
390 .ft 3
391 .in +0.3i
392 superformat /dev/fd0 tracksize=23b mss 2m ssize=2KB
393 .fi
394 .in -0.3i
395 .ft R
396
397 \&\fR
398 .PP
399 All these formats can be autodetected by mtools, using the floppy
400 driver's default settings.
401 .PP
402 .SH Troubleshooting
403 .TP
404 \&\fR\&\f(CWFDC\ busy,\ sleeping\ for\ a\ second\fR\
405 When another program accesses a disk drive on the same controller as the
406 one being formatted, \fR\&\f(CWsuperformat\fR has to wait until the other
407 access is finished. If this happens, check whether any other program
408 accesses a drive (or whether a drive is mounted), kill that program (or
409 unmount the drive), and the format should proceed normally.
410 .TP
411 \&\fR\&\f(CWI/O\ errors\ during\ verification\fR\
412 Your drive may be too far out of tolerance, and you may thus need to
413 supply a margin parameter. Run \fR\&\f(CWfloppymeter\fR (see section floppymeter)
414 to find out an appropriate value for this parameter, and add the
415 suggested \fR\&\f(CWmargin\fR parameter to the command line
416 .PP
417 .SH Bugs
418 Opening up new window while \fR\&\f(CWsuperformat\fR is running produces
419 overrun errors. These errors are benign, as the failed operation is
420 automatically retried until it succeeds.
421 .SH See Also
422 Fdutils' texinfo doc