[src/trunk]: src/share/man/man8/man8.vax Convert to mdoc, except for a grueso...

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/0881d1ed38b1
branches:  trunk
changeset: 545919:0881d1ed38b1
user:      wiz <wiz%NetBSD.org@localhost>
date:      Thu Apr 17 20:04:29 2003 +0000

description:
Convert to mdoc, except for a gruesome example.

diffstat:

 share/man/man8/man8.vax/format.8 |  334 +++++++++++++++++++-------------------
 1 files changed, 170 insertions(+), 164 deletions(-)

diffs (truncated from 400 to 300 lines):

diff -r 2ee895a81759 -r 0881d1ed38b1 share/man/man8/man8.vax/format.8
--- a/share/man/man8/man8.vax/format.8  Thu Apr 17 20:00:03 2003 +0000
+++ b/share/man/man8/man8.vax/format.8  Thu Apr 17 20:04:29 2003 +0000
@@ -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"
-.UC 4
-.SH NAME
-format \- how to format disk packs
-.SH DESCRIPTION
-.PP
+.Dd April 17, 2003
+.Dt FORMAT 8
+.Os
+.Sh NAME
+.Nm format
+.Nd how to format disk packs
+.Sh DESCRIPTION
 There are two ways to format disk packs.  The simplest is to
 use the
-.I format
-program.  The alternative is to use the DEC standard formatting
-software which operates under the DEC diagnostic supervisor.
+.Nm
+program.
+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
-.I Format
-is a standalone program used to
-format and check disks prior to constructing
-file systems.
-In addition to the formatting
-operation,
-.I format
-records any bad sectors encountered
-according to DEC standard 144.
-Formatting is performed one track at a
-time by writing the appropriate
-headers and a test pattern and then checking
-the sector by reading and verifying the pattern, using
-the controller's ECC for error detection.
-A sector is marked bad if an unrecoverable media
-error is detected, or if a correctable
-ECC error too many bits in length
-is detected (such errors are indicated as
-``ECC'' in the summary printed upon
-completing the format operation).
-After the entire disk
-has been formatted and checked,
-the total number of errors are reported,
-any bad sectors and skip sectors are marked,
-and a bad sector forwarding table
-is written to the disk in the first five
-even numbered sectors of the last track.
-It is also possible to reformat sections of the disk
-in units of tracks.
-.I Format
-may be used on any UNIBUS or MASSBUS drive
-supported by the \fIup\fP and \fIhp\fP device
-drivers which uses 4-byte headers (everything except RP's).
-.PP
-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).
+.Pp
+.Nm
+is a standalone program used to format and check disks prior to
+constructing file systems.
+In addition to the formatting operation,
+.Nm
+records any bad sectors encountered according to DEC standard 144.
+Formatting is performed one track at a time by writing the appropriate
+headers and a test pattern and then checking the sector by reading and
+verifying the pattern, using the controller's ECC for error detection.
+A sector is marked bad if an unrecoverable media error is detected, or
+if a correctable ECC error too many bits in length is detected (such
+errors are indicated as
+.Dq ECC
+in the summary printed upon completing the format operation).
+After the entire disk has been formatted and checked, the total number
+of errors are reported, any bad sectors and skip sectors are marked,
+and a bad sector forwarding table is written to the disk in the first
+five even numbered sectors of the last track.
+It is also possible to reformat sections of the disk in units of
+tracks.
+.Nm
+may be used on any
+.Tn UNIBUS
+or
+.Tn MASSBUS
+drive supported by the
+.Em up
+and
+.Em hp
+device drivers which uses 4-byte headers (everything except RP's).
+.Pp
+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
-.I Format
-also has an option to perform an extended \*(lqsevere burn-in,\*(rq
+.Pp
+.Nm
+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,
-up to a maximum of 48,
-with provision for additional passes or termination
-after the preselected number of passes.
+The number of passes can be selected at run time, up to a maximum of
+48, with provision for additional passes or termination after the
+preselected number of passes.
 This test runs for many hours, depending on the disk and processor.
-.PP
+.Pp
 Each time
-.I format
-is run to format an entire disk,
-a completely new bad sector table is generated
-based on errors encountered while formatting.
-The device driver, however, will always attempt to
-read any existing bad sector table when the device is
-first opened.
-Thus, if a disk pack has never previously been formatted,
-or has been formatted with different sectoring,
-five error messages will be printed when the driver attempts
-to read the bad sector table; these diagnostics should be ignored.
-.PP
-Formatting a 400 megabyte disk on a MASSBUS disk controller
-usually takes about 20 minutes.
-Formatting on a UNIBUS disk controller takes significantly
-longer.
+.Nm
+is run to format an entire disk, a completely new bad sector table is
+generated based on errors encountered while formatting.
+The device driver, however, will always attempt to read any existing
+bad sector table when the device is first opened.
+Thus, if a disk pack has never previously been formatted, or has been
+formatted with different sectoring, five error messages will be
+printed when the driver attempts to read the bad sector table; these
+diagnostics should be ignored.
+.Pp
+Formatting a 400 megabyte disk on a
+.Tn MASSBUS
+disk controller usually takes about 20 minutes.
+Formatting on a
+.Tn UNIBUS
+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
-is amiss.)
-.PP
-.I Format
-uses the standard notation of the standalone I/O library
-in identifying a drive to be formatted.  A drive is
-specified as
-.IR zz ( x , y ),
+(This message is just to reassure people that nothing is amiss.)
+.Pp
+.Nm
+uses the standard notation of the standalone I/O library in
+identifying a drive to be formatted.
+A drive is  specified as
+.Em zz(x,y) ,
 where
-.I zz
+.Em zz
 refers to the controller type (either
-.I hp
+.Em hp
+or
+.Em up ) ,
+.Em x
+is the unit number of the drive; 8 times the
+.Tn UNIBUS
 or
-.IR up ),
-.I x
-is the unit number of the drive;
-8 times the UNIBUS or MASSBUS
-adaptor number plus the MASSBUS drive number or UNIBUS
+.Tn MASSBUS
+adaptor number plus the
+.Tn MASSBUS
+drive number or
+.Tn UNIBUS
 drive unit number; and
-.I y
-is the file system partition
-on drive
-.I x
+.Em y
+is the file system partition on drive
+.Em x
 (this should always be 0).
-For example, ``hp(1,0)'' indicates that drive
-1 on MASSBUS adaptor 0 should be formatted; while
-``up(10,0)'' indicates that UNIBUS drive 2 on UNIBUS adaptor 1
-should be formatted.
-.PP
+For example,
+.Dq hp(1,0)
+indicates that drive 1 on
+.Tn MASSBUS
+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
-prompts the user in case debugging should be enabled
-in the appropriate device driver.  A carriage return
-disables debugging information.
-.PP
-.I Format
+.Nm
+prompts the user in case debugging should be enabled in the
+appropriate device driver.
+A carriage return disables debugging information.
+.Pp
+.Nm
 should be used prior to building file systems (with
-.IR newfs (8))
-to ensure that all sectors with uncorrectable media errors
-are remapped.  If a drive develops uncorrectable
-defects after formatting, either
-.IR bad144 (8)
+.Xr newfs 8
+to ensure that all sectors with uncorrectable media errors are
+remapped.
+If a drive develops uncorrectable defects after formatting, either
+.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),
-.I format
+In this example (using a
+.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)
-following a \*(lqB/3\*(rq command.
+.Xr boot 8
+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 @@
 (\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"