git.iko.soy/typeable/pandoc
on master help sign in
Update man page.
67f7cecJohn MacFarlane
MANUAL.txt+1−1
@@ -1,6 +1,6 @@
1% Pandoc User's Guide
1% Pandoc User's Guide
2% John MacFarlane
2% John MacFarlane
3−% May 10, 2018
3+% July 15, 2018
4
4
5Synopsis
5Synopsis
6========
6========
man/pandoc.1+30−17
@@ -1,5 +1,5 @@
1.\"t
1.\"t
2−.TH PANDOC 1 "May 10, 2018" "pandoc 2.2.1"
2+.TH PANDOC 1 "July 15, 2018" "pandoc 2.2.2"
3.SH NAME
3.SH NAME
4pandoc - general markup converter
4pandoc - general markup converter
5.SH SYNOPSIS
5.SH SYNOPSIS
@@ -556,7 +556,7 @@ Reading binary files (docx, odt, epub) implies \f[C]\-\-file\-scope\f[].
556.RS
556.RS
557.RE
557.RE
558.TP
558.TP
559−.B \f[C]\-\-filter=\f[]\f[I]PROGRAM\f[]
559+.B \f[C]\-F\f[] \f[I]PROGRAM\f[], \f[C]\-\-filter=\f[]\f[I]PROGRAM\f[]
560Specify an executable to be used as a filter transforming the pandoc AST
560Specify an executable to be used as a filter transforming the pandoc AST
561after the input is parsed and before the output is written.
561after the input is parsed and before the output is written.
562The executable should read JSON from stdin and write JSON to stdout.
562The executable should read JSON from stdin and write JSON to stdout.
@@ -731,8 +731,8 @@ otherwise, metadata is suppressed.
731.RS
731.RS
732.RE
732.RE
733.TP
733.TP
734−.B \f[C]\-\-template=\f[]\f[I]FILE\f[]
734+.B \f[C]\-\-template=\f[]\f[I]FILE\f[]|\f[I]URL\f[]
735−Use \f[I]FILE\f[] as a custom template for the generated document.
735+Use the specified file as a custom template for the generated document.
736Implies \f[C]\-\-standalone\f[].
736Implies \f[C]\-\-standalone\f[].
737See Templates, below, for a description of template syntax.
737See Templates, below, for a description of template syntax.
738If no extension is specified, an extension corresponding to the writer
738If no extension is specified, an extension corresponding to the writer
@@ -815,7 +815,8 @@ Include an automatically generated table of contents (or, in the case of
815\f[C]latex\f[], \f[C]context\f[], \f[C]docx\f[], \f[C]odt\f[],
815\f[C]latex\f[], \f[C]context\f[], \f[C]docx\f[], \f[C]odt\f[],
816\f[C]opendocument\f[], \f[C]rst\f[], or \f[C]ms\f[], an instruction to
816\f[C]opendocument\f[], \f[C]rst\f[], or \f[C]ms\f[], an instruction to
817create one) in the output document.
817create one) in the output document.
818+This option has no effect unless \f[C]\-s/\-\-standalone\f[] is used,
818−This option has no effect on \f[C]man\f[], \f[C]docbook4\f[],
819+and it has no effect on \f[C]man\f[], \f[C]docbook4\f[],
819\f[C]docbook5\f[], or \f[C]jats\f[] output.
820\f[C]docbook5\f[], or \f[C]jats\f[] output.
820.RS
821.RS
821.RE
822.RE
@@ -927,6 +928,8 @@ directory and the \f[C]test\f[] subdirectory, in that order.
927Set the request header \f[I]NAME\f[] to the value \f[I]VAL\f[] when
928Set the request header \f[I]NAME\f[] to the value \f[I]VAL\f[] when
928making HTTP requests (for example, when a URL is given on the command
929making HTTP requests (for example, when a URL is given on the command
929line, or when resources used in a document must be downloaded).
930line, or when resources used in a document must be downloaded).
931+If you\[aq]re behind a proxy, you also need to set the environment
932+variable \f[C]http_proxy\f[] to \f[C]http://...\f[].
930.RS
933.RS
931.RE
934.RE
932.SS Options affecting specific writers
935.SS Options affecting specific writers
@@ -2109,11 +2112,9 @@ any number (including zero),
2109any object,
2112any object,
2110.IP \[bu] 2
2113.IP \[bu] 2
2111the boolean \f[C]true\f[] (to specify the boolean \f[C]true\f[] value
2114the boolean \f[C]true\f[] (to specify the boolean \f[C]true\f[] value
2112−using YAML metadata or the \f[C]\-\-metadata\f[] flag, use \f[C]y\f[],
2115+using YAML metadata or the \f[C]\-\-metadata\f[] flag, use
2113−\f[C]Y\f[], \f[C]yes\f[], \f[C]Yes\f[], \f[C]YES\f[], \f[C]true\f[],
2114−\f[C]True\f[], \f[C]TRUE\f[], \f[C]on\f[], \f[C]On\f[], or \f[C]ON\f[];
2116+\f[C]true\f[], \f[C]True\f[], or \f[C]TRUE\f[]; with the
2115−with the \f[C]\-\-variable\f[] flag, simply omit a value for the
2117+\f[C]\-\-variable\f[] flag, simply omit a value for the variable, e.g.
2116−variable, e.g.
2117\f[C]\-\-variable\ draft\f[]).
2118\f[C]\-\-variable\ draft\f[]).
2118.PP
2119.PP
2119\f[C]X\f[] and \f[C]Y\f[] are placeholders for any valid template text,
2120\f[C]X\f[] and \f[C]Y\f[] are placeholders for any valid template text,
@@ -3779,7 +3780,10 @@ any existing document metadata.
3779Metadata can contain lists and objects (nested arbitrarily), but all
3780Metadata can contain lists and objects (nested arbitrarily), but all
3780string scalars will be interpreted as Markdown.
3781string scalars will be interpreted as Markdown.
3781Fields with names ending in an underscore will be ignored by pandoc.
3782Fields with names ending in an underscore will be ignored by pandoc.
3782−(They may be given a role by external processors.)
3783+(They may be given a role by external processors.) Field names must not
3784+be interpretable as YAML numbers or boolean values (so, for example,
3785+\f[C]yes\f[], \f[C]True\f[], and \f[C]15\f[] cannot be used as field
3786+names).
3783.PP
3787.PP
3784A document may contain multiple metadata blocks.
3788A document may contain multiple metadata blocks.
3785The metadata fields will be combined through a \f[I]left\-biased
3789The metadata fields will be combined through a \f[I]left\-biased
@@ -4094,8 +4098,15 @@ delimiters.
4094TeX math will be printed in all output formats.
4098TeX math will be printed in all output formats.
4095How it is rendered depends on the output format:
4099How it is rendered depends on the output format:
4096.TP
4100.TP
4101+.B LaTeX
4102+It will appear verbatim surrounded by \f[C]\\(...\\)\f[] (for inline
4103+math) or \f[C]\\[...\\]\f[] (for display math).
4104+.RS
4105+.RE
4106+.TP
4097−.B Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
4107+.B Markdown, Emacs Org mode, ConTeXt, ZimWiki
4098−It will appear verbatim between \f[C]$\f[] characters.
4108+It will appear verbatim surrounded by \f[C]$...$\f[] (for inline math)
4109+or \f[C]$$...$$\f[] (for display math).
4099.RS
4110.RS
4100.RE
4111.RE
4101.TP
4112.TP
@@ -5551,7 +5562,8 @@ introducing the slide:
5551All of the other frame attributes described in Section 8.1 of the Beamer
5562All of the other frame attributes described in Section 8.1 of the Beamer
5552User\[aq]s Guide may also be used: \f[C]allowdisplaybreaks\f[],
5563User\[aq]s Guide may also be used: \f[C]allowdisplaybreaks\f[],
5553\f[C]allowframebreaks\f[], \f[C]b\f[], \f[C]c\f[], \f[C]t\f[],
5564\f[C]allowframebreaks\f[], \f[C]b\f[], \f[C]c\f[], \f[C]t\f[],
5554−\f[C]environment\f[], \f[C]label\f[], \f[C]plain\f[], \f[C]shrink\f[].
5565+\f[C]environment\f[], \f[C]label\f[], \f[C]plain\f[], \f[C]shrink\f[],
5566+\f[C]standout\f[], \f[C]noframenumbering\f[].
5555.SS Background in reveal.js
5567.SS Background in reveal.js
5556.PP
5568.PP
5557Background images can be added to self\-contained reveal.js slideshows.
5569Background images can be added to self\-contained reveal.js slideshows.
@@ -5750,9 +5762,10 @@ iBooks\-specific metadata, with the following fields:
5750.RE
5762.RE
5751.SS Linked media
5763.SS Linked media
5752.PP
5764.PP
5753−By default, pandoc will download linked media (including audio and
5765+By default, pandoc will download media referenced from any
5766+\f[C]<img>\f[], \f[C]<audio>\f[], \f[C]<video>\f[] or \f[C]<source>\f[]
5767+element present in the generated EPUB, and include it in the EPUB
5754−video) and include it in the EPUB container, yielding a completely
5768+container, yielding a completely self\-contained EPUB.
5755−self\-contained EPUB.
5756If you want to link to external media resources instead, use raw HTML in
5769If you want to link to external media resources instead, use raw HTML in
5757your source and add \f[C]data\-external="1"\f[] to the tag with the
5770your source and add \f[C]data\-external="1"\f[] to the tag with the
5758\f[C]src\f[] attribute.
5771\f[C]src\f[] attribute.