git.iko.soy/typeable/pandoc
on master help sign in
Man page templates:

Escaped --'s in option list headers, so they won't be parsed as Em dashes when -S mode is used. git-svn-id: https://pandoc.googlecode.com/svn/trunk@644 788f1e2b-df1e-0410-8736-df70ead52e1b

commit595f6bf39a93b78e74fa7ad121b05ce02c4bc37e authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateSun 8 Jul 2007, 03:31 (19 years ago) parentdc7102e
3 files changed+43−43
compare with master
unifiedsplit
man/man1/html2markdown.1.md+12−12 man/man1/markdown2pdf.1.md+7−7 man/man1/pandoc.1.md+24−24
man/man1/html2markdown.1.md+12−12
@@ -8,7 +8,7 @@ html2markdown - converts HTML to markdown-formatted text
88
99# SYNOPSIS
1010
11−html2markdown [*pandoc-options*] [-- *special-options*] [*input-file* or
11+html2markdown [*pandoc-options*] [\-- *special-options*] [*input-file* or
1212*URL*]
1313
1414# DESCRIPTION
@@ -31,34 +31,34 @@ explicitly using the `-e` special option.
3131`pandoc`'s options may be used. See `pandoc`(1) for
3232a complete list. The following options are most relevant:
3333
34−-s, --standalone
34+-s, \--standalone
3535: Include title, author, and date information (if present) at the
3636 top of markdown output.
3737
38−-o *FILE*, --output=*FILE*
38+-o *FILE*, \--output=*FILE*
3939: Write output to *FILE* instead of STDOUT.
4040
41−--strict
41+\--strict
4242: Use strict markdown syntax, with no extensions or variants.
4343
44−--reference-links
44+\--reference-links
4545: Use reference-style links, rather than inline links, in writing markdown
4646 or reStructuredText.
4747
48−-R, --parse-raw
48+-R, \--parse-raw
4949: Parse untranslatable HTML codes as raw HTML.
5050
51−-H *FILE*, --include-in-header=*FILE*
51+-H *FILE*, \--include-in-header=*FILE*
5252: Include contents of *FILE* at the end of the header. Implies
5353 `-s`.
5454
55−-B *FILE*, --include-before-body=*FILE*
55+-B *FILE*, \--include-before-body=*FILE*
5656: Include contents of *FILE* at the beginning of the document body.
5757
58−-A *FILE*, --include-after-body=*FILE*
58+-A *FILE*, \--include-after-body=*FILE*
5959: Include contents of *FILE* at the end of the document body.
6060
61−-C *FILE*, --custom-header=*FILE*
61+-C *FILE*, \--custom-header=*FILE*
6262: Use contents of *FILE*
6363 as the document header (overriding the default header, which can be
6464 printed using `pandoc -D markdown`). Implies `-s`.
@@ -72,7 +72,7 @@ regular `pandoc` options by the delimiter \``--`', as in
7272 html2markdown -o foo.txt -- -g 'curl -u bar:baz' -e latin1 \
7373 www.foo.com
7474
75−-e *encoding*, --encoding=*encoding*
75+-e *encoding*, \--encoding=*encoding*
7676: Assume the character encoding *encoding* in reading HTML.
7777 (Note: *encoding* will be passed to `iconv`; a list of
7878 available encodings may be obtained using `iconv -l`.)
@@ -82,7 +82,7 @@ regular `pandoc` options by the delimiter \``--`', as in
8282 specified in this way, or if input is from STDIN, UTF-8 will be
8383 assumed.
8484
85−-g *command*, --grabber=*command*
85+-g *command*, \--grabber=*command*
8686: Use *command* to fetch the contents of a URL. (By default,
8787 `html2markdown` searches for an available program or text-based
8888 browser to fetch the contents of a URL.)
man/man1/markdown2pdf.1.md+7−7
@@ -39,26 +39,26 @@ latex setup, they can be obtained from <http://ctan.org>.
3939See `pandoc`(1) for a complete list.
4040The following options are most relevant:
4141
42−-o *FILE*, --output=*FILE*
42+-o *FILE*, \--output=*FILE*
4343: Write output to *FILE*.
4444
45−--strict
45+\--strict
4646: Use strict markdown syntax, with no extensions or variants.
4747
48−-N, --number-sections
48+-N, \--number-sections
4949: Number section headings in LaTeX output. (Default is not to number them.)
5050
51−-H *FILE*, --include-in-header=*FILE*
51+-H *FILE*, \--include-in-header=*FILE*
5252: Include (LaTeX) contents of *FILE* at the end of the header. Implies
5353 `-s`.
5454
55−-B *FILE*, --include-before-body=*FILE*
55+-B *FILE*, \--include-before-body=*FILE*
5656: Include (LaTeX) contents of *FILE* at the beginning of the document body.
5757
58−-A *FILE*, --include-after-body=*FILE*
58+-A *FILE*, \--include-after-body=*FILE*
5959: Include (LaTeX) contents of *FILE* at the end of the document body.
6060
61−-C *FILE*, --custom-header=*FILE*
61+-C *FILE*, \--custom-header=*FILE*
6262: Use contents of *FILE*
6363 as the LaTeX document header (overriding the default header, which can be
6464 printed using `pandoc -D latex`). Implies `-s`.
man/man1/pandoc.1.md+24−24
@@ -58,12 +58,12 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
5858
5959# OPTIONS
6060
61−-f *FORMAT*, -r *FORMAT*, --from=*FORMAT*, --read=*FORMAT*
61+-f *FORMAT*, -r *FORMAT*, \--from=*FORMAT*, \--read=*FORMAT*
6262: Specify input format. *FORMAT* can be
6363 `native` (native Haskell), `markdown` (markdown or plain text),
6464 `rst` (reStructuredText), `html` (HTML), or `latex` (LaTeX).
6565
66−-t *FORMAT*, -w *FORMAT*, --to=*FORMAT*, --write=*FORMAT*
66+-t *FORMAT*, -w *FORMAT*, \--to=*FORMAT*, \--write=*FORMAT*
6767: Specify output format. *FORMAT* can be `native` (native Haskell),
6868 `man` (groff man page),
6969 `markdown` (markdown or plain text), `rst` (reStructuredText),
@@ -71,71 +71,71 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
7171 `docbook` (DocBook XML), `s5` (S5 HTML and javascript slide show),
7272 or `rtf` (rich text format).
7373
74−-s, --standalone
74+-s, \--standalone
7575: Produce output with an appropriate header and footer (e.g. a
7676 standalone HTML, LaTeX, or RTF file, not a fragment).
7777
78−-o *FILE*, --output=*FILE*
78+-o *FILE*, \--output=*FILE*
7979: Write output to *FILE* instead of STDOUT. If *FILE* is
8080 \``-`', output will go to STDOUT.
8181
82−-p, --preserve-tabs
82+-p, \--preserve-tabs
8383: Preserve tabs instead of converting them to spaces.
8484
85−--tab-stop=*TABSTOP*
85+\--tab-stop=*TABSTOP*
8686: Specify tab stop (default is 4).
8787
88−--strict
88+\--strict
8989: Use strict markdown syntax, with no extensions or variants.
9090
91−--reference-links
91+\--reference-links
9292: Use reference-style links, rather than inline links, in writing markdown
9393 or reStructuredText.
9494
95−-R, --parse-raw
95+-R, \--parse-raw
9696: Parse untranslatable HTML codes and LaTeX environments as raw HTML
9797 or LaTeX, instead of ignoring them.
9898
99−-S, --smart
99+-S, \--smart
100100: Use smart quotes, dashes, and ellipses. (This option is significant
101101 only when the input format is `markdown`. It is selected automatically
102102 when the output format is `latex`.)
103103
104−-m, --asciimathml
104+-m, \--asciimathml
105105: Use ASCIIMathML to display embedded LaTeX math in HTML output.
106106
107−-i, --incremental
107+-i, \--incremental
108108: Make list items in S5 display incrementally (one by one).
109109
110−-N, --number-sections
110+-N, \--number-sections
111111: Number section headings in LaTeX output. (Default is not to number
112112 them.)
113113
114−-c *CSS*, --css=*CSS*
114+-c *CSS*, \--css=*CSS*
115115: Link to a CSS style sheet. *CSS* is the pathname of the style sheet.
116116
117−-H *FILE*, --include-in-header=*FILE*
117+-H *FILE*, \--include-in-header=*FILE*
118118: Include contents of *FILE* at the end of the header. Implies `-s`.
119119
120−-B *FILE*, --include-before-body=*FILE*
120+-B *FILE*, \--include-before-body=*FILE*
121121: Include contents of *FILE* at the beginning of the document body.
122122
123−-A *FILE*, --include-after-body=*FILE*
123+-A *FILE*, \--include-after-body=*FILE*
124124: Include contents of *FILE* at the end of the document body.
125125
126−-C *FILE*, --custom-header=*FILE*
126+-C *FILE*, \--custom-header=*FILE*
127127: Use contents of *FILE* as the document header (overriding the
128128 default header, which can be printed by using the `-D` option).
129129 Implies `-s`.
130130
131−-D *FORMAT*, --print-default-header=*FORMAT*
131+-D *FORMAT*, \--print-default-header=*FORMAT*
132132: Print the default header for *FORMAT* (`html`, `s5`, `latex`,
133133 `docbook`, `man`, `markdown`, `rst`, `rtf`).
134134
135−-T *STRING*, --title-prefix=*STRING*
135+-T *STRING*, \--title-prefix=*STRING*
136136: Specify *STRING* as a prefix to the HTML window title.
137137
138−--dump-args
138+\--dump-args
139139: Print information about command-line arguments to STDOUT, then exit.
140140 The first line of output contains the name of the output file specified
141141 with the `-o` option, or \``-`' (for STDOUT) if no output file was
@@ -145,7 +145,7 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
145145 after a \``--`' separator at the end of the line.
146146 This option is intended primarily for use in wrapper scripts.
147147
148−--ignore-args
148+\--ignore-args
149149: Ignore command-line arguments (for use in wrapper scripts).
150150 Regular Pandoc options are not ignored. Thus, for example,
151151
@@ -155,10 +155,10 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
155155
156156: pandoc -o foo.html -s
157157
158−-v, --version
158+-v, \--version
159159: Print version.
160160
161−-h, --help
161+-h, \--help
162162: Show usage message.
163163
164164# SEE ALSO