@@ -10,34 +10,21 @@ 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.
1212.PP
13−Pandoc can read Markdown, CommonMark, PHP Markdown Extra,
14−GitHub\-Flavored Markdown, MultiMarkdown, and (subsets of) Textile,
15−reStructuredText, HTML, LaTeX, MediaWiki markup, TWiki markup, TikiWiki
16−markup, Creole 1.0, Haddock markup, OPML, Emacs Org mode, DocBook, JATS,
17−Muse, txt2tags, Vimwiki, EPUB, ODT, and Word docx.
18−.PP
19−Pandoc can write plain text, Markdown, CommonMark, PHP Markdown Extra,
20−GitHub\-Flavored Markdown, MultiMarkdown, reStructuredText, XHTML,
21−HTML5, LaTeX (including \f[C]beamer\f[] slide shows), ConTeXt, RTF,
22−OPML, DocBook, JATS, OpenDocument, ODT, Word docx, GNU Texinfo,
23−MediaWiki markup, DokuWiki markup, ZimWiki markup, Haddock markup, EPUB
24−(v2 or v3), FictionBook2, Textile, groff man, groff ms, Emacs Org mode,
25−AsciiDoc, InDesign ICML, TEI Simple, Muse, PowerPoint slide shows and
26−Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows.
27−It can also produce PDF output on systems where LaTeX, ConTeXt,
28−\f[C]pdfroff\f[], \f[C]wkhtmltopdf\f[], \f[C]prince\f[], or
29−\f[C]weasyprint\f[] is installed.
13+Pandoc can convert between numerous markup and word processing formats,
14+including, but not limited to, various flavors of Markdown, HTML, LaTeX
15+and Word docx.
16+For the full lists of input and output formats, see the
17+\f[C]\-\-from\f[] and \f[C]\-\-to\f[] options below.
18+Pandoc can also produce PDF output: see creating a PDF, below.
3019.PP
3120Pandoc\[aq]s enhanced version of Markdown includes syntax for tables,
32−definition lists, metadata blocks, \f[C]Div\f[] blocks, footnotes and
33−citations, embedded LaTeX (including math), Markdown inside HTML block
34−elements, and much more.
35−These enhancements, described further under Pandoc\[aq]s Markdown, can
36−be disabled using the \f[C]markdown_strict\f[] format.
21+definition lists, metadata blocks, footnotes, citations, math, and much
22+more.
23+See below under Pandoc\[aq]s Markdown.
3724.PP
3825Pandoc has a modular design: it consists of a set of readers, which
3926parse text in a given format and produce a native representation of the
40−document (like an \f[I]abstract syntax tree\f[] or AST), and a set of
27+document (an \f[I]abstract syntax tree\f[] or AST), and a set of
4128writers, which convert this native representation into a target format.
4229Thus, adding an input or output format requires only adding a reader or
4330writer.
@@ -229,69 +216,182 @@ pandoc\ \-f\ html\ \-t\ markdown\ \-\-request\-header\ User\-Agent:"Mozilla/5.0"
229216.TP
230217.B \f[C]\-f\f[] \f[I]FORMAT\f[], \f[C]\-r\f[] \f[I]FORMAT\f[], \f[C]\-\-from=\f[]\f[I]FORMAT\f[], \f[C]\-\-read=\f[]\f[I]FORMAT\f[]
231218Specify input format.
232−\f[I]FORMAT\f[] can be \f[C]native\f[] (native Haskell), \f[C]json\f[]
233−(JSON version of native AST), \f[C]markdown\f[] (pandoc\[aq]s extended
234−Markdown), \f[C]markdown_strict\f[] (original unextended Markdown),
235−\f[C]markdown_phpextra\f[] (PHP Markdown Extra), \f[C]markdown_mmd\f[]
236−(MultiMarkdown), \f[C]gfm\f[] (GitHub\-Flavored Markdown),
237−\f[C]commonmark\f[] (CommonMark Markdown), \f[C]textile\f[] (Textile),
238−\f[C]rst\f[] (reStructuredText), \f[C]html\f[] (HTML), \f[C]docbook\f[]
239−(DocBook), \f[C]t2t\f[] (txt2tags), \f[C]docx\f[] (docx), \f[C]odt\f[]
240−(ODT), \f[C]epub\f[] (EPUB), \f[C]opml\f[] (OPML), \f[C]org\f[] (Emacs
241−Org mode), \f[C]mediawiki\f[] (MediaWiki markup), \f[C]twiki\f[] (TWiki
242−markup), \f[C]tikiwiki\f[] (TikiWiki markup), \f[C]creole\f[] (Creole
243−1.0), \f[C]haddock\f[] (Haddock markup), or \f[C]latex\f[] (LaTeX).
244−(\f[C]markdown_github\f[] provides deprecated and less accurate support
245−for Github\-Flavored Markdown; please use \f[C]gfm\f[] instead, unless
246−you need to use extensions other than \f[C]smart\f[].) Extensions can be
247−individually enabled or disabled by appending \f[C]+EXTENSION\f[] or
248−\f[C]\-EXTENSION\f[] to the format name.
219+\f[I]FORMAT\f[] can be:
220+.RS
221+.IP \[bu] 2
222+\f[C]commonmark\f[] (CommonMark Markdown)
223+.IP \[bu] 2
224+\f[C]creole\f[] (Creole 1.0)
225+.IP \[bu] 2
226+\f[C]docbook\f[] (DocBook)
227+.IP \[bu] 2
228+\f[C]docx\f[] (Word docx)
229+.IP \[bu] 2
230+\f[C]epub\f[] (EPUB)
231+.IP \[bu] 2
232+\f[C]gfm\f[] (GitHub\-Flavored Markdown), or \f[C]markdown_github\f[],
233+which provides deprecated and less accurate support for Github\-Flavored
234+Markdown; please use \f[C]gfm\f[] instead, unless you need to use
235+extensions other than \f[C]smart\f[].
236+.IP \[bu] 2
237+\f[C]haddock\f[] (Haddock markup)
238+.IP \[bu] 2
239+\f[C]html\f[] (HTML)
240+.IP \[bu] 2
241+\f[C]jats\f[] (JATS XML)
242+.IP \[bu] 2
243+\f[C]json\f[] (JSON version of native AST)
244+.IP \[bu] 2
245+\f[C]latex\f[] (LaTeX)
246+.IP \[bu] 2
247+\f[C]markdown\f[] (Pandoc\[aq]s Markdown)
248+.IP \[bu] 2
249+\f[C]markdown_mmd\f[] (MultiMarkdown)
250+.IP \[bu] 2
251+\f[C]markdown_phpextra\f[] (PHP Markdown Extra)
252+.IP \[bu] 2
253+\f[C]markdown_strict\f[] (original unextended Markdown)
254+.IP \[bu] 2
255+\f[C]mediawiki\f[] (MediaWiki markup)
256+.IP \[bu] 2
257+\f[C]muse\f[] (Muse)
258+.IP \[bu] 2
259+\f[C]native\f[] (native Haskell)
260+.IP \[bu] 2
261+\f[C]odt\f[] (ODT)
262+.IP \[bu] 2
263+\f[C]opml\f[] (OPML)
264+.IP \[bu] 2
265+\f[C]org\f[] (Emacs Org mode)
266+.IP \[bu] 2
267+\f[C]rst\f[] (reStructuredText)
268+.IP \[bu] 2
269+\f[C]t2t\f[] (txt2tags)
270+.IP \[bu] 2
271+\f[C]textile\f[] (Textile)
272+.IP \[bu] 2
273+\f[C]tikiwiki\f[] (TikiWiki markup)
274+.IP \[bu] 2
275+\f[C]twiki\f[] (TWiki markup)
276+.IP \[bu] 2
277+\f[C]vimwiki\f[] (Vimwiki)
278+.PP
279+Extensions can be individually enabled or disabled by appending
280+\f[C]+EXTENSION\f[] or \f[C]\-EXTENSION\f[] to the format name.
249281See Extensions below, for a list of extensions and their names.
250282See \f[C]\-\-list\-input\-formats\f[] and \f[C]\-\-list\-extensions\f[],
251283below.
252−.RS
253284.RE
254285.TP
255286.B \f[C]\-t\f[] \f[I]FORMAT\f[], \f[C]\-w\f[] \f[I]FORMAT\f[], \f[C]\-\-to=\f[]\f[I]FORMAT\f[], \f[C]\-\-write=\f[]\f[I]FORMAT\f[]
256287Specify output format.
257−\f[I]FORMAT\f[] can be \f[C]native\f[] (native Haskell), \f[C]json\f[]
258−(JSON version of native AST), \f[C]plain\f[] (plain text),
259−\f[C]markdown\f[] (pandoc\[aq]s extended Markdown),
260−\f[C]markdown_strict\f[] (original unextended Markdown),
261−\f[C]markdown_phpextra\f[] (PHP Markdown Extra), \f[C]markdown_mmd\f[]
262−(MultiMarkdown), \f[C]gfm\f[] (GitHub\-Flavored Markdown),
263−\f[C]commonmark\f[] (CommonMark Markdown), \f[C]rst\f[]
264−(reStructuredText), \f[C]html4\f[] (XHTML 1.0 Transitional),
265−\f[C]html\f[] or \f[C]html5\f[] (HTML5/XHTML polyglot markup),
266−\f[C]latex\f[] (LaTeX), \f[C]beamer\f[] (LaTeX beamer slide show),
267−\f[C]context\f[] (ConTeXt), \f[C]man\f[] (groff man), \f[C]mediawiki\f[]
268−(MediaWiki markup), \f[C]dokuwiki\f[] (DokuWiki markup),
269−\f[C]zimwiki\f[] (ZimWiki markup), \f[C]textile\f[] (Textile),
270−\f[C]org\f[] (Emacs Org mode), \f[C]texinfo\f[] (GNU Texinfo),
271−\f[C]opml\f[] (OPML), \f[C]docbook\f[] or \f[C]docbook4\f[] (DocBook 4),
272−\f[C]docbook5\f[] (DocBook 5), \f[C]jats\f[] (JATS XML),
273−\f[C]opendocument\f[] (OpenDocument), \f[C]odt\f[] (OpenOffice text
274−document), \f[C]docx\f[] (Word docx), \f[C]haddock\f[] (Haddock markup),
275−\f[C]rtf\f[] (rich text format), \f[C]epub2\f[] (EPUB v2 book),
276−\f[C]epub\f[] or \f[C]epub3\f[] (EPUB v3), \f[C]fb2\f[] (FictionBook2
277−e\-book), \f[C]asciidoc\f[] (AsciiDoc), \f[C]icml\f[] (InDesign ICML),
278−\f[C]tei\f[] (TEI Simple), \f[C]slidy\f[] (Slidy HTML and JavaScript
279−slide show), \f[C]slideous\f[] (Slideous HTML and JavaScript slide
280−show), \f[C]dzslides\f[] (DZSlides HTML5 + JavaScript slide show),
281−\f[C]revealjs\f[] (reveal.js HTML5 + JavaScript slide show), \f[C]s5\f[]
282−(S5 HTML and JavaScript slide show), \f[C]pptx\f[] (PowerPoint slide
283−show) or the path of a custom lua writer (see Custom writers, below).
284−(\f[C]markdown_github\f[] provides deprecated and less accurate support
285−for Github\-Flavored Markdown; please use \f[C]gfm\f[] instead, unless
286−you use extensions that do not work with \f[C]gfm\f[].) Note that
287−\f[C]odt\f[], \f[C]docx\f[], and \f[C]epub\f[] output will not be
288−directed to \f[I]stdout\f[] unless forced with \f[C]\-o\ \-\f[].
288+\f[I]FORMAT\f[] can be:
289+.RS
290+.IP \[bu] 2
291+\f[C]asciidoc\f[] (AsciiDoc)
292+.IP \[bu] 2
293+\f[C]beamer\f[] (LaTeX beamer slide show)
294+.IP \[bu] 2
295+\f[C]commonmark\f[] (CommonMark Markdown)
296+.IP \[bu] 2
297+\f[C]context\f[] (ConTeXt)
298+.IP \[bu] 2
299+\f[C]docbook\f[] or \f[C]docbook4\f[] (DocBook 4)
300+.IP \[bu] 2
301+\f[C]docbook5\f[] (DocBook 5)
302+.IP \[bu] 2
303+\f[C]docx\f[] (Word docx)
304+.IP \[bu] 2
305+\f[C]dokuwiki\f[] (DokuWiki markup)
306+.IP \[bu] 2
307+\f[C]epub\f[] or \f[C]epub3\f[] (EPUB v3 book)
308+.IP \[bu] 2
309+\f[C]epub2\f[] (EPUB v2)
310+.IP \[bu] 2
311+\f[C]fb2\f[] (FictionBook2 e\-book)
312+.IP \[bu] 2
313+\f[C]gfm\f[] (GitHub\-Flavored Markdown), or \f[C]markdown_github\f[],
314+which provides deprecated and less accurate support for Github\-Flavored
315+Markdown; please use \f[C]gfm\f[] instead, unless you use extensions
316+that do not work with \f[C]gfm\f[].
317+.IP \[bu] 2
318+\f[C]haddock\f[] (Haddock markup)
319+.IP \[bu] 2
320+\f[C]html\f[] or \f[C]html5\f[] (HTML, i.e.
321+HTML5/XHTML polyglot markup)
322+.IP \[bu] 2
323+\f[C]html4\f[] (XHTML 1.0 Transitional)
324+.IP \[bu] 2
325+\f[C]icml\f[] (InDesign ICML)
326+.IP \[bu] 2
327+\f[C]jats\f[] (JATS XML)
328+.IP \[bu] 2
329+\f[C]json\f[] (JSON version of native AST)
330+.IP \[bu] 2
331+\f[C]latex\f[] (LaTeX)
332+.IP \[bu] 2
333+\f[C]man\f[] (groff man)
334+.IP \[bu] 2
335+\f[C]markdown\f[] (Pandoc\[aq]s Markdown)
336+.IP \[bu] 2
337+\f[C]markdown_mmd\f[] (MultiMarkdown)
338+.IP \[bu] 2
339+\f[C]markdown_phpextra\f[] (PHP Markdown Extra)
340+.IP \[bu] 2
341+\f[C]markdown_strict\f[] (original unextended Markdown)
342+.IP \[bu] 2
343+\f[C]mediawiki\f[] (MediaWiki markup)
344+.IP \[bu] 2
345+\f[C]ms\f[] (groff ms)
346+.IP \[bu] 2
347+\f[C]muse\f[] (Muse),
348+.IP \[bu] 2
349+\f[C]native\f[] (native Haskell),
350+.IP \[bu] 2
351+\f[C]odt\f[] (OpenOffice text document)
352+.IP \[bu] 2
353+\f[C]opml\f[] (OPML)
354+.IP \[bu] 2
355+\f[C]opendocument\f[] (OpenDocument)
356+.IP \[bu] 2
357+\f[C]org\f[] (Emacs Org mode)
358+.IP \[bu] 2
359+\f[C]plain\f[] (plain text),
360+.IP \[bu] 2
361+\f[C]pptx\f[] (PowerPoint slide show)
362+.IP \[bu] 2
363+\f[C]rst\f[] (reStructuredText)
364+.IP \[bu] 2
365+\f[C]rtf\f[] (Rich Text Format)
366+.IP \[bu] 2
367+\f[C]texinfo\f[] (GNU Texinfo)
368+.IP \[bu] 2
369+\f[C]textile\f[] (Textile)
370+.IP \[bu] 2
371+\f[C]slideous\f[] (Slideous HTML and JavaScript slide show)
372+.IP \[bu] 2
373+\f[C]slidy\f[] (Slidy HTML and JavaScript slide show)
374+.IP \[bu] 2
375+\f[C]dzslides\f[] (DZSlides HTML5 + JavaScript slide show),
376+.IP \[bu] 2
377+\f[C]revealjs\f[] (reveal.js HTML5 + JavaScript slide show)
378+.IP \[bu] 2
379+\f[C]s5\f[] (S5 HTML and JavaScript slide show)
380+.IP \[bu] 2
381+\f[C]tei\f[] (TEI Simple)
382+.IP \[bu] 2
383+\f[C]zimwiki\f[] (ZimWiki markup)
384+.IP \[bu] 2
385+the path of a custom lua writer, see Custom writers below
386+.PP
387+Note that \f[C]odt\f[], \f[C]docx\f[], and \f[C]epub\f[] output will not
388+be directed to \f[I]stdout\f[] unless forced with \f[C]\-o\ \-\f[].
389+.PP
289390Extensions can be individually enabled or disabled by appending
290391\f[C]+EXTENSION\f[] or \f[C]\-EXTENSION\f[] to the format name.
291392See Extensions below, for a list of extensions and their names.
292393See \f[C]\-\-list\-output\-formats\f[] and
293394\f[C]\-\-list\-extensions\f[], below.
294−.RS
295395.RE
296396.TP
297397.B \f[C]\-o\f[] \f[I]FILE\f[], \f[C]\-\-output=\f[]\f[I]FILE\f[]