Convert to mdoc, except for a gruesome example.

share/man/man8/man8.vax/format.8

@@ -1,4 +1,4 @@
-.\"	$NetBSD: format.8,v 1.7 2002/02/13 08:18:33 ross Exp $
+.\"	$NetBSD: format.8,v 1.8 2003/04/17 20:04:29 wiz Exp $
 .\"
 .\" Copyright (c) 1980, 1983, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@@ -33,149 +33,164 @@
 .\"
 .\"	from: @(#)format.8	8.1 (Berkeley) 6/5/93
 .\"
-.TH FORMAT 8 "June 5, 1993"
+.Dd April 17, 2003
-.UC 4
+.Dt FORMAT 8
-.SH NAME
+.Os
-format \- how to format disk packs
+.Sh NAME
-.SH DESCRIPTION
+.Nm format
-.PP
+.Nd how to format disk packs
+.Sh DESCRIPTION
 There are two ways to format disk packs.  The simplest is to
 use the
-.I format
+.Nm
-program.  The alternative is to use the DEC standard formatting
+program.
-software which operates under the DEC diagnostic supervisor.
+The alternative is to use the DEC standard formatting software which
+operates under the DEC diagnostic supervisor.
 This manual page describes the operation of
-.IR format ,
+.Nm ,
 then concludes with some remarks about using the DEC formatter.
