1.\" 2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3.\" 4.\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org> 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.\" $FreeBSD$ 28.\" 29.Dd December 17, 2020 30.Dt CLI.LUA 8 31.Os 32.Sh NAME 33.Nm cli.lua 34.Nd FreeBSD Lua CLI module 35.Sh DESCRIPTION 36.Nm 37contains the main functionality required to add new CLI commands, which can be 38executed at the loader prompt. 39.Pp 40Before hooking into the functionality provided by 41.Nm , 42it must be included with a statement such as the following: 43.Pp 44.Dl local cli = require("cli") 45.Ss Adding new commands 46New loader commands may be created by adding functions to the object returned by 47requiring the 48.Nm 49module. 50.Pp 51For instance: 52.Pp 53.Bd -literal -offset indent -compact 54local cli = require("cli") 55 56cli.foo = function(...) 57 -- Expand args to command name and the rest of argv. These arguments 58 -- are pushed directly to the stack by loader, then handed off to 59 -- cli_execute. cli_execute then passes them on to the invoked 60 -- function, where they appear as varargs that must be peeled apart into 61 -- their respective components. 62 local _, argv = cli.arguments(...) 63 64 print("This is the foo command!") 65 for k, v in ipairs(argv) do 66 print("arg #" .. tostring(k) .. ": '" .. v .. "'") 67 end 68 -- Perform a loader command directly. This will not get dispatched back 69 -- to Lua, so it is acceptable to have a function of the exact same name 70 -- in loader. Lua will have the first chance to handle any commands 71 -- executed at the loader prompt. 72 loader.perform("foo") 73end 74.Ed 75.Pp 76This function may be invoked by a user at the loader prompt by simply typing 77.Ic foo . 78Arguments may be passed to it as usual, space-delimited. 79.Ss Default Commands 80The 81.Nm 82module provides the following default commands: 83.Bl -bullet 84.\"-width toggle-module -offset indent 85.It 86.Ic autoboot 87.It 88.Ic boot 89.It 90.Ic boot-conf 91.It 92.Ic reload-conf 93.It 94.Ic enable-module 95.It 96.Ic disable-module 97.It 98.Ic toggle-module 99.It 100.Ic show-module-options 101.El 102.Pp 103For 104.Ic autoboot , 105.Ic boot , 106and 107.Ic boot-conf , 108the 109.Xr core.lua 8 110module will load all ELF modules as-needed before executing the equivalent 111built-in loader commands. 112All non-kernel arguments to these commands are passed in the same order to the 113loader command. 114.Pp 115The 116.Ic reload-conf 117command will reload the configuration from disk. 118This is useful if you have manually changed currdev and would like to easily 119reload the configuration from the new device. 120.Pp 121The 122.Ic enable-module , 123.Ic disable-module , 124and 125.Ic toggle-module 126commands manipulate the list of modules to be loaded along with the kernel. 127Modules blacklisted are considered disabled by 128.Ic toggle-module . 129These commands will override any such restriction as needed. 130The 131.Ic show-module-options 132command will dump the list of modules that loader has been made aware of and 133any applicable options using paged output. 134.Ss Exported Functions 135The following functions are exported from 136.Nm : 137.Bl -tag -width cli.arguments -offset indent 138.It Fn cli.arguments ... 139Takes varargs passed on the stack from 140.Xr loader 8 141to 142.Ic cli_execute , 143splits them out into two return values: the command name, traditionally argv[0], 144and the rest of argv. 145.El 146.Sh SEE ALSO 147.Xr loader.conf 5 , 148.Xr core.lua 8 , 149.Xr loader 8 150.Sh AUTHORS 151The 152.Nm 153file was originally written by 154.An Kyle Evans Aq Mt kevans@FreeBSD.org . 155