rst2odt(1)

📦
version 0.23 · 6 versions
, in ubuntu stonking

✨ rst2odt ✨

okay bestie, so this is the rst2odt(1) page from the text processing corner of the manual world, and it's literally your ticket to turning reStructuredText into OpenDocument text files. let's get into it 🫶

🌸 NAME 🌸

rst2odt — convert reST documents to OpenDocument text (ODT) 💅

🎀 SYNOPSIS 🎀

rst2odt [options] [<source> [<destination>]]

🦋 DESCRIPTION 🦋

Generate OpenDocument text (ODT) documents from standalone reStructuredText sources — the details live at https://docutils.sourceforge.io/docs/user/odt.html.

It reads from <source> (default is stdin, no cap) and writes to <destination> (default is stdout, iconic). And if you want the full settings reference, it's right here: https://docutils.sourceforge.io/docs/user/config.html ✨

👑 OPTIONS 👑

💖 General Docutils Options

  • --output-path=<destination>, --output=<destination> — the output destination name. this obsoletes the <destination> positional argument. Default: None (i.e. stdout).
  • --title=<title> — specify the document title as metadata.
  • --generator, -g — include a "Generated by Docutils" credit and link.
  • --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 (UTC).
  • --no-datestamp — no datestamp of any kind, 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 implies --source-link.
  • --no-source-link — do not include a "View document source" link.
  • --toc-entry-backlinks — link from section headers to TOC entries. (default)
  • --toc-top-backlinks — link from section headers to the top of the TOC.
  • --no-toc-backlinks — disable backlinks to the table of contents.
  • --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.
  • --strip-comments — remove comment elements from the document tree.
  • --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.)
  • --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>: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5".
  • --verbose, -v — report all system messages. (Same as "--report=1".)
  • --quiet, -q — report no system messages. (Same as "--report=5".)
  • --halt=<level> — halt execution at system messages at or above <level>. Levels work just like --report. Default: 4 (severe).
  • --strict — halt at the slightest problem. Same as "--halt=info".
  • --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.
  • --no-debug — disable debug output. (default)
  • --warnings=<file> — send the output of system messages to <file>.
  • --traceback — enable Python tracebacks when Docutils is halted.
  • --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>, if it exists.
  • --version, -V — show this program's version number and exit.
  • --help, -h — show this help message and exit.

🌈 Generic Parser Options

  • --no-file-insertion — disable directives that insert the contents of an external file; replaced with a "warning" system message.
  • --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.
  • --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.
  • --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). Default is "long".
  • --smart-quotes=<yes/no/alt> — change straight quotation marks to typographic form: one of "yes", "no", "alt[ernative]" (default "no").
  • --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.

🌸 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; enabled by default).
  • --no-doc-info — disable the bibliographic field list transform (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.

💅 ODF-Specific Options

  • --stylesheet=<filename> — specify a stylesheet. Default: "/usr/share/docutils/writers/odf_odt/styles.odt"
  • --odf-config-file=<file> — specify an ODF-specific configuration/mapping file relative to the current working directory.
  • --cloak-email-addresses — obfuscate email addresses to confuse harvesters.
  • --no-cloak-email-addresses — do not obfuscate email addresses.
  • --table-border-thickness=<int> — specify the thickness of table borders in thousands of a cm. Default is 35.
  • --add-syntax-highlighting — add syntax highlighting in literal code blocks.
  • --no-syntax-highlighting — do not add syntax highlighting in literal code blocks. (default)
  • --create-sections — create sections for headers. (default)
  • --no-sections — do not create sections for headers.
  • --create-links — create links.
  • --no-links — do not create links. (default)
  • --endnotes-end-doc — generate endnotes at end of document, not footnotes at bottom of page.
  • --no-endnotes-end-doc — generate footnotes at bottom of page, not endnotes at end of document. (default)
  • --generate-list-toc — generate a bullet list table of contents, not a native ODF table of contents.
  • --generate-oowriter-toc — generate a native ODF table of contents, not a bullet list. (default)
  • --custom-odt-header=<customheader> — specify the contents of an custom header line. See ODF/ODT writer documentation for details about special field character sequences.
  • --custom-odt-footer=<customfooter> — specify the contents of an custom footer line. See ODF/ODT writer documentation for details.

and that's the whole page, bestie 💖 this is the rst2odt(1) page, filed under text processing — go forth and make ODTs, you absolute icon 👑✨

📦 where this page comes from