1.\" 2.\" SPDX-License-Identifier: BSD-2-Clause 3.\" 4.\" Copyright (c) 2018 Kyle Evans <[email protected]> 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.Dd December 28, 2023 28.Dt CORE.LUA 8 29.Os 30.Sh NAME 31.Nm core.lua 32.Nd FreeBSD core module 33.Sh DESCRIPTION 34.Nm 35contains core functionality that does not have a more fitting module. 36.Pp 37Before hooking into or using the functionality provided by 38.Nm , 39it must be included with a statement such as the following: 40.Pp 41.Dl local core = require("core") 42.Ss CONSTANTS 43The following raw key code constants are defined in 44.Nm : 45.Bl -tag -width KEY_BACKSPACE -compact -offset indent 46.It Ic KEY_BACKSPACE 47The backspace code. 48Should generally be checked along with 49.Ic KEY_DELETE 50for backspace functionality. 51.It Ic KEY_ENTER 52The enter key, or hard return. 53.It Ic KEY_DELETE 54The delete code. 55Should generally be checked along with 56.Ic KEY_BACKSPACE 57for backspace functionality. 58.El 59.Pp 60The following key-string constants are defined in 61.Nm : 62.Bl -tag -width KEYSTR_ESCAPE -compact -offset indent 63.It Ic KEYSTR_ESCAPE 64The escape key. 65.It Ic KEYSTR_CSI 66The ANSI CSI sequence. 67.El 68.Pp 69The following menu entry type constants are defined in 70.Nm : 71.Bl -tag -width MENU_CAROUSEL_ENTRY -compact -offset indent 72.It Ic MENU_RETURN 73Return to the parent menu. 74.It Ic MENU_ENTRY 75A normal menu entry. 76.It Ic MENU_SEPARATOR 77A menu entry that serves as a separator. 78.It Ic MENU_SUBMENU 79A menu entry that opens a submenu when selected. 80.It Ic MENU_CAROUSEL_ENTRY 81A menu entry that rotates through items like a carousel upon selection of the 82menu entry. 83.El 84.Pp 85Please see 86.Xr menu.lua 8 87for extended descriptions and usage of the 88.Ic MENU_* 89constants. 90.Ss Exported functions 91The following functions are exported from 92.Nm : 93.Bl -tag -width core.setSingleUser -offset indent 94.It Fn core.setVerbose verbose 95Sets or unsets 96.Ev boot_verbose . 97If 98.Fa verbose 99is omitted, toggle the current verbose setting. 100.It Fn core.setSingleUser singleUser 101Sets or unsets 102.Ev boot_single . 103If 104.Fa singleUser 105is omitted, toggle the current single user setting. 106.It Fn core.getACPI 107Return true if ACPI is both present and not explicitly disabled by 108.Ev hints.acpi.0.disabled . 109.It Fn core.hasACPI 110Checks whether ACPI support is present. 111This requires the loader to probe the system and set 112.Ev acpi.rsdp 113early before starting the interpreter. 114.It Fn core.setACPI acpi 115Sets or unsets 116.Ev acpi_load , 117.Ev hint.acpi.0.disabled , 118and 119.Ev loader.acpi_disabled_by_user . 120If 121.Fa acpi 122is omitted, toggle the current ACPI setting. 123.It Fn core.setSafeMode safeMode 124Set the safe mode setting. 125Sets or unsets 126.Ev kern.smp.disabled , 127.Ev hw.ata.ata_dma , 128.Ev hw.ata.atapi_dma , 129.Ev hw.ata.wc , 130.Ev hw.eisa_slots , 131.Ev kern.eventtimer.periodic , 132and 133.Ev kern.geom.part.check_integrity . 134If 135.Fa safeMode 136is omitted, toggle the current safe mode setting. 137.It Fn core.clearCachedKernels 138Clears out the cache of kernels to be displayed on the boot menu. 139This function is registered as a 140.Ev config.reloaded 141hook. 142It is used to invalidate the kernel list whenever it may have changed, either 143due to a boot environment change or a potential change in either 144.Ic kernel 145or 146.Ic kernels . 147.It Fn core.hasFeature featureName 148Checks whether the named 149.Fa featureName 150is enabled in the current loader. 151This is specifically used for detecting capabilities of the loaded loader 152binary, so that one can reasonably implement backwards compatibility shims if 153needed. 154.It Fn core.kernelList 155Returns a table of kernels to display on the boot menu. 156This will combine 157.Ic kernel 158and 159.Ic kernels 160from 161.Xr loader.conf 5 . 162If 163.Ic kernels_autodetect 164is set in 165.Xr loader.conf 5 , 166kernels will be autodetected from the current system. 167.It Fn core.bootenvDefault 168Returns the default boot environment, nil if unset. 169.It Fn core.bootenvList 170Returns a table of boot environments, or an empty table. 171These will be picked up using the 172.Ev bootenvs 173and 174.Ev bootenvs_count 175variables set by 176.Xr loader 8 . 177.It Fn core.setDefaults 178Resets ACPI, safe mode, single user, and verbose settings to their system 179defauilts. 180.It Fn core.autoboot argstr 181Loads the kernel and specified modules, then invokes the 182.Ic autoboot 183.Xr loader 8 184command with 185.Fa argstr 186as-is. 187.It Fn core.boot argstr 188Loads the kernel and specified modules, then invokes the 189.Ic boot 190.Xr loader 8 191command with 192.Fa argstr 193as-is. 194.It Fn core.isSingleUserBoot 195Returns true if 196.Ev boot_single 197is set to yes. 198.It Fn core.isZFSBoot 199Returns true if 200.Ev currdev 201is set to a 202.Xr zfs 8 203dataset. 204.It Fn core.isSerialBoot 205Returns true if we are booting over serial. 206This checks 207.Ev console , 208.Ev boot_serial , 209and 210.Ev boot_multicons . 211.It Fn core.deepCopyTable tbl 212Recursively deep copies 213.Fa tbl 214and returns the result. 215.It Fn core.popFrontTable tbl 216Pops the front element off of 217.Fa tbl , 218and returns two return values: the front element, and the rest of the table. 219If there are no elements, this returns nil and nil. 220If there is one element, this returns the front element and an empty table. 221This will not operate on truly associative tables; numeric indices are 222required. 223.El 224.Sh SEE ALSO 225.Xr loader.conf 5 , 226.Xr loader 8 , 227.Xr menu.lua 8 228.Sh AUTHORS 229The 230.Nm 231file was originally written by 232.An Pedro Souza Aq Mt [email protected] . 233Later work and this manual page was done by 234.An Kyle Evans Aq Mt [email protected] . 235