xref: /freebsd/share/man/man5/boot.config.5 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
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 October 12, 2020
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
33The
34.Nm
35file contains options for the
36.Fx
37boot block code.
38.Pp
39When the
40.Fx
41boot loader runs, it searches the
42.Dq Li a
43slice of the boot partition for a
44.Nm
45file (as a result, slices which are missing an
46.Dq Li a
47partition require user intervention during the boot process).
48If the
49.Nm
50file is found, its contents are used as the default configuration
51options for the boot block code and are echoed to the system console.
52.Pp
53A valid format of this file is to put BIOS drive number, a controller
54type, a unit number, a partition, a kernel file name, and any other
55valid
56.Xr boot 8
57option on a single line, as it is done at the
58.Dq Li "boot:"
59prompt.
60.Pp
61The options related to the boot image selection described below and all
62the other options available for
63.Nm
64are documented in detail in the
65.Xr boot 8
66manual page.
67.Sh FILES
68.Bl -tag -width /boot.config -compact
69.It Pa /boot.config
70parameters for the boot blocks (optional)
71.It Pa /boot/config
72alternate location for boot config information
73.El
74.Sh EXAMPLES
75The command:
76.Bd -literal -offset indent
77# echo "-P" > /boot.config
78.Ed
79.Pp
80will activate the serial console of
81.Fx
82if no keyboard is present, otherwise video console will be used.
83.Pp
84The command:
85.Bd -literal -offset indent
86# echo "1:ad(1,a)/boot/loader" > /boot.config
87.Ed
88.Pp
89will instruct the second stage of
90.Xr boot 8
91on the first disk to boot with the third
92.Xr boot 8
93stage from the second disk.
94.Pp
95The command:
96.Bd -literal -offset indent
97# echo "1:ad(1,a)/boot/loader -P" > /boot.config
98.Ed
99.Pp
100will do both of the above.
101.Sh SEE ALSO
102.Xr boot 8 ,
103.Xr loader 8
104.Sh AUTHORS
105This manual page was written by
106.An Daniel Gerzo Aq Mt danger@FreeBSD.org .
107