1
<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">
3
<title>Twisted Documentation: GENERATELORE.1</title>
4
<link href="../howto/stylesheet.css" rel="stylesheet" type="text/css"/>
8
<h1 class="title">GENERATELORE.1</h1>
9
<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">AUTHOR</a></li><li><a href="#auto5">REPORTING BUGS</a></li><li><a href="#auto6">COPYRIGHT</a></li></ol></div>
14
<h2>NAME<a name="auto0"/></h2>
16
<p>lore - convert documentations formats
19
<h2>SYNOPSIS<a name="auto1"/></h2>
21
<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>
23
<p><strong>lore</strong> --help</p>
25
<h2>DESCRIPTION<a name="auto2"/></h2>
27
<p>The <strong>--help</strong> prints out a usage message to standard output.
28
<dl><dt><strong>-p</strong>, <strong>--plain</strong>
29
</dt><dd>Use non-flashy progress bar - one file per line.
32
<dt><strong>-n</strong>, <strong>--null</strong>
33
</dt><dd>Do not report progress at all.
36
<dt><strong>-N</strong>, <strong>--number</strong>
37
</dt><dd>Add chapter/section numbers to section headings.
40
<dt><em>-l</em>, <em>--linkrel</em>
41
</dt><dd>Where non-document links should be relative to.
44
<dt><em>-d</em>, <em>--docsdir</em>
45
</dt><dd>Where to look for <strong>.html</strong> files if no files are given.
48
<dt><em>-e</em>, <em>--inputext</em> <extension>
49
</dt><dd>The extension that your Lore input files have (default: .xhtml)
52
<dt><em>-i</em>, <em>--input</em>
53
</dt><dd>Input format. New input formats can be dynamically registered. Lore itself
54
comes with <q>lore</q> (the standard format), <q>mlore</q> (allows LaTeX equations)
55
and <q>man</q> (man page format). If the input format is not registered as a plugin,
56
a module of the named input will be searched. For example,
57
<strong>--i</strong> twisted.lore.defaultis equivalent to using the default Lore input.
60
<dt><em>-o</em>, <em>--output</em>
61
</dt><dd>Output format. Available output formats depend on the input. For the core
62
formats, lore and mlore support html, latex and lint, while man allows
66
<dt><em>-x</em>, <em>--index</em> <filename>
67
</dt><dd>The base filename you want to give your index file.
70
<dt><em>-b</em>, <em>--book</em> <filename>
71
</dt><dd>The book file to generate a book from.
74
<dt><em>--prefixurl</em> <prefix>
75
</dt><dd>The prefix to stick on to relative links; only useful when processing
79
<dt><em>--version</em>
80
</dt><dd>Display version information and exit.
84
</dt><dd>Add input/output-specific information.
85
HTML output allows for 'ext=<extension>',
86
'template=<template>' and 'baseurl=<format string for API URLs>'. LaTeX
87
output allows for 'section' or 'chapter' in Lore, and nothing in Math-Lore.
88
Lore output allows for 'ext=<extension>'. Lint output allows nothing.
89
Note that disallowed <em>--config</em> options are merely ignored, and do
97
<h2>DESCRIPTION<a name="auto3"/></h2>
99
<p>If no files are given, all *.html documents in docsdir are processed.
102
<h2>AUTHOR<a name="auto4"/></h2>
104
<p>Written by Moshe Zadka
107
<h2>REPORTING BUGS<a name="auto5"/></h2>
109
<p>To report a bug, visit <em>http://twistedmatrix.com/bugs/</em>
112
<h2>COPYRIGHT<a name="auto6"/></h2>
114
<p>Copyright © 2003-2008 Twisted Matrix Laboratories.
115
This is free software; see the source for copying conditions. There is NO
116
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
121
<p><a href="../howto/index.html">Index</a></p>
122
<span class="version">Version: 10.0.0</span>
b'\\ No newline at end of file'