freebsd-dev/usr.sbin/fdformat/fdformat.1

.\" Copyright (C) 1993, 1994, 1995 by Joerg Wunsch, Dresden
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd September 16, 1993
.Os
.Dt FDFORMAT 1
.Sh NAME
.Nm fdformat
.Nd format floppy disks
.Sh SYNOPSIS
.Nm
.Op Fl q
.Op Fl y
.Op Fl v | Fl n
.Op Fl f Ar capacity
.Op Fl c Ar cyls
.Op Fl s Ar secs
.Op Fl h Ar heads
.Nm
.Op Fl r Ar rate
.Op Fl g Ar gap3len
.Op Fl i Ar intleave
.Op Fl S Ar secshft
.Op Fl F Ar fillbyte
.Op Fl t Ar steps_per_track
.Ar device_name
.Sh DESCRIPTION
.Nm Fdformat
formats a floppy disk at device
.Ar device_name .
.Ar Device_name
may be given either with a full path
name of a device node for a floppy disk drive
.Pq e.g. Pa /dev/fd0 ,
or a default name in an abbreviated form
.Pq e.g. Em fd0 .
In the latter case, the name is constructed by prepending
.Pa /dev/
and appending a
.Em .capacity
to the
.Ar device_name .
Note that any geometry constraints of the device node
.Pq minor device number
are meaningless, since they're overridden by
.Nm .
.Pp
The options are as follows:
.Bl -tag -width 10n -offset indent
.It Fl q
Suppress any normal output from the command, and don't ask the
user for a confirmation whether to format the floppy disk at
.Ar device_name .
.It Fl y
Suppress confirmation request by automagically responding "yes", but still
report format status.
.It Fl f Ar capacity
The normal way to specify the desired formatting parameters.
.Ar Capacity
is the number of kilobytes to format.
Valid choices are 360, 720, 800, 820,
1200, 1440, 1480 or 1720.
.It Fl n
Don't verify floppy after formatting.
.It Fl v
Don't format, verify only.
.It Fl c Ar cyls
Number of cylinders: 40 or 80.
.It Fl s Ar secs
Number of sectors per track: 9, 10, 15 or 18.
.It Fl h Ar heads
Number of floppy heads: 1 or 2.
.It Fl r Ar rate
Data rate: 250, 300 or 500 kbps.
.It Fl g Ar gap3len
Gap length.
.It Fl i Ar intleave
Interleave factor.
.It Fl S Ar secshft
Sector size: 0=128, 1=256, 2=512 bytes.
.It Fl F Ar fillbyte
Fill byte.
.It Fl t Ar steps_per_track
Number of steps per track.
An alternate method to specify the geometry data to write to the floppy disk.
.El
.Pp
If the
.Fl q
flag has not been specified, the user is asked for a confirmation
of the intended formatting process.
In order to continue, an answer
of
.Dq y
must be given.
.Pp
Note that
.Nm
does only perform low-level formatting.  In case you wish to create
a file system on the medium, see the commands
.Xr newfs 8
for an
.Em ufs
file system, or
.Xr newfs_msdos 8
for an
.Em MS-DOS (FAT)
file system.
.Sh DIAGNOSTICS
Unless
.Fl q
has been specified, a single letter is printed to standard output
to inform the user about the progress of work.
First, an
.Sq Em F
is printed when the track(s) is being formatted, then a
.Sq Em V
while it's being verified, and if an error has been detected, it
will finally change to
.Sq Em E .
.Pp
An exit status of 0 is returned upon successful operation.
Exit status
1 is returned on any errors during floppy formatting, and an exit status
of 2 reflects invalid arguments given to the program (along with an
appropriate information written to diagnostic output).
.Sh SEE ALSO
.Xr fdc 4 ,
.Xr newfs 8 ,
.Xr newfs_msdos 8
.Sh HISTORY
.Nm Fdformat
has been developed for 386BSD 0.1
and upgraded to the new
.Xr fdc 4
floppy disk driver.
It later became part of the
.Fx 1.1
system.
.Sh AUTHORS
.An -nosplit
The program has been contributed by
.An J\(:org Wunsch ,
Dresden, with changes by
.An Serge Vakulenko
and
.An Andrey A. Chernov ,
Moscow.
Cross-reference newfs(8), and mkdosfs(1). 1995-11-05 19:23:42 +00:00			`.\" Copyright (C) 1993, 1994, 1995 by Joerg Wunsch, Dresden`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
Make use of the new FDOPT_NORETRY facility. It does not make sense to verify formatted tracks with fully retryng. The head should not be moved in either case. Also some minor copyright cleanup. 1994-05-22 17:43:34 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
			`.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED`
			`.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE`
			`.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,`
			`.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES`
			`.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR`
			`.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,`
			`.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING`
			`.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE`
			`.\" POSSIBILITY OF SUCH DAMAGE.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Add $Id$, to make it simpler for members of the translation teams to track. The Id line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 20:12:29 +00:00			`.\"`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Dd September 16, 1993`
Make use of the new FDOPT_NORETRY facility. It does not make sense to verify formatted tracks with fully retryng. The head should not be moved in either case. Also some minor copyright cleanup. 1994-05-22 17:43:34 +00:00			`.Os`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Dt FDFORMAT 1`
			`.Sh NAME`
			`.Nm fdformat`
			`.Nd format floppy disks`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`.Op Fl q`
Add -y option which doesn't ask for confimation, but still shows progress PR: 9259 Submitted by: Clark Gaylord <cgaylord@vt.edu> 2000-06-01 22:27:30 +00:00			`.Op Fl y`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`.Op Fl v \| Fl n`
			`.Op Fl f Ar capacity`
			`.Op Fl c Ar cyls`
			`.Op Fl s Ar secs`
			`.Op Fl h Ar heads`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`.Op Fl r Ar rate`
			`.Op Fl g Ar gap3len`
			`.Op Fl i Ar intleave`
			`.Op Fl S Ar secshft`
			`.Op Fl F Ar fillbyte`
			`.Op Fl t Ar steps_per_track`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Ar device_name`
			`.Sh DESCRIPTION`
			`.Nm Fdformat`
			`formats a floppy disk at device`
			`.Ar device_name .`
			`.Ar Device_name`
Fix fdformat to not use /dev/r* device nodes anymore, this usage has been made obsolete by the block/char device merging. Reflect this change in the manual page and fix the usage of a backslash in ``e.g.''. Reviewed by: bright, sheldonh, phk 2000-01-23 12:49:42 +00:00			`may be given either with a full path`
			`name of a device node for a floppy disk drive`
			`.Pq e.g. Pa /dev/fd0 ,`
			`or a default name in an abbreviated form`
			`.Pq e.g. Em fd0 .`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`In the latter case, the name is constructed by prepending`
Fix fdformat to not use /dev/r* device nodes anymore, this usage has been made obsolete by the block/char device merging. Reflect this change in the manual page and fix the usage of a backslash in ``e.g.''. Reviewed by: bright, sheldonh, phk 2000-01-23 12:49:42 +00:00			`.Pa /dev/`
Make use of the new FDOPT_NORETRY facility. It does not make sense to verify formatted tracks with fully retryng. The head should not be moved in either case. Also some minor copyright cleanup. 1994-05-22 17:43:34 +00:00			`and appending a`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Em .capacity`
			`to the`
			`.Ar device_name .`
			`Note that any geometry constraints of the device node`
			`.Pq minor device number`
			`are meaningless, since they're overridden by`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm .`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width 10n -offset indent`
			`.It Fl q`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Suppress any normal output from the command, and don't ask the`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`user for a confirmation whether to format the floppy disk at`
			`.Ar device_name .`
Add -y option which doesn't ask for confimation, but still shows progress PR: 9259 Submitted by: Clark Gaylord <cgaylord@vt.edu> 2000-06-01 22:27:30 +00:00			`.It Fl y`
			`Suppress confirmation request by automagically responding "yes", but still`
			`report format status.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl f Ar capacity`
			`The normal way to specify the desired formatting parameters.`
			`.Ar Capacity`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`is the number of kilobytes to format.`
			`Valid choices are 360, 720, 800, 820,`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`1200, 1440, 1480 or 1720.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl n`
			`Don't verify floppy after formatting.`
			`.It Fl v`
			`Don't format, verify only.`
			`.It Fl c Ar cyls`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Number of cylinders: 40 or 80.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl s Ar secs`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Number of sectors per track: 9, 10, 15 or 18.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl h Ar heads`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Number of floppy heads: 1 or 2.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl r Ar rate`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Data rate: 250, 300 or 500 kbps.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl g Ar gap3len`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Gap length.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl i Ar intleave`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Interleave factor.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl S Ar secshft`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Sector size: 0=128, 1=256, 2=512 bytes.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl F Ar fillbyte`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Fill byte.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.It Fl t Ar steps_per_track`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`Number of steps per track.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`An alternate method to specify the geometry data to write to the floppy disk.`
			`.El`
Prepare for mdoc(7)NG. 2000-12-27 15:30:30 +00:00			`.Pp`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`If the`
			`.Fl q`
			`flag has not been specified, the user is asked for a confirmation`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`of the intended formatting process.`
			`In order to continue, an answer`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`of`
			`.Dq y`
			`must be given.`
Cross-reference newfs(8), and mkdosfs(1). 1995-11-05 19:23:42 +00:00			`.Pp`
			`Note that`
			`.Nm`
			`does only perform low-level formatting. In case you wish to create`
			`a file system on the medium, see the commands`
			`.Xr newfs 8`
			`for an`
			`.Em ufs`
			`file system, or`
mkdosfs(1) is dead, refere to newfs_msdos(8) 1998-09-29 17:31:28 +00:00			`.Xr newfs_msdos 8`
Cross-reference newfs(8), and mkdosfs(1). 1995-11-05 19:23:42 +00:00			`for an`
			`.Em MS-DOS (FAT)`
			`file system.`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Sh DIAGNOSTICS`
Some fixes from Joerg 1994-02-11 21:41:44 +00:00			`Unless`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Fl q`
Some fixes from Joerg 1994-02-11 21:41:44 +00:00			`has been specified, a single letter is printed to standard output`
			`to inform the user about the progress of work.`
			`First, an`
			`.Sq Em F`
			`is printed when the track(s) is being formatted, then a`
			`.Sq Em V`
			`while it's being verified, and if an error has been detected, it`
			`will finally change to`
			`.Sq Em E .`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Pp`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`An exit status of 0 is returned upon successful operation.`
			`Exit status`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`1 is returned on any errors during floppy formatting, and an exit status`
			`of 2 reflects invalid arguments given to the program (along with an`
			`appropriate information written to diagnostic output).`
			`.Sh SEE ALSO`
Cross-reference newfs(8), and mkdosfs(1). 1995-11-05 19:23:42 +00:00			`.Xr fdc 4 ,`
mkdosfs(1) is dead, refere to newfs_msdos(8) 1998-09-29 17:31:28 +00:00			`.Xr newfs 8 ,`
			`.Xr newfs_msdos 8`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`.Sh HISTORY`
			`.Nm Fdformat`
Some fixes from Joerg 1994-02-11 21:41:44 +00:00			`has been developed for 386BSD 0.1`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`and upgraded to the new`
fd(4) referenced in HISTORY has nothing to do with floppy disks; changed to fdc(4). 1998-04-20 11:34:47 +00:00			`.Xr fdc 4`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`floppy disk driver.`
			`It later became part of the`
Use err(3). Document options in man page, not in usage string. 1997-09-17 06:32:45 +00:00			`.Fx 1.1`
			`system.`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.Sh AUTHORS`
mdoc(7) police: do not split author names in the AUTHORS section. 2000-11-22 09:35:58 +00:00			`.An -nosplit`
We got now floppy formatter 1994-01-26 23:44:34 +00:00			`The program has been contributed by`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.An J\(:org Wunsch ,`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`Dresden, with changes by`
			`.An Serge Vakulenko`
			`and`
			`.An Andrey A. Chernov ,`
			`Moscow.`