]> granicus.if.org Git - apache/commitdiff
Add basic almost-useful usage information.
authorRich Bowen <rbowen@apache.org>
Thu, 22 Apr 2010 11:05:30 +0000 (11:05 +0000)
committerRich Bowen <rbowen@apache.org>
Thu, 22 Apr 2010 11:05:30 +0000 (11:05 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@936778 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/index.html.en
docs/manual/mod/mod_lua.html.en
docs/manual/mod/mod_lua.xml

index d7cbedabd4cb058f3a44383c884d1b01464089b7..94bf9863f3464403f844a6e3efbfb2aa69f8a8a6 100644 (file)
@@ -145,7 +145,8 @@ by other LDAP modules</dd>
 <dt><a href="mod_log_config.html">mod_log_config</a></dt><dd>Logging of the requests made to the server</dd>
 <dt><a href="mod_log_forensic.html">mod_log_forensic</a></dt><dd>Forensic Logging of the requests made to the server</dd>
 <dt><a href="mod_logio.html">mod_logio</a></dt><dd>Logging of input and output bytes per request</dd>
-<dt><a href="mod_lua.html">mod_lua</a></dt><dd>Provides Lua hooks to do cool stuff</dd>
+<dt><a href="mod_lua.html">mod_lua</a></dt><dd>Provides Lua hooks into various portions of the httpd
+request processing</dd>
 <dt><a href="mod_mime.html" id="M" name="M">mod_mime</a></dt><dd>Associates the requested filename's extensions
     with the file's behavior (handlers and filters)
     and content (mime-type, language, character set and
index 830eaf048f55fc162af229b758fd9088d5d9bec9..e842ab19d817ef6f205843845f83bf78ace753fa 100644 (file)
@@ -23,7 +23,8 @@
 <div class="toplang">
 <p><span>Available Languages: </span><a href="../en/mod/mod_lua.html" title="English">&nbsp;en&nbsp;</a></p>
 </div>
-<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides Lua hooks to do cool stuff</td></tr>
+<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides Lua hooks into various portions of the httpd
+request processing</td></tr>
 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>lua_module</td></tr>
 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_lua.c</td></tr>
 
 <p>Someone needs to write this.</p>
 
-<div class="example"><h3>Example</h3><p><code>
-# Examples are always helpful.<br />
-</code></p></div>
-
 </div>
 <div id="quickview"><h3 class="directives">Directives</h3>
 <ul id="toc">
 </ul>
 <h3>Topics</h3>
 <ul id="topics">
-<li><img alt="" src="../images/down.gif" /> <a href="#moredocs">Additional Documentation</a></li>
-</ul><h3>See also</h3>
-<ul class="seealso">
-<li><a href="...">Useful document</a></li>
-<li><code class="directive"><a href="../mod/mod_useful.html#useful">Useful</a></code></li>
-<li><code class="module"><a href="../mod/mod_useful.html">mod_useful</a></code></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#basicconf">Basic Configuration</a></li>
 </ul></div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="section">
-<h2><a name="moredocs" id="moredocs">Additional Documentation</a></h2>
+<h2><a name="basicconf" id="basicconf">Basic Configuration</a></h2>
 
-<p>More detailed information about the module in general (as opposed to
-the individual directives) can follow in sections containing titles.</p>
+The basic module loading directive is
 
-<p>The <code>id</code> attribute will be translated into a hypertext
-anchor target.</p>
+<div class="example"><p><code>
+    LoadModule apreq_module modules/mod_apreq2.so<br />
+    LoadModule wombat_module modules/mod_wombat.so
+</code></p></div>
 
-<p>References to directives should use the directive tag: <code class="directive"><a href="#templatedirective">TemplateDirective</a></code>.  References to
-modules should use the module tag
-<code class="module"><a href="../mod/mod_lua.xml.html">mod_lua.xml</a></code>.</p>
+<p>
+<code>mod_lua</code> provides a handler named <code>lua-script</code>,
+which can be used with an <code>AddHandler</code> directive:</p>
+
+<div class="example"><p><code>
+AddHandler lua-script .lua
+</code></p></div>
 
+<p>
+This will cause any <code>.lua</code> file to be evaluated by
+<code>mod_lua</code>.
+</p>
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="" id="" /> <a name="" id="">Directive</a></h2>
index 03197851ecf6d1dad2cfba151da69af3ad05416b..56c31c1191beee7a32c8741106945bf980ca305a 100644 (file)
@@ -24,7 +24,8 @@
 
 <name>mod_lua</name>
 
-<description>Provides Lua hooks to do cool stuff</description>
+<description>Provides Lua hooks into various portions of the httpd
+request processing</description>
 <status>experimental</status>
 <sourcefile>mod_lua.c</sourcefile>
 <identifier>lua_module</identifier>
 <summary>
 <p>Someone needs to write this.</p>
 
-<example><title>Example</title>
-# Examples are always helpful.<br />
-</example>
-
 </summary>
 
-<!-- References to other documents or directives -->
-<seealso><a href="...">Useful document</a></seealso>
-<seealso><directive module="mod_useful">Useful</directive></seealso>
-<seealso><module>mod_useful</module></seealso>
+<section id="basicconf"><title>Basic Configuration</title>
 
-<!-- Any number of sections may be included below -->
-<section id="moredocs"><title>Additional Documentation</title>
+The basic module loading directive is
 
-<p>More detailed information about the module in general (as opposed to
-the individual directives) can follow in sections containing titles.</p>
+<example>
+    LoadModule apreq_module modules/mod_apreq2.so<br />
+    LoadModule wombat_module modules/mod_wombat.so
+</example>
 
-<p>The <code>id</code> attribute will be translated into a hypertext
-anchor target.</p>
+<p>
+<code>mod_lua</code> provides a handler named <code>lua-script</code>,
+which can be used with an <code>AddHandler</code> directive:</p>
 
-<p>References to directives should use the directive tag: <directive
-module="mod_lua">TemplateDirective</directive>.  References to
-modules should use the module tag
-<module>mod_lua.xml</module>.</p>
+<example>
+AddHandler lua-script .lua
+</example>
 
+<p>
+This will cause any <code>.lua</code> file to be evaluated by
+<code>mod_lua</code>.
+</p>
 </section>
 
 <directivesynopsis>