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 April 19, 1994
  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.  As a result, slices which are missing an
  90 .Ql a
  91 parition require user intervention during the boot process.
  92 .Pp
  93 The remainder of this subsection deals only with the boot blocks.
  94 The
  95 .Xr loader 8
  96 program is documented separately.
  97 .Pp
  98 After the boot blocks have been loaded,
  99 you should see a prompt similar to the following:
 100 .Bd -literal
 101 >> FreeBSD/i386 BOOT
 102 Default: 0:ad(0,a)/boot/loader
 103 boot:
 104 .Ed
 105 .Pp
 106 The automatic boot will attempt to load
 107 .Pa /boot/loader
 108 from partition
 109 .Ql a
 110 of either the floppy or the hard disk.
 111 This boot may be aborted by typing any character on the keyboard
 112 at the
 113 .Ql boot:
 114 prompt.
 115 At this time, the following input will be accepted:
 116 .Bl -tag -width indent
 117 .It Ic \&?
 118 Give a short listing of the files in the root directory of the default
 119 boot device, as a hint about available boot files.
 120 (A
 121 .Ic ?\&
 122 may also be specified as the last segment of a path, in which case
 123 the listing will be of the relevant subdirectory.)
 124 .Pp
 125 .It Xo
 126 .Sm off
 127 .Ar bios_drive : interface ( unit , Oo Ar slice , Oc Ar part )
 128 .Sm on
 129 .Ar filename
 130 .Op Fl aCcDdghmnPprsv
 131 .Xc
 132 Specify boot file and flags.
 133 .Bl -tag -width indent
 134 .It Ar bios_drive
 135 The drive number as recognized by the BIOS.
 136 0 for the first drive, 1 for the second drive, etc.
 137 .It Ar interface
 138 The type of controller to boot from.
 139 Note that the controller is required
 140 to have BIOS support since the BIOS services are used to load the
 141 boot file image.
 142 .Pp
 143 The supported interfaces are:
 144 .Pp
 145 .Bl -tag -width "adXX" -compact
 146 .It ad
 147 ST506, IDE, ESDI, RLL disks on a WD100[2367] or lookalike
 148 controller
 149 .It fd
 150 5 1/4" or 3 1/2" High density floppies
 151 .It da
 152 SCSI disk on any supported SCSI controller
 153 .\".It cd
 154 .\"boot from CDROM
 155 .El
 156 .It Ar unit
 157 The unit number of the drive on the interface being used.
 158 0 for the first drive, 1 for the second drive, etc.
 159 .It Oo Ar slice , Oc Ns Ar part
 160 The partition letter inside the
 161 .Bx
 162 portion of the disk.
 163 See
 164 .Xr disklabel 8 .
 165 By convention, only partition
 166 .Ql a
 167 contains a bootable image.
 168 If sliced disks are used
 169 .Pq Dq fdisk partitions ,
 170 any
 171 .Ar slice
 172 (1 for the first slice, 2 for the second slice, etc.\&)
 173 can be booted from, with the default (if not specified) being the active slice
 174 or, otherwise, the first
 175 .Fx
 176 slice.
 177 If
 178 .Ar slice
 179 is specified as 0, the first
 180 .Fx
 181 slice (also known as
 182 .Dq compatibility
 183 slice) is booted from.
 184 .It Ar filename
 185 The pathname of the file to boot (relative to the root directory
 186 on the specified partition).
 187 Defaults to
 188 .Pa /kernel .
 189 Symbolic links are not supported (hard links are).
 190 .It Fl aCcDdghmnPprsv
 191 Boot flags:
 192 .Pp
 193 .Bl -tag -width "-CXX" -compact
 194 .It Fl a
 195 during kernel initialization,
 196 ask for the device to mount as the root file system.
 197 .It Fl C
 198 boot from CDROM.
 199 .It Fl c
 200 run UserConfig to modify hardware parameters for the loaded
 201 kernel.
 202 If the kernel was built with one of
 203 .Dv USERCONFIG , INTRO_USERCONFIG , VISUAL_USERCONFIG
 204 options,
 205 remain in UserConfig regardless of any
 206 .Ic quit
 207 commands present in the script.
 208 .It Fl D
 209 toggle single and dual console configurations.
 210 In the single
 211 configuration the console will be either the internal display
 212 or the serial port, depending on the state of the
 213 .Fl h
 214 option below.
 215 In the dual console configuration,
 216 both the internal display and the serial port will become the console
 217 at the same time, regardless of the state of the
 218 .Fl h
 219 option.
 220 However, the dual console configuration takes effect only during
 221 the boot prompt.
 222 Once the kernel is loaded, the console specified
 223 by the
 224 .Fl h
 225 option becomes the only console.
 226 .It Fl d
 227 enter the DDB kernel debugger
 228 (see
 229 .Xr ddb 4 )
 230 as early as possible in kernel initialization.
 231 .It Fl g
 232 use the GDB remote debugging protocol.
 233 .It Fl h
 234 toggle internal and serial consoles.
 235 You can use this to switch
 236 console devices.
 237 For instance, if you boot from the internal console,
 238 you can use the
 239 .Fl h
 240 option to force the kernel to use the serial port as its
 241 console device.
 242 Alternatively, if you boot from the serial port,
 243 you can use this option to force the kernel to use the internal display
 244 as the console instead.
 245 The serial port driver
 246 .Xr sio 4
 247 has a flag to override this option.
 248 If that flag is set, the serial port will always be used as the console,
 249 regardless of the
 250 .Fl h
 251 option described here.
 252 See the man page for
 253 .Xr sio 4
 254 for more details.
 255 .It Fl m
 256 mute the console.
 257 .It Fl n
 258 ignore key press to interrupt boot before
 259 .Xr loader 8
 260 is invoked.
 261 .It Fl P
 262 probe the keyboard.
 263 If no keyboard is found, the
 264 .Fl D
 265 and
 266 .Fl h
 267 options are automatically set.
 268 .It Fl p
 269 pause after each attached device during the device probing phase.
 270 .It Fl r
 271 use the statically configured default for the device containing the
 272 root file system
 273 (see
 274 .Xr config 8 ) .
 275 Normally, the root file system is on the device
 276 that the kernel was loaded from.
 277 .It Fl s
 278 boot into single-user mode; if the console is marked as
 279 .Dq insecure
 280 (see
 281 .Xr ttys 5 ) ,
 282 the root password must be entered.
 283 .It Fl v
 284 be verbose during device probing (and later).
 285 .El
 286 .El
 287 .El
 288 .Pp
 289 You may put a BIOS drive number, a controller type, a unit number,
 290 a partition, a kernel file name, and any valid option in
 291 .Pa /boot.config
 292 to set defaults.
 293 Enter them in one line just as you type at the
 294 .Ql boot:
 295 prompt.
 296 .Sh FILES
 297 .Bl -tag -width /boot/loader -compact
 298 .It Pa /boot.config
 299 parameters for the boot blocks (optional)
 300 .It Pa /boot/boot1
 301 first stage bootstrap file
 302 .It Pa /boot/boot2
 303 second stage bootstrap file
 304 .It Pa /boot/loader
 305 third stage bootstrap
 306 .It Pa /boot/kernel/kernel
 307 default kernel
 308 .It Pa /boot/kernel.old/kernel
 309 typical non-default kernel (optional)
 310 .El
 311 .Sh SEE ALSO
 312 .Xr ddb 4 ,
 313 .Xr ttys 5 ,
 314 .Xr boot0cfg 8 ,
 315 .Xr btxld 8 ,
 316 .Xr config 8 ,
 317 .Xr disklabel 8 ,
 318 .Xr halt 8 ,
 319 .Xr loader 8 ,
 320 .Xr reboot 8 ,
 321 .Xr shutdown 8
 322 .Sh DIAGNOSTICS
 323 When disk-related errors occur, these are reported by the second-stage
 324 bootstrap using the same error codes returned by the BIOS, for example
 325 .Dq Disk error 0x1 (lba=0x12345678) .
 326 Here is a partial list of these error codes:
 327 .Pp
 328 .Bl -tag -width "0x80" -compact
 329 .It 0x1
 330 Invalid argument
 331 .It 0x2
 332 Address mark not found
 333 .It 0x4
 334 Sector not found
 335 .It 0x8
 336 DMA overrun
 337 .It 0x9
 338 DMA attempt across 64K boundary
 339 .It 0xc
 340 Invalid media
 341 .It 0x10
 342 Uncorrectable CRC/ECC error
 343 .It 0x20
 344 Controller failure
 345 .It 0x40
 346 Seek failed
 347 .It 0x80
 348 Timeout
 349 .El
 350 .Pp
 351 .Sy "NOTE" :
 352 On older machines, or otherwise where EDD support (disk packet
 353 interface support) is not available, all boot-related files and
 354 structures (including the kernel) that need to be accessed during the
 355 boot phase must reside on the disk at or below cylinder 1023 (as the
 356 BIOS understands the geometry).
 357 When a
 358 .Dq Disk error 0x1
 359 is reported by the second-stage bootstrap, it generally means that this
 360 requirement has not been adhered to.
 361 .Sh BUGS
 362 The
 363 .Xr disklabel 5
 364 format used by this version of
 365 .Bx
 366 is quite
 367 different from that of other architectures.
 368 .Pp
 369 Due to space constraints, the keyboard probe initiated by the
 370 .Fl P
 371 option is simply a test that the BIOS has detected an
 372 .Dq extended
 373 keyboard.
 374 If an
 375 .Dq XT/AT
 376 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
 377 fail.