doc/lore/man/lore.1

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