-f FORMAT,
-r FORMAT,
--from=FORMAT,
--read=FORMAT
Specify input format. FORMAT can be
native (native Haskell),
json (JSON version of native AST),
markdown (pandoc’s extended markdown),
markdown_strict (original unextended
markdown), markdown_phpextra (PHP
Markdown Extra extended markdown),
markdown_github (github extended
markdown), textile (Textile),
rst (reStructuredText),
html (HTML), docbook
(DocBook XML), mediawiki (MediaWiki
markup), or latex (LaTeX). If
+lhs is appended to
markdown, rst,
latex, the input will be treated as
literate Haskell source: see
Literate Haskell
support, below. Markdown syntax extensions can be
individually enabled or disabled by appending
+EXTENSION or
-EXTENSION to the format name. So, for
example,
markdown_strict+footnotes+definition_lists
is strict markdown with footnotes and definition lists
enabled, and
markdown-pipe_tables+hard_line_breaks is
pandoc’s markdown without pipe tables and with hard line
breaks. See Pandoc’s
markdown, below, for a list of extensions and their
names.
-t FORMAT,
-w FORMAT,
--to=FORMAT,
--write=FORMAT
Specify output format. FORMAT can be
native (native Haskell),
json (JSON version of native AST),
plain (plain text),
markdown (pandoc’s extended markdown),
markdown_strict (original unextended
markdown), markdown_phpextra (PHP
Markdown extra extended markdown),
markdown_github (github extended
markdown), rst (reStructuredText),
html (XHTML 1), html5
(HTML 5), latex (LaTeX),
beamer (LaTeX beamer slide show),
context (ConTeXt), man
(groff man), mediawiki (MediaWiki
markup), textile (Textile),
org (Emacs Org-Mode),
texinfo (GNU Texinfo),
docbook (DocBook XML),
opendocument (OpenDocument XML),
odt (OpenOffice text document),
docx (Word docx), epub
(EPUB book), epub3 (EPUB v3),
fb2 (FictionBook2 e-book),
asciidoc (AsciiDoc),
slidy (Slidy HTML and javascript slide
show), slideous (Slideous HTML and
javascript slide show), dzslides (HTML5 +
javascript slide show), s5 (S5 HTML and
javascript slide show), or rtf (rich text
format). Note that odt,
epub, and epub3 output
will not be directed to stdout; an
output filename must be specified using the
-o/--output option. If
+lhs is appended to
markdown, rst,
latex, beamer,
html, or html5, the
output will be rendered as literate Haskell source: see
Literate Haskell
support, below. Markdown syntax extensions can be
individually enabled or disabled by appending
+EXTENSION or
-EXTENSION to the format name, as
described above under -f.
-o FILE,
--output=FILE
Write output to FILE instead of
stdout. If FILE is
-, output will go to
stdout. (Exception: if the output
format is odt, docx,
epub, or epub3, output
to stdout is disabled.)
--data-dir=DIRECTORY
Specify the user data directory to search for pandoc data files. If this option is not specified, the default user data directory will be used. This is
$HOME/.pandoc
in unix,
C:\Documents And Settings\USERNAME\Application Data\pandoc
in Windows XP, and
C:\Users\USERNAME\AppData\Roaming\pandoc
in Windows 7. (You can find the default user data directory
on your system by looking at the output of
pandoc --version.) A
reference.odt,
reference.docx,
default.csl, epub.css,
templates, slidy,
slideous, or s5
directory placed in this directory will override pandoc’s
normal defaults.
-v, --version
Print version.
-h, --help
Show usage message.
-R, --parse-raw
Parse untranslatable HTML codes and LaTeX environments as
raw HTML or LaTeX, instead of ignoring them. Affects only
HTML and LaTeX input. Raw HTML can be printed in markdown,
reStructuredText, HTML, Slidy, Slideous, DZSlides, and S5
output; raw LaTeX can be printed in markdown,
reStructuredText, LaTeX, and ConTeXt output. The default is
for the readers to omit untranslatable HTML codes and LaTeX
environments. (The LaTeX reader does pass through
untranslatable LaTeX commands, even if
-R is not specified.)
-S, --smart
Produce typographically correct output, converting straight
quotes to curly quotes, --- to em-dashes,
-- to en-dashes, and
... to ellipses. Nonbreaking spaces are
inserted after certain abbreviations, such as
“Mr.” (Note: This option is significant only
when the input format is markdown,
markdown_strict, or
textile. It is selected automatically
when the input format is textile or the
output format is latex or
context, unless
--no-tex-ligatures is used.)
--old-dashes
Selects the pandoc <= 1.8.2.1 behavior for parsing smart
dashes: - before a numeral is an en-dash,
and -- is an em-dash. This option is
selected automatically for textile input.
--base-header-level=NUMBER
Specify the base level for headers (defaults to 1).
--indented-code-classes=CLASSES
Specify classes to use for indented code blocks–for example,
perl,numberLines or
haskell. Multiple classes may be
separated by spaces or commas.
--default-image-extension=EXTENSION
Specify a default extension to use when image paths/URLs have no extension. This allows you to use the same source for formats that require different kinds of images. Currently this option only affects the markdown and LaTeX readers.
--normalize
Normalize the document after reading: merge adjacent
Str or Emph elements,
for example, and remove repeated Spaces.
-p, --preserve-tabs
Preserve tabs instead of converting them to spaces (the default). Note that this will only affect tabs in literal code spans and code blocks; tabs in regular text will be treated as spaces.
--tab-stop=NUMBER
Specify the number of spaces per tab (default is 4).
-s, --standalone
Produce output with an appropriate header and footer (e.g. a
standalone HTML, LaTeX, or RTF file, not a fragment). This
option is set automatically for pdf,
epub, epub3,
fb2, docx, and
odt output.
--template=FILE
Use FILE as a custom template for the
generated document. Implies --standalone.
See Templates below for a
description of template syntax. If no extension is
specified, an extension corresponding to the writer will be
added, so that --template=special looks
for special.html for HTML output. If the
template is not found, pandoc will search for it in the user
data directory (see --data-dir). If this
option is not used, a default template appropriate for the
output format will be used (see
-D/--print-default-template).
-V KEY[=VAL],
--variable=KEY[:VAL]
Set the template variable KEY to the
value VAL when rendering the document
in standalone mode. This is generally only useful when the
--template option is used to specify a
custom template, since pandoc automatically sets the
variables used in the default templates. If no
VAL is specified, the key will be given
the value true.
-D FORMAT,
--print-default-template=FORMAT
Print the default template for an output
FORMAT. (See -t for
a list of possible FORMATs.)
--no-wrap
Disable text wrapping in output. By default, text is wrapped appropriately for the output format.
--columns=NUMBER
Specify length of lines in characters (for text wrapping).
--toc,
--table-of-contents
Include an automatically generated table of contents (or, in
the case of latex,
context, and rst, an
instruction to create one) in the output document. This
option has no effect on man,
docbook, slidy,
slideous, or s5
output.
--toc-depth=NUMBER
Specify the number of section levels to include in the table
of contents. The default is 3 (which means that level 1, 2,
and 3 headers will be listed in the contents). Implies
--toc.
--no-highlight
Disables syntax highlighting for code blocks and inlines, even when a language attribute is given.
--highlight-style=STYLE
Specifies the coloring style to be used in highlighted
source code. Options are pygments (the
default), kate,
monochrome, espresso,
zenburn, haddock, and
tango.
-H FILE,
--include-in-header=FILE
Include contents of FILE, verbatim, at
the end of the header. This can be used, for example, to
include special CSS or javascript in HTML documents. This
option can be used repeatedly to include multiple files in
the header. They will be included in the order specified.
Implies --standalone.
-B FILE,
--include-before-body=FILE
Include contents of FILE, verbatim, at
the beginning of the document body (e.g. after the
<body> tag in HTML, or the
\begin{document} command in LaTeX). This
can be used to include navigation bars or banners in HTML
documents. This option can be used repeatedly to include
multiple files. They will be included in the order
specified. Implies --standalone.
-A FILE,
--include-after-body=FILE
Include contents of FILE, verbatim, at
the end of the document body (before the
</body> tag in HTML, or the
\end{document} command in LaTeX). This
option can be be used repeatedly to include multiple files.
They will be included in the order specified. Implies
--standalone.
--self-contained
Produce a standalone HTML file with no external
dependencies, using data: URIs to
incorporate the contents of linked scripts, stylesheets,
images, and videos. The resulting file should be
“self-contained,” in the sense that it needs no
external files and no net access to be displayed properly by
a browser. This option works only with HTML output formats,
including html, html5,
html+lhs, html5+lhs,
s5, slidy,
slideous, and
dzslides. Scripts, images, and
stylesheets at absolute URLs will be downloaded; those at
relative URLs will be sought first relative to the working
directory, then relative to the user data directory (see
--data-dir), and finally relative to
pandoc’s default data directory.
--offline
Deprecated synonym for --self-contained.
-5, --html5
Produce HTML5 instead of HTML4. This option has no effect
for writers other than html.
(Deprecated: Use the
html5 output format instead.)
--html-q-tags
Use <q> tags for quotes in HTML.
--ascii
Use only ascii characters in output. Currently supported only for HTML output (which uses numerical entities instead of UTF-8 when this option is selected).
--reference-links
Use reference-style links, rather than inline links, in writing markdown or reStructuredText. By default inline links are used.
--atx-headers
Use ATX style headers in markdown output. The default is to use setext-style headers for levels 1-2, and then ATX headers.
--chapters
Treat top-level headers as chapters in LaTeX, ConTeXt, and
DocBook output. When the LaTeX template uses the report,
book, or memoir class, this option is implied. If
--beamer is used, top-level headers will
become \part{..}.
-N, --number-sections
Number section headings in LaTeX, ConTeXt, HTML, or EPUB
output. By default, sections are not numbered. Sections with
class unnumbered will never be numbered,
even if --number-sections is specified.
--number-offset=NUMBER[,NUMBER,…],
Offset for section headings in HTML output (ignored in other
output formats). The first number is added to the section
number for top-level headers, the second for second-level
headers, and so on. So, for example, if you want the first
top-level header in your document to be numbered
“6”, specify
--number-offset=5. If your document
starts with a level-2 header which you want to be numbered
“1.5”, specify
--number-offset=1,4. Offsets are 0 by
default. Implies --number-sections.
--no-tex-ligatures
Do not convert quotation marks, apostrophes, and dashes to
the TeX ligatures when writing LaTeX or ConTeXt. Instead,
just use literal unicode characters. This is needed for
using advanced OpenType features with XeLaTeX and LuaLaTeX.
Note: normally --smart is selected
automatically for LaTeX and ConTeXt output, but it must be
specified explicitly if
--no-tex-ligatures is selected. If you
use literal curly quotes, dashes, and ellipses in your
source, then you may want to use
--no-tex-ligatures without
--smart.
--listings
Use listings package for LaTeX code blocks
-i, --incremental
Make list items in slide shows display incrementally (one by one). The default is for lists to be displayed all at once.
--slide-level=NUMBER
Specifies that headers with the specified level create
slides (for beamer,
s5, slidy,
slideous, dzslides).
Headers above this level in the hierarchy are used to divide
the slide show into sections; headers below this level
create subheads within a slide. The default is to set the
slide level based on the contents of the document; see
Structuring the
slide show, below.
--section-divs
Wrap sections in <div> tags (or
<section> tags in HTML5), and
attach identifiers to the enclosing
<div> (or
<section>) rather than the header
itself. See
Section
identifiers, below.
--email-obfuscation=none|javascript|references
Specify a method for obfuscating mailto:
links in HTML documents. none leaves
mailto: links as they are.
javascript obfuscates them using
javascript. references obfuscates them
by printing their letters as decimal or hexadecimal
character references.
--id-prefix=STRING
Specify a prefix to be added to all automatically generated identifiers in HTML and DocBook output, and to footnote numbers in markdown output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.
-T STRING,
--title-prefix=STRING
Specify STRING as a prefix at the
beginning of the title that appears in the HTML header (but
not in the title as it appears at the beginning of the HTML
body). Implies --standalone.
-c URL,
--css=URL
Link to a CSS style sheet. This option can be be used repeatedly to include multiple files. They will be included in the order specified.
--reference-odt=FILE
Use the specified file as a style reference in producing an
ODT. For best results, the reference ODT should be a
modified version of an ODT produced using pandoc. The
contents of the reference ODT are ignored, but its
stylesheets are used in the new ODT. If no reference ODT is
specified on the command line, pandoc will look for a file
reference.odt in the user data directory
(see --data-dir). If this is not found
either, sensible defaults will be used.
--reference-docx=FILE
Use the specified file as a style reference in producing a
docx file. For best results, the reference docx should be a
modified version of a docx file produced using pandoc. The
contents of the reference docx are ignored, but its
stylesheets are used in the new docx. If no reference docx
is specified on the command line, pandoc will look for a
file reference.docx in the user data
directory (see --data-dir). If this is
not found either, sensible defaults will be used. The
following styles are used by pandoc: [paragraph] Normal,
Title, Authors, Date, Heading 1, Heading 2, Heading 3,
Heading 4, Heading 5, Block Quote, Definition Term,
Definition, Body Text, Table Caption, Image Caption;
[character] Default Paragraph Font, Body Text Char, Verbatim
Char, Footnote Ref, Link.
--epub-stylesheet=FILE
Use the specified CSS file to style the EPUB. If no
stylesheet is specified, pandoc will look for a file
epub.css in the user data directory (see
--data-dir). If it is not found there,
sensible defaults will be used.
--epub-cover-image=FILE
Use the specified image as the EPUB cover. It is recommended that the image be less than 1000px in width and height.
--epub-metadata=FILE
Look in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements, as documented at http://dublincore.org/documents/dces/. For example:
<dc:rights>Creative Commons</dc:rights> <dc:language>es-AR</dc:language>
By default, pandoc will include the following metadata
elements: <dc:title> (from the
document title), <dc:creator> (from
the document authors), <dc:date>
(from the document date, which should be in
ISO 8601
format), <dc:language>
(from the lang variable, or, if is not
set, the locale), and
<dc:identifier id="BookId">
(a randomly generated UUID). Any of these may be overridden
by elements in the metadata file.
--epub-embed-font=FILE
Embed the specified font in the EPUB. This option can be
repeated to embed multiple fonts. To use embedded fonts, you
will need to add declarations like the following to your CSS
(see --epub-stylesheet):
@font-face {
font-family: DejaVuSans;
font-style: normal;
font-weight: normal;
src:url("DejaVuSans-Regular.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: normal;
font-weight: bold;
src:url("DejaVuSans-Bold.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: italic;
font-weight: normal;
src:url("DejaVuSans-Oblique.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: italic;
font-weight: bold;
src:url("DejaVuSans-BoldOblique.ttf");
}
body { font-family: "DejaVuSans"; }
--epub-chapter-level=NUMBER
Specify the header level at which to split the EPUB into separate “chapter” files. The default is to split into chapters at level 1 headers. This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users. Some readers may be slow if the chapter files are too large, so for large documents with few level 1 headers, one might want to use a chapter level of 2 or 3.
--latex-engine=pdflatex|lualatex|xelatex
Use the specified LaTeX engine when producing PDF output.
The default is pdflatex. If the engine is
not in your PATH, the full path of the engine may be
specified here.
--bibliography=FILE
Specify bibliography database to be used in resolving
citations. The database type will be determined from the
extension of FILE, which may be
.mods (MODS format),
.bib (BibLaTeX format, which will
normally work for BibTeX files as well),
.bibtex (BibTeX format),
.ris (RIS format),
.enl (EndNote format),
.xml (EndNote XML format),
.wos (ISI format),
.medline (MEDLINE format),
.copac (Copac format), or
.json (citeproc JSON). If you want to use
multiple bibliographies, just use this option repeatedly.
--csl=FILE
Specify CSL style to be used in formatting citations and the bibliography. If FILE is not found, pandoc will look for it in
$HOME/.csl
in unix,
C:\Documents And Settings\USERNAME\Application Data\csl
in Windows XP, and
C:\Users\USERNAME\AppData\Roaming\csl
in Windows 7. If the --csl option is not
specified, pandoc will use a default style: either
default.csl in the user data directory
(see --data-dir), or, if that is not
present, the Chicago author-date style.
--citation-abbreviations=FILE
Specify a file containing abbreviations for journal titles
and other bibliographic fields (indicated by setting
form="short" in the CSL node
for the field). The format is described at
http://citationstylist.org/2011/10/19/abbreviations-for-zotero-test-release/.
Here is a short example:
{ "default": {
"container-title": {
"Lloyd's Law Reports": "Lloyd's Rep",
"Estates Gazette": "EG",
"Scots Law Times": "SLT"
}
}
}
--natbib
Use natbib for citations in LaTeX output.
--biblatex
Use biblatex for citations in LaTeX output.
-m [URL],
--latexmathml[=URL]
Use the
LaTeXMathML
script to display embedded TeX math in HTML output. To
insert a link to a local copy of the
LaTeXMathML.js script, provide a
URL. If no URL is
provided, the contents of the script will be inserted
directly into the HTML header, preserving portability at the
price of efficiency. If you plan to use math on several
pages, it is much better to link to a copy of the script, so
it can be cached.
--mathml[=URL]
Convert TeX math to MathML (in docbook as
well as html and
html5). In standalone
html output, a small javascript (or a
link to such a script if a URL is
supplied) will be inserted that allows the MathML to be
viewed on some browsers.
--jsmath[=URL]
Use
jsMath
to display embedded TeX math in HTML output. The
URL should point to the jsMath load
script (e.g. jsMath/easy/load.js); if
provided, it will be linked to in the header of standalone
HTML documents. If a URL is not
provided, no link to the jsMath load script will be
inserted; it is then up to the author to provide such a link
in the HTML template.
--mathjax[=URL]
Use MathJax to
display embedded TeX math in HTML output. The
URL should point to the
MathJax.js load script. If a
URL is not provided, a link to the
MathJax CDN will be inserted.
--gladtex
Enclose TeX math in <eq> tags in
HTML output. These can then be processed by
gladTeX
to produce links to images of the typeset formulas.
--mimetex[=URL]
Render TeX math using the
mimeTeX
CGI script. If URL is not specified, it
is assumed that the script is at
/cgi-bin/mimetex.cgi.
--webtex[=URL]
Render TeX formulas using an external script that converts TeX formulas to images. The formula will be concatenated with the URL provided. If URL is not specified, the Google Chart API will be used.
--dump-args
Print information about command-line arguments to
stdout, then exit. This option is
intended primarily for use in wrapper scripts. The first
line of output contains the name of the output file
specified with the -o option, or
- (for stdout) if no
output file was specified. The remaining lines contain the
command-line arguments, one per line, in the order they
appear. These do not include regular Pandoc options and
their arguments, but do include any options appearing after
a -- separator at the end of the line.
--ignore-args
Ignore command-line arguments (for use in wrapper scripts). Regular Pandoc options are not ignored. Thus, for example,
pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
is equivalent to
pandoc -o foo.html -s