4ea1b2bdc0
option to pandoc, which forces it to stay as close as possible to official Markdown syntax. git-svn-id: https://pandoc.googlecode.com/svn/trunk@347 788f1e2b-df1e-0410-8736-df70ead52e1b
166 lines
4.8 KiB
Groff
166 lines
4.8 KiB
Groff
.TH PANDOC 1 "December 15, 2006" Pandoc "User Manuals"
|
|
.SH NAME
|
|
pandoc \- general markup converter
|
|
.SH SYNOPSIS
|
|
\fBpandoc\fR [\fIoptions\fR] [\fIinput\-file\fR]...
|
|
.SH DESCRIPTION
|
|
\fBPandoc\fR converts files from one markup format to another. It can
|
|
read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and
|
|
it can write markdown, reStructuredText, HTML, LaTeX, RTF, and S5 HTML
|
|
slide shows.
|
|
.PP
|
|
If no \fIinput\-file\fR is specified, input is read from STDIN.
|
|
Otherwise, the \fIinput\-files\fR are concatenated (with a blank
|
|
line between each) and used as input. Output goes to STDOUT by
|
|
default. For output to a file, use the \fB\-o\fR option:
|
|
.IP
|
|
.B pandoc \-o output.html input.txt
|
|
.PP
|
|
The input and output formats may be specified using command-line options
|
|
(see \fBOPTIONS\fR, below, for details). If these formats are not
|
|
specified explicitly, \fIPandoc\fR will attempt to determine them
|
|
from the extensions of the input and output filenames. If input comes
|
|
from STDIN or from a file with an unknown extension, the input is assumed
|
|
to be markdown. If no output filename is specified using the \fB\-o\fR
|
|
option, or if a filename is specified but its extension is unknown,
|
|
the output will default to HTML. Thus, for example,
|
|
.IP
|
|
.B pandoc -o chap1.tex chap1.txt
|
|
.PP
|
|
converts \fIchap1.txt\fR from markdown to LaTeX. And
|
|
.IP
|
|
.B pandoc README
|
|
.PP
|
|
converts \fIREADME\fR from markdown to HTML.
|
|
.PP
|
|
\fIPandoc\fR uses the UTF\-8 character encoding for both input and output.
|
|
If your local character encoding is not UTF\-8, you should pipe input
|
|
and output through \fBiconv\fR:
|
|
.IP
|
|
.B iconv \-t utf\-8 input.txt | pandoc | iconv \-f utf\-8
|
|
.PP
|
|
\fIPandoc\fR's HTML parser is not very forgiving. If your input is
|
|
HTML, consider running it through \fBtidy\fR(1) before passing it
|
|
to Pandoc. Or use \fBhtml2markdown\fR(1), a wrapper around \fBpandoc\fR.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-f \fIFORMAT\fB, \-r \fIFORMAT\fB, \-\-from=\fIFORMAT\fB, \-\-read=\fIFORMAT\fB
|
|
Specify input format.
|
|
.I FORMAT
|
|
can be
|
|
.B native
|
|
(native Haskell),
|
|
.B markdown
|
|
(markdown or plain text),
|
|
.B rst
|
|
(reStructuredText),
|
|
.B html
|
|
(HTML),
|
|
or
|
|
.B latex
|
|
(LaTeX).
|
|
.TP
|
|
.B \-t \fIFORMAT\fB, \-w \fIFORMAT\fB, \-\-to=\fIFORMAT\fB, \-\-write=\fIFORMAT\fB
|
|
Specify output format.
|
|
.I FORMAT
|
|
can be
|
|
.B native
|
|
(native Haskell),
|
|
.B markdown
|
|
(markdown or plain text),
|
|
.B rst
|
|
(reStructuredText),
|
|
.B html
|
|
(HTML),
|
|
.B latex
|
|
(LaTeX),
|
|
.B s5
|
|
(S5 HTML and javascript slide show),
|
|
or
|
|
.B rtf
|
|
(rich text format).
|
|
.TP
|
|
.B \-s, \-\-standalone
|
|
Produce output with an appropriate header and footer (e.g. a
|
|
standalone HTML, LaTeX, or RTF file, not a fragment).
|
|
.TP
|
|
.B \-o FILE, \-\-output=FILE
|
|
Write output to \fIFILE\fR instead of STDOUT.
|
|
.TP
|
|
.B \-p, \-\-preserve-tabs
|
|
Preserve tabs instead of converting them to spaces.
|
|
.TP
|
|
.B \-\-tab-stop=\fITABSTOP\fB
|
|
Specify tab stop (default is 4).
|
|
.TP
|
|
.B \-\-strict
|
|
Use strict markdown syntax, with no extensions or variants.
|
|
.TP
|
|
.B \-R, \-\-parse-raw
|
|
Parse untranslatable HTML codes and LaTeX environments as raw HTML
|
|
or LaTeX, instead of ignoring them.
|
|
.TP
|
|
.B \-S, \-\-smartypants
|
|
Use smart quotes, dashes, and ellipses in HTML output.
|
|
.TP
|
|
.B \-m, \-\-asciimathml
|
|
Use ASCIIMathML to display embedded LaTeX math in HTML output.
|
|
.TP
|
|
.B \-i, \-\-incremental
|
|
Make list items in S5 display incrementally (one by one).
|
|
.TP
|
|
.B \-N, \-\-number-sections
|
|
Number section headings in LaTeX output. (Default is not to number
|
|
them.)
|
|
.TP
|
|
.B \-c \fICSS\fB, \-\-css=\fICSS\fB
|
|
Link to a CSS style sheet.
|
|
.I CSS
|
|
is the pathname of the style sheet.
|
|
.TP
|
|
.B \-H \fIFILE\fB, \-\-include-in-header=\fIFILE\fB
|
|
Include contents of \fIFILE\fR at the end of the header. Implies
|
|
\fB\-s\fR.
|
|
.TP
|
|
.B \-B \fIFILE\fB, \-\-include-before-body=\fIFILE\fB
|
|
Include contents of \fIFILE\fR at the beginning of the document
|
|
body.
|
|
.TP
|
|
.B \-A \fIFILE\fB, \-\-include-after-body=\fIFILE\fB
|
|
Include contents of \fIFILE\fR at the end of the document body.
|
|
.TP
|
|
.B \-C \fIFILE\fB, \-\-custom-header=\fIFILE\fB
|
|
Use contents of \fIFILE\fR as the document header (overriding the
|
|
default header, which can be printed by using the \fB\-D\fR option).
|
|
Implies \fB-s\fR.
|
|
.TP
|
|
.B \-D \fIFORMAT\fB, \-\-print-default-header=\fIFORMAT\fB
|
|
Print the default header for \fIFORMAT\fR (\fIhtml, s5, latex,
|
|
markdown, rst, rtf\fR).
|
|
.TP
|
|
.B \-T \fISTRING\fB, \-\-title-prefix=\fISTRING\fB
|
|
Specify \fISTRING\fR as a prefix to the HTML window title.
|
|
.TP
|
|
.B \-d, \-\-debug
|
|
Print debugging information (names of input and output files) to
|
|
STDERR. Write output to STDOUT, even if an output file was specified
|
|
using the \fB\-o\fR option.
|
|
.TP
|
|
.B \-v, \-\-version
|
|
Print version.
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Show usage message.
|
|
|
|
.SH "SEE ALSO"
|
|
\fBhtml2markdown\fR(1),
|
|
\fBmarkdown2pdf\fR(1).
|
|
The
|
|
.I README
|
|
file distributed with Pandoc contains full documentation.
|
|
|
|
The Pandoc source code and all documentation may be downloaded from
|
|
<http://sophos.berkeley.edu/macfarlane/pandoc/>.
|
|
.SH AUTHOR
|
|
John MacFarlane
|