summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_lua.html.en
diff options
context:
space:
mode:
authorRainer Jung <rjung@apache.org>2012-12-12 15:15:38 +0100
committerRainer Jung <rjung@apache.org>2012-12-12 15:15:38 +0100
commitea38445e20df16a4b4e6cb7167e58a876d29133b (patch)
treed39fa6388408e05fa9e56f46e99e1ce0b5c4b244 /docs/manual/mod/mod_lua.html.en
parentDocs update concerning recent htpasswd and htdbm (diff)
downloadapache2-ea38445e20df16a4b4e6cb7167e58a876d29133b.tar.xz
apache2-ea38445e20df16a4b4e6cb7167e58a876d29133b.zip
Docs xforms.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1420690 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_lua.html.en')
-rw-r--r--docs/manual/mod/mod_lua.html.en184
1 files changed, 183 insertions, 1 deletions
diff --git a/docs/manual/mod/mod_lua.html.en b/docs/manual/mod/mod_lua.html.en
index c7bea58dd1..ef8e7024b9 100644
--- a/docs/manual/mod/mod_lua.html.en
+++ b/docs/manual/mod/mod_lua.html.en
@@ -673,7 +673,7 @@ end
<pre class="prettyprint lang-lua">
-r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua table.
+ r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua table.
-- An optional number may be passed to specify the maximum number
-- of bytes to parse. Default is 8192 bytes.
</pre>
@@ -693,6 +693,188 @@ r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua ta
r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Escapes HTML code and returns the escaped result
</pre>
+
+ <pre class="prettyprint lang-lua">
+ r:base64_encode(string) -- Encodes a string using the Base64 encoding standard
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:base64_decode(string) -- Decodes a Base64-encoded string
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe)
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe)
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:escape(string) -- URL-Escapes a string
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:unescape(string) -- Unescapes an URL-escaped string
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:banner() -- Returns the current server banner
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:port() -- Returns the current server port used for the request
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:mpm_query(number) -- Queries the server for MPM information using ap_mpm_query
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:expr(string) -- Evaluates an <a href="../expr.html">expr</a> string.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:scoreboard_process(a) -- Queries the server for information about the process at position <code>a</code>
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:scoreboard_worker(a, b) -- Queries for information about the worker thread, <code>b</code>, in process <code>a</code>
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:started() -- Returns the time of the last server (re)start
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:clock() -- Returns the current time with microsecond precision
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+r:requestbody(filename) -- Reads and returns the request body of a request.
+ -- If 'filename' is specified, it instead saves the
+ -- contents to that file.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:module_info(module_name) -- Queries the server for information about a module
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:loaded_modules() -- Returns a list of modules loaded by httpd
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+r:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file")
+ -- relative to the appropriate run-time directory.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:server_info() -- Returns a table containing server information, such as
+ -- the name of the httpd executable file, mpm used etc.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:set_document_root(file_path) -- Sets the document root for the request to file_path
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:add_version_component(component_string) -- Adds a component to the server banner.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependant way
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:escape_logitem(string) -- Escapes a string for logging
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+r:strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (GLOBs).
+ -- fx. whether 'www.example.com' matches '*.example.com'
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:make_etag() -- Constructs and returns the etag for the current request.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+r:send_interim_response(clear) -- Sends an interim (1xx) response to the client.
+ -- if 'clear' is true, available headers will be sent and cleared.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+r:custom_response(status_code, string) -- Construct and set a custom response for a given status code.
+ -- This works much like the ErrorDocument directive.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:exists_config_define(string) -- Checks whether a configuration definition exists or not.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:state_query(string) -- Queries the server for state information
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:stat(filename) -- Runs stat() on a file, and returns a table with file information
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:regex(string, pattern) -- Runs a regular expression match on a string, returning captures if matched.
+ </pre>
+
+
+ <pre class="prettyprint lang-lua">
+ r:sleep(number_of_seconds) -- Puts the script to sleep for a given number of seconds.
+ </pre>
+
</dd>
</dl>