Scroll to navigation

RST2LATEX(1) text processing RST2LATEX(1)

NAME

rst2latex - convert reST documents to LaTeX

SYNOPSIS

rst2latex [options] [<source> [<destination>]]

DESCRIPTION

Generates LaTeX documents from standalone reStructuredText sources. Reads from <source> (default is stdin) and writes to <destination> (default is stdout). See <http://docutils.sourceforge.net/docs/user/latex.html> for the full reference.

OPTIONS

General Docutils Options

Specify the document title as metadata.
Include a "Generated by Docutils" credit and link.
Do not include a generator credit.
Include the date at the end of the document (UTC).
Include the time & date (UTC).
Do not include a datestamp of any kind.
Include a "View document source" link.
Use <URL> for a source link; implies --source-link.
Do not include a "View document source" link.
Link from section headers to TOC entries. (default)
Link from section headers to the top of the TOC.
Disable backlinks to the table of contents.
Link from footnotes/citations to references. (default)
Disable backlinks from footnotes and citations.
Enable section numbering by Docutils. (default)
Disable section numbering by Docutils.
Remove comment elements from the document tree.
Leave comment elements in the document tree. (default)
Remove all elements with classes="<class>" from the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)
Remove all classes="<class>" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)
Report system messages at or higher than <level>: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5"
Report all system messages. (Same as "--report=1".)
Report no system messages. (Same as "--report=5".)
Halt execution at system messages at or above <level>. Levels as in --report. Default: 4 (severe).
Halt at the slightest problem. Same as "--halt=info".
Enable a non-zero exit status for non-halting system messages at or above <level>. Default: 5 (disabled).
Enable debug-level system messages and diagnostics.
Disable debug output. (default)
Send the output of system messages to <file>.
Enable Python tracebacks when Docutils is halted.
Disable Python tracebacks. (default)
Specify the encoding and optionally the error handler of input text. Default: <locale-dependent>:strict.
Specify the error handler for undecodable characters. Choices: "strict" (default), "ignore", and "replace".
Specify the text encoding and optionally the error handler for output. Default: UTF-8:strict.
Specify error handler for unencodable output characters; "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace".
Specify text encoding and error handler for error output. Default text encoding: system encoding. Default error handler: backslashreplace.
Specify the error handler for unencodable characters in error output. Default: backslashreplace.
Specify the language (as BCP 47 language tag). Default: en.
Write output file dependencies to <file>.
Read configuration settings from <file>, if it exists.
Show this program's version number and exit.
Show this help message and exit.

reStructuredText Parser Options

Recognize and link to standalone PEP references (like "PEP 258").
Base URL for PEP references (default "http://www.python.org/dev/peps/").
Template for PEP file part of URL. (default "pep-%04d")
Recognize and link to standalone RFC references (like "RFC 822").
Base URL for RFC references (default "http://tools.ietf.org/html/").
Set number of spaces for tab expansion (default 8).
Remove spaces before footnote references.
Leave spaces before footnote references.
Disable directives that insert the contents of external file ("include" & "raw"); replaced with a "warning" system message.
Enable directives that insert the contents of external file ("include" & "raw"). Enabled by default.
Disable the "raw" directives; replaced with a "warning" system message.
Enable the "raw" directive. Enabled by default.
Token name set for parsing code with Pygments: one of "long", "short", or "none (no parsing)". Default is "long".
Change straight quotation marks to typographic form: one of "yes", "no", "alt[ernative]" (default "no").
Characters to use as "smart quotes" for <language>.
Inline markup recognized at word boundaries only (adjacent to punctuation or whitespace). Force character-level inline markup recognition with "" (backslash + space). Default.
Inline markup recognized anywhere, regardless of surrounding characters. Backslash-escapes must be used to avoid unwanted markup recognition. Useful for East Asian languages. Experimental.

Standalone Reader

Disable the promotion of a lone top-level section title to document title (and subsequent section title to document subtitle promotion; enabled by default).
Disable the bibliographic field list transform (enabled by default).
Activate the promotion of lone subsection titles to section subtitles (disabled by default).
Deactivate the promotion of lone subsection titles.

LaTeX-Specific Options

Specify LaTeX documentclass. Default: "article".
Specify document options. Multiple options can be given, separated by commas. Default: "a4paper".
Format for footnote references: one of "superscript" or "brackets". Default: "superscript".
Use cite command for citations. (future default)
Use figure floats for citations (might get mixed with real figures). (current default)
Format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default: "dash".
Specify LaTeX packages/stylesheets. A style is referenced with "usepackage" if extension is ".sty" or omitted and with "input" else. Overrides previous --stylesheet and --stylesheet-path settings.
Comma separated list of LaTeX packages/stylesheets. 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 
*
.tex file.
Inline emphasis start-string without end-string.
Link to the stylesheet(s) in the output file. (default)
Embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing.
Comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: ".".
Customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier).
Specify the template file. Default: "default.tex".
Table of contents by LaTeX. (default)
Table of contents by Docutils (without page numbers).
Add parts on top of the section hierarchy.
Attach author and date to the document info table. (default)
Attach author and date to the document title.
Typeset abstract as topic. (default)
Use LaTeX abstract environment for the document's abstract.
Color of any hyperlinks embedded in text. Default: "blue" (use "false" to disable).
Additional options to the "hyperref" package.
Enable compound enumerators for nested enumerated lists (e.g. "1.2.a.ii").
Disable compound enumerators for nested enumerated lists. (default)
Enable section ("." subsection ...) prefixes for compound enumerators. This has no effect without --compound-enumerators.
Disable section prefixes for compound enumerators. (default)
Set the separator between section number and enumerator for compound enumerated lists. Default: "-".
When possible, use the specified environment for literal-blocks. Default: "" (fall back to "alltt").
When possible, use "verbatim" for literal-blocks. Compatibility alias for "--literal-block- env=verbatim".
Table style. "standard" with horizontal and vertical lines, "booktabs" (LaTeX booktabs style) only horizontal lines above and below the table and below the header, or "borderless". Default: "standard"
LaTeX graphicx package option. Possible values are "dvips", "pdftex". "auto" includes LaTeX code to use "pdftex" if processing with pdf(la)tex and dvips otherwise. Default: "".
LaTeX font encoding. Possible values are "", "T1" (default), "OT1", "LGR,T1" or any other combination of options to the fontenc package.
Per default the latex-writer puts the reference title into hyperreferences. Specify "ref*" or "pageref*" to get the section number or the page number.
Specify style and database for bibtex, for example "-- use-bibtex=mystyle,mydb1,mydb2".
Footnotes with numbers/symbols by Docutils. (default) (The alternative, --latex-footnotes, is not implemented yet.)