xref: /freebsd/share/man/man5/boot.config.5 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
183b49532SDaniel Gerzo.\" Copyright (c) 2007 Daniel Gerzo <danger@FreeBSD.org>
283b49532SDaniel Gerzo.\" All rights reserved.
383b49532SDaniel Gerzo.\"
483b49532SDaniel Gerzo.\" Redistribution and use in source and binary forms, with or without
583b49532SDaniel Gerzo.\" modification, are permitted provided that the following conditions
683b49532SDaniel Gerzo.\" are met:
783b49532SDaniel Gerzo.\" 1. Redistributions of source code must retain the above copyright
883b49532SDaniel Gerzo.\"    notice, this list of conditions and the following disclaimer.
983b49532SDaniel Gerzo.\" 2. Redistributions in binary form must reproduce the above copyright
1083b49532SDaniel Gerzo.\"    notice, this list of conditions and the following disclaimer in the
1183b49532SDaniel Gerzo.\"    documentation and/or other materials provided with the distribution.
1283b49532SDaniel Gerzo.\"
1383b49532SDaniel Gerzo.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1483b49532SDaniel Gerzo.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1583b49532SDaniel Gerzo.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1683b49532SDaniel Gerzo.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1783b49532SDaniel Gerzo.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1883b49532SDaniel Gerzo.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1983b49532SDaniel Gerzo.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2083b49532SDaniel Gerzo.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2183b49532SDaniel Gerzo.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2283b49532SDaniel Gerzo.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2383b49532SDaniel Gerzo.\" SUCH DAMAGE.
24085e62ebSWarner Losh.Dd October 12, 2020
2583b49532SDaniel Gerzo.Dt BOOT.CONFIG 5
2683b49532SDaniel Gerzo.Os
2783b49532SDaniel Gerzo.Sh NAME
2883b49532SDaniel Gerzo.Nm boot.config
2983b49532SDaniel Gerzo.Nd "Configuration file for the boot blocks"
3083b49532SDaniel Gerzo.Sh DESCRIPTION
3183b49532SDaniel GerzoThe
3283b49532SDaniel Gerzo.Nm
3383b49532SDaniel Gerzofile contains options for the
3483b49532SDaniel Gerzo.Fx
3583b49532SDaniel Gerzoboot block code.
3683b49532SDaniel Gerzo.Pp
3783b49532SDaniel GerzoWhen the
3883b49532SDaniel Gerzo.Fx
3983b49532SDaniel Gerzoboot loader runs, it searches the
4083b49532SDaniel Gerzo.Dq Li a
4183b49532SDaniel Gerzoslice of the boot partition for a
4283b49532SDaniel Gerzo.Nm
4383b49532SDaniel Gerzofile (as a result, slices which are missing an
4483b49532SDaniel Gerzo.Dq Li a
4583b49532SDaniel Gerzopartition require user intervention during the boot process).
4683b49532SDaniel GerzoIf the
4783b49532SDaniel Gerzo.Nm
4883b49532SDaniel Gerzofile is found, its contents are used as the default configuration
4983b49532SDaniel Gerzooptions for the boot block code and are echoed to the system console.
5083b49532SDaniel Gerzo.Pp
5183b49532SDaniel GerzoA valid format of this file is to put BIOS drive number, a controller
5283b49532SDaniel Gerzotype, a unit number, a partition, a kernel file name, and any other
5383b49532SDaniel Gerzovalid
5483b49532SDaniel Gerzo.Xr boot 8
5583b49532SDaniel Gerzooption on a single line, as it is done at the
5683b49532SDaniel Gerzo.Dq Li "boot:"
5783b49532SDaniel Gerzoprompt.
5883b49532SDaniel Gerzo.Pp
5983b49532SDaniel GerzoThe options related to the boot image selection described below and all
6083b49532SDaniel Gerzothe other options available for
6183b49532SDaniel Gerzo.Nm
6283b49532SDaniel Gerzoare documented in detail in the
6383b49532SDaniel Gerzo.Xr boot 8
6483b49532SDaniel Gerzomanual page.
650b31f1f7SUlrich Spörlein.Sh FILES
660b31f1f7SUlrich Spörlein.Bl -tag -width /boot.config -compact
670b31f1f7SUlrich Spörlein.It Pa /boot.config
680b31f1f7SUlrich Spörleinparameters for the boot blocks (optional)
69085e62ebSWarner Losh.It Pa /boot/config
70*c8f8299aSDaniel Gerzoalternate location for boot config information
710b31f1f7SUlrich Spörlein.El
7283b49532SDaniel Gerzo.Sh EXAMPLES
7383b49532SDaniel GerzoThe command:
7483b49532SDaniel Gerzo.Bd -literal -offset indent
7583b49532SDaniel Gerzo# echo "-P" > /boot.config
7683b49532SDaniel Gerzo.Ed
7783b49532SDaniel Gerzo.Pp
7883b49532SDaniel Gerzowill activate the serial console of
79085e62ebSWarner Losh.Fx
80085e62ebSWarner Loshif no keyboard is present, otherwise video console will be used.
8183b49532SDaniel Gerzo.Pp
8283b49532SDaniel GerzoThe command:
8383b49532SDaniel Gerzo.Bd -literal -offset indent
8483b49532SDaniel Gerzo# echo "1:ad(1,a)/boot/loader" > /boot.config
8583b49532SDaniel Gerzo.Ed
8683b49532SDaniel Gerzo.Pp
8706019effSDaniel Gerzowill instruct the second stage of
8806019effSDaniel Gerzo.Xr boot 8
8906019effSDaniel Gerzoon the first disk to boot with the third
9006019effSDaniel Gerzo.Xr boot 8
9106019effSDaniel Gerzostage from the second disk.
9283b49532SDaniel Gerzo.Pp
9383b49532SDaniel GerzoThe command:
9483b49532SDaniel Gerzo.Bd -literal -offset indent
9583b49532SDaniel Gerzo# echo "1:ad(1,a)/boot/loader -P" > /boot.config
9683b49532SDaniel Gerzo.Ed
9783b49532SDaniel Gerzo.Pp
9883b49532SDaniel Gerzowill do both of the above.
9983b49532SDaniel Gerzo.Sh SEE ALSO
10083b49532SDaniel Gerzo.Xr boot 8 ,
10183b49532SDaniel Gerzo.Xr loader 8
10283b49532SDaniel Gerzo.Sh AUTHORS
10383b49532SDaniel GerzoThis manual page was written by
104a63d6c94SBaptiste Daroussin.An Daniel Gerzo Aq Mt danger@FreeBSD.org .
105