Rename /kernel and /module to /boot/kernel and /boot/module where appropriate.
[dragonfly.git] / sbin / reboot / boot_pc32.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/boot_pc32.8,v 1.10 2008/09/02 11:50:45 matthias Exp $
43 .\"
44 .Dd September 2, 2008
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 DragonFly boot
96 0:ad(0,a)/boot/loader:
97 .Ed
98 .Pp
99 The automatic boot will attempt to load
100 .Pa /boot/loader
101 from partition
102 .Ql a
103 of either the floppy or the hard disk.
104 This boot may be aborted by typing any character on the keyboard
105 at the
106 .Ql boot:
107 prompt.  At this time, the following input will be accepted:
108 .Bl -tag -width indent
109 .It Ic \&?
110 Give a short listing of the files in the root directory of the default
111 boot device, as a hint about available boot files.  (A
112 .Ic ?\&
113 may also be specified as the last segment of a path, in which case
114 the listing will be of the relevant subdirectory.)
115 .Pp
116 .It Xo
117 .Ar bios_drive : Ns Ar interface Ns Po
118 .Ar unit , Ns Ar part Pc
119 .Ar filename
120 .Op Fl aCcDdghmnPprsvV
121 .Xc
122 Specify boot file and flags.
123 .Bl -tag -width indent
124 .It Ar bios_drive
125 The drive number as recognized by the BIOS.
126 0 for the first drive, 1 for the second drive, etc.
127 .It Ar interface
128 The type of controller to boot from.  Note that the controller is required
129 to have BIOS support since the BIOS services are used to load the
130 boot file image.
131 .Pp
132 The supported interfaces are:
133 .Pp
134 .Bl -tag -width "adXX" -compact
135 .It ad
136 ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
137 controller
138 .It fd
139 5 \(14" or 3 \(12" High density floppies
140 .It da
141 SCSI disk on any supported SCSI controller
142 .\".It cd
143 .\"boot from CDROM
144 .El
145 .It Ar unit
146 The unit number of the drive on the interface being used.
147 0 for the first drive, 1 for the second drive, etc.
148 .It Ar part
149 The partition letter inside the
150 .Bx
151 portion of the disk.  See
152 .Xr disklabel 8 .
153 By convention, only partition
154 .Ql a
155 contains a bootable image.  If sliced disks are used
156 .Pq Dq fdisk partitions ,
157 any slice can be booted from, with the default being the active slice
158 or, otherwise, the first
159 .Dx
160 slice.
161 .It Ar filename
162 The pathname of the file to boot (relative to the root directory
163 on the specified partition).  Defaults to
164 .Pa /boot/kernel .
165 Symbolic links are not supported (hard links are).
166 .It Fl acCdDghnPrsv
167 Boot flags:
168 .Pp
169 .Bl -tag -width "-CXX" -compact
170 .It Fl a
171 during kernel initialization,
172 ask for the device to mount as the root file system.
173 .It Fl C
174 boot from CDROM.
175 .It Fl c
176 run UserConfig to modify hardware parameters for the loaded
177 kernel.  If the kernel was built with one of
178 .Dv USERCONFIG , INTRO_USERCONFIG , VISUAL_USERCONFIG
179 options,
180 remain in UserConfig regardless of any
181 .Ic quit
182 commands present in the script.
183 .It Fl D
184 Use all available consoles as the system console.  Input will be accepted
185 on any console and output will be routed to all of them.  This is the
186 default.
187 .It Fl h
188 Use the serial console as the system console.
189 .It Fl V
190 Use the video console as the system console.
191 .It Fl m
192 Mute the system console.  None of the console devices will be used for the
193 system console.
194 .It Fl d
195 enter the DDB kernel debugger
196 (see
197 .Xr ddb 4 )
198 as early as possible in kernel initialization.
199 .It Fl g
200 use the GDB remote debugging protocol.
201 .It Fl n
202 ignore key press to interrupt boot before
203 .Xr loader 8
204 is invoked.
205 .It Fl P
206 probe the keyboard.  If no keyboard is found, the
207 .Fl D
208 and
209 .Fl h
210 options are automatically set.
211 .It Fl p
212 pause after each attached device during the device probing phase.
213 .It Fl r
214 use the statically configured default for the device containing the
215 root file system
216 (see
217 .Xr config 8 ) .
218 Normally, the root file system is on the device
219 that the kernel was loaded from.
220 .It Fl s
221 boot into single-user mode; if the console is marked as
222 .Dq insecure
223 (see
224 .Xr ttys 5 ) ,
225 the root password must be entered.
226 .It Fl v
227 be verbose during device probing (and later).
228 .El
229 .El
230 .El
231 .Pp
232 You may put a BIOS drive number, a controller type, a unit number,
233 a partition, a kernel file name, and any valid option in
234 .Pa /boot.config
235 to set defaults.  Enter them in one line just as you type at the
236 .Ql boot:
237 prompt.
238 .Sh FILES
239 .Bl -tag -width /boot/loader -compact
240 .It Pa /boot.config
241 parameters for the boot blocks (optional)
242 .It Pa /boot/boot1
243 first stage bootstrap file
244 .It Pa /boot/boot2
245 second stage bootstrap file
246 .It Pa /boot/loader
247 third stage bootstrap
248 .It Pa /boot/kernel
249 default kernel
250 .It Pa /boot/kernel.old
251 typical non-default kernel (optional)
252 .El
253 .Sh DIAGNOSTICS
254 When disk-related errors occur, these are reported by the second-stage
255 bootstrap using the same error codes returned by the BIOS, for example
256 .Dq Disk error 0x1 (lba=0x12345678) .
257 Here is a partial list of these error codes:
258 .Pp
259 .Bl -tag -width "0x80" -compact
260 .It 0x1
261 Invalid argument
262 .It 0x2
263 Address mark not found
264 .It 0x4
265 Sector not found
266 .It 0x8
267 DMA overrun
268 .It 0x9
269 DMA attempt across 64K boundary
270 .It 0xc
271 Invalid media
272 .It 0x10
273 Uncorrectable CRC/ECC error
274 .It 0x20
275 Controller failure
276 .It 0x40
277 Seek failed
278 .It 0x80
279 Timeout
280 .El
281 .Pp
282 .Sy "NOTE" :
283 On older machines, or otherwise where EDD support (disk packet
284 interface support) is not available, all boot-related files and
285 structures (including the kernel) that need to be accessed during the
286 boot phase must reside on the disk at or below cylinder 1023 (as the
287 BIOS understands the geometry).  When a
288 .Dq Disk error 0x1
289 is reported by the second-stage bootstrap, it generally means that this
290 requirement has not been adhered to.
291 .Sh SEE ALSO
292 .Xr ddb 4 ,
293 .Xr ttys 5 ,
294 .Xr boot0cfg 8 ,
295 .Xr btxld 8 ,
296 .Xr config 8 ,
297 .Xr disklabel 8 ,
298 .Xr halt 8 ,
299 .Xr loader 8 ,
300 .Xr reboot 8 ,
301 .Xr shutdown 8
302 .Sh BUGS
303 The
304 .Xr disklabel 5
305 format used by this version of
306 .Bx
307 is quite
308 different from that of other architectures.
309 .Pp
310 Due to space constraints, the keyboard probe initiated by the
311 .Fl P
312 option is simply a test that the BIOS has detected an
313 .Dq extended
314 keyboard.  If an
315 .Dq XT/AT
316 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
317 fail.
318 .Pp
319 Some features are not yet documented.