通用选项

通用选项

-f FORMAT, -r FORMAT, —from=FORMAT, —read=FORMAT 指定输入格式. FORMAT 参数的取值可以是以下几种：

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)
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)
自定义 Lua reader 的 path, 具体参见自定义 readers 和 writers 相关章节 扩展可以单独地通过在指定格式后面添加 +EXTENSION 或者 -EXTENSION 来开启或者关闭. 详情参考扩展相关章节, 可以通过 —list-input-formats 和 —list-extensions 来查看支持的扩展列表以及对应扩展的名字.

-t FORMAT, -w FORMAT, —to=FORMAT, —write=FORMAT 指定输出格式. FORMAT 参数的取值可以是以下之一:

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)
自定义 Lua writer 的 path, 参见自定义 readers and writers 章节

odt, docx, epub, 和 pdf 格式的输出不会直接输出到标准输出，除非使用了 -o - 参数。

扩展可以单独地通过在指定格式后面添加 +EXTENSION 或者 -EXTENSION 来开启或者关闭. 详情参考扩展相关章节, 可以通过 —list-output-formats 和 —list-extensions 来查看支持的扩展列表以及对应扩展的名字.

-o FILE, —output=FILE

将输出写入到 FILE 而不是标准输出，如果 FILE 值为 -, 会输出到标准输出。即使不是文本输出（docx, odt, epub2, epub3）。

—data-dir=DIRECTORY

通过 —data-dir 配置选项来指定 pandoc 要在那个目录下搜索 pandoc 数据文件。如果改选项没有指定时，默认会使用用户数据目录，在 *nix 和 MacOS 系统下是 XDG 数据目录（默认是 $HOME/.local/share，可以通过设置 XDG_DATA_HOME 环境变量类覆盖）下的 pandoc 子目录。如果对应的目录不存在但是存在 $HOME/.pandoc 时，就会使用 $HOME/.pandoc 目录（这是为了向后兼容）。在 Windows 系统中默认目录是 C:\Users\USERNAME\AppData\Roaming\pandoc，可以通过命令 pandoc —version 来查看对应的数据目录。在该目录中存放的数据文件（比如 reference.odt, reference.docx, epub.css, templates）会覆盖 pandoc 的默认值。

-d FILE, --defaults=FILE

指定默认选项设置， FILE 是一个 YAML 文件，文件中的 field 就是对应的命令行设置参数。所有的文件转换参数，包括所有的输入和输出文件都可以通过默认文件来设置。pandoc 会首先在当前目录下搜素对应的文件，然后在默认的用户数据目录的子目录下搜索（参见 —data-dir）。.yaml 后缀是缺省后缀，参考 Defaults files 部分来获得关于文件格式的更多信息。defaults 文件中的配置会被命令行中的参数覆盖。

--bash-completion

生成 bash completion script. 要在 pandoc 中开启 bash completion, 添加下面的部分到 .bashrc 文件中:

eval "$(pandoc --bash-completion)"

--verbose 详细的 debug 输出.

--quiet 不展示 warning 信息.

--fail-if-warnings 在有 warning 产生的时候直接退出。

--log=FILE 将日志信息以机器可读的形式写入文件中。 所有非 DEBUG 等级的消息都会被写入，会忽略 verbosity 设置。（—verbose, —quiet）

--list-input-formats 展示所有支持的输入格式，每行一个格式。

--list-output-formats 展示所有支持的输出格式，每行一个。

--list-extensions[=FORMAT] 列出对应的 FORMAT 支持的扩展，每行一个，扩展前的 + 或者 - 表示对应的 FORMAT 是否默认开启。如果没有指定 FORMAT 的话默认就是 pandoc 的 Markdown。

没有指定任何格式的话默认是 pandoc 的 Markdown 格式

指定了对应的格式是 CSV 格式

--list-highlight-languages 列出支持语法高亮的语言有那些，每行一个。

--list-highlight-styles 列出支持语法高亮的样式有那些，每行一个。参见 —highlight-style。

-v, --version 打印版本

-h, --help 展示使用信息