~dustin-spy/twisted/dustin

« back to all changes in this revision

Viewing changes to doc/man/generatelore.1

  • Committer: moshez
  • Date: 2002-10-25 07:41:23 UTC
  • Revision ID: vcs-imports@canonical.com-20021025074123-4fbcb37163e9d169
Twisted.Lore, the Twisted Document generation lanaguage

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH GENERATELORE "1" "July 2001" "" ""
 
2
.SH NAME
 
3
generatelore \- generate spiffy HTML from a plain subset of HTML
 
4
.SH SYNOPSIS
 
5
.B generatelore [-t \fItemplate\fR] [-a \fIapidir\fR] [-d \fIdocsdir\fR]  [-e \fIext\fR] [-u \fIbaseurl\fR] [file [...]]
 
6
.B generatelore --help
 
7
.SH DESCRIPTION
 
8
.PP
 
9
The \fB\--help\fR prints out a usage message to standard output.
 
10
.TP \fB-t\fR, \fB--template\fR <template>
 
11
The template file to follow for generating content (default: template.tpl)
 
12
.TP \fB-a\fR, \fB--apidir\fR <apidir>
 
13
The directory in which a copy of the epydoc-generated api documentation is.
 
14
If available, will allow for non-full references to modules and classes.
 
15
.TP \fB-e\fR, \fB--ext\fR <extension>
 
16
The new extension (defaults to xhtml)
 
17
.TP \fB-u\fR, \fB--baseurl\fR <url>
 
18
URL in which the API documentation is available.
 
19
.SH DESCRIPTION
 
20
The exact HTML syntax to follow is documented in Twisted's doc-standard.html.
 
21
If no files are given, all *.html documents in docsdir will be processed.
 
22
.SH AUTHOR
 
23
Written by Moshe Zadka, based on generatelore's help messages
 
24
.SH "REPORTING BUGS"
 
25
Report bugs to <twisted-python@twistedmatrix.com>.
 
26
.SH COPYRIGHT
 
27
Copyright \(co 2000 Matthew W. Lefkowitz
 
28
.br
 
29
This is free software; see the source for copying conditions.  There is NO
 
30
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
31
.SH "SEE ALSO"
 
32
html2latex(1)