@@ -1,195 +0,0 @@
1−.TH PANDOC 1 "December 15, 2006" Pandoc "User Manuals"
2−.SH NAME
3−pandoc \- general markup converter
4−.SH SYNOPSIS
5−\fBpandoc\fR [\fIoptions\fR] [\fIinput\-file\fR]...
6−.SH DESCRIPTION
7−\fIPandoc\fR converts files from one markup format to another. It can
8−read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and
9−it can write markdown, reStructuredText, HTML, LaTeX, RTF, DocBook
10−XML, and S5 HTML slide shows.
11−.PP
12−If no \fIinput\-file\fR is specified, input is read from STDIN.
13−Otherwise, the \fIinput\-files\fR are concatenated (with a blank
14−line between each) and used as input. Output goes to STDOUT by
15−default. For output to a file, use the \fB\-o\fR option:
16−.IP
17−.B pandoc \-o output.html input.txt
18−.PP
19−The input and output formats may be specified using command-line options
20−(see \fBOPTIONS\fR, below, for details). If these formats are not
21−specified explicitly, \fIPandoc\fR will attempt to determine them
22−from the extensions of the input and output filenames. If input comes
23−from STDIN or from a file with an unknown extension, the input is assumed
24−to be markdown. If no output filename is specified using the \fB\-o\fR
25−option, or if a filename is specified but its extension is unknown,
26−the output will default to HTML. Thus, for example,
27−.IP
28−.B pandoc -o chap1.tex chap1.txt
29−.PP
30−converts \fIchap1.txt\fR from markdown to LaTeX. And
31−.IP
32−.B pandoc README
33−.PP
34−converts \fIREADME\fR from markdown to HTML.
35−.PP
36−Pandoc's version of markdown is an extended variant of standard
37−markdown: the differences are described in the \fIREADME\fR file in
38−the user documentation. If standard markdown syntax is desired, the
39−\fB\-\-strict\fR option may be used.
40−.PP
41−\fIPandoc\fR uses the UTF\-8 character encoding for both input and output.
42−If your local character encoding is not UTF\-8, you should pipe input
43−and output through \fBiconv\fR:
44−.IP
45−.B iconv \-t utf\-8 input.txt | pandoc | iconv \-f utf\-8
46−.PP
47−\fIPandoc\fR's HTML parser is not very forgiving. If your input is
48−HTML, consider running it through \fBtidy\fR(1) before passing it
49−to Pandoc. Or use \fBhtml2markdown\fR(1), a wrapper around \fBpandoc\fR.
50−
51−.SH OPTIONS
52−.TP
53−.B \-f \fIFORMAT\fB, \-r \fIFORMAT\fB, \-\-from=\fIFORMAT\fB, \-\-read=\fIFORMAT\fB
54−Specify input format.
55−.I FORMAT
56−can be
57−.B native
58−(native Haskell),
59−.B markdown
60−(markdown or plain text),
61−.B rst
62−(reStructuredText),
63−.B html
64−(HTML),
65−or
66−.B latex
67−(LaTeX).
68−.TP
69−.B \-t \fIFORMAT\fB, \-w \fIFORMAT\fB, \-\-to=\fIFORMAT\fB, \-\-write=\fIFORMAT\fB
70−Specify output format.
71−.I FORMAT
72−can be
73−.B native
74−(native Haskell),
75−.B markdown
76−(markdown or plain text),
77−.B rst
78−(reStructuredText),
79−.B html
80−(HTML),
81−.B latex
82−(LaTeX),
83−.B docbook
84−(DocBook XML),
85−.B s5
86−(S5 HTML and javascript slide show),
87−or
88−.B rtf
89−(rich text format).
90−.TP
91−.B \-s, \-\-standalone
92−Produce output with an appropriate header and footer (e.g. a
93−standalone HTML, LaTeX, or RTF file, not a fragment).
94−.TP
95−.B \-o FILE, \-\-output=FILE
96−Write output to \fIFILE\fR instead of STDOUT. If \fIFILE\fR is
97−`\-', output will go to STDOUT.
98−.TP
99−.B \-p, \-\-preserve-tabs
100−Preserve tabs instead of converting them to spaces.
101−.TP
102−.B \-\-tab-stop=\fITABSTOP\fB
103−Specify tab stop (default is 4).
104−.TP
105−.B \-\-strict
106−Use strict markdown syntax, with no extensions or variants.
107−.TP
108−.B \-\-reference\-links
109−Use reference-style links, rather than inline links, in writing markdown
110−or reStructuredText.
111−.TP
112−.B \-R, \-\-parse-raw
113−Parse untranslatable HTML codes and LaTeX environments as raw HTML
114−or LaTeX, instead of ignoring them.
115−.TP
116−.B \-S, \-\-smart
117−Use smart quotes, dashes, and ellipses. (This option is significant
118−only when the input format is \fBmarkdown\fR. It is selected automatically
119−when the output format is \fBlatex\fR.)
120−.TP
121−.B \-m, \-\-asciimathml
122−Use ASCIIMathML to display embedded LaTeX math in HTML output.
123−.TP
124−.B \-i, \-\-incremental
125−Make list items in S5 display incrementally (one by one).
126−.TP
127−.B \-N, \-\-number-sections
128−Number section headings in LaTeX output. (Default is not to number
129−them.)
130−.TP
131−.B \-c \fICSS\fB, \-\-css=\fICSS\fB
132−Link to a CSS style sheet.
133−.I CSS
134−is the pathname of the style sheet.
135−.TP
136−.B \-H \fIFILE\fB, \-\-include-in-header=\fIFILE\fB
137−Include contents of \fIFILE\fR at the end of the header. Implies
138−\fB\-s\fR.
139−.TP
140−.B \-B \fIFILE\fB, \-\-include-before-body=\fIFILE\fB
141−Include contents of \fIFILE\fR at the beginning of the document
142−body.
143−.TP
144−.B \-A \fIFILE\fB, \-\-include-after-body=\fIFILE\fB
145−Include contents of \fIFILE\fR at the end of the document body.
146−.TP
147−.B \-C \fIFILE\fB, \-\-custom-header=\fIFILE\fB
148−Use contents of \fIFILE\fR as the document header (overriding the
149−default header, which can be printed by using the \fB\-D\fR option).
150−Implies \fB-s\fR.
151−.TP
152−.B \-D \fIFORMAT\fB, \-\-print-default-header=\fIFORMAT\fB
153−Print the default header for \fIFORMAT\fR (\fBhtml, s5, latex, docbook,
154−markdown, rst, rtf\fR).
155−.TP
156−.B \-T \fISTRING\fB, \-\-title-prefix=\fISTRING\fB
157−Specify \fISTRING\fR as a prefix to the HTML window title.
158−.TP
159−.B \-\-dump\-args
160−Print information about command\-line arguments to STDOUT, then exit.
161−The first line of output contains the name of the output file specified
162−with the \fB\-o\fR option, or `\-' (for STDOUT) if no output file was
163−specified. The remaining lines contain the command\-line arguments,
164−one per line, in the order they appear. These do not include regular
165−Pandoc options and their arguments, but do include any options appearing
166−after a `\-\-' separator at the end of the line.
167−This option is intended primarily for use in wrapper scripts.
168−.TP
169−.B \-\-ignore\-args
170−Ignore command\-line arguments (for use in wrapper scripts).
171−Regular Pandoc options are not ignored. Thus, for example,
172−.IP
173−.B pandoc \-\-ignore\-args \-o foo.html \-s foo.txt -- -e latin1
174−.IP
175−is equivalent to
176−.IP
177−.B pandoc \-o foo.html \-s
178−.TP
179−.B \-v, \-\-version
180−Print version.
181−.TP
182−.B \-h, \-\-help
183−Show usage message.
184−
185−.SH "SEE ALSO"
186−\fBhtml2markdown\fR(1),
187−\fBmarkdown2pdf\fR(1).
188−The
189−.I README
190−file distributed with Pandoc contains full documentation.
191−
192−The Pandoc source code and all documentation may be downloaded from
193−<http://sophos.berkeley.edu/macfarlane/pandoc/>.
194−.SH AUTHOR
195−John MacFarlane