| cli.lua.8 (d9ec4fa9cec0444bf0a13348ee07705f58520151) | cli.lua.8 (4634bb1f4052ff5f1c0a423fd8cce11396ca7fd2) |
|---|---|
| 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: --- 12 unchanged lines hidden (view full) --- 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.\" | 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: --- 12 unchanged lines hidden (view full) --- 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 September 13, 2019 | 29.Dd December 12, 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 --- 34 unchanged lines hidden (view full) --- 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 | 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 --- 34 unchanged lines hidden (view full) --- 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 |
| 80As of present, the | 80The |
| 81.Nm | 81.Nm |
| 82module by default provides commands for 83.Ic autoboot , 84.Ic boot , 85.Ic boot-conf , 86and 87.Ic reload-conf . | 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.El |
| 88.Pp 89For 90.Ic autoboot , 91.Ic boot , 92and 93.Ic boot-conf , 94the 95.Xr core.lua 8 96module will load all ELF modules as-needed before executing the equivalent 97built-in loader commands. 98All non-kernel arguments to these commands are passed in the same order to the 99loader command. 100.Pp 101The 102.Ic reload-conf 103command will reload the configuration from disk. 104This is useful if you have manually changed currdev and would like to easily 105reload the configuration from the new device. | 100.Pp 101For 102.Ic autoboot , 103.Ic boot , 104and 105.Ic boot-conf , 106the 107.Xr core.lua 8 108module will load all ELF modules as-needed before executing the equivalent 109built-in loader commands. 110All non-kernel arguments to these commands are passed in the same order to the 111loader command. 112.Pp 113The 114.Ic reload-conf 115command will reload the configuration from disk. 116This is useful if you have manually changed currdev and would like to easily 117reload the configuration from the new device. |
| 118.Pp 119The 120.Ic enable-module , 121.Ic disable-module , 122and 123.Ic toggle-module 124commands manipulate the list of modules to be loaded along with the kernel. 125Modules blacklisted are considered disabled by 126.Ic toggle-module . 127These commands will override any such restriction as needed. |
|
| 106.Ss Exported Functions 107The following functions are exported from 108.Nm : 109.Bl -tag -width cli.arguments -offset indent 110.It Fn cli.arguments ... 111Takes varargs passed on the stack from 112.Xr loader 8 113to --- 13 unchanged lines hidden --- | 128.Ss Exported Functions 129The following functions are exported from 130.Nm : 131.Bl -tag -width cli.arguments -offset indent 132.It Fn cli.arguments ... 133Takes varargs passed on the stack from 134.Xr loader 8 135to --- 13 unchanged lines hidden --- |