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