.\" Man page generated from reStructuredText.
.
.TH RST-BUILDHTML 1 "" "" "text processing"
.SH NAME
rst-buildhtml \- convert many reST documents to HTML
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
rst\-buildhtml [options] [<directory> ...]
.SH DESCRIPTION
.sp
Generates .html from all the reStructuredText .txt files (including PEPs) in
each <directory> (default is the current directory).
.SH OPTIONS
.SS General Docutils Options
.INDENT 0.0
.TP
.BI \-\-title\fB= TITLE
Specify the document title as metadata.
.TP
.B \-\-generator\fP,\fB  \-g
Include a "Generated by Docutils" credit and link.
.TP
.B \-\-no\-generator
Do not include a generator credit.
.TP
.B \-\-date\fP,\fB  \-d
Include the date at the end of the document (UTC).
.TP
.B \-\-time\fP,\fB  \-t
Include the time & date (UTC).
.TP
.B \-\-no\-datestamp
Do not include a datestamp of any kind.
.TP
.B \-\-source\-link\fP,\fB  \-s
Include a "View document source" link.
.TP
.BI \-\-source\-url\fB= <URL>
Use <URL> for a source link; implies \-\-source\-link.
.TP
.B \-\-no\-source\-link
Do not include a "View document source" link.
.TP
.B \-\-toc\-entry\-backlinks
Link from section headers to TOC entries.  (default)
.TP
.B \-\-toc\-top\-backlinks
Link from section headers to the top of the TOC.
.TP
.B \-\-no\-toc\-backlinks
Disable backlinks to the table of contents.
.TP
.B \-\-footnote\-backlinks
Link from footnotes/citations to references. (default)
.TP
.B \-\-no\-footnote\-backlinks
Disable backlinks from footnotes and citations.
.TP
.B \-\-section\-numbering
Enable section numbering by Docutils.  (default)
.TP
.B \-\-no\-section\-numbering
Disable section numbering by Docutils.
.TP
.B \-\-strip\-comments
Remove comment elements from the document tree.
.TP
.B \-\-leave\-comments
Leave comment elements in the document tree. (default)
.TP
.BI \-\-strip\-elements\-with\-class\fB= <class>
Remove all elements with classes="<class>" from the
document tree. Warning: potentially dangerous; use
with caution. (Multiple\-use option.)
.TP
.BI \-\-strip\-class\fB= <class>
Remove all classes="<class>" attributes from elements
in the document tree. Warning: potentially dangerous;
use with caution. (Multiple\-use option.)
.TP
.BI \-\-report\fB= <level>\fP,\fB \ \-r \ <level>
Report system messages at or higher than <level>:
"info" or "1", "warning"/"2" (default), "error"/"3",
"severe"/"4", "none"/"5"
.TP
.B \-\-verbose\fP,\fB  \-v
Report all system messages.  (Same as "\-\-report=1".)
.TP
.B \-\-quiet\fP,\fB  \-q
Report no system messages.  (Same as "\-\-report=5".)
.TP
.BI \-\-halt\fB= <level>
Halt execution at system messages at or above <level>.
Levels as in \-\-report.  Default: 4 (severe).
.TP
.B \-\-strict
Halt at the slightest problem.  Same as "\-\-halt=info".
.TP
.BI \-\-exit\-status\fB= <level>
Enable a non\-zero exit status for non\-halting system
messages at or above <level>.  Default: 5 (disabled).
.TP
.B \-\-debug
Enable debug\-level system messages and diagnostics.
.TP
.B \-\-no\-debug
Disable debug output.  (default)
.TP
.BI \-\-warnings\fB= <file>
Send the output of system messages to <file>.
.TP
.B \-\-traceback
Enable Python tracebacks when Docutils is halted.
.TP
.B \-\-no\-traceback
Disable Python tracebacks.  (default)
.TP
.BI \-\-input\-encoding\fB= <name[:handler]>\fP,\fB \ \-i \ <name[:handler]>
Specify the encoding and optionally the error handler
of input text.  Default: <locale\-dependent>:strict.
.TP
.BI \-\-input\-encoding\-error\-handler\fB= INPUT_ENCODING_ERROR_HANDLER
Specify the error handler for undecodable characters.
Choices: "strict" (default), "ignore", and "replace".
.TP
.BI \-\-output\-encoding\fB= <name[:handler]>\fP,\fB \ \-o \ <name[:handler]>
Specify the text encoding and optionally the error
handler for output.  Default: UTF\-8:strict.
.TP
.BI \-\-output\-encoding\-error\-handler\fB= OUTPUT_ENCODING_ERROR_HANDLER
Specify error handler for unencodable output
characters; "strict" (default), "ignore", "replace",
"xmlcharrefreplace", "backslashreplace".
.TP
.BI \-\-error\-encoding\fB= <name[:handler]>\fP,\fB \ \-e \ <name[:handler]>
Specify text encoding and error handler for error
output.  Default text encoding: system encoding.
Default error handler: backslashreplace.
.TP
.BI \-\-error\-encoding\-error\-handler\fB= ERROR_ENCODING_ERROR_HANDLER
Specify the error handler for unencodable characters
in error output.  Default: backslashreplace.
.TP
.BI \-\-language\fB= <name>\fP,\fB \ \-l \ <name>
Specify the language (as BCP 47 language tag).
Default: en.
.TP
.BI \-\-record\-dependencies\fB= <file>
Write output file dependencies to <file>.
.TP
.BI \-\-config\fB= <file>
Read configuration settings from <file>, if it exists.
.TP
.B \-\-version\fP,\fB  \-V
Show this program\(aqs version number and exit.
.TP
.B \-\-help\fP,\fB  \-h
Show this help message and exit.
.UNINDENT
.SS PEP Reader Option Defaults
.sp
The \-\-pep\-references and \-\-rfc\-references options (for the reStructuredText
parser) are on by default.
.SS reStructuredText Parser Options
.INDENT 0.0
.TP
.B \-\-pep\-references
Recognize and link to standalone PEP references (like
"PEP 258").
.TP
.BI \-\-pep\-base\-url\fB= <URL>
Base URL for PEP references (default
"\fI\%http://www.python.org/dev/peps/\fP").
.TP
.BI \-\-pep\-file\-url\-template\fB= <URL>
Template for PEP file part of URL. (default
"pep\-%04d")
.TP
.B \-\-rfc\-references
Recognize and link to standalone RFC references (like
"RFC 822").
.TP
.BI \-\-rfc\-base\-url\fB= <URL>
Base URL for RFC references (default
"\fI\%http://tools.ietf.org/html/\fP").
.TP
.BI \-\-tab\-width\fB= <width>
Set number of spaces for tab expansion (default 8).
.TP
.B \-\-trim\-footnote\-reference\-space
Remove spaces before footnote references.
.TP
.B \-\-leave\-footnote\-reference\-space
Leave spaces before footnote references.
.TP
.B \-\-no\-file\-insertion
Disable directives that insert the contents of
external file ("include" & "raw"); replaced with a
"warning" system message.
.TP
.B \-\-file\-insertion\-enabled
Enable directives that insert the contents of external
file ("include" & "raw").  Enabled by default.
.TP
.B \-\-no\-raw
Disable the "raw" directives; replaced with a
"warning" system message.
.TP
.B \-\-raw\-enabled
Enable the "raw" directive.  Enabled by default.
.TP
.BI \-\-syntax\-highlight\fB= <format>
Token name set for parsing code with Pygments: one of
"long", "short", or "none (no parsing)". Default is
"long".
.TP
.BI \-\-smart\-quotes\fB= SMART_QUOTES
Change straight quotation marks to typographic form:
one of "yes", "no", "alt[ernative]" (default "no").
.TP
.B \-\-word\-level\-inline\-markup
Inline markup recognized at word boundaries only
(adjacent to punctuation or whitespace). Force
character\-level inline markup recognition with ""
(backslash + space). Default.
.TP
.B \-\-character\-level\-inline\-markup
Inline markup recognized anywhere, regardless of
surrounding characters. Backslash\-escapes must be used
to avoid unwanted markup recognition. Useful for East
Asian languages. Experimental.
.UNINDENT
.SS HTML\-Specific Options
.INDENT 0.0
.TP
.BI \-\-template\fB= <file>
Specify the template file (UTF\-8 encoded).  Default is
"/build/python\-docutils\-2cjRjh/python\-docutils\-0.13.1+
dfsg/docutils/writers/html4css1/template.txt".
.TP
.BI \-\-stylesheet\fB= <URL[,URL,...]>
Comma separated list of stylesheet URLs. Overrides
previous \-\-stylesheet and \-\-stylesheet\-path settings.
.TP
.BI \-\-stylesheet\-path\fB= <file[,file,...]>
Comma separated list of stylesheet paths. Relative
paths are expanded if a matching file is found in the
\-\-stylesheet\-dirs. With \-\-link\-stylesheet, the path is
rewritten relative to the output HTML file. Default:
"html4css1.css"
.TP
.B \-\-embed\-stylesheet
Embed the stylesheet(s) in the output HTML file.  The
stylesheet files must be accessible during processing.
This is the default.
.TP
.B \-\-link\-stylesheet
Link to the stylesheet(s) in the output HTML file.
Default: embed stylesheets.
.TP
.BI \-\-stylesheet\-dirs\fB= <dir[,dir,...]>
Comma\-separated list of directories where stylesheets
are found. Used by \-\-stylesheet\-path when expanding
relative path arguments. Default: "[\(aq.\(aq, \(aq/build
/python\-docutils\-2cjRjh/python\-
docutils\-0.13.1+dfsg/docutils/writers/html4css1\(aq,
\(aq/build/python\-docutils\-2cjRjh/python\-docutils\-0.13.1+
dfsg/docutils/writers/html5_polyglot\(aq]"
.TP
.BI \-\-initial\-header\-level\fB= <level>
Specify the initial header level.  Default is 1 for
"<h1>".  Does not affect document title & subtitle
(see \-\-no\-doc\-title).
.TP
.BI \-\-field\-name\-limit\fB= <level>
Specify the maximum width (in characters) for one\-
column field names.  Longer field names will span an
entire row of the table used to render the field list.
Default is 14 characters.  Use 0 for "no limit".
.TP
.BI \-\-option\-limit\fB= <level>
Specify the maximum width (in characters) for options
in option lists.  Longer options will span an entire
row of the table used to render the option list.
Default is 14 characters.  Use 0 for "no limit".
.TP
.BI \-\-footnote\-references\fB= <format>
Format for footnote references: one of "superscript"
or "brackets".  Default is "brackets".
.TP
.BI \-\-attribution\fB= <format>
Format for block quote attributions: one of "dash"
(em\-dash prefix), "parentheses"/"parens", or "none".
Default is "dash".
.TP
.B \-\-compact\-lists
Remove extra vertical whitespace between items of
"simple" bullet lists and enumerated lists.  Default:
enabled.
.TP
.B \-\-no\-compact\-lists
Disable compact simple bullet and enumerated lists.
.TP
.B \-\-compact\-field\-lists
Remove extra vertical whitespace between items of
simple field lists.  Default: enabled.
.TP
.B \-\-no\-compact\-field\-lists
Disable compact simple field lists.
.TP
.BI \-\-table\-style\fB= TABLE_STYLE
Added to standard table classes. Defined styles:
"borderless". Default: ""
.TP
.BI \-\-math\-output\fB= MATH_OUTPUT
Math output format, one of "MathML", "HTML", "MathJax"
or "LaTeX". Default: "HTML math.css"
.TP
.B \-\-no\-xml\-declaration
Omit the XML declaration.  Use with caution.
.TP
.B \-\-cloak\-email\-addresses
Obfuscate email addresses to confuse harvesters while
still keeping email links usable with standards\-
compliant browsers.
.UNINDENT
.SS PEP/HTML\-Specific Options
.sp
For the PEP/HTML writer, the default value for the \-\-stylesheet\-path option is
"/usr/share/docutils/writers/pep_html/pep.css", and the default value for \-\-template is
"/usr/share/docutils/writers/pep_html/template.txt". See HTML\-Specific Options above.
.INDENT 0.0
.TP
.BI \-\-python\-home\fB= <URL>
Python\(aqs home URL.  Default is
"\fI\%http://www.python.org\fP".
.TP
.BI \-\-pep\-home\fB= <URL>
Home URL prefix for PEPs.  Default is "." (current
directory).
.UNINDENT
.SS Build\-HTML Options
.INDENT 0.0
.TP
.B \-\-recurse
Recursively scan subdirectories for files to process.
This is the default.
.TP
.B \-\-local
Do not scan subdirectories for files to process.
.TP
.BI \-\-prune\fB= <directory>
Do not process files in <directory> (shell globbing
patterns, separated by colons).  This option may be
used more than once to specify multiple directories.
Default: ".hg:.bzr:.git:.svn:CVS".
.TP
.BI \-\-ignore\fB= <patterns>
Recursively ignore files matching any of the given
wildcard (shell globbing) patterns (separated by
colons).
.TP
.B \-\-silent
Work silently (no progress messages).  Independent of
"\-\-quiet".
.TP
.B \-\-dry\-run
Do not process files, show files that would be
processed.
.UNINDENT
.\" Generated by docutils manpage writer.
.