@@ -1,20 +1,168 @@
1−.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
1+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
22.SH NAME
33pandoc \- general markup converter
44.SH SYNOPSIS
5−.B pandoc [options] [input-files]
5+.B pandoc [
6+.I options
7+] [
8+.I input-files
9+]
10+
611.SH DESCRIPTION
7−.B pandoc
12+.I Pandoc
813converts files from one markup format to another. It can read markdown
9−and (with some limitations) reStructuredText, HTML, and LaTeX, and it
10−can write markdown, reStructuredText, HTML, LaTeX, RTF, and S5 HTML
11−slide shows.
14+and (subsets of) reStructuredText, HTML, and LaTeX, and it can write
15+markdown, reStructuredText, HTML, LaTeX, RTF, and S5 HTML slide shows.
16+.PP
17+If no
18+.I input-files
19+are specified, input is read from STDIN. Otherwise, the
20+.I input-files
21+are concatenated (with a blank line between each) and used
22+as input. Output goes to STDOUT. Use redirection to produce
23+a file:
24+.IP
25+.B pandoc input.txt > output.html
26+.PP
27+The default behavior of
28+.I Pandoc
29+is to convert the
30+input from markdown-formatted plain text to HTML. Different
31+input and output formats can be specified using command-line
32+options.
33+.PP
34+.I Pandoc
35+uses the UTF-8 character encoding for both input and output.
36+If your local character encoding is not UTF-8, you should pipe
37+input and output through
38+.B iconv
39+:
40+.IP
41+.B iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
42+
1243.SH OPTIONS
13−For full usage information, including command-line options,
14−type
15−.B pandoc -h
44+.TP
45+.B \-v, \-\-version
46+Print version.
47+.TP
48+.B \-h, \-\-help
49+Show usage message.
50+.TP
51+.B \-f FORMAT, \-r FORMAT, --from=FORMAT, --read=FORMAT
52+Specify input format.
53+.I FORMAT
54+can be
55+.I native
56+(native Haskell),
57+.I markdown
58+(markdown or plain text),
59+.I rst
60+(reStructuredText),
61+.I html
62+(HTML),
63+or
64+.I latex
65+(LaTeX).
66+.TP
67+.B \-t FORMAT, \-w FORMAT, --to=FORMAT, --write=FORMAT
68+Specify output format.
69+.I FORMAT
70+can be
71+.I native
72+(native Haskell),
73+.I markdown
74+(markdown or plain text),
75+.I rst
76+(reStructuredText),
77+.I html
78+(HTML),
79+.I latex
80+(LaTeX),
81+.I s5
82+(S5 HTML and javascript slide show),
83+or
84+.I rtf
85+(rich text format).
86+.TP
87+.B \-s, \-\-standalone
88+Produce output with an appropriate header and footer (e.g. a
89+standalone HTML, LaTeX, or RTF file, not a fragment).
90+.TP
91+.B \-p, \-\-preserve-tabs
92+Preserve tabs instead of converting them to spaces.
93+.TP
94+.B \-\-tab-stop=TABSTOP
95+Specify tab stop (default is 4).
96+.TP
97+.B \-R, \-\-parse-raw
98+Parse untranslatable HTML codes and LaTeX environments as raw HTML or
99+LaTeX, instead of ignoring them.
100+.TP
101+.B \-S, \-\-smartypants
102+Use smart quotes, dashes, and ellipses in HTML output.
103+.TP
104+.B \-m, \-\-asciimathml
105+Use ASCIIMathML to display embedded LaTeX math in HTML output.
106+.TP
107+.B \-i, \-\-incremental
108+Make list items in S5 display incrementally (one by one).
109+.TP
110+.B \-N, \-\-number-sections
111+Number section headings in LaTeX output. (Default is not to number them.)
112+.TP
113+.B \-c CSS, \-\-css=CSS
114+Link to a CSS style sheet.
115+.I CSS
116+is the pathname of the style sheet.
117+.TP
118+.B \-H FILENAME, \-\-include-in-header=FILENAME
119+Include contents of
120+.I FILENAME
121+at the end of the header. Implies
122+.B \-s.
123+.TP
124+.B \-B FILENAME, \-\-include-before-body=FILENAME
125+Include contents of
126+.I FILENAME
127+at the beginning of the document body.
128+.TP
129+.B \-A FILENAME, \-\-include-after-body=FILENAME
130+Include contents of
131+.I FILENAME
132+at the end of the document body.
133+.TP
134+.B \-\-custom-header=FILENAME
135+Use contents of
136+.I FILENAME
137+as the document header (overriding the default header, which can be
138+printed by using the
139+.B \-D
140+option). Implies
141+.B \-s.
142+.TP
143+.B \-D FORMAT, \-\-print-default-header=FORMAT
144+Print the default header for
145+.I FORMAT
146+(
147+.I html, s5, latex, markdown, rst, rtf
148+).
149+.TP
150+.B \-T STRING, \-\-title-prefix=STRING
151+Specify
152+.I STRING
153+as a prefix to the HTML window title.
154+
16155.SH AUTHOR
17−John MacFarlane <jgm at berkeley.edu>
156+John MacFarlane
157+
18158.SH "SEE ALSO"
19−markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
159+markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1), iconv (1)
160+
161+The
162+.B README
163+file distributed with Pandoc contains full documentation.
164+
165+The Pandoc source code and all documentation may be downloaded from
166+.B http://sophos.berkeley.edu/macfarlane/pandoc/
167+.
20168