git.iko.soy/typeable/pandoc
on master help sign in
Updated man page.
commitafd986d808ca7911039c11d49e7c77fc31d3a489 authorJohn MacFarlane <jgm@berkeley.edu> dateThu 14 Jul 2016, 22:57 (10 years ago) parent3d6e32b
1 file changed+60−47
man/pandoc.1+60−47
man/pandoc.1+60−47
@@ -1,5 +1,5 @@
11.\"t
2−.TH PANDOC 1 "June 4, 2016" "pandoc 1.17.1"
2+.TH PANDOC 1 "June 4, 2016" "pandoc 1.17.2"
33.SH NAME
44pandoc - general markup converter
55.SH SYNOPSIS
@@ -10,16 +10,16 @@ pandoc - general markup converter
1010Pandoc is a Haskell library for converting from one markup format to
1111another, and a command\-line tool that uses this library.
1212It can read Markdown, CommonMark, PHP Markdown Extra, GitHub\-Flavored
13−Markdown, and (subsets of) Textile, reStructuredText, HTML, LaTeX,
14−MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs Org mode,
15−DocBook, txt2tags, EPUB, ODT and Word docx; and it can write plain text,
16−Markdown, CommonMark, PHP Markdown Extra, GitHub\-Flavored Markdown,
17−reStructuredText, XHTML, HTML5, LaTeX (including \f[C]beamer\f[] slide
18−shows), ConTeXt, RTF, OPML, DocBook, OpenDocument, ODT, Word docx, GNU
19−Texinfo, MediaWiki markup, DokuWiki markup, Haddock markup, EPUB (v2 or
20−v3), FictionBook2, Textile, groff man pages, Emacs Org mode, AsciiDoc,
21−InDesign ICML, TEI Simple, and Slidy, Slideous, DZSlides, reveal.js or
22−S5 HTML slide shows.
13+Markdown, MultiMarkdown, and (subsets of) Textile, reStructuredText,
14+HTML, LaTeX, MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs
15+Org mode, DocBook, txt2tags, EPUB, ODT and Word docx; and it can write
16+plain text, Markdown, CommonMark, PHP Markdown Extra, GitHub\-Flavored
17+Markdown, MultiMarkdown, reStructuredText, XHTML, HTML5, LaTeX
18+(including \f[C]beamer\f[] slide shows), ConTeXt, RTF, OPML, DocBook,
19+OpenDocument, ODT, Word docx, GNU Texinfo, MediaWiki markup, DokuWiki
20+markup, ZimWiki markup, Haddock markup, EPUB (v2 or v3), FictionBook2,
21+Textile, groff man pages, Emacs Org mode, AsciiDoc, InDesign ICML, TEI
22+Simple, and Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows.
2323It can also produce PDF output on systems where LaTeX, ConTeXt, or
2424\f[C]wkhtmltopdf\f[] is installed.
2525.PP
@@ -212,12 +212,13 @@ Specify input format.
212212Markdown), \f[C]markdown_strict\f[] (original unextended Markdown),
213213\f[C]markdown_phpextra\f[] (PHP Markdown Extra),
214214\f[C]markdown_github\f[] (GitHub\-Flavored Markdown),
215−\f[C]commonmark\f[] (CommonMark Markdown), \f[C]textile\f[] (Textile),
216−\f[C]rst\f[] (reStructuredText), \f[C]html\f[] (HTML), \f[C]docbook\f[]
217−(DocBook), \f[C]t2t\f[] (txt2tags), \f[C]docx\f[] (docx), \f[C]odt\f[]
218−(ODT), \f[C]epub\f[] (EPUB), \f[C]opml\f[] (OPML), \f[C]org\f[] (Emacs
219−Org mode), \f[C]mediawiki\f[] (MediaWiki markup), \f[C]twiki\f[] (TWiki
220−markup), \f[C]haddock\f[] (Haddock markup), or \f[C]latex\f[] (LaTeX).
215+\f[C]markdown_mmd\f[] (MultiMarkdown), \f[C]commonmark\f[] (CommonMark
216+Markdown), \f[C]textile\f[] (Textile), \f[C]rst\f[] (reStructuredText),
217+\f[C]html\f[] (HTML), \f[C]docbook\f[] (DocBook), \f[C]t2t\f[]
218+(txt2tags), \f[C]docx\f[] (docx), \f[C]odt\f[] (ODT), \f[C]epub\f[]
219+(EPUB), \f[C]opml\f[] (OPML), \f[C]org\f[] (Emacs Org mode),
220+\f[C]mediawiki\f[] (MediaWiki markup), \f[C]twiki\f[] (TWiki markup),
221+\f[C]haddock\f[] (Haddock markup), or \f[C]latex\f[] (LaTeX).
221222If \f[C]+lhs\f[] is appended to \f[C]markdown\f[], \f[C]rst\f[],
222223\f[C]latex\f[], or \f[C]html\f[], the input will be treated as literate
223224Haskell source: see Literate Haskell support, below.
@@ -241,24 +242,25 @@ Specify output format.
241242\f[C]markdown_strict\f[] (original unextended Markdown),
242243\f[C]markdown_phpextra\f[] (PHP Markdown Extra),
243244\f[C]markdown_github\f[] (GitHub\-Flavored Markdown),
244−\f[C]commonmark\f[] (CommonMark Markdown), \f[C]rst\f[]
245−(reStructuredText), \f[C]html\f[] (XHTML), \f[C]html5\f[] (HTML5),
246−\f[C]latex\f[] (LaTeX), \f[C]beamer\f[] (LaTeX beamer slide show),
247−\f[C]context\f[] (ConTeXt), \f[C]man\f[] (groff man), \f[C]mediawiki\f[]
248−(MediaWiki markup), \f[C]dokuwiki\f[] (DokuWiki markup),
249−\f[C]textile\f[] (Textile), \f[C]org\f[] (Emacs Org mode),
250−\f[C]texinfo\f[] (GNU Texinfo), \f[C]opml\f[] (OPML), \f[C]docbook\f[]
251−(DocBook 4), \f[C]docbook5\f[] (DocBook 5), \f[C]opendocument\f[]
252−(OpenDocument), \f[C]odt\f[] (OpenOffice text document), \f[C]docx\f[]
253−(Word docx), \f[C]haddock\f[] (Haddock markup), \f[C]rtf\f[] (rich text
254−format), \f[C]epub\f[] (EPUB v2 book), \f[C]epub3\f[] (EPUB v3),
255−\f[C]fb2\f[] (FictionBook2 e\-book), \f[C]asciidoc\f[] (AsciiDoc),
256−\f[C]icml\f[] (InDesign ICML), \f[C]tei\f[] (TEI Simple), \f[C]slidy\f[]
257−(Slidy HTML and javascript slide show), \f[C]slideous\f[] (Slideous HTML
258−and javascript slide show), \f[C]dzslides\f[] (DZSlides HTML5 +
259−javascript slide show), \f[C]revealjs\f[] (reveal.js HTML5 + javascript
260−slide show), \f[C]s5\f[] (S5 HTML and javascript slide show), or the
261−path of a custom lua writer (see Custom writers, below).
245+\f[C]markdown_mmd\f[] (MultiMarkdown), \f[C]commonmark\f[] (CommonMark
246+Markdown), \f[C]rst\f[] (reStructuredText), \f[C]html\f[] (XHTML),
247+\f[C]html5\f[] (HTML5), \f[C]latex\f[] (LaTeX), \f[C]beamer\f[] (LaTeX
248+beamer slide show), \f[C]context\f[] (ConTeXt), \f[C]man\f[] (groff
249+man), \f[C]mediawiki\f[] (MediaWiki markup), \f[C]dokuwiki\f[] (DokuWiki
250+markup), \f[C]zimwiki\f[] (ZimWiki markup), \f[C]textile\f[] (Textile),
251+\f[C]org\f[] (Emacs Org mode), \f[C]texinfo\f[] (GNU Texinfo),
252+\f[C]opml\f[] (OPML), \f[C]docbook\f[] (DocBook 4), \f[C]docbook5\f[]
253+(DocBook 5), \f[C]opendocument\f[] (OpenDocument), \f[C]odt\f[]
254+(OpenOffice text document), \f[C]docx\f[] (Word docx), \f[C]haddock\f[]
255+(Haddock markup), \f[C]rtf\f[] (rich text format), \f[C]epub\f[] (EPUB
256+v2 book), \f[C]epub3\f[] (EPUB v3), \f[C]fb2\f[] (FictionBook2 e\-book),
257+\f[C]asciidoc\f[] (AsciiDoc), \f[C]icml\f[] (InDesign ICML),
258+\f[C]tei\f[] (TEI Simple), \f[C]slidy\f[] (Slidy HTML and javascript
259+slide show), \f[C]slideous\f[] (Slideous HTML and javascript slide
260+show), \f[C]dzslides\f[] (DZSlides HTML5 + javascript slide show),
261+\f[C]revealjs\f[] (reveal.js HTML5 + javascript slide show), \f[C]s5\f[]
262+(S5 HTML and javascript slide show), or the path of a custom lua writer
263+(see Custom writers, below).
262264Note that \f[C]odt\f[], \f[C]epub\f[], and \f[C]epub3\f[] output will
263265not be directed to \f[I]stdout\f[]; an output filename must be specified
264266using the \f[C]\-o/\-\-output\f[] option.
@@ -351,9 +353,10 @@ Show usage message.
351353Parse untranslatable HTML codes and LaTeX environments as raw HTML or
352354LaTeX, instead of ignoring them.
353355Affects only HTML and LaTeX input.
354−Raw HTML can be printed in Markdown, reStructuredText, HTML, Slidy,
355−Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX can be printed
356−in Markdown, reStructuredText, LaTeX, and ConTeXt output.
356+Raw HTML can be printed in Markdown, reStructuredText, Emacs Org mode,
357+HTML, Slidy, Slideous, DZSlides, reveal.js, and S5 output; raw LaTeX can
358+be printed in Markdown, reStructuredText, Emacs Org mode, LaTeX, and
359+ConTeXt output.
357360The default is for the readers to omit untranslatable HTML codes and
358361LaTeX environments.
359362(The LaTeX reader does pass through untranslatable LaTeX
@@ -486,13 +489,16 @@ Specify the number of spaces per tab (default is 4).
486489.RE
487490.TP
488491.B \f[C]\-\-track\-changes=accept\f[]|\f[C]reject\f[]|\f[C]all\f[]
489−Specifies what to do with insertions and deletions produced by the MS
490−Word "Track Changes" feature.
492+Specifies what to do with insertions, deletions, and comments produced
493+by the MS Word "Track Changes" feature.
491494\f[C]accept\f[] (the default), inserts all insertions, and ignores all
492495deletions.
493496\f[C]reject\f[] inserts all deletions and ignores insertions.
494−\f[C]all\f[] puts in both insertions and deletions, wrapped in spans
495−with \f[C]insertion\f[] and \f[C]deletion\f[] classes, respectively.
497+Both \f[C]accept\f[] and \f[C]reject\f[] ignore comments.
498+\f[C]all\f[] puts in insertions, deletions, and comments, wrapped in
499+spans with \f[C]insertion\f[], \f[C]deletion\f[],
500+\f[C]comment\-start\f[], and \f[C]comment\-end\f[] classes,
501+respectively.
496502The author and time of change is included.
497503\f[C]all\f[] is useful for scripting: only accepting changes from a
498504certain reviewer, say, or before a certain date.
@@ -800,7 +806,7 @@ documents.
800806\f[C]javascript\f[] obfuscates them using javascript.
801807\f[C]references\f[] obfuscates them by printing their letters as decimal
802808or hexadecimal character references.
803−The default is \f[C]javascript\f[].
809+The default is \f[C]none\f[].
804810.RS
805811.RE
806812.TP
@@ -1087,6 +1093,8 @@ Render TeX formulas using an external script that converts TeX formulas
10871093to images.
10881094The formula will be concatenated with the URL provided.
10891095If \f[I]URL\f[] is not specified, the Google Chart API will be used.
1096+Note: the \f[C]\-\-webtex\f[] option will affect Markdown output as well
1097+as HTML.
10901098.RS
10911099.RE
10921100.TP
@@ -1490,6 +1498,11 @@ level of section to include in table of contents
14901498.RS
14911499.RE
14921500.TP
1501+.B \f[C]secnumdepth\f[]
1502+numbering depth for sections, if sections are numbered
1503+.RS
1504+.RE
1505+.TP
14931506.B \f[C]lof\f[], \f[C]lot\f[]
14941507include list of figures, list of tables
14951508.RS
@@ -3280,7 +3293,7 @@ delimiters.
32803293TeX math will be printed in all output formats.
32813294How it is rendered depends on the output format:
32823295.TP
3283−.B Markdown, LaTeX, Emacs Org mode, ConTeXt
3296+.B Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
32843297It will appear verbatim between \f[C]$\f[] characters.
32853298.RS
32863299.RE
@@ -3411,8 +3424,8 @@ it, but it has been made an extension so that it can be disabled if
34113424desired.)
34123425.PP
34133426The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3414−DZSlides, EPUB, Markdown, and Textile output, and suppressed in other
3415−formats.
3427+DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and
3428+suppressed in other formats.
34163429.SS Extension: \f[C]markdown_in_html_blocks\f[]
34173430.PP
34183431Standard Markdown allows you to include HTML "blocks": blocks of HTML
@@ -3506,7 +3519,7 @@ the material between the begin and end tags will be interpreted as raw
35063519LaTeX, not as Markdown.
35073520.PP
35083521Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
3509−and ConTeXt.
3522+Emacs Org mode, and ConTeXt.
35103523.SS LaTeX macros
35113524.SS Extension: \f[C]latex_macros\f[]
35123525.PP