diff options
Diffstat (limited to 'static/netbsd/man9lua')
| -rw-r--r-- | static/netbsd/man9lua/Makefile | 6 | ||||
| -rw-r--r-- | static/netbsd/man9lua/intro.9lua | 54 | ||||
| -rw-r--r-- | static/netbsd/man9lua/pmf.9lua | 99 | ||||
| -rw-r--r-- | static/netbsd/man9lua/systm.9lua | 163 |
4 files changed, 322 insertions, 0 deletions
diff --git a/static/netbsd/man9lua/Makefile b/static/netbsd/man9lua/Makefile new file mode 100644 index 00000000..edf451b8 --- /dev/null +++ b/static/netbsd/man9lua/Makefile @@ -0,0 +1,6 @@ +# $NetBSD: Makefile,v 1.4 2013/12/16 23:54:26 lneto Exp $ + +MAN= systm.9lua intro.9lua pmf.9lua + +.include <bsd.man.mk> +.include <bsd.subdir.mk> diff --git a/static/netbsd/man9lua/intro.9lua b/static/netbsd/man9lua/intro.9lua new file mode 100644 index 00000000..c5455a65 --- /dev/null +++ b/static/netbsd/man9lua/intro.9lua @@ -0,0 +1,54 @@ +.\" $NetBSD: intro.9lua,v 1.5 2015/05/13 22:31:16 pgoyette Exp $ +.\" +.\" Copyright (c) 2013 Marc Balmer <mbalmer@NetBSD.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. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. +.\" +.\" +.Dd October 26, 2013 +.Dt INTRO 9lua +.Os +.Sh NAME +.Nm intro +.Nd introduction to the Lua kernel bindings +.Sh DESCRIPTION +This section provides an overview of the Lua kernel bindings, their +functions, error returns and other common definitions and concepts. +.Sh EXAMPLES +An example module is available in the +.Pa src/sys/modules/examples/ +directory hierarchy. +.Sh SEE ALSO +.Xr lua 1 , +.Xr luac 1 , +.Xr intro 3lua , +.Xr lua 4 , +.Xr pmf 9lua , +.Xr systm 9lua +.Sh HISTORY +An +.Nm +manual for Lua kernel bindings appeared in +.Nx 7.0 . diff --git a/static/netbsd/man9lua/pmf.9lua b/static/netbsd/man9lua/pmf.9lua new file mode 100644 index 00000000..4dbaeb22 --- /dev/null +++ b/static/netbsd/man9lua/pmf.9lua @@ -0,0 +1,99 @@ +.\" $NetBSD: pmf.9lua,v 1.3 2016/02/15 20:33:18 snj Exp $ +.\" +.\" Copyright (c) 2013 Marc Balmer <mbalmer@NetBSD.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. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. +.\" +.\" +.Dd October 29, 2013 +.Dt PMF 9lua +.Os +.Sh NAME +.Nm pmf +.Nd Lua binding to the power management framework +.Sh SYNOPSIS +.Cd "local pmf = require 'pmf'" +.Pp +.Bl -tag -width XXXX -compact +.It Dv pmf.system_shutdown(howto) +.It Dv pmf.set_platform(key, value) +.It Dv value = pmf.get_platform(key) +.El +.Sh DESCRIPTION +The +.Nm +Lua binding provides access to the power management framework. +.Pp +.Bl -tag -width XXXX -compact +.It Dv pmf.system_shutdown(howto) +Shutdown all attached devices. +.Ar howto +should contain the +.Xr reboot 2 +.Ar howto +argument. +The following values are defined as constants in the +.Nm +table: +.Pp +.Bl -tag -width XXXX -compact +.It Dv pmf.RB_AUTOBOOT +.It Dv pmf.RB_ASKNAME +.It Dv pmf.RB_DUMP +.It Dv pmf.RB_HALT +.It Dv pmf.RB_POWERDOWN +.It Dv pmf.RB_KDB +.It Dv pmf.RB_NOSYNC +.It Dv pmf.RB_RDONLY +.It Dv pmf.RB_SINGLE +.It Dv pmf.RB_USERCONF +.El +.Pp +.It Dv pmf.set_platform(key, value) +Insert a name-value pair into the platform information database. +.Pp +.It Dv value = pmf.get_platform(key) +Retrieve the value for +.Ar key +from the platform information database. +Returns nil if the key is not present. +.El +.Sh SEE ALSO +.Xr lua 1 , +.Xr luac 1 , +.Xr lua 4 , +.Xr pmf 9 , +.Xr intro 9lua +.Sh HISTORY +A +.Nm +Lua manual appeared in +.Nx 7.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +Lua binding was written by +.An Marc Balmer Aq Mt mbalmer@NetBSD.org . diff --git a/static/netbsd/man9lua/systm.9lua b/static/netbsd/man9lua/systm.9lua new file mode 100644 index 00000000..369bd3cc --- /dev/null +++ b/static/netbsd/man9lua/systm.9lua @@ -0,0 +1,163 @@ +.\" $NetBSD: systm.9lua,v 1.2 2014/01/06 13:03:33 wiz Exp $ +.\" +.\" Copyright (c) 2013 Marc Balmer <mbalmer@NetBSD.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. +.\" 3. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. +.\" +.\" +.Dd October 29, 2013 +.Dt SYSTM 9lua +.Os +.Sh NAME +.Nm systm +.Nd access +to general kernel functionality from Lua +.Sh SYNOPSIS +.Cd "local systm = require 'systm'" +.Pp +.Bl -tag -width XXXX -compact +.It Dv systm.print(msg) +.It Dv systm.print_nolog(msg) +.It Dv systm.uprint(msg) +.It Dv systm.aprint_normal(msg) +.It Dv systm.aprint_naive(msg) +.It Dv systm.aprint_verbose(msg) +.It Dv systm.aprint_debug(msg) +.It Dv systm.aprint_error(msg) +.It Dv count = systm.aprint_get_error_count() +.It Dv systm.panic(msg) +.El +.Sh DESCRIPTION +The +.Nm +Lua binding provides access to general kernel functionality like printing +messages on the console. +The +.Em systm.aprint +functions are meant to be using during kernel autoconfiguration. +.Pp +.Bl -tag -width XXXX -compact +.It Dv systm.print(msg) +Send +.Ar msg +to the console. +.Pp +.It Dv systm.print_nolog(msg) +The +.Fn systm.print_nolog +function is identical to the +.Fn systm.print +function, +except is does not send +.Ar msg +to the system log. +.Pp +.It Dv systm.uprint(msg) +Send +.Ar msg +to the current process's controlling tty. +.Pp +.It Dv systm.aprint_normal(msg) +Send +.Ar msg +to the console unless AB_QUIET is set. +Always sends to the log. +.Pp +.It Dv systm.aprint_naive(msg) +Send +.Ar msg +to the console only if AB_QUIET is set. +Never sends to the log. +.Pp +.It Dv systm.aprint_verbose(msg) +Send +.Ar msg +to the console only if AB_VERBOSE is set. +Always sends to the log. +.Pp +.It Dv systm.aprint_debug(msg) +Send +.Ar msg +to the console and the log only if AB_DEBUG is set. +.Pp +.It Dv systm.aprint_error(msg) +Like +.Fn systm.aprint_normal , +but also keeps track of the number of times called. +This allows a subsystem to report the number of errors that occurred during a +quiet or silent initialization phase. +.Pp +.It Dv count = systm.aprint_get_error_count() +The +.Fn systm.aprint_get_error_count +function reports the number of errors and +resets the counter to 0. +.Pp +.It Dv systm.panic(msg) +The +.Fn systm.panic +function terminates the +.Nx +system. +The message +.Ar msg +is printed to the console and saved in the variable +.Em panicstr +for later retrieval via core dump inspection. +A newline character is added at the end automatically. +.El +.Sh VARIABLES +Upon initialisation, the +.Nm +module sets the following variables with the values of the corresponding kernel +variable: +.Pp +.Bl -tag -width XXXX -compact +.It Dv systm.copyright +.It Dv systm.cpu_model +.It Dv systm.machine +.It Dv systm.machine_arch +.It Dv systm.osrelease +.It Dv systm.ostype +.It Dv systm.kernel_ident +.It Dv systm.version +.It Dv systm.ncpu +.El +.Sh SEE ALSO +.Xr lua 1 , +.Xr luac 1 , +.Xr lua 4 , +.Xr intro 9lua +.Sh HISTORY +An +.Nm +manual appeared in +.Nx 7.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +Lua binding was written by +.An Marc Balmer Aq Mt mbalmer@NetBSD.org . |