-.PP
+.Pp
-.I Format
+.Nm
-is a standalone program used to
+is a standalone program used to format and check disks prior to
-format and check disks prior to constructing
+constructing file systems.
-file systems.
+In addition to the formatting operation,
-In addition to the formatting
+.Nm
-operation,
+records any bad sectors encountered according to DEC standard 144.
-.I format
+Formatting is performed one track at a time by writing the appropriate
-records any bad sectors encountered
+headers and a test pattern and then checking the sector by reading and
-according to DEC standard 144.
+verifying the pattern, using the controller's ECC for error detection.
-Formatting is performed one track at a
+A sector is marked bad if an unrecoverable media error is detected, or
-time by writing the appropriate
+if a correctable ECC error too many bits in length is detected (such
-headers and a test pattern and then checking
+errors are indicated as
-the sector by reading and verifying the pattern, using
+.Dq ECC
-the controller's ECC for error detection.
+in the summary printed upon completing the format operation).
-A sector is marked bad if an unrecoverable media
+After the entire disk has been formatted and checked, the total number
-error is detected, or if a correctable
+of errors are reported, any bad sectors and skip sectors are marked,
-ECC error too many bits in length
+and a bad sector forwarding table is written to the disk in the first
-is detected (such errors are indicated as
+five even numbered sectors of the last track.
-``ECC'' in the summary printed upon
+It is also possible to reformat sections of the disk in units of
-completing the format operation).
+tracks.
-After the entire disk
+.Nm
-has been formatted and checked,
+may be used on any
-the total number of errors are reported,
+.Tn UNIBUS
-any bad sectors and skip sectors are marked,
+or
-and a bad sector forwarding table
+.Tn MASSBUS
-is written to the disk in the first five
+drive supported by the
-even numbered sectors of the last track.
+.Em up
-It is also possible to reformat sections of the disk
+and
-in units of tracks.
+.Em hp
-.I Format
+device drivers which uses 4-byte headers (everything except RP's).
-may be used on any UNIBUS or MASSBUS drive
+.Pp
-supported by the \fIup\fP and \fIhp\fP device
+The test pattern used during the media check may be selected from one
-drivers which uses 4-byte headers (everything except RP's).
+of: 0xf00f (RH750 worst case), 0xec6d (media worst case), and 0xa5a5
-.PP
+(alternating 1's and 0's).
-The test pattern used during the media check
-may be selected from one of: 0xf00f (RH750 worst case),
-0xec6d (media worst case), and 0xa5a5 (alternating
-1's and 0's).
 Normally the media worst case pattern is used.
-.PP
+.Pp
-.I Format
+.Nm
-also has an option to perform an extended \*(lqsevere burn-in,\*(rq
+also has an option to perform an extended
+.Dq severe burn-in ,
 which makes a number of passes using different patterns.
-The number of passes can be selected at run time,
+The number of passes can be selected at run time, up to a maximum of
-up to a maximum of 48,
+48, with provision for additional passes or termination after the
-with provision for additional passes or termination
+preselected number of passes.
-after the preselected number of passes.
 This test runs for many hours, depending on the disk and processor.
-.PP
+.Pp
 Each time
-.I format
+.Nm
-is run to format an entire disk,
+is run to format an entire disk, a completely new bad sector table is
-a completely new bad sector table is generated
+generated based on errors encountered while formatting.
-based on errors encountered while formatting.
+The device driver, however, will always attempt to read any existing
-The device driver, however, will always attempt to
+bad sector table when the device is first opened.
-read any existing bad sector table when the device is
+Thus, if a disk pack has never previously been formatted, or has been
-first opened.
+formatted with different sectoring, five error messages will be
-Thus, if a disk pack has never previously been formatted,
+printed when the driver attempts to read the bad sector table; these
-or has been formatted with different sectoring,
+diagnostics should be ignored.
-five error messages will be printed when the driver attempts
+.Pp
-to read the bad sector table; these diagnostics should be ignored.
+Formatting a 400 megabyte disk on a
-.PP
+.Tn MASSBUS
-Formatting a 400 megabyte disk on a MASSBUS disk controller
+disk controller usually takes about 20 minutes.
-usually takes about 20 minutes.
+Formatting on a
-Formatting on a UNIBUS disk controller takes significantly
+.Tn UNIBUS
-longer.
+disk controller takes significantly longer.
 For every hundredth cylinder formatted
-.I format
+.Nm
 prints a message indicating the current cylinder being formatted.
-(This message is just to reassure people that nothing is
+(This message is just to reassure people that nothing is amiss.)
-is amiss.)
+.Pp
-.PP
+.Nm
-.I Format
+uses the standard notation of the standalone I/O library in
-uses the standard notation of the standalone I/O library
+identifying a drive to be formatted.
-in identifying a drive to be formatted.  A drive is
+A drive is  specified as
-specified as
+.Em zz(x,y) ,
-.IR zz ( x , y ),
 where
-.I zz
+.Em zz
 refers to the controller type (either
-.I hp
+.Em hp
 or
-.IR up ),
+.Em up ) ,
-.I x
+.Em x
-is the unit number of the drive;
+is the unit number of the drive; 8 times the
-8 times the UNIBUS or MASSBUS
+.Tn UNIBUS
-adaptor number plus the MASSBUS drive number or UNIBUS
+or
+.Tn MASSBUS
+adaptor number plus the
+.Tn MASSBUS
+drive number or
+.Tn UNIBUS
 drive unit number; and
-.I y
+.Em y
-is the file system partition
+is the file system partition on drive
-on drive
+.Em x
-.I x
 (this should always be 0).
-For example, ``hp(1,0)'' indicates that drive
+For example,
-1 on MASSBUS adaptor 0 should be formatted; while
+.Dq hp(1,0)
-``up(10,0)'' indicates that UNIBUS drive 2 on UNIBUS adaptor 1
+indicates that drive 1 on
-should be formatted.
+.Tn MASSBUS
-.PP
+adaptor 0 should be formatted; while
+.Dq up(10,0)
+indicates that
+.Tn UNIBUS
+drive 2 on
+.Tn UNIBUS
+adaptor 1 should be formatted.
+.Pp
 Before each formatting attempt,
-.I format
+.Nm
-prompts the user in case debugging should be enabled
+prompts the user in case debugging should be enabled in the
-in the appropriate device driver.  A carriage return
+appropriate device driver.
-disables debugging information.
+A carriage return disables debugging information.
-.PP
+.Pp
-.I Format
+.Nm
 should be used prior to building file systems (with
-.IR newfs (8))
+.Xr newfs 8
-to ensure that all sectors with uncorrectable media errors
+to ensure that all sectors with uncorrectable media errors are
-are remapped.  If a drive develops uncorrectable
+remapped.
-defects after formatting, either
+If a drive develops uncorrectable defects after formatting, either
-.IR bad144 (8)
+.Xr bad144 8
 or
-.IR badsect (8)
+.Xr badsect 8
 should be able to avoid the bad sectors.
-.SH EXAMPLE
+.Sh EXAMPLES
 A sample run of
-.I format
+.Nm
 is shown below.
-In this example (using a VAX-11/780),
+In this example (using a
-.I format
+.Tn VAX-11/780 ) ,
+.Nm
 is loaded from the console floppy;
 on an 11/750
-.I format
+.Nm
 will be loaded from the root file system with
-.IR boot (8)
+.Xr boot 8
-following a \*(lqB/3\*(rq command.
+following a
+.Dq B/3
+command.
 Boldface means user input.
-As usual, ``#'' and ``@'' may be used to edit input.
+As usual,
+.Dq #
+and
+.Dq @
+may be used to edit input.
 .nf
 .in +0.5i
 .ta  1i
@@ -224,28 +239,26 @@ Done
 (\fI...to abort halt machine with ^P\fP)
 .fi
 .sp 1
-.SH DIAGNOSTICS
+.Sh DIAGNOSTICS
 The diagnostics are intended to be self explanatory.
-.SH "USING DEC SOFTWARE TO FORMAT"
+.Sh USING DEC SOFTWARE TO FORMAT
-.PP
+.Em "Warning:  These instructions are for people with 11/780 CPU's."
-.B "Warning:  These instructions are for people with 11/780 CPU's."
+The steps needed for 11/750 or 11/730 CPU's are similar, but not
-The steps needed for 11/750 or 11/730 cpu's are similar, but not
 covered in detail here.
-.I
+.Pp
-.PP
+The formatting procedures are different for each type of disk.
-The formatting procedures are different for each type of disk.  Listed
+Listed here are the formatting procedures for RK07's, RP0X, and RM0X
-here are the formatting procedures for RK07's, RP0X, and RM0X
 disks.
-.PP
+.Pp
 You should shut down UNIX and halt the machine to do any disk formatting.
-Make certain you put in the pack you want formatted.  It is also a good idea
+Make certain you put in the pack you want formatted.
-to spin down or write protect the disks you don't want to format, just in case.
+It is also a good idea to spin down or write protect the disks you
-.PP
+don't want to format, just in case.
-.B "Formatting an RK07."
+.Ss Formatting an RK07
-Load the console floppy labeled, "RX11 VAX DSK LD DEV #1" in
+Load the console floppy labeled,
-the console disk drive, and type the following commands:
+.Dq RX11 VAX DSK LD DEV #1
-.RS
+in the console disk drive, and type the following commands:
-.nf
+.Bd -literal -offset indent
 \*[Gt]\*[Gt]\*[Gt]BOOT
 DIAGNOSTIC SUPERVISOR.  ZZ-ESSAA-X5.0-119  23-JAN-1980 12:44:40.03
 DS\*[Gt]ATTACH DW780 SBI DW0 3 5
@@ -254,42 +267,35 @@ DS\*[Gt]ATTACH RK07 DW0 DMA0
 DS\*[Gt]SELECT DMA0
 DS\*[Gt]LOAD EVRAC
 DS\*[Gt]START/SEC:PACKINIT
-.fi
+.Ed
-.RE
+.Ss Formatting an RP0X
-.PP
-.B "Formatting an RP0X."
 Follow the above procedures except that the
 ATTACH and SELECT lines should read:
-.RS
+.Bd -literal -offset indent
-.nf
 DS\*[Gt]ATTACH RH780 SBI RH0 8 5
-DS\*[Gt]ATTACH RP0X RH0 DBA0		(RP0X is, e.g. RP06)
+DS\*[Gt]ATTACH RP0X RH0 DBA0		(RP0X is, e.g., RP06)
 DS\*[Gt]SELECT DBA0
-.fi
+.Ed
-.RE
+.Pp
-.PP
 This is for drive 0 on mba0; use 9 instead of 8 for mba1, etc.
-.PP
+.Ss Formatting an RM0X
-.B "Formatting an RM0X."
 Follow the above procedures except that the
 ATTACH and SELECT lines should read:
-.RS
+.Bd -literal -offset indent
-.nf
 DS\*[Gt]ATTACH RH780 SBI RH0 8 5
 DS\*[Gt]ATTACH RM0X RH0 DRA0
 DS\*[Gt]SELECT DRA0
-.fi
+.Ed
-.RE
+.Pp
-.PP
+Don't forget to put your UNIX console floppy back in the floppy disk
-Don't forget to put your UNIX console floppy back
+drive.
-in the floppy disk drive.
+.Sh SEE ALSO
-.SH SEE ALSO
+.Xr bad144 8 ,
-bad144(8),
+.Xr badsect 8 ,
-badsect(8),
+.Xr newfs 8
-newfs(8)
+.Sh BUGS
-.SH BUGS
+An equivalent facility should be available which operates under a
-An equivalent facility should be available which operates under
+running UNIX system.
-a running UNIX system.
+.Pp
-.PP
 It should be possible to reformat or verify part or all of a disk,
 then update the existing bad sector table.