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$
  42 .\"
  43 .Dd April 19, 1994
  44 .Dt BOOT 8 i386
  45 .Os
  46 .Sh NAME
  47 .Nm boot
  48 .Nd system bootstrapping procedures
  49 .Sh DESCRIPTION
  50 .Sy Power fail and crash recovery .
  51 Normally, the system will reboot itself at power-up or after crashes.
  52 An automatic consistency check of the file systems will be performed,
  53 and unless this fails, the system will resume multi-user operations.
  54 .Pp
  55 .Sy Cold starts .
  56 Most i386 PCs attempt to boot first from floppy disk drive 0 (sometimes
  57 known as drive A:) and, failing that, from hard disk drive 0 (sometimes
  58 known as drive C:, or as drive 0x80 to the BIOS).  Some BIOSes allow
  59 you to change this default sequence, and may also include a CD-ROM
  60 drive as a boot device.
  61 .Pp
  62 By default, a three-stage bootstrap is employed, and control is
  63 automatically passed from the boot blocks (bootstrap stages one and
  64 two) to a separate third-stage bootstrap program,
  65 .Xr loader 8 .
  66 This third stage provides more sophisticated control over the booting
  67 process than it is possible to achieve in the boot blocks, which are
  68 constrained by occupying limited fixed space on a given disk or slice.
  69 .Pp
  70 However, it is possible to dispense with the third stage altogether,
  71 either by specifying a kernel name in the boot block parameter
  72 file,
  73 .Pa /boot.config ,
  74 or, unless option
  75 .Fl n
  76 is set, by hitting a key during a brief pause (while one of the characters
  77 .Sy - ,
  78 .Sy \e ,
  79 .Sy \&| ,
  80 or
  81 .Sy /
  82 is displayed) before
  83 .Xr loader 8
  84 is invoked.  Booting will also be attempted at stage two, if the
  85 third stage cannot be loaded.
  86 .Pp
  87 The remainder of this subsection deals only with the boot blocks.  The
  88 .Xr loader 8
  89 program is documented separately.
  90 .Pp
  91 After the boot blocks have been loaded,
  92 you should see a prompt similar to the following:
  93 .Bd -literal
  94 >> FreeBSD/i386 BOOT
  95 Default: 0:ad(0,a)/kernel
  96 boot:
  97 .Ed
  98 .Pp
  99 The automatic boot will attempt to load
 100 .Pa /kernel
 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 .Sm off
 118 .Ar bios_drive : interface ( unit , Oo Ar slice , Oc Ar part )
 119 .Sm on
 120 .Ar filename
 121 .Op Fl aCcDdghmnPprsv
 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 1/4" or 3 1/2" 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 Oo Ar slice , Oc Ns 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
 159 .Ar slice
 160 (1 for the first slice, 2 for the second slice, etc.\&)
 161 can be booted from, with the default (if not specified) being the active slice
 162 or, otherwise, the first
 163 .Fx
 164 slice.
 165 If
 166 .Ar slice
 167 is specified as 0, the first
 168 .Fx
 169 slice (also known as
 170 .Dq compatibility
 171 slice) is booted from.
 172 .It Ar filename
 173 The pathname of the file to boot (relative to the root directory
 174 on the specified partition).  Defaults to
 175 .Pa /kernel .
 176 Symbolic links are not supported (hard links are).
 177 .It Fl aCcDdghmnPprsv
 178 Boot flags:
 179 .Pp
 180 .Bl -tag -width "-CXX" -compact
 181 .It Fl a
 182 during kernel initialization,
 183 ask for the device to mount as the root file system.
 184 .It Fl C
 185 boot from CDROM.
 186 .It Fl c
 187 run UserConfig to modify hardware parameters for the loaded
 188 kernel.  If the kernel was built with one of
 189 .Dv USERCONFIG , INTRO_USERCONFIG , VISUAL_USERCONFIG
 190 options,
 191 remain in UserConfig regardless of any
 192 .Ic quit
 193 commands present in the script.
 194 .It Fl D
 195 toggle single and dual console configurations.  In the single
 196 configuration the console will be either the internal display
 197 or the serial port, depending on the state of the
 198 .Fl h
 199 option below.  In the dual console configuration,
 200 both the internal display and the serial port will become the console
 201 at the same time, regardless of the state of the
 202 .Fl h
 203 option.  However, the dual console configuration takes effect only during
 204 the boot prompt.  Once the kernel is loaded, the console specified
 205 by the
 206 .Fl h
 207 option becomes the only console.
 208 .It Fl d
 209 enter the DDB kernel debugger
 210 (see
 211 .Xr ddb 4 )
 212 as early as possible in kernel initialization.
 213 .It Fl g
 214 use the GDB remote debugging protocol.
 215 .It Fl h
 216 toggle internal and serial consoles.  You can use this to switch
 217 console devices.  For instance, if you boot from the internal console,
 218 you can use the
 219 .Fl h
 220 option to force the kernel to use the serial port as its
 221 console device.  Alternatively, if you boot from the serial port,
 222 you can use this option to force the kernel to use the internal display
 223 as the console instead.
 224 The serial port driver
 225 .Xr sio 4
 226 has a flag to override this option.
 227 If that flag is set, the serial port will always be used as the console,
 228 regardless of the
 229 .Fl h
 230 option described here.  See the man page for
 231 .Xr sio 4
 232 for more details.
 233 .It Fl m
 234 mute the console.
 235 .It Fl n
 236 ignore key press to interrupt boot before loader(8) is invoked.
 237 .It Fl P
 238 probe the keyboard.  If no keyboard is found, the
 239 .Fl D
 240 and
 241 .Fl h
 242 options are automatically set.
 243 .It Fl p
 244 pause after each attached device during the device probing phase.
 245 .It Fl r
 246 use the statically configured default for the device containing the
 247 root file system
 248 (see
 249 .Xr config 8 ) .
 250 Normally, the root file system is on the device
 251 that the kernel was loaded from.
 252 .It Fl s
 253 boot into single-user mode; if the console is marked as
 254 .Dq insecure
 255 (see
 256 .Xr ttys 5 ) ,
 257 the root password must be entered.
 258 .It Fl v
 259 be verbose during device probing (and later).
 260 .El
 261 .El
 262 .El
 263 .Pp
 264 You may put a BIOS drive number, a controller type, a unit number,
 265 a partition, a kernel file name, and any valid option in
 266 .Pa /boot.config
 267 to set defaults.  Enter them in one line just as you type at the
 268 .Ql boot:
 269 prompt.
 270 .Sh FILES
 271 .Bl -tag -width /boot/loader -compact
 272 .It Pa /boot.config
 273 parameters for the boot blocks (optional)
 274 .It Pa /boot/boot1
 275 first stage bootstrap file
 276 .It Pa /boot/boot2
 277 second stage bootstrap file
 278 .It Pa /boot/loader
 279 third stage bootstrap
 280 .It Pa /kernel
 281 default kernel
 282 .It Pa /kernel.old
 283 typical non-default kernel (optional)
 284 .El
 285 .Sh SEE ALSO
 286 .Xr ddb 4 ,
 287 .Xr ttys 5 ,
 288 .Xr boot0cfg 8 ,
 289 .Xr btxld 8 ,
 290 .Xr config 8 ,
 291 .Xr disklabel 8 ,
 292 .Xr halt 8 ,
 293 .Xr loader 8 ,
 294 .Xr reboot 8 ,
 295 .Xr shutdown 8
 296 .Sh DIAGNOSTICS
 297 When disk-related errors occur, these are reported by the second-stage
 298 bootstrap using the same error codes returned by the BIOS, for example
 299 .Dq Disk error 0x1 (lba=0x12345678) .
 300 Here is a partial list of these error codes:
 301 .Pp
 302 .Bl -tag -width "0x80" -compact
 303 .It 0x1
 304 Invalid argument
 305 .It 0x2
 306 Address mark not found
 307 .It 0x4
 308 Sector not found
 309 .It 0x8
 310 DMA overrun
 311 .It 0x9
 312 DMA attempt across 64K boundary
 313 .It 0xc
 314 Invalid media
 315 .It 0x10
 316 Uncorrectable CRC/ECC error
 317 .It 0x20
 318 Controller failure
 319 .It 0x40
 320 Seek failed
 321 .It 0x80
 322 Timeout
 323 .El
 324 .Pp
 325 .Sy "NOTE" :
 326 On older machines, or otherwise where EDD support (disk packet
 327 interface support) is not available, all boot-related files and
 328 structures (including the kernel) that need to be accessed during the
 329 boot phase must reside on the disk at or below cylinder 1023 (as the
 330 BIOS understands the geometry).  When a
 331 .Dq Disk error 0x1
 332 is reported by the second-stage bootstrap, it generally means that this
 333 requirement has not been adhered to.
 334 .Sh BUGS
 335 The
 336 .Xr disklabel 5
 337 format used by this version of
 338 .Bx
 339 is quite
 340 different from that of other architectures.
 341 .Pp
 342 Due to space constraints, the keyboard probe initiated by the
 343 .Fl P
 344 option is simply a test that the BIOS has detected an
 345 .Dq extended
 346 keyboard.  If an
 347 .Dq XT/AT
 348 keyboard (with no F11 and F12 keys, etc.) is attached, the probe will
 349 fail.