lore-man.html   [plain text]


<?xml version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><title>Twisted Documentation: GENERATELORE.1</title><link href="../howto/stylesheet.css" type="text/css" rel="stylesheet" /></head><body bgcolor="white"><h1 class="title">GENERATELORE.1</h1><div class="toc"><ol><li><a href="#auto0">NAME</a></li><li><a href="#auto1">SYNOPSIS</a></li><li><a href="#auto2">DESCRIPTION</a></li><li><a href="#auto3">DESCRIPTION</a></li><li><a href="#auto4">SEE ALSO</a></li><li><a href="#auto5">AUTHOR</a></li><li><a href="#auto6">REPORTING BUGS</a></li><li><a href="#auto7">COPYRIGHT</a></li></ol></div><div class="content"><span></span><h2>NAME<a name="auto0"></a></h2><p>lore - convert documentations formats
</p><h2>SYNOPSIS<a name="auto1"></a></h2><p><strong>lore</strong>  [-l <em>linkrel</em>] [-d <em>docsdir</em>] [-i <em>input</em>] [-o <em>output</em>] [--config attribute[=value] [...]] [-p] [file [...]]</p><p><strong>lore</strong>  --help</p><h2>DESCRIPTION<a name="auto2"></a></h2><p>The <strong>--help</strong> prints out a usage message to standard output.
</p><dl><dt><strong>-p</strong>, <strong>--plain</strong></dt><dd>Use non-flashy progress bar - one file per line.
</dd><dt><strong>-n</strong>, <strong>--null</strong></dt><dd>Do not report progress at all.
</dd><dt><em>-l</em>, <em>--linkrel</em></dt><dd>Where non-document links should be relative to.
</dd><dt><em>-d</em>, <em>--docsdir</em></dt><dd>Where to look for <strong>.html</strong> files if no files are given.
</dd><dt><em>-i</em>, <em>--input</em></dt><dd>Input format. New input formats can be dynamically registered. Lore itself
comes with <q>lore</q> (the standard format), <q>mlore</q> (allows LaTeX equations)
and <q>man</q> (man page format). If the input format is not registered as a plugin,
a module of the named input will be searched. For example, 
<strong>--i</strong>  twisted.lore.defaultis equivalent to using the default Lore input.
</dd><dt><em>-o</em>, <em>--output</em></dt><dd>Output format. Available output formats depend on the input. For the core
formats, lore and mlore support html, latex and lint, while man allows
lore.
</dd><dt><em>--config</em></dt><dd>Add input/output-specific information. 
HTML output allows for 'ext=&lt;extension&gt;',
'template=&lt;template&gt;' and 'baseurl=&lt;format string for API URLs&gt;'. LaTeX
output allows for 'section' or 'chapter' in Lore, and nothing in Math-Lore. 
Lore output allows for 'ext=&lt;extension&gt;'. Lint output allows nothing.
Note that disallowed <em>--config</em> options are merely ignored, and do
not cause errors.
</dd></dl><h2>DESCRIPTION<a name="auto3"></a></h2><p>If no files are given, all *.html documents in docsdir are processed.
</p><h2>SEE ALSO<a name="auto4"></a></h2><p>doc/howto/lore.xhtml, doc/howto/doc-standard.xhtml, doc/howto/extend-lore.xhtml
</p><h2>AUTHOR<a name="auto5"></a></h2><p>Written by Moshe Zadka
</p><h2>REPORTING BUGS<a name="auto6"></a></h2><p>Report bugs to &lt;twisted-python@twistedmatrix.com&gt;.
</p><h2>COPYRIGHT<a name="auto7"></a></h2><p>Copyright &copy; 2003 Matthew W. Lefkowitz
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
</p></div><p><a href="../howto/index.html">Index</a></p><span class="version">Version: 1.3.0</span></body></html>