Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src add a core(9lua) man page
details: https://anonhg.NetBSD.org/src/rev/6e3da9bd1040
branches: trunk
changeset: 790977:6e3da9bd1040
user: mbalmer <mbalmer%NetBSD.org@localhost>
date: Tue Oct 29 08:34:07 2013 +0000
description:
add a core(9lua) man page
diffstat:
distrib/sets/lists/man/mi | 5 +-
share/man/man9lua/Makefile | 4 +-
share/man/man9lua/core.9lua | 151 ++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 157 insertions(+), 3 deletions(-)
diffs (199 lines):
diff -r 7c14240d5d97 -r 6e3da9bd1040 distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Tue Oct 29 00:45:00 2013 +0000
+++ b/distrib/sets/lists/man/mi Tue Oct 29 08:34:07 2013 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1446 2013/10/28 19:05:21 mbalmer Exp $
+# $NetBSD: mi,v 1.1447 2013/10/29 08:34:07 mbalmer Exp $
#
# Note: don't delete entries from here - mark them as "obsolete" instead.
#
@@ -3117,6 +3117,7 @@
./usr/share/man/cat8/zpool.0 man-zfs-catman zfs,.cat
./usr/share/man/cat8/zzz.0 man-sysutil-catman .cat
./usr/share/man/cat9/boot.0 man-obsolete obsolete
+./usr/share/man/cat9lua/core.0 man-sys-catman .cat
./usr/share/man/cat9lua/intro.0 man-sys-catman .cat
./usr/share/man/html1/Mail.html man-mail-htmlman html
./usr/share/man/html1/[.html man-util-htmlman html
@@ -5802,6 +5803,7 @@
./usr/share/man/html8/zic.html man-sysutil-htmlman html
./usr/share/man/html8/zpool.html man-zfs-htmlman zfs,html
./usr/share/man/html8/zzz.html man-sysutil-htmlman html
+./usr/share/man/html9lua/core.html man-sys-htmlman html
./usr/share/man/html9lua/intro.html man-sys-htmlman html
./usr/share/man/man1/Mail.1 man-mail-man .man
./usr/share/man/man1/[.1 man-util-man .man
@@ -8876,5 +8878,6 @@
./usr/share/man/man8/zpool.8 man-zfs-man zfs,.man
./usr/share/man/man8/zzz.8 man-sysutil-man .man
./usr/share/man/man9/boot.9 man-obsolete obsolete
+./usr/share/man/man9lua/core.9lua man-sys-man .man
./usr/share/man/man9lua/intro.9lua man-sys-man .man
./usr/share/man/style.css man-mdocml-htmlman html
diff -r 7c14240d5d97 -r 6e3da9bd1040 share/man/man9lua/Makefile
--- a/share/man/man9lua/Makefile Tue Oct 29 00:45:00 2013 +0000
+++ b/share/man/man9lua/Makefile Tue Oct 29 08:34:07 2013 +0000
@@ -1,6 +1,6 @@
-# $NetBSD: Makefile,v 1.1 2013/10/26 07:42:18 mbalmer Exp $
+# $NetBSD: Makefile,v 1.2 2013/10/29 08:34:07 mbalmer Exp $
-MAN= intro.9lua
+MAN= core.9lua intro.9lua
.include <bsd.man.mk>
.include <bsd.subdir.mk>
diff -r 7c14240d5d97 -r 6e3da9bd1040 share/man/man9lua/core.9lua
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man9lua/core.9lua Tue Oct 29 08:34:07 2013 +0000
@@ -0,0 +1,151 @@
+.\" $NetBSD: core.9lua,v 1.1 2013/10/29 08:34:07 mbalmer Exp $
+.\"
+.\" Copyright (c) 2013 Marc Balmer <mbalmer%NetBSD.org@localhost>. 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 CORE 9lua
+.Os
+.Sh NAME
+.Nm core
+.Nd access
+to general kernel functionality from Lua
+.Sh SYNOPSIS
+.Cd "local core = require 'core'"
+.Pp
+.Bl -tag -width XXXX -compact
+.It Dv core.print(msg)
+.It Dv core.print_nolog(msg)
+.It Dv core.uprint(msg)
+.It Dv core.aprint_normal(msg)
+.It Dv core.aprint_naive(msg)
+.It Dv core.aprint_verbose(msg)
+.It Dv core.aprint_debug(msg)
+.It Dv core.aprint_error(msg)
+.It Dv count = core.aprint_get_error_count()
+.It Dv core.panic(msg)
+.El
+.Sh DESCRIPTION
+The
+.Nm
+Lua binding provides access to general kernel functionality like printing
+messages on the console.
+The
+.Em core.aprint
+functions are meant to be using during kernel autoconfiguration.
+.Pp
+.Bl -tag -width XXXX -compact
+.It Dv core.print(msg)
+Send
+.Ar msg
+to the console.
+.Pp
+.It Dv core.print_nolog(msg)
+The core.print_nolog() function is identical to the core.print() function,
+except is does not send
+.Ar msg
+to lthe system og.
+.Pp
+.It Dv core.uprint(msg)
+Send
+.Ar msg
+to the current process's controlling tty.
+.Pp
+.It Dv core.aprint_normal(msg)
+Send
+.Ar msg
+to the console unless AB_QUIET is set.
+Always sends to the log.
+.Pp
+.It Dv core.aprint_naive(msg)
+Send
+.Ar msg
+to the console only if AB_QUIET is set.
+Never sends to the log.
+.Pp
+.It Dv core.aprint_verbose(msg)
+Send
+.Ar msg
+to the console only if AB_VERBOSE is set.
+Always sends to the log.
+.Pp
+.It Dv core.aprint_debug(msg)
+Send
+.Ar msg
+to the console and the log only if AB_DEBUG is set.
+.Pp
+.It Dv core.aprint_error(msg)
+Like core.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 = core.aprint_get_error_count()
+The core.aprint_get_error_count() function reports the number of errors and
+resets the counter to 0.
+.Pp
+.It Dv core.panic(msg)
+The core.panic() function terminates the NetBSD 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 correspondig kernel
+variable:
+.Pp
+.Bl -tag -width XXXX -compact
+.It Dv core.copyright
+.It Dv core.cpu_model
+.It Dv core.machine
+.It Dv core.machine_arch
+.It Dv core.osrelease
+.It Dv core.ostype
+.It Dv core.kernel_ident
+.It Dv core.version
+.It Dv core.ncpu
+.El
+.Sh SEE ALSO
+.Xr lua 1 ,
+.Xr luac 1 ,
+.Xr intro 9lua ,
+.Xr lua 4
+.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@localhost .
Home |
Main Index |
Thread Index |
Old Index