~ntt-pf-lab/nova/monkey_patch_notification

« back to all changes in this revision

Viewing changes to vendor/Twisted-10.0.0/doc/lore/man/lore-man.html

  • Committer: Jesse Andrews
  • Date: 2010-05-28 06:05:26 UTC
  • Revision ID: git-v1:bf6e6e718cdc7488e2da87b21e258ccc065fe499
initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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">
 
2
  <head>
 
3
<title>Twisted Documentation: GENERATELORE.1</title>
 
4
<link href="../howto/stylesheet.css" rel="stylesheet" type="text/css"/>
 
5
  </head>
 
6
 
 
7
  <body bgcolor="white">
 
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>
 
10
    <div class="content">
 
11
 
 
12
<span/>
 
13
 
 
14
<h2>NAME<a name="auto0"/></h2>
 
15
 
 
16
<p>lore - convert documentations formats
 
17
</p>
 
18
 
 
19
<h2>SYNOPSIS<a name="auto1"/></h2>
 
20
 
 
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>
 
22
 
 
23
<p><strong>lore</strong>  --help</p>
 
24
 
 
25
<h2>DESCRIPTION<a name="auto2"/></h2>
 
26
 
 
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.
 
30
</dd>
 
31
 
 
32
<dt><strong>-n</strong>, <strong>--null</strong>
 
33
</dt><dd>Do not report progress at all.
 
34
</dd>
 
35
 
 
36
<dt><strong>-N</strong>, <strong>--number</strong>
 
37
</dt><dd>Add chapter/section numbers to section headings.
 
38
</dd>
 
39
 
 
40
<dt><em>-l</em>, <em>--linkrel</em>
 
41
</dt><dd>Where non-document links should be relative to.
 
42
</dd>
 
43
 
 
44
<dt><em>-d</em>, <em>--docsdir</em>
 
45
</dt><dd>Where to look for <strong>.html</strong> files if no files are given.
 
46
</dd>
 
47
 
 
48
<dt><em>-e</em>, <em>--inputext</em> &lt;extension&gt;
 
49
</dt><dd>The extension that your Lore input files have (default: .xhtml)
 
50
</dd>
 
51
 
 
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.
 
58
</dd>
 
59
 
 
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
 
63
lore.
 
64
</dd>
 
65
 
 
66
<dt><em>-x</em>, <em>--index</em> &lt;filename&gt;
 
67
</dt><dd>The base filename you want to give your index file.
 
68
</dd>
 
69
 
 
70
<dt><em>-b</em>, <em>--book</em> &lt;filename&gt;
 
71
</dt><dd>The book file to generate a book from.
 
72
</dd>
 
73
 
 
74
<dt><em>--prefixurl</em> &lt;prefix&gt;
 
75
</dt><dd>The prefix to stick on to relative links; only useful when processing 
 
76
directories.
 
77
</dd>
 
78
 
 
79
<dt><em>--version</em>
 
80
</dt><dd>Display version information and exit.
 
81
</dd>
 
82
 
 
83
<dt><em>--config</em>
 
84
</dt><dd>Add input/output-specific information. 
 
85
HTML output allows for 'ext=&lt;extension&gt;',
 
86
'template=&lt;template&gt;' and 'baseurl=&lt;format string for API URLs&gt;'. LaTeX
 
87
output allows for 'section' or 'chapter' in Lore, and nothing in Math-Lore. 
 
88
Lore output allows for 'ext=&lt;extension&gt;'. Lint output allows nothing.
 
89
Note that disallowed <em>--config</em> options are merely ignored, and do
 
90
not cause errors.
 
91
</dd>
 
92
 
 
93
</dl>
 
94
 
 
95
</p>
 
96
 
 
97
<h2>DESCRIPTION<a name="auto3"/></h2>
 
98
 
 
99
<p>If no files are given, all *.html documents in docsdir are processed.
 
100
</p>
 
101
 
 
102
<h2>AUTHOR<a name="auto4"/></h2>
 
103
 
 
104
<p>Written by Moshe Zadka
 
105
</p>
 
106
 
 
107
<h2>REPORTING BUGS<a name="auto5"/></h2>
 
108
 
 
109
<p>To report a bug, visit <em>http://twistedmatrix.com/bugs/</em>
 
110
</p>
 
111
 
 
112
<h2>COPYRIGHT<a name="auto6"/></h2>
 
113
 
 
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.
 
117
</p>
 
118
 
 
119
</div>
 
120
 
 
121
    <p><a href="../howto/index.html">Index</a></p>
 
122
    <span class="version">Version: 10.0.0</span>
 
123
  </body>
 
124
</html>
 
 
b'\\ No newline at end of file'