-f
FORMAT, -r
FORMAT,
--from=
FORMAT,
--read=
FORMATSpecify input format. FORMAT can be:
bibtex
(BibTeX bibliography)biblatex
(BibLaTeX bibliography)commonmark
(CommonMark Markdown)commonmark_x
(CommonMark Markdown with
extensions)creole
(Creole 1.0)csljson
(CSL
JSON bibliography)csv
(CSV table)tsv
(TSV
table)docbook
(DocBook)docx
(Word docx)dokuwiki
(DokuWiki markup)endnotexml
(EndNote
XML bibliography)epub
(EPUB)fb2
(FictionBook2
e-book)gfm
(GitHub-Flavored
Markdown), or the deprecated and less accurate
markdown_github
; use markdown_github
only if you need extensions not supported in gfm
.haddock
(Haddock
markup)html
(HTML)ipynb
(Jupyter
notebook)jats
(JATS
XML)jira
(Jira/Confluence
wiki markup)json
(JSON version of native AST)latex
(LaTeX)markdown
(Pandoc’s
Markdown)markdown_mmd
(MultiMarkdown)markdown_phpextra
(PHP Markdown
Extra)markdown_strict
(original unextended Markdown)mediawiki
(MediaWiki
markup)man
(roff
man)muse
(Muse)native
(native Haskell)odt
(ODT)opml
(OPML)org
(Emacs Org
mode)ris
(RIS
bibliography)rtf
(Rich Text
Format)rst
(reStructuredText)t2t
(txt2tags)textile
(Textile)tikiwiki
(TikiWiki
markup)twiki
(TWiki
markup)vimwiki
(Vimwiki)Extensions can be individually enabled or disabled by appending
+EXTENSION
or -EXTENSION
to the format name.
See Extensions below, for a
list of extensions and their names. See
--list-input-formats
and --list-extensions
,
below.
-t
FORMAT, -w
FORMAT,
--to=
FORMAT,
--write=
FORMATSpecify output format. FORMAT can be:
asciidoc
(AsciiDoc) or
asciidoctor
(AsciiDoctor)beamer
(LaTeX
beamer slide show)bibtex
(BibTeX bibliography)biblatex
(BibLaTeX bibliography)commonmark
(CommonMark Markdown)commonmark_x
(CommonMark Markdown with
extensions)context
(ConTeXt)csljson
(CSL
JSON bibliography)docbook
or docbook4
(DocBook 4)docbook5
(DocBook 5)docx
(Word docx)dokuwiki
(DokuWiki markup)epub
or epub3
(EPUB v3 book)epub2
(EPUB v2)fb2
(FictionBook2
e-book)gfm
(GitHub-Flavored
Markdown), or the deprecated and less accurate
markdown_github
; use markdown_github
only if you need extensions not supported in gfm
.haddock
(Haddock
markup)html
or html5
(HTML, i.e. HTML5/XHTML polyglot markup)html4
(XHTML 1.0 Transitional)icml
(InDesign
ICML)ipynb
(Jupyter
notebook)jats_archiving
(JATS XML, Archiving and Interchange
Tag Set)jats_articleauthoring
(JATS XML, Article Authoring Tag
Set)jats_publishing
(JATS XML, Journal Publishing Tag
Set)jats
(alias for jats_archiving
)jira
(Jira/Confluence
wiki markup)json
(JSON version of native AST)latex
(LaTeX)man
(roff
man)markdown
(Pandoc’s
Markdown)markdown_mmd
(MultiMarkdown)markdown_phpextra
(PHP Markdown
Extra)markdown_strict
(original unextended Markdown)markua
(Markua)mediawiki
(MediaWiki
markup)ms
(roff
ms)muse
(Muse)native
(native Haskell)odt
(OpenOffice text
document)opml
(OPML)opendocument
(OpenDocument)org
(Emacs Org
mode)pdf
(PDF)plain
(plain text)pptx
(PowerPoint
slide show)rst
(reStructuredText)rtf
(Rich Text
Format)texinfo
(GNU Texinfo)textile
(Textile)slideous
(Slideous HTML and
JavaScript slide show)slidy
(Slidy HTML and
JavaScript slide show)dzslides
(DZSlides HTML5 + JavaScript
slide show)revealjs
(reveal.js
HTML5 + JavaScript slide show)s5
(S5 HTML and JavaScript
slide show)tei
(TEI
Simple)xwiki
(XWiki
markup)zimwiki
(ZimWiki
markup)Note that odt
, docx
, epub
, and
pdf
output will not be directed to stdout unless
forced with -o -
.
Extensions can be individually enabled or disabled by appending
+EXTENSION
or -EXTENSION
to the format name.
See Extensions below, for a
list of extensions and their names. See
--list-output-formats
and --list-extensions
,
below.
-o
FILE,
--output=
FILEWrite output to FILE instead of stdout. If
FILE is -
, output will go to stdout, even
if a non-textual format (docx
, odt
,
epub2
, epub3
) is specified.
--data-dir=
DIRECTORYSpecify the user data directory to search for pandoc data files. If
this option is not specified, the default user data directory will be
used. On *nix and macOS systems this will be the pandoc
subdirectory of the XDG data directory (by default,
$HOME/.local/share
, overridable by setting the
XDG_DATA_HOME
environment variable). If that directory does
not exist and $HOME/.pandoc
exists, it will be used (for
backwards compatibility). On Windows the default user data directory is
C:\Users\USERNAME\AppData\Roaming\pandoc
. You can find the
default user data directory on your system by looking at the output of
pandoc --version
. Data files placed in this directory (for
example, reference.odt
, reference.docx
,
epub.css
, templates
) will override pandoc’s
normal defaults.
-d
FILE,
--defaults=
FILESpecify a set of default option settings. FILE is a YAML
file whose fields correspond to command-line option settings. All
options for document conversion, including input and output files, can
be set using a defaults file. The file will be searched for first in the
working directory, and then in the defaults
subdirectory of
the user data directory (see --data-dir
). The
.yaml
extension may be omitted. See the section Defaults files for more
information on the file format. Settings from the defaults file may be
overridden or extended by subsequent options on the command line.
--bash-completion
Generate a bash completion script. To enable bash completion with
pandoc, add this to your .bashrc
:
eval "$(pandoc --bash-completion)"
--verbose
Give verbose debugging output.
--quiet
Suppress warning messages.
--fail-if-warnings
Exit with error status if there are any warnings.
--log=
FILEWrite log messages in machine-readable JSON format to FILE.
All messages above DEBUG level will be written, regardless of verbosity
settings (--verbose
, --quiet
).
--list-input-formats
List supported input formats, one per line.
--list-output-formats
List supported output formats, one per line.
--list-extensions
[=
FORMAT]List supported extensions for FORMAT, one per line, preceded
by a +
or -
indicating whether it is enabled
by default in FORMAT. If FORMAT is not specified,
defaults for pandoc’s Markdown are given.
--list-highlight-languages
List supported languages for syntax highlighting, one per line.
--list-highlight-styles
List supported styles for syntax highlighting, one per line. See
--highlight-style
.
-v
, --version
Print version.
-h
, --help
Show usage message.