SPDX-License-Identifier: BSD-2-Clause-FreeBSD

Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

$FreeBSD: stable/11/stand/lua/core.lua.8 344399 2019-02-20 23:55:35Z kevans $

.Dd March 21, 2018 .Dt CORE.LUA 8 .Os .Sh NAME .Nm core.lua .Nd FreeBSD core module .Sh DESCRIPTION .Nm contains core functionality that does not have a more fitting module.

p Before hooking into or using the functionality provided by .Nm , it must be included with a statement such as the following:

p .Dl local core = require("core") .Ss CONSTANTS The following raw key code constants are defined in .Nm : l -tag -width KEY_BACKSPACE -compact -offset indent t Ic KEY_BACKSPACE The backspace code. Should generally be checked along with c KEY_DELETE for backspace functionality. t Ic KEY_ENTER The enter key, or hard return. t Ic KEY_DELETE The delete code. Should generally be checked along with c KEY_BACKSPACE for backspace functionality. .El

p The following key-string constants are defined in .Nm : l -tag -width KEYSTR_ESCAPE -compact -offset indent t Ic KEYSTR_ESCAPE The escape key. t Ic KEYSTR_CSI The ANSI CSI sequence. .El

p The following menu entry type constants are defined in .Nm : l -tag -width MENU_CAROUSEL_ENTRY -compact -offset indent t Ic MENU_RETURN Return to the parent menu. t Ic MENU_ENTRY A normal menu entry. t Ic MENU_SEPARATOR A menu entry that serves as a separator. t Ic MENU_SUBMENU A menu entry that opens a submenu when selected. t Ic MENU_CAROUSEL_ENTRY A menu entry that rotates through items like a carousel upon selection of the menu entry. .El

p Please see .Xr menu.lua 8 for extended descriptions and usage of the c MENU_* constants. .Ss Exported functions The following functions are exported from .Nm : l -tag -width core.getACPIPresent -offset indent t Fn core.setVerbose verbose Sets or unsets .Ev boot_verbose . If .Fa verbose is omitted, toggle the current verbose setting. t Fn core.setSingleUser singleUser Sets or unsets .Ev boot_single . If .Fa singleUser is omitted, toggle the current single user setting. t Fn core.getACPIPresent checkingSystemDefaults Check whether ACPI is present. This will only be accurate for i386-compatible loaders, including non-UEFI loaders on amd64 systems. If .Fa checkingSystemDefaults is true, ignore the current value of .Ev hint.acpi.0.disabled . Otherwise, return true only if ACPI is both present and not disabled. t Fn core.setACPI acpi Sets or unsets .Ev acpi_load , .Ev hint.acpi.0.disabled , and .Ev loader.acpi_disabled_by_user . If .Fa acpi is omitted, toggle the current ACPI setting. t Fn core.setSafeMode safeMode Set the safe mode setting. Sets or unsets .Ev kern.smp.disabled , .Ev hw.ata.ata_dma , .Ev hw.ata.atapi_dma , .Ev hw.ata.wc , .Ev hw.eisa_slots , .Ev kern.eventtimer.periodic , and .Ev kern.geom.part.check_integrity . If .Fa safeMode is omitted, toggle the current safe mode setting. t Fn core.clearCachedKernels Clears out the cache of kernels to be displayed on the boot menu. This function is registered as a .Ev config.reloaded hook. It is used to invalidate the kernel list whenever it may have changed, either due to a boot environment change or a potential change in either c kernel or c kernels . t Fn core.kernelList Returns a table of kernels to display on the boot menu. This will combine c kernel and c kernels from .Xr loader.conf 5 . If c kernels_autodetect is set in .Xr loader.conf 5 , kernels will be autodetected from the current system. t Fn core.bootenvDefault Returns the default boot environment, nil if unset. t Fn core.bootenvList Returns a table of boot environments, or an empty table. These will be picked up using the .Ev bootenvs and .Ev bootenvs_count variables set by .Xr loader 8 . t Fn core.setDefaults Resets ACPI, safe mode, single user, and verbose settings to their system defauilts. t Fn core.autoboot argstr Loads the kernel and specified modules, then invokes the c autoboot .Xr loader 8 command with .Fa argstr as-is. t Fn core.boot argstr Loads the kernel and specified modules, then invokes the c boot .Xr loader 8 command with .Fa argstr as-is. t Fn core.isSingleUserBoot Returns true if .Ev boot_single is set to yes. t Fn core.isZFSBoot Returns true if .Ev currdev is set to a .Xr zfs 8 dataset. t Fn core.isSerialBoot Returns true if we are booting over serial. This checks .Ev console , .Ev boot_serial , and .Ev boot_multicons . t Fn core.isSystem386 Returns true if this bootloader was compiled as an i386 binary. This generally applies to i386 loaders as well as non-UEFI loaders on amd64. t Fn core.deepCopyTable tbl Recursively deep copies .Fa tbl and returns the result. t Fn core.popFrontTable tbl Pops the front element off of .Fa tbl , and returns two return values: the front element, and the rest of the table. If there are no elements, this returns nil and nil. If there is one element, this returns the front element and an empty table. This will not operate on truly associative tables; numeric indices are required. .El .Sh SEE ALSO .Xr loader.conf 5 , .Xr loader 8 , .Xr menu.lua 8 .Sh AUTHORS The .Nm file was originally written by .An Pedro Souza Aq Mt pedrosouza@FreeBSD.org . Later work and this manual page was done by .An Kyle Evans Aq Mt kevans@FreeBSD.org .