.\" 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 "RST2ODT" 1 "" "" "text processing" .SH NAME rst2odt \- convert reST documents to OpenDocument text (ODT) .SH SYNOPSIS .sp rst2odt [options] [ []] .SH DESCRIPTION .sp Generates OpenDocument/OpenOffice/ODF documents from standalone reStructuredText sources. Reads from (default is stdin) and writes to (default is stdout). See \fI\%https://docutils.sourceforge.io/docs/user/config.html\fP for a detailed settings 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 ODF\-Specific Options .INDENT 0.0 .TP .BI \-\-stylesheet\fB= STYLESHEET Specify a stylesheet. Default: \(dq/usr/share/docutils/writers/odf_odt/styles.odt\(dq .TP .BI \-\-odf\-config\-file\fB= Specify a configuration/mapping file relative to the current working directory for additional ODF options. In particular, this file may contain a section named \(dqFormats\(dq that maps default style names to names to be used in the resulting output file allowing for adhering to external standards. For more info and the format of the configuration/mapping file, see the odtwriter doc. .TP .B \-\-cloak\-email\-addresses Obfuscate email addresses to confuse harvesters while still keeping email links usable with standards\- compliant browsers. .TP .B \-\-no\-cloak\-email\-addresses Do not obfuscate email addresses. .TP .BI \-\-table\-border\-thickness\fB= TABLE_BORDER_THICKNESS Specify the thickness of table borders in thousands of a cm. Default is 35. .TP .B \-\-add\-syntax\-highlighting Add syntax highlighting in literal code blocks. .TP .B \-\-no\-syntax\-highlighting Do not add syntax highlighting in literal code blocks. (default) .TP .B \-\-create\-sections Create sections for headers. (default) .TP .B \-\-no\-sections Do not create sections for headers. .TP .B \-\-create\-links Create links. .TP .B \-\-no\-links Do not create links. (default) .TP .B \-\-endnotes\-end\-doc Generate endnotes at end of document, not footnotes at bottom of page. .TP .B \-\-no\-endnotes\-end\-doc Generate footnotes at bottom of page, not endnotes at end of document. (default) .TP .B \-\-generate\-list\-toc Generate a bullet list table of contents, not an ODF/oowriter table of contents. .TP .B \-\-generate\-oowriter\-toc Generate an ODF/oowriter table of contents, not a bullet list. (default) .TP .BI \-\-custom\-odt\-header\fB= CUSTOM_HEADER Specify the contents of an custom header line. See odf_odt writer documentation for details about special field character sequences. .TP .BI \-\-custom\-odt\-footer\fB= CUSTOM_FOOTER Specify the contents of an custom footer line. See odf_odt writer documentation for details about special field character sequences. .UNINDENT .\" Generated by docutils manpage writer. .