{
"name": "pandoc",
"description": "A universal document converter",
"options": [
{
"names": [
"-f",
"-r",
"--from",
"--read"
],
"description": "Specify input format",
"takes_arg": true,
"arg": {
"name": "format"
}
},
{
"names": [
"-t",
"-w",
"--to",
"--write"
],
"description": "Specify output format",
"takes_arg": true,
"arg": {
"name": "format"
}
},
{
"names": [
"-o",
"--output"
],
"description": "Write output to FILE instead of stdout",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--data-dir"
],
"description": "Specify the user data directory to search for pandoc data files",
"takes_arg": true,
"arg": {
"name": "directory",
"template": "folders"
}
},
{
"names": [
"-d",
"--defaults"
],
"description": "Specify a set of default option settings",
"takes_arg": true,
"arg": {
"name": "file"
}
},
{
"names": [
"--bash-completion"
],
"description": "Generate a bash completion script"
},
{
"names": [
"--verbose"
],
"description": "Give verbose debugging output"
},
{
"names": [
"--quiet"
],
"description": "Suppress warning messages"
},
{
"names": [
"--fail-if-warnings"
],
"description": "Exit with error status if there are any warnings"
},
{
"names": [
"--log"
],
"description": "Write log messages in machine-readable JSON format to FILE",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--list-input-formats"
],
"description": "List supported input formats, one per line"
},
{
"names": [
"--list-output-formats"
],
"description": "List supported output formats, one per line"
},
{
"names": [
"--list-extensions"
],
"description": "List supported extensions for FORMAT, one per line, preceded by a + or - indicating whether it is enabled by default in FORMAT",
"takes_arg": true,
"arg": {
"name": "format"
}
},
{
"names": [
"--list-highlight-languages"
],
"description": "List supported languages for syntax highlighting, one per line"
},
{
"names": [
"--list-highlight-styles"
],
"description": "List supported styles for syntax highlighting, one per line"
},
{
"names": [
"-v",
"--version"
],
"description": "Print version"
},
{
"names": [
"-h",
"--help"
],
"description": "Show usage message"
},
{
"names": [
"--shift-heading-level-by"
],
"description": "Shift heading levels by a positive or negative integer",
"takes_arg": true,
"arg": {
"name": "number"
}
},
{
"names": [
"--indented-code-classes"
],
"description": "Specify classes to use for indented code blocks–for example, perl,numberLines or haskell. Multiple classes may be separated by spaces or commas",
"takes_arg": true,
"arg": {
"name": "classes"
}
},
{
"names": [
"--default-image-extension"
],
"description": "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 affect",
"takes_arg": true,
"arg": {
"name": "extension"
}
},
{
"names": [
"--file-scope"
],
"description": "Parse each file individually before combining for multifile documents. This will allow footnotes in different files with the same identifiers to work as expected"
},
{
"names": [
"-F",
"--filter"
],
"description": "Specify an executable to be used as a filter transforming the pandoc AST after the input is parsed and before the output is written",
"takes_arg": true,
"arg": {
"name": "executable",
"template": "filepaths"
}
},
{
"names": [
"-L",
"--lua-filter"
],
"description": "Transform the document in a similar fashion as JSON filters, but use pandoc’s built-in Lua filtering system",
"takes_arg": true,
"arg": {
"name": "script",
"template": "filepaths"
}
},
{
"names": [
"-M",
"--metadata"
],
"description": "Set the metadata field KEY to the value VAL",
"takes_arg": true,
"arg": {
"name": "key"
}
},
{
"names": [
"--metadata-file"
],
"description": "Read metadata from the supplied YAML (or JSON) file",
"takes_arg": true,
"arg": {
"name": "file"
}
},
{
"names": [
"-p",
"--preserve-tabs"
],
"description": "Preserve tabs instead of converting them to spaces"
},
{
"names": [
"--tab-stop"
],
"description": "Specify the number of spaces per tab",
"takes_arg": true,
"arg": {
"name": "number"
}
},
{
"names": [
"--track-changes"
],
"description": "Specifies what to do with insertions, deletions, and comments produced by the MS Word `Track Changes` feature",
"takes_arg": true,
"arg": {
"name": "mode",
"suggestions": [
"accept",
"reject",
"all"
]
}
},
{
"names": [
"--extract-media"
],
"description": "Extract images and other media contained in or linked from the source document to the path DIR, creating it if necessary, and adjust the images references in the document so they point to the extracte",
"takes_arg": true,
"arg": {
"name": "dir",
"template": "folders"
}
},
{
"names": [
"--abbreviations"
],
"description": "Specifies a custom abbreviations file, with abbreviations one to a line. If this option is not specified, pandoc will read the data file abbreviations from the user data directory or fall back on a sy",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"-s",
"--standalone"
],
"description": "Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option is set automatically for pdf, epub, epub3, fb2, docx, and odt output"
},
{
"names": [
"--template"
],
"description": "Use the specified file as a custom template for the generated document",
"takes_arg": true,
"arg": {
"name": "file or URL",
"template": "filepaths"
}
},
{
"names": [
"-V",
"--variable"
],
"description": "Set the template variable KEY to the value VAL when rendering the document in standalone mode. If no VAL is specified, the key will be given the value true",
"takes_arg": true,
"arg": {
"name": "key"
}
},
{
"names": [
"-D",
"--print-default-template"
],
"description": "Print the system default template for an output FORMAT. Templates in the user data directory are ignored",
"takes_arg": true,
"arg": {
"name": "format"
}
},
{
"names": [
"--print-default-data-file"
],
"description": "Print a system default data file. Files in the user data directory are ignored",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--eol"
],
"description": "Manually specify line endings: crlf (Windows), lf (macOS/Linux/UNIX), or native (line endings appropriate to the OS on which pandoc is being run). The default is native",
"takes_arg": true,
"arg": {
"name": "type",
"suggestions": [
"crlf",
"lf",
"native"
]
}
},
{
"names": [
"--dpi"
],
"description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/centimeters and vice versa",
"takes_arg": true,
"arg": {
"name": "number"
}
},
{
"names": [
"--wrap"
],
"description": "Determine how text is wrapped in the output (the source code, not the rendered version)",
"takes_arg": true,
"arg": {
"name": "mode",
"suggestions": [
"auto",
"none",
"preserve"
]
}
},
{
"names": [
"--columns"
],
"description": "Specify length of lines in characters. This affects text wrapping in the generated source code",
"takes_arg": true,
"arg": {
"name": "number"
}
},
{
"names": [
"--toc",
"--table-of-contents"
],
"description": "Include an automatically generated table of contents (or, in the case of latex, context, docx, odt, opendocument, rst, or ms, an instruction to create one) in the output document. It has no effect on "
},
{
"names": [
"--toc-depth"
],
"description": "Specify the number of section levels to include in the table of contents",
"takes_arg": true,
"arg": {
"name": "number"
}
},
{
"names": [
"--strip-comments"
],
"description": "Strip out HTML comments in the Markdown or Textile source, rather than passing them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML comments inside raw HTML blocks when"
},
{
"names": [
"--no-highlight"
],
"description": "Disables syntax highlighting for code blocks and inlines, even when a language attribute is given"
},
{
"names": [
"--highlight-style"
],
"description": "Specifies the coloring style to be used in highlighted source code",
"takes_arg": true,
"arg": {
"name": "STYLE|FILE",
"suggestions": [
"pygments",
"kate",
"monochrome",
"breezeDark",
"espresso",
"zenburn",
"haddock",
"tango"
],
"template": "filepaths"
}
},
{
"names": [
"--print-highlight-style"
],
"description": "Prints a JSON version of a highlighting style, which can be modified, saved with a .theme extension, and used with --highlight-style",
"takes_arg": true,
"arg": {
"name": "STYLE|FILE",
"suggestions": [
"pygments",
"kate",
"monochrome",
"breezeDark",
"espresso",
"zenburn",
"haddock",
"tango"
],
"template": "filepaths"
}
},
{
"names": [
"--syntax-definition"
],
"description": "Instructs pandoc to load a KDE XML syntax definition file, which will be used for syntax highlighting of appropriately marked code blocks",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"-H",
"--include-in-header"
],
"description": "Include contents of FILE, verbatim, at the end of the header",
"takes_arg": true,
"arg": {
"name": "FILE|URL",
"template": "filepaths"
}
},
{
"names": [
"-B",
"--include-before-body"
],
"description": "Include contents of FILE, verbatim, at the beginning of the document body",
"takes_arg": true,
"arg": {
"name": "FILE|URL",
"template": "filepaths"
}
},
{
"names": [
"-A",
"--include-after-body"
],
"description": "Include contents of FILE, verbatim, at the end of the document body",
"takes_arg": true,
"arg": {
"name": "FILE|URL",
"template": "filepaths"
}
},
{
"names": [
"--resource-path"
],
"description": "List of paths to search for images and other resources. If --resource-path is not specified, the default resource path is the working directory",
"takes_arg": true,
"arg": {
"name": "search path",
"description": "The paths should be separated by : on Linux, UNIX, and macOS systems, and by ; on Windows",
"template": "folders"
}
},
{
"names": [
"--request-header"
],
"description": "Set the request header NAME to the value VAL when making HTTP requests. If you’re behind a proxy, you also need to set the environment variable http_proxy to http://",
"takes_arg": true,
"arg": {
"name": "NAME:VAL"
}
},
{
"names": [
"--no-check-certificate"
],
"description": "Disable the certificate verification to allow access to unsecure HTTP resources"
},
{
"names": [
"--self-contained"
],
"description": "Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos"
},
{
"names": [
"--html-q-tags"
],
"description": "Use <q> tags for quotes in HTML. This option only has an effect if the smart extension is enabled"
},
{
"names": [
"--ascii"
],
"description": "Use only ASCII characters in output. Currently supported for XML, HTML formats, CommonMark, gfm, Markdown, roff ms , and to a limited degree LaTeX, roff man output uses ASCII by default"
},
{
"names": [
"--reference-links"
],
"description": "Use reference-style links, rather than inline links, in writing Markdown or reStructuredText"
},
{
"names": [
"--reference-location"
],
"description": "Specify whether footnotes (and references, if reference-links is set) are placed at the end of the current (top-level) block, the current section, or the document. Currently only affects the markdown ",
"takes_arg": true,
"arg": {
"name": "type",
"suggestions": [
"block",
"section",
"document"
]
}
},
{
"names": [
"--markdown-headings"
],
"description": "Specify whether to use ATX-style (#-prefixed) or Setext-style (underlined) headings for level 1 and 2 headings in Markdown output",
"takes_arg": true,
"arg": {
"name": "type",
"suggestions": [
"setext",
"atx"
]
}
},
{
"names": [
"--atx-headers"
],
"description": "Deprecated synonym for --markdown-headings=atx"
},
{
"names": [
"--top-level-division"
],
"description": "Treat top-level headings as the given division type in LaTeX, ConTeXt, DocBook, and TEI output",
"takes_arg": true,
"arg": {
"name": "mode",
"suggestions": [
"default",
"section",
"chapter",
"part"
]
}
},
{
"names": [
"-N",
"--number-sections"
],
"description": "Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB output. By default, sections are not numbered"
},
{
"names": [
"--number-offset"
],
"description": "Offset for section headings in HTML output (ignored in other output formats)",
"takes_arg": true,
"arg": {
"name": "number",
"description": "The first number is added to the section number for top-level headings, the second for second-level headings, and so on",
"is_variadic": true
}
},
{
"names": [
"--listings"
],
"description": "Use the listings package for LaTeX code blocks. The package does not support multi-byte encoding for source code. To handle UTF-8 you would need to use a custom template"
},
{
"names": [
"-i",
"--incremental"
],
"description": "Make list items in slide shows display incrementally"
},
{
"names": [
"--slide-level"
],
"description": "Specifies that headings with the specified level create slides (for beamer, s5, slidy, slideous, dzslides). Headings above this level in the hierarchy are used to divide the slide show into sections; ",
"takes_arg": true,
"arg": {
"name": "level",
"description": "Number"
}
},
{
"names": [
"--section-divs"
],
"description": "Wrap sections in <section> tags (or <div> tags for html4), and attach identifiers to the enclosing <section> (or <div>) rather than the heading itself"
},
{
"names": [
"--email-obfuscation"
],
"description": "Specify a method for obfuscating mailto: links in HTML documents references . The default is none",
"takes_arg": true,
"arg": {
"name": "type",
"suggestions": [
"none",
"javascript",
"references"
]
}
},
{
"names": [
"--id-prefix"
],
"description": "Specify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"-T",
"--title-prefix"
],
"description": "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)",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"-c",
"--css"
],
"description": "Link to a CSS style sheet. This option can be used repeatedly to include multiple files. They will be included in the order specified",
"takes_arg": true,
"arg": {
"name": "URL"
}
},
{
"names": [
"--reference-doc"
],
"description": "Use the specified file as a style reference in producing a docx or ODT file",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--epub-cover-image"
],
"description": "Use the specified image as the EPUB cover. It is recommended that the image be less than 1000px in width and height. Note that in a Markdown source document you can also specify cover-image in a YAML ",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--epub-metadata"
],
"description": "Look in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--epub-embed-font"
],
"description": "Embed the specified font in the EPUB. This option can be repeated to embed multiple fonts. Wildcards can also be used",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--pdf-engine"
],
"description": "Use the specified engine when producing PDF output",
"takes_arg": true,
"arg": {
"name": "program",
"suggestions": [
"pdflatex",
"lualatex",
"xelatex",
"latexmk",
"tectonic",
"wkhtmltopdf",
"weasyprint",
"prince",
"context",
"pdfroff"
]
}
},
{
"names": [
"--pdf-engine-opt"
],
"description": "Use the given string as a command-line argument to the pdf-engine",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"-C",
"--citeproc"
],
"description": "Process the citations in the file, replacing them with rendered citations and adding a bibliography. Citation processing will not take place unless bibliographic data is supplied, either through an ex"
},
{
"names": [
"--bibliography"
],
"description": "Set the bibliography field in the document’s metadata to FILE, overriding any value set in the metadata. If you supply this argument multiple times, each FILE will be added to bibliography. If FILE is",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--csl"
],
"description": "Set the csl field in the document’s metadata to FILE, overriding any value set in the metadata. (This is equivalent to --metadata csl=FILE.) If FILE is a URL, it will be fetched via HTTP. If FILE is n",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--citation-abbreviations"
],
"description": "Set the citation-abbreviations field in the document’s metadata to FILE, overriding any value set in the metadata. If FILE is a URL, it will be fetched via HTTP. If FILE is not found relative to the w",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--natbib"
],
"description": "Use natbib for citations in LaTeX output. It is intended for use in producing a LaTeX file that can be processed with bibtex"
},
{
"names": [
"--biblatex"
],
"description": "Use biblatex for citations in LaTeX output. It is intended for use in producing a LaTeX file that can be processed with bibtex or biber"
},
{
"names": [
"--mathjax"
],
"description": "Use MathJax to display embedded TeX math in HTML output. TeX math will be put between (...) (for inline math) or [...] (for display math) and wrapped in <span> tags with class math. Then the MathJax J",
"takes_arg": true,
"arg": {
"name": "URL"
}
},
{
"names": [
"--mathml"
],
"description": "Convert TeX math to MathML (in epub3, docbook4, docbook5, jats, html4 and html5). This is the default in odt output. Note that currently only Firefox and Safari (and select e-book readers) natively su"
},
{
"names": [
"--webtex"
],
"description": "Convert TeX formulas to <img> tags that link to an external script that converts formulas to images. The formula will be URL-encoded and concatenated with the URL provided. For SVG images you can for ",
"takes_arg": true,
"arg": {
"name": "URL"
}
},
{
"names": [
"--katex"
],
"description": "Use KaTeX to display embedded TeX math in HTML output. The URL is the base URL for the KaTeX library. That directory should contain a katex.min.js and a katex.min.css file. If a URL is not provided, a",
"takes_arg": true,
"arg": {
"name": "URL"
}
},
{
"names": [
"--gladtex"
],
"description": "Enclose TeX math in <eq> tags in HTML output. The resulting HTML can then be processed by GladTeX to produce SVG images of the typeset formulas and an HTML file with these images embedded"
},
{
"names": [
"--dump-args"
],
"description": "Print information about command-line arguments to stdout, then exit. This option is intended primarily for use in wrapper scripts"
},
{
"names": [
"--ignore-args"
],
"description": "Ignore command-line arguments (for use in wrapper scripts). Regular pandoc options are not ignored"
}
],
"args": [
{
"name": "input file(s)",
"is_variadic": true,
"template": "filepaths"
}
]
}