[Reconnoiter-devel] [reconnoiter commit] r411 - docs/config/modules trunk/src/modules

svn-commit at lists.omniti.com svn-commit at lists.omniti.com
Tue Sep 2 23:06:28 EDT 2008


Author: jesus
Date: 2008-09-02 23:06:28 -0400 (Tue, 02 Sep 2008)
New Revision: 411

Added:
   docs/config/modules/lua.xml
   trunk/src/modules/lua.xml
Log:
document the lua loader

Added: docs/config/modules/lua.xml
===================================================================
--- docs/config/modules/lua.xml	                        (rev 0)
+++ docs/config/modules/lua.xml	2008-09-03 03:06:28 UTC (rev 411)
@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<section>
+  <title>lua</title>
+  <para>The lua module is a loader that allows the authoring of checks in Lua.</para>
+  <variablelist>
+    <varlistentry>
+      <term>loader</term>
+      <listitem>
+        <para>C</para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term>image</term>
+      <listitem>
+        <para>lua.so</para>
+      </listitem>
+    </varlistentry>
+  </variablelist>
+  <section>
+    <title>Module Configuration</title>
+    <variablelist>
+      <varlistentry>
+        <term>directory</term>
+        <listitem>
+          <variablelist>
+            <varlistentry>
+              <term>required</term>
+              <listitem>
+                <para>optional</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>default</term>
+              <listitem>
+                <para>/install/prefix/modules-lua/?.lua</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>allowed</term>
+              <listitem>
+                <para>.+</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+          <para>This is the lua load path.  See the lua manual for more details on meaning and syntax.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </section>
+  <section>
+    <title>Check Configuration</title>
+  </section>
+  <example>
+    <title>Loading the lua loader.</title>
+    <para>This example loads the lua VM and registers it as a module loader.</para>
+    <programlisting>
+      &lt;noit&gt;
+        &lt;modules&gt;
+          &lt;module image="lua" name="lua"&gt;
+            &lt;config&gt;
+              &lt;directory&gt;/some/other/path/?.lua&lt;/directory&gt;
+            &lt;/config&gt;
+          &lt;/module&gt;
+        &lt;/modules&gt;
+      &lt;/noit&gt;
+    </programlisting>
+  </example>
+</section>

Added: trunk/src/modules/lua.xml
===================================================================
--- trunk/src/modules/lua.xml	                        (rev 0)
+++ trunk/src/modules/lua.xml	2008-09-03 03:06:28 UTC (rev 411)
@@ -0,0 +1,30 @@
+<module>
+  <name>lua</name>
+  <description><para>The lua module is a loader that allows the authoring of checks in Lua.</para></description>
+  <loader>C</loader>
+  <image>lua.so</image>
+  <moduleconfig>
+    <parameter name="directory"
+               required="optional"
+               default="/install/prefix/modules-lua/?.lua"
+               allowed=".+">This is the lua load path.  See the lua manual for more details on meaning and syntax.</parameter>
+  </moduleconfig>
+  <checkconfig />
+  <examples>
+    <example>
+      <title>Loading the lua loader.</title>
+      <para>This example loads the lua VM and registers it as a module loader.</para>
+      <programlisting><![CDATA[
+      <noit>
+        <modules>
+          <module image="lua" name="lua">
+            <config>
+              <directory>/some/other/path/?.lua</directory>
+            </config>
+          </module>
+        </modules>
+      </noit>
+    ]]></programlisting>
+    </example>
+  </examples>
+</module>



More information about the Reconnoiter-devel mailing list