1GENERATELORE(1) GENERATELORE(1)
2
3
4
6 lore - convert documentations formats
7
9 lore [-l linkrel] [-d docsdir] [-i input] [-o output] [--config
10 attribute[=value] [...]] [-p] [file [...]]
11
12 lore --help
13
15 The --help prints out a usage message to standard output.
16
17 -p, --plain
18 Use non-flashy progress bar - one file per line.
19
20 -n, --null
21 Do not report progress at all.
22
23 -N, --number
24 Add chapter/section numbers to section headings.
25
26 -l, --linkrel
27 Where non-document links should be relative to.
28
29 -d, --docsdir
30 Where to look for .html files if no files are given.
31
32 -e, --inputext <extension>
33 The extension that your Lore input files have (default: .xhtml)
34
35 -i, --input
36 Input format. New input formats can be dynamically registered.
37 Lore itself comes with "lore" (the standard format), "mlore"
38 (allows LaTeX equations) and "man" (man page format). If the
39 input format is not registered as a plugin, a module of the
40 named input will be searched. For example, --i
41 twisted.lore.default is equivalent to using the default Lore
42 input.
43
44 -o, --output
45 Output format. Available output formats depend on the input. For
46 the core formats, lore and mlore support html, latex and lint,
47 while man allows lore.
48
49 -x, --index <filename>
50 The base filename you want to give your index file.
51
52 -b, --book <filename>
53 The book file to generate a book from.
54
55 --prefixurl <prefix>
56 The prefix to stick on to relative links; only useful when pro‐
57 cessing directories.
58
59 --version
60 Display version information and exit.
61
62 --config
63 Add input/output-specific information. HTML output allows for
64 'ext=<extension>', output allows for 'section' or 'chapter' in
65 Lore, and nothing in Math-Lore. Lore output allows for
66 'ext=<extension>'. Lint output allows nothing. Note that disal‐
67 lowed --config options are merely ignored, and do not cause
68 errors.
69
71 If no files are given, all *.html documents in docsdir are processed.
72
74 Written by Moshe Zadka
75
77 To report a bug, visit http://twistedmatrix.com/bugs/
78
80 Copyright © 2003-2008 Twisted Matrix Laboratories.
81 This is free software; see the source for copying conditions. There is
82 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
83 PURPOSE.
84
85
86
87 October 2002 GENERATELORE(1)