aboutsummaryrefslogtreecommitdiff
path: root/stand/man
diff options
context:
space:
mode:
Diffstat (limited to 'stand/man')
-rw-r--r--stand/man/boot1.efi.82
-rw-r--r--stand/man/loader.857
-rw-r--r--stand/man/loader.efi.89
-rw-r--r--stand/man/loader_4th.87
-rw-r--r--stand/man/loader_lua.83
-rw-r--r--stand/man/loader_simp.89
6 files changed, 77 insertions, 10 deletions
diff --git a/stand/man/boot1.efi.8 b/stand/man/boot1.efi.8
index b6135f8e0e12..2c882a595592 100644
--- a/stand/man/boot1.efi.8
+++ b/stand/man/boot1.efi.8
@@ -1,4 +1,6 @@
.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 2020 Netflix, Inc
.\"
.\" Redistribution and use in source and binary forms, with or without
diff --git a/stand/man/loader.8 b/stand/man/loader.8
index 4fc3bbb7cff0..484e0a7b300c 100644
--- a/stand/man/loader.8
+++ b/stand/man/loader.8
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 1999 Daniel C. Sobral
.\" All rights reserved.
.\" Copyright (c) 2021 Warner Losh <imp@FreeBSD.org>
@@ -23,7 +26,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd September 29, 2021
+.Dd November 14, 2025
.Dt LOADER 8
.Os
.Sh NAME
@@ -86,6 +89,52 @@ The commands common to all interpreters are described in the
.Xr loader_simp 8
.Dq BUILTIN COMMANDS
section.
+.Pp
+The following commands are only available in
+.Xr loader_lua 8
+and
+.Xr loader_4th 8 :
+.Pp
+.Bl -tag -width indent -compact
+.\" sort the following entries according to the second field
+.It Ic boot-conf
+Load the
+.Nm
+config and commence the autoboot sequence.
+.Pp
+.It Ic read-conf Ar file
+Load the specified configuration file.
+.Pp
+.It Ic reload-conf
+Revert any previously applied settings, and reload the configuration.
+Set comands that were executed at the command line to override variables
+previously
+.Cm set
+by
+.Xr loader.conf 5
+configuration will also be reverted,
+along with any module options that were toggled.
+.Pp
+.It Ic enable-module Ar kmod-name
+.It Ic disable-module Ar kmod-name
+.It Ic toggle-module Ar kmod-name
+Enable, disable, or toggle loading of the kernel module named
+.Dq Ar kmod-name .
+.Pp
+.It Ic show-module-options
+Describe all modules the
+.Nm
+is aware of, and show if they are enabled or not.
+.El
+.Pp
+The following command is only available in
+.Xr loader_lua 8 :
+.Pp
+.Bl -tag -width indent -compact
+.It Ic disable-device Ar device
+Set a newbus hint to disable the
+.Ar device .
+.El
.Ss BUILTIN ENVIRONMENT VARIABLES
The environment variables common to all interpreters are described in the
.Xr loader_simp 8
@@ -115,11 +164,11 @@ scripting language changed to Lua by default in
The
.Nm
was written by
-.An Michael Smith Aq msmith@FreeBSD.org .
+.An Michael Smith Aq Mt msmith@FreeBSD.org .
.Pp
FICL was written by
-.An John Sadler Aq john_sadler@alum.mit.edu .
+.An John Sadler Aq Mt john_sadler@alum.mit.edu .
.Pp
-.An Warner Losh Aq imp@FreeBSD.org
+.An Warner Losh Aq Mt imp@FreeBSD.org
integrated Lua into the tree based on initial work done by Pedro Souza
for the 2014 Google Summer of Code.
diff --git a/stand/man/loader.efi.8 b/stand/man/loader.efi.8
index c488ac257804..d9a5c827ba71 100644
--- a/stand/man/loader.efi.8
+++ b/stand/man/loader.efi.8
@@ -158,6 +158,7 @@ The serial ports are assigned as follows on IBM PC compatible systems:
.It COM3 Ta 0x3e8 Ta Pa /dev/uart2
.It COM4 Ta 0x2e8 Ta Pa /dev/uart3
.El
+.Pp
Though
.Dv COM3
and
@@ -191,8 +192,9 @@ of any behavior not covered in this document.
.It Fl s Ta Dv boot_single Ta Va RB_SINGLE
.It Fl v Ta Dv boot_verbose Ta Va RB_VERBOSE
.El
+.Pp
And the following flags determine the primary console:
-.Bl -column -offset indent ".Sy Flags" ".Sy Kernel Flags" ".Sy Kernel Consoles" ".Sy Primary Console"
+.Bl -column -offset xxx "Flags" "RB_SERIAL | RB_MULTIPLE" "Kernel Consoles" "Primary Console"
.It Sy Flags Ta Sy Kernel Flags Ta Sy Kernel Consoles Ta Sy Primary Console
.It none Ta 0 Ta Video Ta Video
.It Fl h Ta RB_SERIAL Ta Serial Ta Serial
@@ -380,6 +382,7 @@ To check:
# mount | grep nda0p1
/dev/nda0p1 on /boot/efi (msdosfs, local)
.Ed
+.Pp
If it's not mounted, you will need to mount it:
.Bd -literal -offset indent
# mount -t msdosfs /dev/nda0p1 /boot/efi
@@ -398,6 +401,7 @@ BootOrder : 0000, 0001, 0003, 0004, 0005, 0006, 0001, 0008, 000A, 000B, 000C, 0
nda0p1:/EFI/FREEBSD/LOADER.EFI /boot/efi//EFI/FREEBSD/LOADER.EFI
\&...
.Ed
+.Pp
Often there are several options, depending on the BIOS.
The entry that we booted with is marked with a
.Sq +
@@ -416,6 +420,7 @@ loader, which varies by architecture.
.It i386 Ta Pa /EFI/BOOT/BOOTIA32.EFI
.It riscv Ta Pa /EFI/BOOT/BOOTRISCV64.EFI
.El
+.Pp
However, care must be taken: some multiple-boot environments rely on a special
.Pa bootXXX.efi
to function.
@@ -436,10 +441,12 @@ above table):
.Bd -literal -offset indent
# cmp /boot/efi/EFI/FREEBSD/LOADER.EFI /boot/efi/EFI/BOOT/BOOTX64.EFI
.Ed
+.Pp
Copy the loader:
.Bd -literal -offset indent
# cp /boot/loader.efi /boot/efi/EFI/FREEBSD/LOADER.EFI
.Ed
+.Pp
replacing the all caps part of the example with the proper path.
.Pp
If ESP path was
diff --git a/stand/man/loader_4th.8 b/stand/man/loader_4th.8
index 9e87326f893b..21e907bd8630 100644
--- a/stand/man/loader_4th.8
+++ b/stand/man/loader_4th.8
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 1999 Daniel C. Sobral
.\" All rights reserved.
.\"
@@ -576,8 +579,8 @@ first appeared in
The
.Nm
was written by
-.An Michael Smith Aq msmith@FreeBSD.org .
+.An Michael Smith Aq Mt msmith@FreeBSD.org .
.Pp
.Tn FICL
was written by
-.An John Sadler Aq john_sadler@alum.mit.edu .
+.An John Sadler Aq Mt john_sadler@alum.mit.edu .
diff --git a/stand/man/loader_lua.8 b/stand/man/loader_lua.8
index 0aa467237266..c60de9417abc 100644
--- a/stand/man/loader_lua.8
+++ b/stand/man/loader_lua.8
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 1999 Daniel C. Sobral
.\" All rights reserved.
.\"
diff --git a/stand/man/loader_simp.8 b/stand/man/loader_simp.8
index cdacd823b1a5..52cb598fdd89 100644
--- a/stand/man/loader_simp.8
+++ b/stand/man/loader_simp.8
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 1999 Daniel C. Sobral
.\" All rights reserved.
.\"
@@ -355,8 +358,8 @@ in
.Xr kenv 1 ,
not for any particular value.
.It Va boot_serial
-Force the use of a serial console even when an internal console
-is present.
+Force the use of a serial console for the kernel
+even when an internal console is present.
.It Va boot_single
Prevents the kernel from initiating a multi-user startup; instead,
a single-user mode will be entered when the kernel has finished
@@ -755,4 +758,4 @@ first appeared in
The
.Nm
was written by
-.An Michael Smith Aq msmith@FreeBSD.org .
+.An Michael Smith Aq Mt msmith@FreeBSD.org .