1RST2MD(1) User Commands RST2MD(1)
2
6 rst2md - manual page for rst2md 0.6
7
9 Usage =====
10 rst2md [options] [<source> [<destination>]]
12 Generates Markdown formatted text from standalone reStructuredText
14 sources. Reads from <source> (default is stdin) and writes to <desti‐
15 nation> (default is stdout). See <http://docu‐
16 tils.sf.net/docs/user/config.html> for the full reference.
17 Options ======= General Docutils Options ------------------------ --ti‐
19 tle=TITLE Specify the document title as metadata. --genera‐
20 tor, -g Include a "Generated by Docutils" credit and link.
21 --no-generator Do not include a generator credit. --date, -d
22 Include the date at the end of the document (UTC). --time, -t
23 Include the time & date (UTC). --no-datestamp Do not include
24 a datestamp of any kind. --source-link, -s Include a "View docu‐
25 ment source" link. --source-url=<URL> Use <URL> for a source
26 link; implies --source-link. --no-source-link Do not include a
27 "View document source" link. --toc-entry-backlinks Link from section
28 headers to TOC entries. (default) --toc-top-backlinks Link from
29 section headers to the top of the TOC. --no-toc-backlinks Disable
30 backlinks to the table of contents. --footnote-backlinks Link from
31 footnotes/citations to references. (default) --no-footnote-backlinks
32 Disable backlinks from footnotes and citations.
34 --section-numbering Enable section numbering by Docutils. (de‐
36 fault) --no-section-numbering Disable section numbering by Docutils.
37 --strip-comments Remove comment elements from the document tree.
38 --leave-comments Leave comment elements in the document tree.
39 (default) --strip-elements-with-class=<class>
40 Remove all elements with classes="<class>" from the
42 document tree. Warning: potentially dangerous; use with caution.
43 (Multiple-use option.)
44 --strip-class=<class> Remove all classes="<class>" attributes from
46 elements
47 in the document tree. Warning: potentially dangerous;
49 use with caution. (Multiple-use option.)
50 --report=<level>, -r <level>
52 Report system messages at or higher than <level>:
54 "info" or "1", "warning"/"2" (default), "error"/"3", "se‐
55 vere"/"4", "none"/"5"
56 --verbose, -v Report all system messages. (Same as "--re‐
58 port=1".) --quiet, -q Report no system messages. (Same as
59 "--report=5".) --halt=<level> Halt execution at system mes‐
60 sages at or above <level>.
61 Levels as in --report.
63 Default: 4 (severe).
64 --strict Halt at the slightest problem. Same as
66 "--halt=info". --exit-status=<level> Enable a non-zero exit status
67 for non-halting system
68 messages at or above <level>.
70 Default: 5 (disabled).
71 --debug Enable debug-level system messages and diagnos‐
73 tics. --no-debug Disable debug output. (default) --warn‐
74 ings=<file> Send the output of system messages to <file>.
75 --traceback Enable Python tracebacks when Docutils is
76 halted. --no-traceback Disable Python tracebacks. (default)
77 --input-encoding=<name[:handler]>, -i <name[:handler]>
78 Specify the encoding and optionally the error handler
80 of input text. Default: <locale-dependent>:strict.
81 --input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER
83 Specify the error handler for undecodable characters.
85 Choices: "strict" (default), "ignore", and "replace".
86 --output-encoding=<name[:handler]>, -o <name[:handler]>
88 Specify the text encoding and optionally the error
90 handler for output. Default: UTF-8:strict.
91 --output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER
93 Specify error handler for unencodable output
95 characters; "strict" (default), "ignore", "replace", "xmlchar‐
96 refreplace", "backslashreplace".
97 --error-encoding=<name[:handler]>, -e <name[:handler]>
99 Specify text encoding and error handler for error
101 output. Default: utf-8:backslashreplace.
102 --error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER
104 Specify the error handler for unencodable characters
106 in error output. Default: backslashreplace.
107 --language=<name>, -l <name>
109 Specify the language (as BCP 47 language tag).
111 Default: en.
112 --record-dependencies=<file>
114 Write output file dependencies to <file>.
116 --config=<file> Read configuration settings from <file>, if it
118 exists. --version, -V Show this program's version number and
119 exit. --help, -h Show this help message and exit.
120 reStructuredText Parser Options -------------------------------
122 --pep-references Recognize and link to standalone PEP references
123 (like
124 "PEP 258").
126 --pep-base-url=<URL> Base URL for PEP references (default
128 "http://www.python.org/dev/peps/").
130 --pep-file-url-template=<URL>
132 Template for PEP file part of URL. (default
134 "pep-%04d")
135 --rfc-references Recognize and link to standalone RFC references
137 (like
138 "RFC 822").
140 --rfc-base-url=<URL> Base URL for RFC references (default
142 "http://tools.ietf.org/html/").
144 --tab-width=<width> Set number of spaces for tab expansion (default
146 8). --trim-footnote-reference-space
147 Remove spaces before footnote references.
149 --leave-footnote-reference-space
151 Leave spaces before footnote references.
153 --no-file-insertion Disable directives that insert the contents of
155 external file ("include" & "raw"); replaced with a
157 "warning" system message.
158 --file-insertion-enabled
160 Enable directives that insert the contents of external
162 file ("include" & "raw"). Enabled by default.
163 --no-raw Disable the "raw" directives; replaced with a
165 "warning" system message.
167 --raw-enabled Enable the "raw" directive. Enabled by de‐
169 fault. --syntax-highlight=<format>
170 Token name set for parsing code with Pygments: one of
172 "long", "short", or "none (no parsing)". Default is "long".
173 --smart-quotes=<yes/no/alt>
175 Change straight quotation marks to typographic form:
177 one of "yes", "no", "alt[ernative]" (default "no").
178 --smartquotes-locales=<language:quotes[,language:quotes,...]>
180 Characters to use as "smart quotes" for <language>.
182 --word-level-inline-markup
184 Inline markup recognized at word boundaries only
186 (adjacent to punctuation or whitespace). Force character-level
187 inline markup recognition with "\ " (backslash + space). De‐
188 fault.
189 --character-level-inline-markup
191 Inline markup recognized anywhere, regardless of
193 surrounding characters. Backslash-escapes must be used to avoid
194 unwanted markup recognition. Useful for East Asian languages.
195 Experimental.
196 Standalone Reader ----------------- --no-doc-title Disable the
198 promotion of a lone top-level section
199 title to document title (and subsequent section title
201 to document subtitle promotion; enabled by default).
202 --no-doc-info Disable the bibliographic field list transform
204 (enabled by default).
206 --section-subtitles Activate the promotion of lone subsection ti‐
208 tles to
209 section subtitles (disabled by default).
211 --no-section-subtitles Deactivate the promotion of lone subsection ti‐
213 tles.
214 Markdown-Specific Options ------------------------- --extended-markdown
216 Extended Markdown syntax. --strict-markdown Strict Markdown syn‐
217 tax. Default: true
218rst2md 0.6 January 2021 RST2MD(1)