rst2latex(1)

📦
version 0.23 · 6 versions
, in ubuntu stonking

🌸 NAME 🌸

rst2latex — text processing, and literally the moment. Okay so bestie, this is the little icon that converts reST documents to LaTeX 💖. That's it, that's the whole job, and she does it flawlessly.

✨ SYNOPSIS ✨

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

🦋 DESCRIPTION 🦋

She generates LaTeX documents from standalone reStructuredText sources — the tea is all documented over at https://docutils.sourceforge.io/docs/user/latex.html if you want to go read it yourself, no cap.

She reads from <source> (and if you don't give her one, default is stdin, she'll just sit there waiting for you to say something) and she writes to <destination> (default is stdout). And if you need the full settings reference, it lives at https://docutils.sourceforge.io/docs/user/config.html. Go forth and read, queen.

👑 OPTIONS 👑

💜 General Docutils Options

  • --output-path=<destination>, --output=<destination> — The name of where the output goes. This one straight-up obsoletes the <destination> positional argument, like it's too good for it. Default: None (which means stdout, she's just talking out loud).
  • --title=<title> — Set the document title as metadata. A little name tag for your doc.
  • --generator, -g — Slap a "Generated by Docutils" credit and link on there. Give credit where credit is due 💅.
  • --no-generator — No generator credit. She's humble today.
  • --date, -d — Include the date at the end of the document (UTC).
  • --time, -t — Include the time & date (UTC). Both. The full timestamp slay.
  • --no-datestamp — No datestamp of any kind, whatsoever, periodt.
  • --root-prefix=<path> — Base directory for absolute paths when reading from the local filesystem. Default "".
  • --source-link, -s — Include a "View document source" link.
  • --source-url=<URL> — Use <URL> for a source link. This one implies --source-link — it doesn't ask, it just does it.
  • --no-source-link — Do not include a "View document source" link.
  • --toc-entry-backlinks — Link from section headers to TOC entries. This is the default vibe.
  • --toc-top-backlinks — Link from section headers to the top of the TOC instead.
  • --no-toc-backlinks — Disable backlinks to the table of contents. Cut off.
  • --footnote-backlinks — Link from footnotes/citations to references. Default.
  • --no-footnote-backlinks — Disable backlinks from footnotes and citations.
  • --section-numbering — Enable section numbering by Docutils. Default.
  • --no-section-numbering — Disable section numbering by Docutils. Numbers? Never met her.
  • --strip-comments — Remove comment elements from the document tree. Gone, deleted, not invited.
  • --leave-comments — Leave comment elements in the document tree. Default.
  • --strip-elements-with-class=<class> — Remove all elements with classes="<class>" from the document tree. ⚠️ Warning: potentially dangerous; use with caution. (Multiple-use option — you can stack it.)
  • --strip-class=<class> — Remove all classes="<class>" attributes from elements in the document tree. ⚠️ Warning: potentially dangerous; use with caution. (Multiple-use option.)
  • --report=<level>, -r <level> — Report system messages at or higher than <level>. The levels are: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5".
  • --verbose, -v — Report all the system messages. Same as --report=1. She's telling you everything, she's an open book 📖.
  • --quiet, -q — Report no system messages. Same as --report=5. Not a single word.
  • --halt=<level> — Halt execution at system messages at or above <level>. Same level scale as --report. Default: 4 (severe). She stops dead in her tracks.
  • --strict — Halt at the slightest problem. Same as --halt=info. One tiny thing goes wrong and she's done, she's leaving 🚪.
  • --exit-status=<level> — Enable a non-zero exit status for non-halting system messages at or above <level>. Default: 5 (disabled).
  • --debug — Enable debug-level system messages and diagnostics. Chaotic but informative.
  • --no-debug — Disable debug output. Default.
  • --warnings=<file> — Send the output of system messages to <file>.
  • --traceback — Enable Python tracebacks when Docutils is halted. Show me the receipts.
  • --no-traceback — Disable Python tracebacks. Default.
  • --input-encoding=<name[:handler]> — Specify the encoding and optionally the error handler of input text. Default: utf-8.
  • --output-encoding=<name[:handler]> — Specify the text encoding and optionally the error handler for output. Default: utf-8.
  • --error-encoding=<name[:handler]>, -e <name[:handler]> — Specify text encoding and optionally the error handler for error output. Default: system encoding.
  • --language=<tag>, -l <tag> — Specify the language (as a BCP 47 language tag). Default: en.
  • --record-dependencies=<file> — Write output file dependencies to <file>.
  • --config=<file> — Read configuration settings from <file> — but only if it exists. If it doesn't, no worries, she moves on.
  • --version, -V — Show this program's version number and exit. Iconic behavior.
  • --help, -h — Show this help message and exit. Hi bestie 👋.

