lore2.21
Convert documentations formats
Usage
lore [-l
linkrel]
[-d
docsdir]
[-i
input]
[-o
output]
[--config
attribute
[=value]
[]]
[-p]
[file
[]]
lore --help
Overview
The --help prints out a usage message to standard output.
-
-p, --plain -
Use non-flashy progress bar - one file per line.
-
-n, --null -
Do not report progress at all.
-
-l, --linkrel -
Where non-document links should be relative to.
-
-d, --docsdir -
Where to look for
.htmlfiles if no files are given.
-
-i, --input -
Input format. New input formats can be dynamically registered. Lore itself comes with "lore" (the standard format), "mlore" (allows LaTeX equations) and "man" (man page format). If the input format is not registered as a plugin, a module of the named input will be searched. For example, --i twisted.lore.default is equivalent to using the default Lore input.
-
-o, --output -
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.
-
--config -
Add input/output-specific information. HTML output allows for 'ext=<extension>', output allows for 'section' or 'chapter' in Lore, and nothing in Math-Lore. Lore output allows for 'ext=<extension>'. Lint output allows nothing. Note that disallowed --config options are merely ignored, and do not cause errors.
Overview
If no files are given, all *.html documents in docsdir are processed.