Module Name: src
Committed By: wiz
Date: Thu Oct 17 08:21:03 UTC 2013
Modified Files:
src/sbin/luactl: luactl.8
Log Message:
More markup, typo fixes, update date and NetBSD version for import.
To generate a diff of this commit:
cvs rdiff -u -r1.1 -r1.2 src/sbin/luactl/luactl.8
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/sbin/luactl/luactl.8
diff -u src/sbin/luactl/luactl.8:1.1 src/sbin/luactl/luactl.8:1.2
--- src/sbin/luactl/luactl.8:1.1 Wed Oct 16 19:48:21 2013
+++ src/sbin/luactl/luactl.8 Thu Oct 17 08:21:03 2013
@@ -1,4 +1,4 @@
-.\" $NetBSD: luactl.8,v 1.1 2013/10/16 19:48:21 mbalmer Exp $
+.\" $NetBSD: luactl.8,v 1.2 2013/10/17 08:21:03 wiz Exp $
.\"
.\" Copyright (c) 2011 Marc Balmer <m...@msys.ch>
.\"
@@ -14,52 +14,52 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd August 26, 2011
+.Dd October 17, 2013
.Dt LUACTL 8
.Os
.Sh NAME
.Nm luactl
.Nd control kernel Lua states
.Sh SYNOPSIS
-.Nm luactl
+.Nm
.Op Fl cq
-.Nm luactl
+.Nm
.Op Fl cq
-create
+.Cm create
.Ar name
.Op desc
-.Nm luactl
+.Nm
.Op Fl cq
-destroy
+.Cm destroy
.Ar name
-.Nm luactl
+.Nm
.Op Fl cq
-require
+.Cm require
.Ar name module
-.Nm luactl
+.Nm
.Op Fl cq
-load
+.Cm load
.Ar name path
.Sh DESCRIPTION
The
.Nm
program allows the manipulation of Lua states in the kernel.
Lua states are created using the
-.Sq create
+.Dq Cm create
command (see below),
Lua bindings are provided as modules.
To make a Lua binding available to a state, it must be
-.Sq required .
+.Dq required .
If a kernel subsystem is to use a Lua state, a state has to be
-.Sq assigned
+.Dq assigned
to it.
Once a module has been
-.Sq required
+.Dq required
by a state, it can not be unloaded from memory using the
.Xr modunload 8
command until the state using it has been destroyed.
.Pp
-Lua code can be loaded from the filesystem into a state at anytime, please
+Lua code can be loaded from the file system into a state at anytime, please
note that code loaded into a state is immediately executed.
.Pp
When executed without a command,
@@ -72,22 +72,22 @@ The options are as follows:
.Bl -tag -width Ds
.It Fl c
Create a Lua state before executing the command.
-This flag is used for the require, assing, and, load commands only, it
+This flag is used for the require, assign, and, load commands only, it
is ignored for all other commands.
.It Fl q
Operate quietly i.e. nothing is printed to stdout.
.El
.Sh COMMANDS
.Bl -tag -width Ds
-.It create Ar name Op Ar desc
+.It Cm create Ar name Op Ar desc
Create a Lua state with name
.Ar name
and optional description
.Ar desc .
-.It destroy Ar name
+.It Cm destroy Ar name
Destroy the Lua state
.Ar name .
-.It require Ar name module
+.It Cm require Ar name module
Let the Lua state
.Ar name
use the bindings provided in module
@@ -95,7 +95,7 @@ use the bindings provided in module
This is the equivalent of userland Lua code calling the
.Sq require
function.
-.It load Ar name Pa path
+.It Cm load Ar name Pa path
Load Lua code in file
.Pa path
into the Lua state
@@ -110,17 +110,17 @@ Lua device file.
.El
.Sh SEE ALSO
.Xr lua 4 ,
-.Xr lua 9 ,
-.Xr modload 8 ,
.Xr module 7 ,
-.Xr modunload 8
+.Xr modload 8 ,
+.Xr modunload 8 ,
+.Xr lua 9
.Sh HISTORY
The
.Nm
command first appeared in
-.Nx 6.0 .
+.Nx 7.0 .
.Sh AUTHORS
The
.Nm
program was written by
-.An Marc Balmer Aq m...@msys.ch .
+.An Marc Balmer Aq Mt m...@msys.ch .
