BSD 4_3_Net_2 release

[unix-history] / usr / src / sbin / badsect / badsect.8

diff --git a/usr/src/sbin/badsect/badsect.8 b/usr/src/sbin/badsect/badsect.8
index fb45320..3814663 100644 (file)
--- a/usr/src/sbin/badsect/badsect.8
+++ b/usr/src/sbin/badsect/badsect.8
@@ -1,100 +1,132 @@
-.\" Copyright (c) 1985 The Regents of the University of California.
+.\" Copyright (c) 1985, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)badsect.8   6.3 (Berkeley) 6/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.

 .\"
 .\"

-.TH BADSECT 8 "June 24, 1990"
-.UC 4
-.SH NAME
-badsect \- create files to contain bad sectors
-.SH SYNOPSIS
-.B /etc/badsect
-bbdir sector ...
-.SH DESCRIPTION
-.I Badsect
+.\"     @(#)badsect.8  6.4 (Berkeley) 3/16/91
+.\"
+.Dd March 16, 1991
+.Dt BADSECT 8
+.Os BSD 4
+.Sh NAME
+.Nm badsect
+.Nd create files to contain bad sectors
+.Sh SYNOPSIS
+.Nm /etc/badsect
+.Ar bbdir sector ...
+.Sh DESCRIPTION
+.Nm Badsect

 makes a file to contain a bad sector.  Normally, bad sectors
 are made inaccessible by the standard formatter, which provides
 a forwarding table for bad sectors to the driver; see
 makes a file to contain a bad sector.  Normally, bad sectors
 are made inaccessible by the standard formatter, which provides
 a forwarding table for bad sectors to the driver; see

-.IR bad144 (8)
+.Xr bad144 8

 for details.
 If a driver supports the bad blocking standard it is much preferable to
 use that method to isolate bad blocks, since the bad block forwarding
 makes the pack appear perfect, and such packs can then be copied with
 for details.
 If a driver supports the bad blocking standard it is much preferable to
 use that method to isolate bad blocks, since the bad block forwarding
 makes the pack appear perfect, and such packs can then be copied with

-.IR dd (1).
+.Xr dd 1 .

 The technique used by this program is also less general than
 bad block forwarding, as
 The technique used by this program is also less general than
 bad block forwarding, as

-.I badsect
+.Nm badsect

 can't make amends for
 bad blocks in the i-list of file systems or in swap areas.
 can't make amends for
 bad blocks in the i-list of file systems or in swap areas.

-.PP
+.Pp

 On some disks,
 adding a sector which is suddenly bad to the bad sector table
 On some disks,
 adding a sector which is suddenly bad to the bad sector table

-currently requires the running of the standard DEC formatter.
+currently requires the running of the standard
+.Tn DEC
+formatter.

 Thus to deal with a newly bad block
 or on disks where the drivers
 do not support the bad-blocking standard 
 Thus to deal with a newly bad block
 or on disks where the drivers
 do not support the bad-blocking standard 

-.I badsect
+.Nm badsect

 may be used to good effect.
 may be used to good effect.

-.PP
-.I Badsect
+.Pp
+.Nm Badsect

 is used on a quiet file system in the following way:
 First mount the file system, and change to its root directory.
 is used on a quiet file system in the following way:
 First mount the file system, and change to its root directory.

-Make a directory BAD there.  Run
-.I badsect
-giving as argument the BAD directory followed by
+Make a directory
+.Li BAD
+there.  Run
+.Nm badsect
+giving as argument the
+.Ar BAD
+directory followed by

 all the bad sectors you wish to add.
 (The sector numbers must be relative to the beginning of
 the file system, but this is not hard as the system reports
 relative sector numbers in its console error messages.)
 Then change back to the root directory, unmount the file system
 and run
 all the bad sectors you wish to add.
 (The sector numbers must be relative to the beginning of
 the file system, but this is not hard as the system reports
 relative sector numbers in its console error messages.)
 Then change back to the root directory, unmount the file system
 and run

-.IR fsck (8)
+.Xr fsck 8

 on the file system.  The bad sectors should show up in two files
 or in the bad sector files and the free list.  Have
 on the file system.  The bad sectors should show up in two files
 or in the bad sector files and the free list.  Have

-.I fsck
+.Xr fsck

 remove files containing the offending bad sectors, but 
 remove files containing the offending bad sectors, but 

-.B "do not"
-have it remove the BAD/\fInnnnn\fR files.
-This will leave the bad sectors in only the BAD files.
-.PP
-.I Badsect
+.Em do not
+have it remove the
+.Pa BAD/ Ns Em nnnnn
+files.
+This will leave the bad sectors in only the
+.Li BAD
+files.
+.Pp
+.Nm Badsect

 works by giving the specified sector numbers in a
 works by giving the specified sector numbers in a

-.IR mknod (2)
+.Xr mknod 2

 system call,
 creating an illegal file whose first block address is the block containing
 bad sector and whose name is the bad sector number.
 When it is discovered by 
 system call,
 creating an illegal file whose first block address is the block containing
 bad sector and whose name is the bad sector number.
 When it is discovered by 

-.I fsck
-it will ask ``HOLD BAD BLOCK''?
+.Xr fsck
+it will ask
+.Dq Li "HOLD BAD BLOCK ?"

 A positive response will cause 
 A positive response will cause 

-.I fsck
+.Xr fsck

 to convert the inode to a regular file containing the bad block.
 to convert the inode to a regular file containing the bad block.

-.SH SEE ALSO
-bad144(8),
-fsck(8),
-format(8V)
-.SH DIAGNOSTICS
-.I Badsect
+.Sh SEE ALSO
+.Xr bad144 8 ,
+.Xr fsck 8 ,
+.Xr format 8
+.Sh DIAGNOSTICS
+.Nm Badsect

 refuses to attach a block that
 resides in a critical area or is out of range of the file system.
 A warning is issued if the block is already in use.
 refuses to attach a block that
 resides in a critical area or is out of range of the file system.
 A warning is issued if the block is already in use.

-.SH BUGS
+.Sh BUGS

 If more than one sector which comprise a file system fragment are bad,
 you should specify only one of them to
 If more than one sector which comprise a file system fragment are bad,
 you should specify only one of them to

-.I badsect,
+.Nm badsect ,

 as the blocks in the bad sector files actually cover all the sectors in a
 file system fragment.
 as the blocks in the bad sector files actually cover all the sectors in a
 file system fragment.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.1 .