.\" Man page generated from reStructuredText. . . .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 .. .TH "RST2LATEX" 1 "" "" "text processing" .SH NAME rst2latex \- convert reST documents to LaTeX .SH SYNOPSIS .sp rst2latex [options] [ []] .SH DESCRIPTION .sp Generates LaTeX documents from standalone reStructuredText sources. Reads from (default is stdin) and writes to (default is stdout). See <\fI\%https://docutils.sourceforge.io/docs/user/latex.html\fP> for the full reference. .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 \(dqGenerated by Docutils\(dq 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 \(dqView document source\(dq link. .TP .BI \-\-source\-url\fB= Use for a source link; implies \-\-source\-link. .TP .B \-\-no\-source\-link Do not include a \(dqView document source\(dq 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= Remove all elements with classes=\(dq\(dq from the document tree. Warning: potentially dangerous; use with caution. (Multiple\-use option.) .TP .BI \-\-strip\-class\fB= Remove all classes=\(dq\(dq attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple\-use option.) .TP .BI \-\-report\fB= \fR,\fB \ \-r \ Report system messages at or higher than : \(dqinfo\(dq or \(dq1\(dq, \(dqwarning\(dq/\(dq2\(dq (default), \(dqerror\(dq/\(dq3\(dq, \(dqsevere\(dq/\(dq4\(dq, \(dqnone\(dq/\(dq5\(dq .TP .B \-\-verbose\fP,\fB \-v Report all system messages. (Same as \(dq\-\-report=1\(dq.) .TP .B \-\-quiet\fP,\fB \-q Report no system messages. (Same as \(dq\-\-report=5\(dq.) .TP .BI \-\-halt\fB= Halt execution at system messages at or above . Levels as in \-\-report. Default: 4 (severe). .TP .B \-\-strict Halt at the slightest problem. Same as \(dq\-\-halt=info\(dq. .TP .BI \-\-exit\-status\fB= Enable a non\-zero exit status for non\-halting system messages at or above . 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= Send the output of system messages to . .TP .B \-\-traceback Enable Python tracebacks when Docutils is halted. .TP .B \-\-no\-traceback Disable Python tracebacks. (default) .TP .BI \-\-input\-encoding\fB= \fR,\fB \ \-i \ Specify the encoding and optionally the error handler of input text. Default: :strict. .TP .BI \-\-input\-encoding\-error\-handler\fB= INPUT_ENCODING_ERROR_HANDLER Specify the error handler for undecodable characters. Choices: \(dqstrict\(dq (default), \(dqignore\(dq, and \(dqreplace\(dq. .TP .BI \-\-output\-encoding\fB= \fR,\fB \ \-o \ 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; \(dqstrict\(dq (default), \(dqignore\(dq, \(dqreplace\(dq, \(dqxmlcharrefreplace\(dq, \(dqbackslashreplace\(dq. .TP .BI \-\-error\-encoding\fB= \fR,\fB \ \-e \ Specify text encoding and optionally 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= \fR,\fB \ \-l \ Specify the language (as BCP 47 language tag). Default: en. .TP .BI \-\-record\-dependencies\fB= Write output file dependencies to . .TP .BI \-\-config\fB= Read configuration settings from , 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 Generic Parser Options .INDENT 0.0 .TP .B \-\-no\-file\-insertion Disable directives that insert the contents of an external file; replaced with a \(dqwarning\(dq system message. .TP .B \-\-file\-insertion\-enabled Enable directives that insert the contents of an external file. (default) .TP .B \-\-no\-raw Disable the \(dqraw\(dq directive; replaced with a \(dqwarning\(dq system message. .TP .B \-\-raw\-enabled Enable the \(dqraw\(dq directive. (default) .TP .BI \-\-line\-length\-limit\fB= Maximal number of characters in an input line. Default 10 000. .UNINDENT .SS reStructuredText Parser Options .INDENT 0.0 .TP .B \-\-pep\-references Recognize and link to standalone PEP references (like \(dqPEP 258\(dq). .TP .BI \-\-pep\-base\-url\fB= Base URL for PEP references (default \(dq\fI\%https://peps.python.org/\fP\(dq). .TP .BI \-\-pep\-file\-url\-template\fB= Template for PEP file part of URL. (default \(dqpep\-%04d\(dq) .TP .B \-\-rfc\-references Recognize and link to standalone RFC references (like \(dqRFC 822\(dq). .TP .BI \-\-rfc\-base\-url\fB= Base URL for RFC references (default \(dq\fI\%https://tools.ietf.org/html/\fP\(dq). .TP .BI \-\-tab\-width\fB= 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 .BI \-\-syntax\-highlight\fB= Token name set for parsing code with Pygments: one of \(dqlong\(dq, \(dqshort\(dq, or \(dqnone\(dq (no parsing). Default is \(dqlong\(dq. .TP .BI \-\-smart\-quotes\fB= Change straight quotation marks to typographic form: one of \(dqyes\(dq, \(dqno\(dq, \(dqalt[ernative]\(dq (default \(dqno\(dq). .TP .BI \-\-smartquotes\-locales\fB= Characters to use as \(dqsmart quotes\(dq for . .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 \(dq\(dq (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 Standalone Reader Options .INDENT 0.0 .TP .B \-\-no\-doc\-title Disable the promotion of a lone top\-level section title to document title (and subsequent section title to document subtitle promotion; enabled by default). .TP .B \-\-no\-doc\-info Disable the bibliographic field list transform (enabled by default). .TP .B \-\-section\-subtitles Activate the promotion of lone subsection titles to section subtitles (disabled by default). .TP .B \-\-no\-section\-subtitles Deactivate the promotion of lone subsection titles. .UNINDENT .SS LaTeX\-Specific Options .INDENT 0.0 .TP .BI \-\-documentclass\fB= DOCUMENTCLASS Specify LaTeX documentclass. Default: \(dqarticle\(dq. .TP .BI \-\-documentoptions\fB= DOCUMENTOPTIONS Specify document options. Multiple options can be given, separated by commas. Default: \(dqa4paper\(dq. .TP .BI \-\-footnote\-references\fB= Format for footnote references: one of \(dqsuperscript\(dq or \(dqbrackets\(dq. Default: \(dqsuperscript\(dq. .TP .B \-\-use\-latex\-citations Use cite command for citations. (future default) .TP .B \-\-figure\-citations Use figure floats for citations (might get mixed with real figures). (provisional default) .TP .BI \-\-attribution\fB= Format for block quote attributions: one of \(dqdash\(dq (em\-dash prefix), \(dqparentheses\(dq/\(dqparens\(dq, or \(dqnone\(dq. Default: \(dqdash\(dq. .TP .BI \-\-stylesheet\fB= Specify LaTeX packages/stylesheets. A style is referenced with \(dqusepackage\(dq if extension is \(dq.sty\(dq or omitted and with \(dqinput\(dq else. Overrides previous \-\-stylesheet and \-\-stylesheet\-path settings. .TP .BI \-\-stylesheet\-path\fB= 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 .nf * .fi \&.tex file. .IP "System Message: WARNING/2 (debian/tmp/man/rst2latex.txt:, line 185)" Inline emphasis start\-string without end\-string. .TP .B \-\-link\-stylesheet Link to the stylesheet(s) in the output file. (default) .TP .B \-\-embed\-stylesheet Embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing. .TP .BI \-\-stylesheet\-dirs\fB= Comma\-separated list of directories where stylesheets are found. Used by \-\-stylesheet\-path when expanding relative path arguments. Default: \(dq.\(dq. .TP .BI \-\-latex\-preamble\fB= LATEX_PREAMBLE Customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier). .TP .BI \-\-template\fB= Specify the template file. Default: \(dqdefault.tex\(dq. .TP .B \-\-use\-latex\-toc Table of contents by LaTeX. (default) .TP .B \-\-use\-docutils\-toc Table of contents by Docutils (without page numbers). .TP .B \-\-use\-part\-section Add parts on top of the section hierarchy. .TP .B \-\-use\-docutils\-docinfo Attach author and date to the document info table. (default) .TP .B \-\-use\-latex\-docinfo Attach author and date to the document title. .TP .B \-\-topic\-abstract Typeset abstract as topic. (default) .TP .B \-\-use\-latex\-abstract Use LaTeX abstract environment for the document\(aqs abstract. .TP .BI \-\-hyperlink\-color\fB= HYPERLINK_COLOR Color of any hyperlinks embedded in text. Default: \(dqblue\(dq (use \(dqfalse\(dq to disable). .TP .BI \-\-hyperref\-options\fB= HYPERREF_OPTIONS Additional options to the \(dqhyperref\(dq package. .TP .B \-\-compound\-enumerators Enable compound enumerators for nested enumerated lists (e.g. \(dq1.2.a.ii\(dq). .TP .B \-\-no\-compound\-enumerators Disable compound enumerators for nested enumerated lists. (default) .TP .B \-\-section\-prefix\-for\-enumerators Enable section (\(dq.\(dq subsection ...) prefixes for compound enumerators. This has no effect without \-\-compound\-enumerators. .TP .B \-\-no\-section\-prefix\-for\-enumerators Disable section prefixes for compound enumerators. (default) .TP .BI \-\-section\-enumerator\-separator\fB= Set the separator between section number and enumerator for compound enumerated lists. Default: \(dq\-\(dq. .TP .BI \-\-literal\-block\-env\fB= LITERAL_BLOCK_ENV When possible, use the specified environment for literal\-blocks. Default: \(dq\(dq (fall back to \(dqalltt\(dq). .TP .B \-\-use\-verbatim\-when\-possible Deprecated alias for \(dq\-\-literal\-block\-env=verbatim\(dq. .TP .BI \-\-table\-style\fB= Table style. \(dqstandard\(dq with horizontal and vertical lines, \(dqbooktabs\(dq (LaTeX booktabs style) only horizontal lines above and below the table and below the header, or \(dqborderless\(dq. Default: \(dqstandard\(dq .TP .BI \-\-graphicx\-option\fB= GRAPHICX_OPTION LaTeX graphicx package option. Possible values are \(dqdvipdfmx\(dq, \(dqdvips\(dq, \(dqdvisvgm\(dq, \(dqluatex\(dq, \(dqpdftex\(dq, and \(dqxetex\(dq.Default: \(dq\(dq. .TP .BI \-\-font\-encoding\fB= FONT_ENCODING LaTeX font encoding. Possible values are \(dq\(dq, \(dqT1\(dq (default), \(dqOT1\(dq, \(dqLGR,T1\(dq or any other combination of options to the \fIfontenc\fP package. .TP .BI \-\-reference\-label\fB= REFERENCE_LABEL Per default the latex\-writer puts the reference title into hyperreferences. Specify \(dqref*\(dq or \(dqpageref*\(dq to get the section number or the page number. .TP .BI \-\-use\-bibtex\fB= USE_BIBTEX Specify style and database for bibtex, for example \(dq\-\- use\-bibtex=mystyle,mydb1,mydb2\(dq. .TP .B \-\-legacy\-class\-functions Use legacy functions with class value list for DUtitle and DUadmonition. .TP .B \-\-new\-class\-functions Use DUrole and \(dqDUclass\(dq wrappers for class values. Place admonition content in an environment. (default) .TP .B \-\-legacy\-column\-widths Use legacy algorithm to determine table column widths. (provisional default) .TP .B \-\-new\-column\-widths Use new algorithm to determine table column widths. (future default) .TP .B \-\-docutils\-footnotes Footnotes with numbers/symbols by Docutils. (default) (The alternative, \-\-latex\-footnotes, is not implemented yet.) .UNINDENT .\" Generated by docutils manpage writer. .