Differential D13356 Diff 36173 usr.sbin/ufdformat/ufdformat.1

Changeset View

Standalone View

usr.sbin/ufdformat/ufdformat.1

				.\"
				.\" Copyright (c) 2004 by Bruce M. Simpson.
				.\" 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 October 12, 2004
				.Os
				.Dt UFDFORMAT 1
				.Sh NAME
				.Nm ufdformat
				.Nd format USB floppy disks
				.Sh SYNOPSIS
				.Nm
				.Op Fl f Ar fmt
				.Op Fl nqvy
				.Ar device
				.Sh DESCRIPTION
				The
				.Nm
				utility formats a floppy disk at
				.Ar device ,
				where
				.Ar device
				may either be given as a full path
				wblockUnsubmitted Not Done Inline Actions can be given as the full path wblock: ```can be given as the full path```
				name of a device node for a USB floppy disk drive
				(e.g.\&
				wblockUnsubmitted Not Done Inline Actions (like wblock: ```(like```
				.Pa /dev/da0 ) ,
				or using an abbreviated name that will be looked up
				wblockUnsubmitted Not Done Inline Actions or as an short device name that is located in`` wblock: ```or as an short device name that is located in``
				under
				wblockUnsubmitted Not Done Inline Actions Remove this line. wblock: Remove this line.
				.Pa /dev
				(e.g.\&
				wblockUnsubmitted Not Done Inline Actions (like wblock: ```(like```
				.Dq Li da0 ) .
				.Pp
				The options are as follows:
				wblockUnsubmitted Not Done Inline Actions The options are: wblock: ```The options are:```
				.Bl -tag -width ".Fl s Ar fmtstr"
				.It Fl f Ar fmt
				Specify the density settings for a
				.Ar fmt
				kilobyte format, as described in
				.Xr fdcontrol 8 ;
				wblockUnsubmitted Not Done Inline Actions Break the sentence here. .Xr fdcontrol 8 . wblock: Break the sentence here. ```.Xr fdcontrol 8 .```
				1.44MB is assumed as the default.
				wblockUnsubmitted Not Done Inline Actions The default is 1.44MB. wblock: ```The default is 1.44MB.```
				.It Fl n
				Do not verify floppy after formatting.
				.It Fl q
				Suppress any normal output from the command, and do not ask the
				user for a confirmation whether to format the floppy disk at
				.Ar device .
				.It Fl v
				Do not format, verify only.
				.It Fl y
				Do not ask for confirmation whether to format the floppy disk but
				wblockUnsubmitted Not Done Inline Actions Do not ask for confirmation about formatting the floppy disk, but wblock: ```Do not ask for confirmation about formatting the floppy disk, but```
				still report formatting status.
				.El
				.Pp
				If the
				.Fl q
				flag has not been specified, the user is asked for a confirmation
				wblockUnsubmitted Not Done Inline Actions flag has not been specified, ask the user for confirmation wblock: ```flag has not been specified, ask the user for confirmation```
				of the intended formatting process.
				In order to continue, an answer
				wblockUnsubmitted Not Done Inline Actions To continue, an answer wblock: ```To continue, an answer```
				of
				.Ql y
				must be given.
				.Pp
				Note that
				.Nm
				only performs low-level formatting.
				In order to create
				wblockUnsubmitted Not Done Inline Actions To create wblock: ```To create```
				a file system on the medium, see the commands
				.Xr newfs 8
				for a
				.Tn UFS
				file system, or
				.Xr newfs_msdos 8
				for an
				.Tn 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
				.Ql F
				is printed when the track is being formatted, then a
				.Ql V
				while it is being verified, and if an error has been detected, it
				wblockUnsubmitted Not Done Inline Actions s/has been/is/ wblock: s/has been/is/
				will finally change to
				wblockUnsubmitted Not Done Inline Actions Don't need "finally". wblock: Don't need "finally".
				.Ql E .
				Detailed status information (cylinder, head and sector number, and the
				exact cause of the error) will be printed for up to 10 errors after the
				wblockUnsubmitted Not Done Inline Actions s/will be/are/ wblock: s/will be/are/
				entire formatting process has completed.
				.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
				wblockUnsubmitted Not Done Inline Actions Break the sentence: 1 is returned on any errors during floppy formatting. An exit status wblock: Break the sentence: ```1 is returned on any errors during floppy formatting. An exit status```
				of 2 reflects invalid arguments given to the program (along with an
				wblockUnsubmitted Not Done Inline Actions of 2 reflects invalid arguments given to the program, along with wblock: ```of 2 reflects invalid arguments given to the program, along with```
				appropriate information written to diagnostic output).
				wblockUnsubmitted Not Done Inline Actions appropriate information written to diagnostic output. wblock: ```appropriate information written to diagnostic output.```
				.Sh SEE ALSO
				.Xr fdformat 1 ,
				.Xr fdcontrol 8 ,
				.Xr umass 4 ,
				.Xr newfs 8 ,
				.Xr newfs_msdos 8
				.Rs
				.%T UFI Command Specification
				.%Q "USB Implementers Forum, Inc."
				.%N "Revision 1.0"
				.%D "December 1998"
				.Re
				.Sh HISTORY
				The
				.Nm
				utility
				first appeared in
				.Fx 6.0 .
				wblockUnsubmitted Not Done Inline Actions Ummm.... copy/paste error? ufdformat didn't appear in FreeBSD 6, unless I'm mistaken. wblock: Ummm.... copy/paste error? ufdformat didn't appear in FreeBSD 6, unless I'm mistaken.
				.Sh AUTHORS
				.An -nosplit
				The program has been contributed by
				.An Bruce M. Simpson .