No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man8 / rescue.8
blob53cf75552ff6fd95118591d91c8a450540e656b3
1 .\"     $NetBSD: rescue.8,v 1.5 2009/01/20 04:10:38 lukem Exp $
2 .\"
3 .\" Copyright (c) 2003 Tim Kientzle <kientzle@acm.org>
4 .\" Copyright (c) 2003 Simon L. Nielsen <simon@FreeBSD.org>
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"  FreeBSD: src/share/man/man8/rescue.8,v 1.3 2005/11/10 15:42:51 kientzle Exp
29 .\"
30 .Dd January 20, 2009
31 .Dt RESCUE 8
32 .Os
33 .Sh NAME
34 .Nm rescue
35 .Nd rescue utilities in
36 .Pa /rescue
37 .Sh DESCRIPTION
38 The
39 .Pa /rescue
40 directory contains a collection of common utilities intended for use
41 in recovering a badly damaged system.
42 With the transition to a dynamically-linked root beginning with
43 .Nx 2.0 ,
44 there is a real possibility that the standard tools in
45 .Pa /bin
46 and
47 .Pa /sbin
48 may become non-functional due to a failed upgrade or a disk error.
49 The tools in
50 .Pa /rescue
51 are statically linked and should therefore be more resistant to
52 damage.
53 However, being statically linked, the tools in
54 .Pa /rescue
55 are also less functional than the standard utilities.
56 In particular, they do not have full use of the locale,
57 .Xr pam 3 ,
58 and nsswitch libraries.
59 .Pp
60 If your system fails to boot, and it shows an error message similar to:
61 .Pp
62 .Dl "init: not found"
63 .Pp
64 try booting the system with the boot flag
65 .Dq Fl a
66 and supplying
67 .Pa /rescue/init ,
68 which is the
69 .Nm
70 .Xr init 8 ,
71 as the init path.
72 .Pp
73 If your system fails to boot, and it shows a prompt similar to:
74 .Pp
75 .Dl "Enter full pathname of shell or RETURN for /bin/sh: "
76 .Pp
77 the first thing to try running is the standard shell,
78 .Pa /bin/sh .
79 If that fails, try running
80 .Pa /rescue/sh ,
81 which is the
82 .Nm
83 shell.
84 To repair the system, the root partition must first be remounted
85 read-write.
86 This can be done with the following
87 .Xr mount 8
88 command:
89 .Pp
90 .Dl "/rescue/mount -uw /"
91 .Pp
92 The next step is to double-check the contents of
93 .Pa /bin ,
94 .Pa /lib ,
95 .Pa /libexec ,
96 and
97 .Pa /sbin ,
98 possibly mounting a
99 .Nx
100 installation CD-ROM
101 and copying files from there.
102 Once it is possible to successfully run
103 .Pa /bin/sh , /bin/ls ,
104 and other standard utilities, try rebooting back into the standard
105 system.
108 .Pa /rescue
109 tools are compiled using
110 .Xr crunchgen 1 ,
111 which makes them considerably more compact than the standard
112 utilities.
113 .Sh FILES
114 .Bl -tag -width ".Pa /rescue" -compact
115 .It Pa /rescue
116 Root of the
118 hierarchy.
120 .Sh SEE ALSO
121 .Xr crunchgen 1
122 .Sh HISTORY
125 utilities first appeared in
126 .Nx 2.0 .
127 .Sh AUTHORS
128 .An -nosplit
131 system was written by
132 .An Luke Mewburn Aq lukem@NetBSD.org .
133 This manual page was written by
134 .An Simon L. Nielsen Aq simon@FreeBSD.org ,
135 based on text by
136 .An Tim Kientzle Aq kientzle@FreeBSD.org .
137 .Sh BUGS
138 Most of the
140 tools work even in a fairly crippled system.
141 The most egregious exception is the
143 version of
144 .Xr vi 1 ,
145 which currently requires that
146 .Pa /usr
147 be mounted so that it can access the
148 .Xr termcap 5
149 files.
150 Hopefully, a failsafe
151 .Xr termcap 3
152 entry will eventually be added into the
153 .Xr curses 3
154 library, so that
155 .Pa /rescue/vi
156 can be used even in a system where
157 .Pa /usr
158 cannot immediately be mounted.
159 In the meantime, the
161 version of the
162 .Xr ed 1
163 editor can be used from
164 .Pa /rescue/ed
165 if you need to edit files, but cannot mount
166 .Pa /usr .