1RST2MD(1)                        User Commands                       RST2MD(1)
2
3
4

NAME

6       rst2md - manual page for rst2md 0.6.1
7

DESCRIPTION

9       Usage =====
10
11              rst2md [options] [<source> [<destination>]]
12
13       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
18       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
33              Disable backlinks from footnotes and citations.
34
35       --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
41       Remove all elements with classes="<class>" from the
42              document tree. Warning: potentially dangerous; use with caution.
43              (Multiple-use option.)
44
45       --strip-class=<class>   Remove all  classes="<class>"  attributes  from
46       elements
47
48       in the document tree. Warning: potentially dangerous;
49              use with caution. (Multiple-use option.)
50
51       --report=<level>, -r <level>
52
53       Report system messages at or higher than <level>:
54              "info"   or  "1",  "warning"/"2"  (default),  "error"/"3",  "se‐
55              vere"/"4", "none"/"5"
56
57       --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
62       Levels as in --report.
63              Default: 4 (severe).
64
65       --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
69       messages at or above <level>.
70              Default: 5 (disabled).
71
72       --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
79       Specify the encoding and optionally the error handler
80              of input text.  Default: <locale-dependent>:strict.
81
82       --input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER
83
84       Specify the error handler for undecodable characters.
85              Choices: "strict" (default), "ignore", and "replace".
86
87       --output-encoding=<name[:handler]>, -o <name[:handler]>
88
89       Specify the text encoding and optionally the error
90              handler for output.  Default: UTF-8:strict.
91
92       --output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER
93
94       Specify error handler for unencodable output
95              characters; "strict" (default), "ignore",  "replace",  "xmlchar‐
96              refreplace", "backslashreplace".
97
98       --error-encoding=<name[:handler]>, -e <name[:handler]>
99
100       Specify text encoding and error handler for error
101              output.  Default: utf-8:backslashreplace.
102
103       --error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER
104
105       Specify the error handler for unencodable characters
106              in error output.  Default: backslashreplace.
107
108       --language=<name>, -l <name>
109
110       Specify the language (as BCP 47 language tag).
111              Default: en.
112
113       --record-dependencies=<file>
114
115              Write output file dependencies to <file>.
116
117       --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
121       Generic   Parser   Options  ----------------------  --no-file-insertion
122       Disable directives that insert the contents of an
123
124       external file; replaced with a "warning" system
125              message.
126
127       --file-insertion-enabled
128
129       Enable directives that insert the contents of an
130              external file. (default)
131
132       --no-raw                Disable the "raw" directive;  replaced  with  a
133       "warning"
134
135              system message.
136
137       --raw-enabled             Enable   the   "raw"   directive.   (default)
138       --line-length-limit=<length>
139
140       Maximal number of characters in an input line. Default
141              10 000.
142
143       reStructuredText   Parser    Options    -------------------------------
144       --pep-references        Recognize and link to standalone PEP references
145       (like
146
147              "PEP 258").
148
149       --pep-base-url=<URL>    Base URL for PEP references (default
150
151              "http://www.python.org/dev/peps/").
152
153       --pep-file-url-template=<URL>
154
155       Template for PEP file part of URL. (default
156              "pep-%04d")
157
158       --rfc-references        Recognize and link to standalone RFC references
159       (like
160
161              "RFC 822").
162
163       --rfc-base-url=<URL>    Base URL for RFC references (default
164
165              "http://tools.ietf.org/html/").
166
167       --tab-width=<width>     Set number of spaces for tab expansion (default
168       8).  --trim-footnote-reference-space
169
170              Remove spaces before footnote references.
171
172       --leave-footnote-reference-space
173
174              Leave spaces before footnote references.
175
176       --syntax-highlight=<format>
177
178       Token name set for parsing code with Pygments: one of
179              "long", "short", or "none" (no parsing). Default is "long".
180
181       --smart-quotes=<yes/no/alt>
182
183       Change straight quotation marks to typographic form:
184              one of "yes", "no", "alt[ernative]" (default "no").
185
186       --smartquotes-locales=<language:quotes[,language:quotes,...]>
187
188              Characters to use as "smart quotes" for <language>.
189
190       --word-level-inline-markup
191
192       Inline markup recognized at word boundaries only
193              (adjacent to punctuation or whitespace).  Force  character-level
194              inline  markup  recognition  with  "\ " (backslash + space). De‐
195              fault.
196
197       --character-level-inline-markup
198
199       Inline markup recognized anywhere, regardless of
200              surrounding characters. Backslash-escapes must be used to  avoid
201              unwanted  markup  recognition.  Useful for East Asian languages.
202              Experimental.
203
204       Standalone Reader ----------------- --no-doc-title          Disable the
205       promotion of a lone top-level section
206
207       title to document title (and subsequent section title
208              to document subtitle promotion; enabled by default).
209
210       --no-doc-info           Disable the bibliographic field list transform
211
212              (enabled by default).
213
214       --section-subtitles      Activate  the promotion of lone subsection ti‐
215       tles to
216
217              section subtitles (disabled by default).
218
219       --no-section-subtitles  Deactivate the promotion of lone subsection ti‐
220       tles.
221
222       Markdown-Specific Options ------------------------- --extended-markdown
223       Extended Markdown syntax.  --strict-markdown       Strict Markdown syn‐
224       tax. Default: true
225
226
227
228rst2md 0.6.1                       June 2022                         RST2MD(1)
Impressum