share/man/man5/boot.config.5

   1 .\" Copyright (c) 2007 Daniel Gerzo <danger@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd May 13, 2007
  27 .Dt BOOT.CONFIG 5
  28 .Os
  29 .Sh NAME
  30 .Nm boot.config
  31 .Nd "Configuration file for the boot blocks"
  32 .Sh DESCRIPTION
  33 The
  34 .Nm
  35 file contains options for the
  36 .Fx
  37 boot block code.
  38 .Pp
  39 When the
  40 .Fx
  41 boot loader runs, it searches the
  42 .Dq Li a
  43 slice of the boot partition for a
  44 .Nm
  45 file (as a result, slices which are missing an
  46 .Dq Li a
  47 partition require user intervention during the boot process).
  48 If the
  49 .Nm
  50 file is found, its contents are used as the default configuration
  51 options for the boot block code and are echoed to the system console.
  52 .Pp
  53 A valid format of this file is to put BIOS drive number, a controller
  54 type, a unit number, a partition, a kernel file name, and any other
  55 valid
  56 .Xr boot 8
  57 option on a single line, as it is done at the
  58 .Dq Li "boot:"
  59 prompt.
  60 .Pp
  61 The options related to the boot image selection described below and all
  62 the other options available for
  63 .Nm
  64 are documented in detail in the
  65 .Xr boot 8
  66 manual page.
  67 .Sh EXAMPLES
  68 The command:
  69 .Bd -literal -offset indent
  70 # echo "-P" > /boot.config
  71 .Ed
  72 .Pp
  73 will activate the serial console of
  74 .Fx .
  75 .Pp
  76 The command:
  77 .Bd -literal -offset indent
  78 # echo "1:ad(1,a)/boot/loader" > /boot.config
  79 .Ed
  80 .Pp
  81 will instruct the second stage of
  82 .Xr boot 8
  83 on the first disk to boot with the third
  84 .Xr boot 8
  85 stage from the second disk.
  86 .Pp
  87 The command:
  88 .Bd -literal -offset indent
  89 # echo "1:ad(1,a)/boot/loader -P" > /boot.config
  90 .Ed
  91 .Pp
  92 will do both of the above.
  93 .Sh FILES
  94 .Bl -tag -width /boot.config -compact
  95 .It Pa /boot.config
  96 parameters for the boot blocks (optional)
  97 .El
  98 .Sh SEE ALSO
  99 .Xr boot 8 ,
 100 .Xr loader 8
 101 .Sh AUTHORS
 102 This manual page was written by
 103 .An Daniel Gerzo Aq danger@FreeBSD.org .