Add a check for installworld (similar to the buildworld check) to ensure
[dragonfly.git] / sbin / reboot / boot_i386.8
1 .\" Copyright (c) 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software written and contributed
5 .\" to Berkeley by William Jolitz.
6 .\"
7 .\" Almost completely rewritten for FreeBSD 2.1 by Joerg Wunsch.
8 .\"
9 .\" Substantially revised for FreeBSD 3.1 by Robert Nordier.
10 .\"
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
13 .\" are met:
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\"    notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\"    notice, this list of conditions and the following disclaimer in the
18 .\"    documentation and/or other materials provided with the distribution.
19 .\" 3. All advertising materials mentioning features or use of this software
20 .\"    must display the following acknowledgement:
21 .\"     This product includes software developed by the University of
22 .\"     California, Berkeley and its contributors.
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\"    may be used to endorse or promote products derived from this software
25 .\"    without specific prior written permission.
26 .\"
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .\" SUCH DAMAGE.
38 .\"
39 .\"     @(#)boot_i386.8 8.2 (Berkeley) 4/19/94
40 .\"
41 .\" $FreeBSD: src/sbin/reboot/boot_i386.8,v 1.23.2.11 2002/04/24 17:47:58 rnordier Exp $
42 .\" $DragonFly: src/sbin/reboot/Attic/boot_i386.8,v 1.6 2006/02/28 02:25:10 swildner Exp $
43 .\"
44 .Dd April 19, 1994
45 .Dt BOOT 8 i386
46 .Os
47 .Sh NAME
48 .Nm boot
49 .Nd system bootstrapping procedures
50 .Sh DESCRIPTION
51 .Sy Power fail and crash recovery .
52 Normally, the system will reboot itself at power-up or after crashes.
53 An automatic consistency check of the file systems will be performed,
54 and unless this fails, the system will resume multi-user operations.
55 .Pp
56 .Sy Cold starts .
57 Most i386 PCs attempt to boot first from floppy disk drive 0 (sometimes
58 known as drive A:) and, failing that, from hard disk drive 0 (sometimes
59 known as drive C:, or as drive 0x80 to the BIOS).  Some BIOSes allow
60 you to change this default sequence, and may also include a CD-ROM
61 drive as a boot device.
62 .Pp
63 By default, a three-stage bootstrap is employed, and control is
64 automatically passed from the boot blocks (bootstrap stages one and
65 two) to a separate third-stage bootstrap program,
66 .Xr loader 8 .
67 This third stage provides more sophisticated control over the booting
68 process than it is possible to achieve in the boot blocks, which are
69 constrained by occupying limited fixed space on a given disk or slice.
70 .Pp
71 However, it is possible to dispense with the third stage altogether,
72 either by specifying a kernel name in the boot block parameter
73 file,
74 .Pa /boot.config ,
75 or, unless option
76 .Fl n
77 is set, by hitting a key during a brief pause (while one of the characters
78 .Sy - ,
79 .Sy \e ,
80 .Sy \&| ,
81 or
82 .Sy /
83 is displayed) before
84 .Xr loader 8
85 is invoked.  Booting will also be attempted at stage two, if the
86 third stage cannot be loaded.
87 .Pp
88 The remainder of this subsection deals only with the boot blocks.  The
89 .Xr loader 8
90 program is documented separately.
91 .Pp
92 After the boot blocks have been loaded,
93 you should see a prompt similar to the following:
94 .Bd -literal
95 >> BSD/i386 BOOT
96 Default: 0:ad(0,a)/kernel
97 boot:
98 .Ed
99 .Pp
100 The automatic boot will attempt to load
101 .Pa /kernel
102 from partition
103 .Ql a
104 of either the floppy or the hard disk.
105 This boot may be aborted by typing any character on the keyboard
106 at the
107 .Ql boot:
108 prompt.  At this time, the following input will be accepted:
109 .Bl -tag -width indent
110 .It Ic \&?
111 Give a short listing of the files in the root directory of the default
112 boot device, as a hint about available boot files.  (A
113 .Ic ?\&
114 may also be specified as the last segment of a path, in which case
115 the listing will be of the relevant subdirectory.)
116 .Pp
117 .It Xo
118 .Ar bios_drive : Ns Ar interface Ns Po
119 .Ar unit , Ns Ar part Pc
120 .Ar filename
121 .Op Fl aCcDdghmnPprsvV
122 .Xc
123 Specify boot file and flags.
124 .Bl -tag -width indent
125 .It Ar bios_drive
126 The drive number as recognized by the BIOS.
127 0 for the first drive, 1 for the second drive, etc.
128 .It Ar interface
129 The type of controller to boot from.  Note that the controller is required
130 to have BIOS support since the BIOS services are used to load the
131 boot file image.
132 .Pp
133 The supported interfaces are:
134 .Pp
135 .Bl -tag -width "adXX" -compact
136 .It ad
137 ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
138 controller
139 .It fd
140 5 \(14" or 3 \(12" High density floppies
141 .It da
142 SCSI disk on any supported SCSI controller
143 .\".It cd
144 .\"boot from CDROM
145 .El
146 .It Ar unit
147 The unit number of the drive on the interface being used.
148 0 for the first drive, 1 for the second drive, etc.
149 .It Ar part
150 The partition letter inside the
151 .Bx
152 portion of the disk.  See
153 .Xr disklabel 8 .
154 By convention, only partition
155 .Ql a
156 contains a bootable image.  If sliced disks are used
157 .Pq Dq fdisk partitions ,
158 any slice can be booted from, with the default being the active slice
159 or, otherwise, the first
160 .Dx
161 slice.
162 .It Ar filename
163 The pathname of the file to boot (relative to the root directory
164 on the specified partition).  Defaults to
165 .Pa /kernel .
166 Symbolic links are not supported (hard links are).
167 .It Fl acCdDghnPrsv
168 Boot flags:
169 .Pp
170 .Bl -tag -width "-CXX" -compact
171 .It Fl a
172 during kernel initialization,
173 ask for the device to mount as the root file system.
174 .It Fl C
175 boot from CDROM.
176 .It Fl c
177 run UserConfig to modify hardware parameters for the loaded
178 kernel.  If the kernel was built with one of
179 .Dv USERCONFIG , INTRO_USERCONFIG , VISUAL_USERCONFIG
180 options,
181 remain in UserConfig regardless of any
182 .Ic quit
183 commands present in the script.
184 .It Fl D
185 Use all available consoles as the system console.  Input will be accepted
186 on any console and output will be routed to all of them.  This is the
187 default.
188 .It Fl h
189 Use the serial console as the system console.
190 .It Fl V
191 Use the video console as the system console.
192 .It Fl m
193 Mute the system console.  None of the console devices will be used for the
194 system console.
195 .It Fl d
196 enter the DDB kernel debugger
197 (see
198 .Xr ddb 4 )
199 as early as possible in kernel initialization.
200 .It Fl g
201 use the GDB remote debugging protocol.
202 .It Fl n
203 ignore key press to interrupt boot before loader(8) is invoked.
204 .It Fl P
205 probe the keyboard.  If no keyboard is found, the
206 .Fl D
207 and
208 .Fl h
209 options are automatically set.
210 .It Fl p
211 pause after each attached device during the device probing phase.
212 .It Fl r
213 use the statically configured default for the device containing the
214 root file system
215 (see
216 .Xr config 8 ) .
217 Normally, the root file system is on the device
218 that the kernel was loaded from.
219 .It Fl s
220 boot into single-user mode; if the console is marked as
221 .Dq insecure
222 (see
223 .Xr ttys 5 ) ,
224 the root password must be entered.
225 .It Fl v
226 be verbose during device probing (and later).
227 .El
228 .El
229 .El
230 .Pp
231 You may put a BIOS drive number, a controller type, a unit number,
232 a partition, a kernel file name, and any valid option in
233 .Pa /boot.config
234 to set defaults.  Enter them in one line just as you type at the
235 .Ql boot:
236 prompt.
237 .Sh FILES
238 .Bl -tag -width /boot/loader -compact
239 .It Pa /boot.config
240 parameters for the boot blocks (optional)
241 .It Pa /boot/boot1
242 first stage bootstrap file
243 .It Pa /boot/boot2
244 second stage bootstrap file
245 .It Pa /boot/loader
246 third stage bootstrap
247 .It Pa /kernel
248 default kernel
249 .It Pa /kernel.old
250 typical non-default kernel (optional)
251 .El
252 .Sh DIAGNOSTICS
253 When disk-related errors occur, these are reported by the second-stage
254 bootstrap using the same error codes returned by the BIOS, for example
255 .Dq Disk error 0x1 (lba=0x12345678) .
256 Here is a partial list of these error codes:
257 .Pp
258 .Bl -tag -width "0x80" -compact
259 .It 0x1
260 Invalid argument
261 .It 0x2
262 Address mark not found
263 .It 0x4
264 Sector not found
265 .It 0x8
266 DMA overrun
267 .It 0x9
268 DMA attempt across 64K boundary
269 .It 0xc
270 Invalid media
271 .It 0x10
272 Uncorrectable CRC/ECC error
273 .It 0x20
274 Controller failure
275 .It 0x40
276 Seek failed
277 .It 0x80
278 Timeout
279 .El
280 .Pp
281 .Sy "NOTE" :
282 On older machines, or otherwise where EDD support (disk packet
283 interface support) is not available, all boot-related files and
284 structures (including the kernel) that need to be accessed during the
285 boot phase must reside on the disk at or below cylinder 1023 (as the
286 BIOS understands the geometry).  When a
287 .Dq Disk error 0x1
288 is reported by the second-stage bootstrap, it generally means that this
289 requirement has not been adhered to.
290 .Sh SEE ALSO
291 .Xr ddb 4 ,
292 .Xr ttys 5 ,
293 .Xr boot0cfg 8 ,
294 .Xr btxld 8 ,
295 .Xr config 8 ,
296 .Xr disklabel 8 ,
297 .Xr halt 8 ,
298 .Xr loader 8 ,
299 .Xr reboot 8 ,
300 .Xr shutdown 8
301 .Sh BUGS
302 The
303 .Xr disklabel 5
304 format used by this version of
305 .Bx
306 is quite
307 different from that of other architectures.
308 .Pp
309 Due to space constraints, the keyboard probe initiated by the
310 .Fl P
311 option is simply a test that the BIOS has detected an
312 .Dq extended
313 keyboard.  If an
314 .Dq XT/AT
315 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
316 fail.
317 .Pp
318 Some features are not yet documented.