|
--title=TITLE |
Specify the document title as metadata (not part of
the document body). Overrides a document-provided
title. There is no default. |
|
--generator, -g |
| | Include a "Generated by Docutils" credit and link at
the end of the document. |
|
--no-generator |
Do not include a generator credit. |
|
--date, -d |
Include the date at the end of the document (UTC). |
|
--time, -t |
Include the time & date at the end of the document
(UTC). |
|
--no-datestamp |
Do not include a datestamp of any kind. |
|
--source-link, -s |
| | Include a "View document source" link (relative to
destination). |
|
--source-url=<URL> |
| | Use the supplied <URL> verbatim for a "View document
source" link; implies --source-link. |
|
--no-source-link |
| | Do not include a "View document source" link. |
|
--toc-entry-backlinks |
| | Enable backlinks from section headers to table of
contents entries. This is the default. |
|
--toc-top-backlinks |
| | Enable backlinks from section headers to the top of
the table of contents. |
|
--no-toc-backlinks |
| | Disable backlinks to the table of contents. |
|
--footnote-backlinks |
| | Enable backlinks from footnotes and citations to their
references. This is the default. |
|
--no-footnote-backlinks |
| | Disable backlinks from footnotes and citations. |
|
--section-numbering |
| | Enable Docutils section numbering (default: enabled). |
|
--no-section-numbering |
| | Disable Docutils section numbering (default: enabled). |
|
--strip-comments |
| | Remove comment elements from the document tree
(default: leave them). |
|
--leave-comments |
| | Leave comment elements in the document tree (this is
the default). |
|
--report=<level>, -r <level> |
| | Set verbosity threshold; report system messages at or
higher than <level> (by name or number: "info" or "1",
warning/2, error/3, severe/4; also, "none" or "5").
Default is 2 (warning). |
|
--verbose, -v |
Report all system messages, info-level and higher.
(Same as "--report=info".) |
|
--quiet, -q |
Do not report any system messages. (Same as "--
report=none".) |
|
--halt=<level> |
Set the threshold (<level>) at or above which system
messages are converted to exceptions, halting
execution immediately by exiting (or propagating the
exception if --traceback set). Levels as in --report.
Default is 4 (severe). |
|
--strict |
Same as "--halt=info": halt processing at the
slightest problem. |
|
--exit-status=<level> |
| | Enable a non-zero exit status for normal exit if non-
halting system messages (at or above <level>) were
generated. Levels as in --report. Default is 5
(disabled). Exit status is the maximum system message
level plus 10 (11 for INFO, etc.). |
|
--debug |
Report debug-level system messages and generate
diagnostic output. |
|
--no-debug |
Do not report debug-level system messages or generate
diagnostic output. |
|
--warnings=<file> |
| | Send the output of system messages (warnings) to
<file>. |
|
--traceback |
Enable Python tracebacks when halt-level system
messages and other exceptions occur. Useful for
debugging, and essential for issue reports. |
|
--no-traceback |
Disable Python tracebacks when errors occur; report
just the error instead. This is the default. |
|
--input-encoding=<name[:handler]>, -i <name[:handler]> |
| | Specify the encoding of input text. Default is
locale-dependent. Optionally also specify the error
handler for undecodable characters, after a colon
(":"); default is "strict". (See "--intput-encoding-
error-handler".) |
|
--input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER |
| | Specify the error handler for undecodable characters
in the input. Acceptable values include "strict",
"ignore", and "replace". Default is "strict".
Usually specified as part of --input-encoding. |
|
--output-encoding=<name[:handler]>, -o <name[:handler]> |
| | Specify the text encoding for output. Default is
UTF-8. Optionally also specify the error handler for
unencodable characters, after a colon (":"); default
is "strict". (See "--output-encoding-error-handler".) |
|
--output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER |
| | Specify the error handler for unencodable characters
in the output. Acceptable values include "strict",
"ignore", "replace", "xmlcharrefreplace", and
"backslashreplace" (in Python 2.3+). Default is
"strict". Usually specified as part of --output-
encoding. |
|
--error-encoding=<name[:handler]>, -e <name[:handler]> |
| | Specify the text encoding for error output. Default
is ASCII. Optionally also specify the error handler
for unencodable characters, after a colon (":");
default is "backslashreplace". (See "--output-
encoding-error-handler".) |
|
--error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER |
| | Specify the error handler for unencodable characters
in error output. See --output-encoding-error-handler
for acceptable values. Default is "backslashreplace".
Usually specified as part of --error-encoding. |
|
--language=<name>, -l <name> |
| | Specify the language of input text (ISO 639 2-letter
identifier). Default is "en" (English). |
|
--record-dependencies=<file> |
| | Write dependencies (caused e.g. by file inclusions) to
<file>. Useful in conjunction with programs like
"make". |
|
--config=<file> |
| | Read configuration settings from <file>, if it exists. |
|
--version, -V |
Show this program's version number and exit. |
|
--help, -h |
Show this help message and exit. |