🧚 Generic Parser Options

  • --no-file-insertion — Disable directives that insert the contents of an external file; replaced with a "warning" system message. Safety first.
  • --file-insertion-enabled — Enable directives that insert the contents of an external file. Default.
  • --no-raw — Disable the "raw" directive; replaced with a "warning" system message. Locked up for your own good.
  • --raw-enabled — Enable the "raw" directive. Default.
  • --line-length-limit=<length> — Maximal number of characters in an input line. Default 10 000.
  • --legacy-ids — Keep identifiers backwards compatible. Default.
  • --matching-ids — Explicit targets use identifiers matching the reference name.
  • --validate — Validate the document tree after parsing. Get it checked.
  • --no-validation — Do not validate the document tree. Default.

🌈 reStructuredText Parser Options

  • --pep-references — Recognize and link to standalone PEP references, like "PEP 258".
  • --pep-base-url=<URL> — Base URL for PEP references. Default: https://peps.python.org/.
  • --pep-file-url-template=<URL> — Template for the PEP file part of the URL. Default: "pep-%04d".
  • --rfc-references — Recognize and link to standalone RFC references, like "RFC 822".
  • --rfc-base-url=<URL> — Base URL for RFC references. Default: https://tools.ietf.org/html/.
  • --tab-width=<width> — Set number of spaces for tab expansion. Default 8.
  • --trim-footnote-reference-space — Remove spaces before footnote references.
  • --leave-footnote-reference-space — Leave spaces before footnote references.
  • --syntax-highlight=<format> — Token name set for parsing code with Pygments: one of "long", "short", or "none" (no parsing at all). Default is "long".
  • --smart-quotes=<yes/no/alt> — Change straight quotation marks to typographic form: one of "yes", "no", "alt[ernative]". Default "no". Fancy quotes, but only if you say so.
  • --smartquotes-locales=<language:quotes[,language:quotes,...]> — Characters to use as "smart quotes" for <language>.
  • --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.
  • --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. (👀 tread carefully bestie)

🎀 Standalone Reader Options

  • --no-doc-title — Disable the promotion of a lone top-level section title to document title (and the subsequent section title to document subtitle promotion; this stuff is enabled by default).
  • --no-doc-info — Disable the bibliographic field list transform (which is enabled by default).
  • --section-subtitles — Activate the promotion of lone subsection titles to section subtitles (disabled by default).
  • --no-section-subtitles — Deactivate the promotion of lone subsection titles.

