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 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)boot_i386.8 8.2 (Berkeley) 4/19/94
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd August 18, 2005
  40 .Dt BOOT 8 i386
  41 .Os
  42 .Sh NAME
  43 .Nm boot
  44 .Nd system bootstrapping procedures
  45 .Sh DESCRIPTION
  46 .Sy Power fail and crash recovery .
  47 Normally, the system will reboot itself at power-up or after crashes.
  48 An automatic consistency check of the file systems will be performed,
  49 and unless this fails, the system will resume multi-user operations.
  50 .Pp
  51 .Sy Cold starts .
  52 Most i386 PCs attempt to boot first from floppy disk drive 0 (sometimes
  53 known as drive A:) and, failing that, from hard disk drive 0 (sometimes
  54 known as drive C:, or as drive 0x80 to the BIOS).
  55 Some BIOSes allow
  56 you to change this default sequence, and may also include a CD-ROM
  57 drive as a boot device.
  58 .Pp
  59 By default, a three-stage bootstrap is employed, and control is
  60 automatically passed from the boot blocks (bootstrap stages one and
  61 two) to a separate third-stage bootstrap program,
  62 .Xr loader 8 .
  63 This third stage provides more sophisticated control over the booting
  64 process than it is possible to achieve in the boot blocks, which are
  65 constrained by occupying limited fixed space on a given disk or slice.
  66 .Pp
  67 However, it is possible to dispense with the third stage altogether,
  68 either by specifying a kernel name in the boot block parameter
  69 file,
  70 .Pa /boot.config ,
  71 or, unless option
  72 .Fl n
  73 is set, by hitting a key during a brief pause (while one of the characters
  74 .Sy - ,
  75 .Sy \e ,
  76 .Sy \&| ,
  77 or
  78 .Sy /
  79 is displayed) before
  80 .Xr loader 8
  81 is invoked.
  82 Booting will also be attempted at stage two, if the
  83 third stage cannot be loaded.
  84 .Pp
  85 Make note of the fact that
  86 .Pa /boot.config
  87 is read only from the
  88 .Ql a
  89 partition.
  90 As a result, slices which are missing an
  91 .Ql a
  92 partition require user intervention during the boot process.
  93 .Pp
  94 The remainder of this subsection deals only with the boot blocks.
  95 The
  96 .Xr loader 8
  97 program is documented separately.
  98 .Pp
  99 After the boot blocks have been loaded,
 100 you should see a prompt similar to the following:
 101 .Bd -literal
 102 >> FreeBSD/i386 BOOT
 103 Default: 0:ad(0,a)/boot/loader
 104 boot:
 105 .Ed
 106 .Pp
 107 The automatic boot will attempt to load
 108 .Pa /boot/loader
 109 from partition
 110 .Ql a
 111 of either the floppy or the hard disk.
 112 This boot may be aborted by typing any character on the keyboard
 113 at the
 114 .Ql boot:
 115 prompt.
 116 At this time, the following input will be accepted:
 117 .Bl -tag -width indent
 118 .It Ic \&?
 119 Give a short listing of the files in the root directory of the default
 120 boot device, as a hint about available boot files.
 121 (A
 122 .Ic ?\&
 123 may also be specified as the last segment of a path, in which case
 124 the listing will be of the relevant subdirectory.)
 125 .Pp
 126 .It Xo
 127 .Sm off
 128 .Ar bios_drive : interface ( unit , Oo Ar slice , Oc Ar part )
 129 .Ar filename
 130 .Sm on
 131 .Op Fl aCcDdghmnPprsv
 132 .Sm off
 133 .Op Fl S Ar speed
 134 .Sm on
 135 .Xc
 136 Specify boot file and flags.
 137 .Bl -tag -width indent
 138 .It Ar bios_drive
 139 The drive number as recognized by the BIOS.
 140 0 for the first drive, 1 for the second drive, etc.
 141 .It Ar interface
 142 The type of controller to boot from.
 143 Note that the controller is required
 144 to have BIOS support since the BIOS services are used to load the
 145 boot file image.
 146 .Pp
 147 The supported interfaces are:
 148 .Pp
 149 .Bl -tag -width "adXX" -compact
 150 .It ad
 151 ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
 152 controller
 153 .It fd
 154 5 1/4" or 3 1/2" High density floppies
 155 .It da
 156 SCSI disk on any supported SCSI controller
 157 .\".It cd
 158 .\"boot from CDROM
 159 .El
 160 .It Ar unit
 161 The unit number of the drive on the interface being used.
 162 0 for the first drive, 1 for the second drive, etc.
 163 .It Oo Ar slice , Oc Ns Ar part
 164 The partition letter inside the
 165 .Bx
 166 portion of the disk.
 167 See
 168 .Xr bsdlabel 8 .
 169 By convention, only partition
 170 .Ql a
 171 contains a bootable image.
 172 If sliced disks are used
 173 .Pq Dq fdisk partitions ,
 174 any
 175 .Ar slice
 176 (1 for the first slice, 2 for the second slice, etc.\&)
 177 can be booted from, with the default (if not specified) being the active slice
 178 or, otherwise, the first
 179 .Fx
 180 slice.
 181 If
 182 .Ar slice
 183 is specified as 0, the first
 184 .Fx
 185 slice (also known as
 186 .Dq compatibility
 187 slice) is booted from.
 188 .It Ar filename
 189 The pathname of the file to boot (relative to the root directory
 190 on the specified partition).
 191 Defaults to
 192 .Pa /boot/kernel/kernel .
 193 Symbolic links are not supported (hard links are).
 194 .It Xo Op Fl aCcDdghmnPprsv
 195 .Sm off
 196 .Op Fl S Ar speed
 197 .Sm on
 198 .Xc
 199 Boot flags:
 200 .Pp
 201 .Bl -tag -width "-CXX" -compact
 202 .It Fl a
 203 during kernel initialization,
 204 ask for the device to mount as the root file system.
 205 .It Fl C
 206 try to mount root file system from a CD-ROM.
 207 .It Fl c
 208 this flag is currently a no-op.
 209 .It Fl D
 210 boot with the dual console configuration.
 211 In the single
 212 configuration, the console will be either the internal display
 213 or the serial port, depending on the state of the
 214 .Fl h
 215 option below.
 216 In the dual console configuration,
 217 both the internal display and the serial port will become the console
 218 at the same time, regardless of the state of the
 219 .Fl h
 220 option.
 221 .It Fl d
 222 enter the DDB kernel debugger
 223 (see
 224 .Xr ddb 4 )
 225 as early as possible in kernel initialization.
 226 .It Fl g
 227 use the GDB remote debugging protocol.
 228 .It Fl h
 229 force the serial console.
 230 For instance, if you boot from the internal console,
 231 you can use the
 232 .Fl h
 233 option to force the kernel to use the serial port as its
 234 console device.
 235 The serial port driver
 236 .Xr sio 4
 237 has a flag (0x20) to override this option.
 238 If that flag is set, the serial port will always be used as the console,
 239 regardless of the
 240 .Fl h
 241 option described here.
 242 See the man page for
 243 .Xr sio 4
 244 for more details.
 245 .It Fl m
 246 mute the console.
 247 .It Fl n
 248 ignore key press to interrupt boot before
 249 .Xr loader 8
 250 is invoked.
 251 .It Fl P
 252 probe the keyboard.
 253 If no keyboard is found, the
 254 .Fl D
 255 and
 256 .Fl h
 257 options are automatically set.
 258 .It Fl p
 259 pause after each attached device during the device probing phase.
 260 .It Fl r
 261 use the statically configured default for the device containing the
 262 root file system
 263 (see
 264 .Xr config 8 ) .
 265 Normally, the root file system is on the device
 266 that the kernel was loaded from.
 267 .It Fl s
 268 boot into single-user mode; if the console is marked as
 269 .Dq insecure
 270 (see
 271 .Xr ttys 5 ) ,
 272 the root password must be entered.
 273 .It Xo Sm off
 274 .Fl S Ar speed
 275 .Sm on
 276 .Xc
 277 set the speed of the serial console to
 278 .Ar speed .
 279 The default is 9600 unless it has been overridden by setting
 280 .Va BOOT_COMCONSOLE_SPEED
 281 in
 282 .Pa /etc/make.conf
 283 and recompiling the boot blocks.
 284 .It Fl v
 285 be verbose during device probing (and later).
 286 .El
 287 .El
 288 .El
 289 .Pp
 290 You may put a BIOS drive number, a controller type, a unit number,
 291 a partition, a kernel file name, and any valid option in
 292 .Pa /boot.config
 293 to set defaults.
 294 Enter them in one line just as you type at the
 295 .Ql boot:
 296 prompt.
 297 .Sh FILES
 298 .Bl -tag -width /boot/loader -compact
 299 .It Pa /boot.config
 300 parameters for the boot blocks (optional)
 301 .It Pa /boot/boot1
 302 first stage bootstrap file
 303 .It Pa /boot/boot2
 304 second stage bootstrap file
 305 .It Pa /boot/loader
 306 third stage bootstrap
 307 .It Pa /boot/kernel/kernel
 308 default kernel
 309 .It Pa /boot/kernel.old/kernel
 310 typical non-default kernel (optional)
 311 .El
 312 .Sh DIAGNOSTICS
 313 When disk-related errors occur, these are reported by the second-stage
 314 bootstrap using the same error codes returned by the BIOS, for example
 315 .Dq Disk error 0x1 (lba=0x12345678) .
 316 Here is a partial list of these error codes:
 317 .Pp
 318 .Bl -tag -width "0x80" -compact
 319 .It 0x1
 320 Invalid argument
 321 .It 0x2
 322 Address mark not found
 323 .It 0x4
 324 Sector not found
 325 .It 0x8
 326 DMA overrun
 327 .It 0x9
 328 DMA attempt across 64K boundary
 329 .It 0xc
 330 Invalid media
 331 .It 0x10
 332 Uncorrectable CRC/ECC error
 333 .It 0x20
 334 Controller failure
 335 .It 0x40
 336 Seek failed
 337 .It 0x80
 338 Timeout
 339 .El
 340 .Pp
 341 .Sy "NOTE" :
 342 On older machines, or otherwise where EDD support (disk packet
 343 interface support) is not available, all boot-related files and
 344 structures (including the kernel) that need to be accessed during the
 345 boot phase must reside on the disk at or below cylinder 1023 (as the
 346 BIOS understands the geometry).
 347 When a
 348 .Dq Disk error 0x1
 349 is reported by the second-stage bootstrap, it generally means that this
 350 requirement has not been adhered to.
 351 .Sh SEE ALSO
 352 .Xr ddb 4 ,
 353 .Xr ttys 5 ,
 354 .Xr boot0cfg 8 ,
 355 .Xr bsdlabel 8 ,
 356 .Xr btxld 8 ,
 357 .Xr config 8 ,
 358 .Xr halt 8 ,
 359 .Xr loader 8 ,
 360 .Xr reboot 8 ,
 361 .Xr shutdown 8
 362 .Sh BUGS
 363 The
 364 .Xr bsdlabel 5
 365 format used by this version of
 366 .Bx
 367 is quite
 368 different from that of other architectures.
 369 .Pp
 370 Due to space constraints, the keyboard probe initiated by the
 371 .Fl P
 372 option is simply a test that the BIOS has detected an
 373 .Dq extended
 374 keyboard.
 375 If an
 376 .Dq XT/AT
 377 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
 378 fail.