Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sbin / badsect / badsect.8
1 .\" Copyright (c) 1985, 1991, 1993
2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgment:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)badsect.8   8.1 (Berkeley) 6/5/93
33 .\" $FreeBSD: src/sbin/badsect/badsect.8,v 1.10.2.6 2002/08/21 18:58:06 trhodes Exp $
34 .\"
35 .Dd June 5, 1993
36 .Dt BADSECT 8
37 .Os
38 .Sh NAME
39 .Nm badsect
40 .Nd create files to contain bad sectors
41 .Sh SYNOPSIS
42 .Nm
43 .Ar bbdir sector ...
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility makes a file to contain a bad sector.  Normally, bad sectors
48 are made inaccessible by the standard formatter, which provides
49 a forwarding table for bad sectors to the driver.
50 If a driver supports the bad blocking standard it is much preferable to
51 use that method to isolate bad blocks, since the bad block forwarding
52 makes the pack appear perfect, and such packs can then be copied with
53 .Xr dd 1 .
54 The technique used by this program is also less general than
55 bad block forwarding, as
56 .Nm
57 can't make amends for
58 bad blocks in the i-list of file systems or in swap areas.
59 .Pp
60 On some disks,
61 adding a sector which is suddenly bad to the bad sector table
62 currently requires the running of the standard
63 .Tn DEC
64 formatter.
65 Thus to deal with a newly bad block
66 or on disks where the drivers
67 do not support the bad-blocking standard
68 .Nm
69 may be used to good effect.
70 .Pp
71 The
72 .Nm
73 utility is used on a quiet file system in the following way:
74 First mount the file system, and change to its root directory.
75 Make a directory
76 .Li BAD
77 there.
78 Run
79 .Nm
80 giving as argument the
81 .Ar BAD
82 directory followed by
83 all the bad sectors you wish to add.
84 (The sector numbers must be relative to the beginning of
85 the file system, but this is not hard as the system reports
86 relative sector numbers in its console error messages.)
87 Then change back to the root directory, unmount the file system
88 and run
89 .Xr fsck 8
90 on the file system.  The bad sectors should show up in two files
91 or in the bad sector files and the free list.  Have
92 .Xr fsck
93 remove files containing the offending bad sectors, but
94 .Em do not
95 have it remove the
96 .Pa BAD/ Ns Em nnnnn
97 files.
98 This will leave the bad sectors in only the
99 .Li BAD
100 files.
101 .Pp
102 The
103 .Nm
104 utility works by giving the specified sector numbers in a
105 .Xr mknod 2
106 system call,
107 creating an illegal file whose first block address is the block containing
108 bad sector and whose name is the bad sector number.
109 When it is discovered by
110 .Xr fsck 8
111 it will ask
112 .Dq Li "HOLD BAD BLOCK \&?" .
113 A positive response will cause
114 .Xr fsck 8
115 to convert the inode to a regular file containing the bad block.
116 .Sh SEE ALSO
117 .Xr fsck 8
118 .Sh DIAGNOSTICS
119 The
120 .Nm
121 utility refuses to attach a block that
122 resides in a critical area or is out of range of the file system.
123 A warning is issued if the block is already in use.
124 .Sh BUGS
125 If more than one sector which comprise a file system fragment are bad,
126 you should specify only one of them to
127 .Nm ,
128 as the blocks in the bad sector files actually cover all the sectors in a
129 file system fragment.
130 .Sh HISTORY
131 The
132 .Nm
133 utility appeared in
134 .Bx 4.1 .