[unix-history] / usr.sbin / fdformat / fdformat.1

.\" Copyright (C) 1993 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.
.\"
.Dd September 16, 1993
.Os
.Dt FDFORMAT 1
.Sh NAME
.Nm fdformat
.Nd format floppy disks
.Sh SYNOPSIS
.Nm fdformat
.Bq Fl q
.Bq Fl v
.Bq Fl n
.Bq Fl f Ar capacity
.Bq Fl c Ar cyls
.Bq Fl s Ar secs
.Bq Fl h Ar heads
.br
.Bq Fl r Ar rate
.Bq Fl g Ar gap3len
.Bq Fl i Ar intleave
.Bq Fl S Ar secshft
.Bq Fl F Ar fillbyte
.Bq 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
should be a character device; it may be given either with a full path
name of a raw device node for a floppy disk drive
.Pq e.\ g. Pa /dev/rfd0 ,
or default name in an abbreviated form
.Pq e.\ g. Em fd0 .
In the latter case, the name is constructed by prepending
.Pa /dev/r
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 fdformat .
.Pp
The options are as follows:
.Bl -tag -width 10n -offset indent
.It Fl q
supress 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 f Ar capacity
The normal way to specify the desired formatting parameters.
.Ar Capacity
is the number of kilobytes to format.
.It Fl n
Don't verify floppy after formatting.
.It Fl v
Don't format, verify only.
.It Fl c Ar cyls
.It Fl s Ar secs
.It Fl h Ar heads
.It Fl r Ar rate
.It Fl g Ar gap3len
.It Fl i Ar intleave
.It Fl S Ar secshft
.It Fl F Ar fillbyte
.It Fl t Ar steps_per_track
An alternate method to specify the geometry data to write to the floppy disk.
.El

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.
.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 fd 4 .
.Sh HISTORY
.Nm Fdformat
has been developed for 386BSD 0.1
and upgraded to the new
.Xr fd 4
floppy disk driver. It later became part of the
.Em FreeBSD
system, release 1.1.
.Sh AUTHOR
The program has been contributed by
.if n Joerg Wunsch,
.if t J\(:org Wunsch,
Dresden, with changes by Serge Vakulenko and Andrew A. Chernov, Moscow.
Commit	Line	Data
745cabe1 AC	1	.\" Copyright (C) 1993 by Joerg Wunsch, Dresden
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\"
1bd4610c JW	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
	14	.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	15	.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	16	.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
	17	.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	18	.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	19	.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	21	.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	22	.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	23	.\" POSSIBILITY OF SUCH DAMAGE.
745cabe1 AC	24	.\"
745cabe1 AC	25	.Dd September 16, 1993
1bd4610c	26	.Os
745cabe1 AC	27	.Dt FDFORMAT 1
	28	.Sh NAME
	29	.Nm fdformat
	30	.Nd format floppy disks
	31	.Sh SYNOPSIS
	32	.Nm fdformat
	33	.Bq Fl q
	34	.Bq Fl v
	35	.Bq Fl n
	36	.Bq Fl f Ar capacity
	37	.Bq Fl c Ar cyls
	38	.Bq Fl s Ar secs
	39	.Bq Fl h Ar heads
	40	.br
	41	.Bq Fl r Ar rate
	42	.Bq Fl g Ar gap3len
	43	.Bq Fl i Ar intleave
	44	.Bq Fl S Ar secshft
	45	.Bq Fl F Ar fillbyte
	46	.Bq Fl t Ar steps_per_track
	47	.Ar device_name
	48	.Sh DESCRIPTION
	49	.Nm Fdformat
	50	formats a floppy disk at device
	51	.Ar device_name .
	52	.Ar Device_name
	53	should be a character device; it may be given either with a full path
	54	name of a raw device node for a floppy disk drive
	55	.Pq e.\ g. Pa /dev/rfd0 ,
	56	or default name in an abbreviated form
	57	.Pq e.\ g. Em fd0 .
	58	In the latter case, the name is constructed by prepending
	59	.Pa /dev/r
1bd4610c	60	and appending a
745cabe1 AC	61	.Em .capacity
	62	to the
	63	.Ar device_name .
	64	Note that any geometry constraints of the device node
	65	.Pq minor device number
	66	are meaningless, since they're overridden by
	67	.Nm fdformat .
	68	.Pp
	69	The options are as follows:
	70	.Bl -tag -width 10n -offset indent
	71	.It Fl q
	72	supress any normal output from the command, and don't ask the
	73	user for a confirmation whether to format the floppy disk at
	74	.Ar device_name .
	75	.It Fl f Ar capacity
	76	The normal way to specify the desired formatting parameters.
	77	.Ar Capacity
	78	is the number of kilobytes to format.
	79	.It Fl n
	80	Don't verify floppy after formatting.
	81	.It Fl v
	82	Don't format, verify only.
	83	.It Fl c Ar cyls
	84	.It Fl s Ar secs
	85	.It Fl h Ar heads
	86	.It Fl r Ar rate
	87	.It Fl g Ar gap3len
	88	.It Fl i Ar intleave
	89	.It Fl S Ar secshft
	90	.It Fl F Ar fillbyte
	91	.It Fl t Ar steps_per_track
	92	An alternate method to specify the geometry data to write to the floppy disk.
	93	.El
	94
	95	If the
	96	.Fl q
	97	flag has not been specified, the user is asked for a confirmation
	98	of the intended formatting process. In order to continue, an answer
	99	of
	100	.Dq y
	101	must be given.
	102	.Sh DIAGNOSTICS
4a0b2285	103	Unless
745cabe1	104	.Fl q
4a0b2285 AC	105	has been specified, a single letter is printed to standard output
	106	to inform the user about the progress of work.
	107	First, an
	108	.Sq Em F
	109	is printed when the track(s) is being formatted, then a
	110	.Sq Em V
	111	while it's being verified, and if an error has been detected, it
	112	will finally change to
	113	.Sq Em E .
745cabe1 AC	114	.Pp
	115	An exit status of 0 is returned upon successful operation. Exit status
	116	1 is returned on any errors during floppy formatting, and an exit status
	117	of 2 reflects invalid arguments given to the program (along with an
	118	appropriate information written to diagnostic output).
745cabe1 AC	119	.Sh SEE ALSO
	120	.Xr fd 4 .
	121	.Sh HISTORY
	122	.Nm Fdformat
4a0b2285	123	has been developed for 386BSD 0.1
745cabe1 AC	124	and upgraded to the new
745cabe1 AC	125	.Xr fd 4
4a0b2285 AC	126	floppy disk driver. It later became part of the
	127	.Em FreeBSD
	128	system, release 1.1.
745cabe1 AC	129	.Sh AUTHOR
	130	The program has been contributed by
	131	.if n Joerg Wunsch,
	132	.if t J\(:org Wunsch,
4a0b2285	133	Dresden, with changes by Serge Vakulenko and Andrew A. Chernov, Moscow.