1GENERATELORE(1)                                                GENERATELORE(1)
2
3
4

NAME

6       lore - convert documentations formats
7

SYNOPSIS

9       lore  [-l  linkrel]  [-d  docsdir]  [-i  input]  [-o  output] [--config
10       attribute[=value] [...]] [-p] [file [...]]
11
12       lore --help
13

DESCRIPTION

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       -l, --linkrel
24              Where non-document links should be relative to.
25
26       -d, --docsdir
27              Where to look for .html files if no files are given.
28
29       -i, --input
30              Input format. New input formats can be  dynamically  registered.
31              Lore  itself  comes  with  "lore" (the standard format), "mlore"
32              (allows LaTeX equations) and "man" (man  page  format).  If  the
33              input  format  is  not  registered  as a plugin, a module of the
34              named   input   will   be    searched.    For    example,    --i
35              twisted.lore.default  is  equivalent  to  using the default Lore
36              input.
37
38       -o, --output
39              Output format. Available output formats depend on the input. For
40              the  core  formats, lore and mlore support html, latex and lint,
41              while man allows lore.
42
43       --config
44              Add input/output-specific information.  HTML output  allows  for
45              'ext=<extension>',  output  allows for 'section' or 'chapter' in
46              Lore,  and  nothing  in  Math-Lore.   Lore  output  allows   for
47              'ext=<extension>'. Lint output allows nothing.  Note that disal‐
48              lowed --config options are merely  ignored,  and  do  not  cause
49              errors.
50

DESCRIPTION

52       If no files are given, all *.html documents in docsdir are processed.
53

SEE ALSO

55       doc/howto/lore.xhtml,  doc/howto/doc-standard.xhtml,  doc/howto/extend-
56       lore.xhtml
57

AUTHOR

59       Written by Moshe Zadka
60

REPORTING BUGS

62       To report a bug, visit http://twistedmatrix.com/bugs/
63

65       Copyright © 2003 Matthew W. Lefkowitz
66       This is free software; see the source for copying conditions.  There is
67       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
68       PURPOSE.
69
70
71
72                                 October 2002                  GENERATELORE(1)
Impressum