Module Name: src
Committed By: mbalmer
Date: Tue Oct 29 09:40:44 UTC 2013
Modified Files:
src/distrib/sets/lists/man: mi
src/share/man/man9lua: Makefile
Added Files:
src/share/man/man9lua: pmf.9lua
Log Message:
add pmf(9lua) man page
To generate a diff of this commit:
cvs rdiff -u -r1.1447 -r1.1448 src/distrib/sets/lists/man/mi
cvs rdiff -u -r1.2 -r1.3 src/share/man/man9lua/Makefile
cvs rdiff -u -r0 -r1.1 src/share/man/man9lua/pmf.9lua
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/distrib/sets/lists/man/mi
diff -u src/distrib/sets/lists/man/mi:1.1447 src/distrib/sets/lists/man/mi:1.1448
--- src/distrib/sets/lists/man/mi:1.1447 Tue Oct 29 08:34:07 2013
+++ src/distrib/sets/lists/man/mi Tue Oct 29 09:40:43 2013
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1447 2013/10/29 08:34:07 mbalmer Exp $
+# $NetBSD: mi,v 1.1448 2013/10/29 09:40:43 mbalmer Exp $
#
# Note: don't delete entries from here - mark them as "obsolete" instead.
#
@@ -3119,6 +3119,7 @@
./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/cat9lua/pmf.0 man-sys-catman .cat
./usr/share/man/html1/Mail.html man-mail-htmlman html
./usr/share/man/html1/[.html man-util-htmlman html
./usr/share/man/html1/agrep.html man-util-htmlman html
@@ -5805,6 +5806,7 @@
./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/html9lua/pmf.html man-sys-htmlman html
./usr/share/man/man1/Mail.1 man-mail-man .man
./usr/share/man/man1/[.1 man-util-man .man
./usr/share/man/man1/agrep.1 man-util-man .man
@@ -8880,4 +8882,5 @@
./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/man9lua/pmf.9lua man-sys-man .man
./usr/share/man/style.css man-mdocml-htmlman html
Index: src/share/man/man9lua/Makefile
diff -u src/share/man/man9lua/Makefile:1.2 src/share/man/man9lua/Makefile:1.3
--- src/share/man/man9lua/Makefile:1.2 Tue Oct 29 08:34:07 2013
+++ src/share/man/man9lua/Makefile Tue Oct 29 09:40:44 2013
@@ -1,6 +1,6 @@
-# $NetBSD: Makefile,v 1.2 2013/10/29 08:34:07 mbalmer Exp $
+# $NetBSD: Makefile,v 1.3 2013/10/29 09:40:44 mbalmer Exp $
-MAN= core.9lua intro.9lua
+MAN= core.9lua intro.9lua pmf.9lua
.include <bsd.man.mk>
.include <bsd.subdir.mk>
Added files:
Index: src/share/man/man9lua/pmf.9lua
diff -u /dev/null src/share/man/man9lua/pmf.9lua:1.1
--- /dev/null Tue Oct 29 09:40:44 2013
+++ src/share/man/man9lua/pmf.9lua Tue Oct 29 09:40:44 2013
@@ -0,0 +1,99 @@
+.\" $NetBSD: pmf.9lua,v 1.1 2013/10/29 09:40:44 mbalmer Exp $
+.\"
+.\" Copyright (c) 2013 Marc Balmer <mbal...@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 intro 9lua ,
+.Xr lua 4 ,
+.Xr pmf 9
+.Sh HISTORY
+An
+.Nm
+Lua manual appeared in
+.Nx 7.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+Lua binding was written by
+.An Marc Balmer Aq Mt mbal...@netbsd.org .