💅 LaTeX-Specific Options

  • --documentclass=<documentclass> — Specify LaTeX documentclass. Default: "article".
  • --documentoptions=<options> — Specify document options. Multiple options can be given, separated by commas. Default: "a4paper".
  • --footnote-references=<format> — Format for footnote references: one of "superscript" or "brackets". Default: "superscript".
  • --use-latex-citations — Use cite command for citations. (future default — she's coming, get ready).
  • --figure-citations — Use figure floats for citations (might get mixed with real figures, so, be aware). (provisional default).
  • --attribution=<format> — Format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default: "dash".
  • --stylesheet=<file[,file,...]> — Specify LaTeX packages/stylesheets. A style is referenced with "usepackage" if the extension is ".sty" or omitted, and with "input" otherwise. This overrides previous --stylesheet and --stylesheet-path settings. She's not negotiating.
  • --stylesheet-path=<file[,file,...]> — 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.
System Message: WARNING/2 (debian/tmp/man/rst2latex.txt:, line 185) Inline emphasis start-string without end-string.
  • --link-stylesheet — Link to the stylesheet(s) in the output file. Default.
  • --embed-stylesheet — Embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing — no showing up empty-handed.
  • --stylesheet-dirs=<dir[,dir,...]> — Comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: ".".
  • --latex-preamble=<preamble> — Customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier).
  • --template=<file> — Specify the template file. Default: "default.tex".
  • --use-latex-toc — Table of contents by LaTeX. Default.
  • --use-docutils-toc — Table of contents by Docutils (without page numbers).
  • --use-part-section — Add parts on top of the section hierarchy. Layered, like a good outfit.
  • --use-docutils-docinfo — Attach author and date to the document info table. Default.
  • --use-latex-docinfo — Attach author and date to the document title.
  • --topic-abstract — Typeset abstract as topic. Default.
  • --use-latex-abstract — Use LaTeX abstract environment for the document's abstract.
  • --hyperlink-color=<color> — Color of any hyperlinks embedded in text. Default: "blue" (use "false" to disable). 💙
  • --hyperref-options=<options> — Additional options to the "hyperref" package.
  • --compound-enumerators — Enable compound enumerators for nested enumerated lists (e.g. "1.2.a.ii").
  • --no-compound-enumerators — disables compound enumerators for nested enumerated lists. (default, bestie — so this is already the vibe unless you say otherwise 💅)
  • --section-prefix-for-enumerators — enables section ("." subsection ...) prefixes for compound enumerators. But listen: this has no effect without --compound-enumerators. No cap.
  • --no-section-prefix-for-enumerators — disables section prefixes for compound enumerators. (default ✨)
  • --section-enumerator-separator=<char> — sets the separator between the section number and the enumerator for compound enumerated lists. Default: "-". so cute, so specific.
  • --literal-block-env=<environment> — when possible, use the specified <environment> for literal-blocks. Default: "" — and that falls back to "alltt". fallback behavior stays fallback behavior.
  • --table-style=<format> — table style, okay? "standard" gives horizontal and vertical lines. "booktabs" is the LaTeX booktabs style — only horizontal lines above and below the table and below the header. Or "borderless". Default: "standard". pick your fighter 💖
  • --graphicx-option=<option> — LaTeX graphicx package option. Default: "". empty but iconic.
  • --font-encoding=<encoding> — LaTeX font encoding. Possible values are "", "T1" (default), "OT1", "LGR,T1" or any other combination of options to the fontenc package. yes, any combo, go off.
  • --reference-label=<commandname> — per default the latex-writer puts the reference title into hyperreferences. Specify "ref" or "pageref" to get the section number or the page number. choose your reference destiny.
  • --use-bibtex=<style,bibfile[,bibfile,...]> — specify style and database(s) for bibtex, for example "--use-bibtex=unsrt,mydb1,mydb2". Provisional! like, do not build your whole personality on this yet, bestie.
  • --legacy-class-functions — use legacy functions with class value list for DUtitle and DUadmonition. old-school, but make it classy.
  • --new-class-functions — use DUrole and "DUclass" wrappers for class values. Place admonition content in an environment. (default ✨)
  • --legacy-column-widths — use legacy algorithm to determine table column widths. (provisional default) so it’s the default, but it’s giving provisional, okay?
  • --new-column-widths — use new algorithm to determine table column widths. (future default) manifesting.
  • --docutils-footnotes — footnotes with numbers/symbols by Docutils. (default 💖)
  • --latex-footnotes — footnotes with numbers by LaTeX. let LaTeX handle the little numbers.

That’s the rst2latex(1) moment, bestie. Source/version and date? They’re chillin’ in the footer, where rst2latex(1) and the date do their little iconic thing. Now go make some LaTeX and slay. 💅✨🎀

📦 where this page comes from