319 lines
9.7 KiB
HTML
319 lines
9.7 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>Penlight Documentation</title>
|
|
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>Penlight</h1>
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Functions">Functions</a></li>
|
|
<li><a href="#Fields">Fields</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Modules</h2>
|
|
<ul>
|
|
<li><a href="../modules/pl.html">pl</a></li>
|
|
<li><a href="../modules/pl.Date.html">pl.Date</a></li>
|
|
<li><a href="../modules/pl.List.html">pl.List</a></li>
|
|
<li><a href="../modules/pl.Map.html">pl.Map</a></li>
|
|
<li><a href="../modules/pl.MultiMap.html">pl.MultiMap</a></li>
|
|
<li><a href="../modules/pl.OrderedMap.html">pl.OrderedMap</a></li>
|
|
<li><a href="../modules/pl.Set.html">pl.Set</a></li>
|
|
<li><a href="../modules/pl.app.html">pl.app</a></li>
|
|
<li><a href="../modules/pl.array2d.html">pl.array2d</a></li>
|
|
<li><a href="../modules/pl.class.html">pl.class</a></li>
|
|
<li><a href="../modules/pl.comprehension.html">pl.comprehension</a></li>
|
|
<li><a href="../modules/pl.config.html">pl.config</a></li>
|
|
<li><a href="../modules/pl.data.html">pl.data</a></li>
|
|
<li><a href="../modules/pl.dir.html">pl.dir</a></li>
|
|
<li><a href="../modules/pl.file.html">pl.file</a></li>
|
|
<li><a href="../modules/pl.func.html">pl.func</a></li>
|
|
<li><a href="../modules/pl.input.html">pl.input</a></li>
|
|
<li><strong>pl.lapp</strong></li>
|
|
<li><a href="../modules/pl.lexer.html">pl.lexer</a></li>
|
|
<li><a href="../modules/pl.luabalanced.html">pl.luabalanced</a></li>
|
|
<li><a href="../modules/pl.operator.html">pl.operator</a></li>
|
|
<li><a href="../modules/pl.path.html">pl.path</a></li>
|
|
<li><a href="../modules/pl.permute.html">pl.permute</a></li>
|
|
<li><a href="../modules/pl.pretty.html">pl.pretty</a></li>
|
|
<li><a href="../modules/pl.seq.html">pl.seq</a></li>
|
|
<li><a href="../modules/pl.sip.html">pl.sip</a></li>
|
|
<li><a href="../modules/pl.strict.html">pl.strict</a></li>
|
|
<li><a href="../modules/pl.stringio.html">pl.stringio</a></li>
|
|
<li><a href="../modules/pl.stringx.html">pl.stringx</a></li>
|
|
<li><a href="../modules/pl.tablex.html">pl.tablex</a></li>
|
|
<li><a href="../modules/pl.template.html">pl.template</a></li>
|
|
<li><a href="../modules/pl.test.html">pl.test</a></li>
|
|
<li><a href="../modules/pl.text.html">pl.text</a></li>
|
|
<li><a href="../modules/pl.utils.html">pl.utils</a></li>
|
|
<li><a href="../modules/pl.xml.html">pl.xml</a></li>
|
|
</ul>
|
|
<h2>Topics</h2>
|
|
<ul>
|
|
<li><a href="../topics/01-introduction.md.html">01-introduction.md</a></li>
|
|
<li><a href="../topics/02-arrays.md.html">02-arrays.md</a></li>
|
|
<li><a href="../topics/03-strings.md.html">03-strings.md</a></li>
|
|
<li><a href="../topics/04-paths.md.html">04-paths.md</a></li>
|
|
<li><a href="../topics/05-dates.md.html">05-dates.md</a></li>
|
|
<li><a href="../topics/06-data.md.html">06-data.md</a></li>
|
|
<li><a href="../topics/07-functional.md.html">07-functional.md</a></li>
|
|
<li><a href="../topics/08-additional.md.html">08-additional.md</a></li>
|
|
<li><a href="../topics/09-discussion.md.html">09-discussion.md</a></li>
|
|
</ul>
|
|
<h2>Examples</h2>
|
|
<ul>
|
|
<li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li>
|
|
<li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li>
|
|
<li><a href="../examples/symbols.lua.html">symbols.lua</a></li>
|
|
<li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li>
|
|
<li><a href="../examples/test-data.lua.html">test-data.lua</a></li>
|
|
<li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li>
|
|
<li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li>
|
|
<li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li>
|
|
<li><a href="../examples/testapp.lua.html">testapp.lua</a></li>
|
|
<li><a href="../examples/testclone.lua.html">testclone.lua</a></li>
|
|
<li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li>
|
|
<li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li>
|
|
<li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li>
|
|
<li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li>
|
|
<li><a href="../examples/testxml.lua.html">testxml.lua</a></li>
|
|
<li><a href="../examples/which.lua.html">which.lua</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>pl.lapp</code></h1>
|
|
|
|
<p>Simple command-line parsing using human-readable specification.</p>
|
|
<p> Supports GNU-style parameters.</p>
|
|
|
|
<pre><code> lapp = require 'pl.lapp'
|
|
local args = lapp [[
|
|
Does some calculations
|
|
-o,--offset (default 0.0) Offset to add to scaled number
|
|
-s,--scale (number) Scaling factor
|
|
&lt;number&gt; (number ) Number to be scaled
|
|
]]
|
|
|
|
print(args.offset + args.scale * args.number)
|
|
</code></pre>
|
|
|
|
<p> Lines begining with ‘–’ are flags; there may be a short and a long name;
|
|
lines begining wih ‘<var>’ are arguments. Anything in parens after
|
|
the flag/argument is either a default, a type name or a range constraint.</p>
|
|
|
|
<p> >See <a href="../topics/08-additional.md.html#Command_line_Programs_with_Lapp">the Guide</a></p>
|
|
|
|
<p> Dependencies: <a href="../modules/pl.sip.html#">pl.sip</a> </p>
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#quit">quit (msg, no_usage)</a></td>
|
|
<td class="summary">quit this script immediately.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#error">error (msg, no_usage)</a></td>
|
|
<td class="summary">print an error to stderr and quit.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#open">open (file, opt)</a></td>
|
|
<td class="summary">open a file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#assert">assert (condn, msg)</a></td>
|
|
<td class="summary">quit if the condition is false.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#add_type">add_type (name, converter, constraint)</a></td>
|
|
<td class="summary">add a new type to Lapp.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#process_options_string">process_options_string (str, args)</a></td>
|
|
<td class="summary">process a Lapp options string.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Fields">Fields</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#show_usage_error">show_usage_error</a></td>
|
|
<td class="summary">controls whether to dump usage on error.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="Functions"></a>Functions</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "quit"></a>
|
|
<strong>quit (msg, no_usage)</strong>
|
|
</dt>
|
|
<dd>
|
|
quit this script immediately.
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><code><em>msg</em></code>: optional message</li>
|
|
<li><code><em>no_usage</em></code>: suppress ‘usage’ display</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "error"></a>
|
|
<strong>error (msg, no_usage)</strong>
|
|
</dt>
|
|
<dd>
|
|
print an error to stderr and quit.
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><code><em>msg</em></code>: a message</li>
|
|
<li><code><em>no_usage</em></code>: suppress ‘usage’ display</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "open"></a>
|
|
<strong>open (file, opt)</strong>
|
|
</dt>
|
|
<dd>
|
|
open a file.
|
|
This will quit on error, and keep a list of file objects for later cleanup.
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><code><em>file</em></code>: filename</li>
|
|
<li><code><em>opt</em></code>: same as second parameter of <code>io.open</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "assert"></a>
|
|
<strong>assert (condn, msg)</strong>
|
|
</dt>
|
|
<dd>
|
|
quit if the condition is false.
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><code><em>condn</em></code>: a condition</li>
|
|
<li><code><em>msg</em></code>: an optional message</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "add_type"></a>
|
|
<strong>add_type (name, converter, constraint)</strong>
|
|
</dt>
|
|
<dd>
|
|
add a new type to Lapp. These appear in parens after the value like
|
|
a range constraint, e.g. ‘<ival> (integer) Process PID’
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><code><em>name</em></code>: name of type</li>
|
|
<li><code><em>converter</em></code>: either a function to convert values, or a Lua type name.</li>
|
|
<li><code><em>constraint</em></code>: optional function to verify values, should use lapp.error
|
|
if failed.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "process_options_string"></a>
|
|
<strong>process_options_string (str, args)</strong>
|
|
</dt>
|
|
<dd>
|
|
process a Lapp options string.
|
|
Usually called as lapp().
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><code><em>str</em></code>: the options text</li>
|
|
<li><code><em>args</em></code>: a table of arguments (default is <code>_G.arg</code>)</li>
|
|
</ul>
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
a table with parameter-value pairs
|
|
</ol>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Fields"></a>Fields</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "show_usage_error"></a>
|
|
<strong>show_usage_error</strong>
|
|
</dt>
|
|
<dd>
|
|
controls whether to dump usage on error.
|
|
Defaults to true
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.2</a></i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|