git.iko.soy/typeable/pandoc
on master help sign in
Update man page.
commitc2530ee2d7df94f2f08c23e327edd8c8551b29bd authorJohn MacFarlane <jgm@berkeley.edu> dateThu 4 Mar 2021, 08:57 (6 years ago) parentfb3b4fa
1 file changed+54−13
man/pandoc.1+54−13
man/pandoc.1+54−13
@@ -1,7 +1,7 @@
11'\" t
22.\" Automatically generated by Pandoc 2.11.4
33.\"
4−.TH "Pandoc User\[cq]s Guide" "" "January 21, 2021" "pandoc 2.11.4" ""
4+.TH "Pandoc User\[cq]s Guide" "" "March 4, 2021" "pandoc 2.12" ""
55.hy
66.SH NAME
77pandoc - general markup converter
@@ -172,13 +172,12 @@ You can then test it with \f[C]pdflatex test.tex\f[R].
172172When using LaTeX, the following packages need to be available (they are
173173included with all recent versions of TeX Live): \f[C]amsfonts\f[R],
174174\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode-math\f[R],
175−\f[C]ifxetex\f[R], \f[C]ifluatex\f[R], \f[C]listings\f[R] (if the
176−\f[C]--listings\f[R] option is used), \f[C]fancyvrb\f[R],
177−\f[C]longtable\f[R], \f[C]booktabs\f[R], \f[C]graphicx\f[R] (if the
178−document contains images), \f[C]hyperref\f[R], \f[C]xcolor\f[R],
179−\f[C]ulem\f[R], \f[C]geometry\f[R] (with the \f[C]geometry\f[R] variable
180−set), \f[C]setspace\f[R] (with \f[C]linestretch\f[R]), and
181−\f[C]babel\f[R] (with \f[C]lang\f[R]).
175+\f[C]iftex\f[R], \f[C]listings\f[R] (if the \f[C]--listings\f[R] option
176+is used), \f[C]fancyvrb\f[R], \f[C]longtable\f[R], \f[C]booktabs\f[R],
177+\f[C]graphicx\f[R] (if the document contains images),
178+\f[C]hyperref\f[R], \f[C]xcolor\f[R], \f[C]ulem\f[R], \f[C]geometry\f[R]
179+(with the \f[C]geometry\f[R] variable set), \f[C]setspace\f[R] (with
180+\f[C]linestretch\f[R]), and \f[C]babel\f[R] (with \f[C]lang\f[R]).
182181The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the PDF engine
183182requires \f[C]fontspec\f[R].
184183\f[C]lualatex\f[R] uses \f[C]selnolig\f[R].
@@ -1614,6 +1613,11 @@ T}@T{
16141613PandocPDFError
16151614T}
16161615T{
1616+44
1617+T}@T{
1618+PandocXMLError
1619+T}
1620+T{
1617162147
16181622T}@T{
16191623PandocPDFProgramNotFoundError
@@ -1674,6 +1678,11 @@ T}@T{
16741678PandocIpynbDecodingError
16751679T}
16761680T{
1681+94
1682+T}@T{
1683+PandocUnsupportedCharsetError
1684+T}
1685+T{
1677168697
16781687T}@T{
16791688PandocCouldNotFindDataFileError
@@ -1773,8 +1782,11 @@ data-dir:
17731782verbosity: INFO
17741783log-file: log.json
17751784
1776−# citeproc, natbib, or biblatex
1785+# citeproc, natbib, or biblatex. This only affects LaTeX
1786+# output. If you want to use citeproc to format citations,
1787+# you should also set \[aq]citeproc: true\[aq] (see above).
17771788cite-method: citeproc
1789+
17781790# part, chapter, section, or default:
17791791top-level-division: chapter
17801792abbreviations:
@@ -2134,9 +2146,9 @@ ${ styles.html() }
21342146\f[R]
21352147.fi
21362148.PP
2137−(If a partial is not found in the directory of the template, it will
2138−also be sought in the \f[C]templates\f[R] subdirectory of the user data
2139−directory.)
2149+(If a partial is not found in the directory of the template and the
2150+template path is given as a relative path, it will also be sought in the
2151+\f[C]templates\f[R] subdirectory of the user data directory.)
21402152.PP
21412153Partials may optionally be applied to variables using a colon:
21422154.IP
@@ -3928,6 +3940,9 @@ begin with a space.
39283940\f[R]
39293941.fi
39303942.PP
3943+Inline formatting (such as emphasis) is allowed in the content, but not
3944+block-level formatting (such as block quotes or lists).
3945+.PP
39313946This syntax is borrowed from reStructuredText.
39323947.SS Lists
39333948.SS Bullet lists
@@ -5048,7 +5063,9 @@ delimiters.
50485063.PP
50495064For display math, use \f[C]$$\f[R] delimiters.
50505065(In this case, the delimiters may be separated from the formula by
5051−whitespace.)
5066+whitespace.
5067+However, there can be no blank lines betwen the opening and closing
5068+\f[C]$$\f[R] delimiters.)
50525069.PP
50535070TeX math will be printed in all output formats.
50545071How it is rendered depends on the output format:
@@ -6938,6 +6955,16 @@ A string value.
69386955\f[B]\f[CB]rights\f[B]\f[R]
69396956A string value.
69406957.TP
6958+\f[B]\f[CB]belongs-to-collection\f[B]\f[R]
6959+A string value.
6960+identifies the name of a collection to which the EPUB Publication
6961+belongs.
6962+.TP
6963+\f[B]\f[CB]group-position\f[B]\f[R]
6964+The \f[C]group-position\f[R] field indicates the numeric position in
6965+which the EPUB Publication belongs relative to other works belonging to
6966+the same \f[C]belongs-to-collection\f[R] field.
6967+.TP
69416968\f[B]\f[CB]cover-image\f[B]\f[R]
69426969A string value (path to cover image).
69436970.TP
@@ -7453,6 +7480,20 @@ need to specify a template manually using \f[C]--template\f[R] or add a
74537480new default template with the name
74547481\f[C]default.NAME_OF_CUSTOM_WRITER.lua\f[R] to the \f[C]templates\f[R]
74557482subdirectory of your user data directory (see Templates).
7483+.SH REPRODUCIBLE BUILDS
7484+.PP
7485+Some of the document formats pandoc targets (such as EPUB, docx, and
7486+ODT) include build timestamps in the generated document.
7487+That means that the files generated on successive builds will differ,
7488+even if the source does not.
7489+To avoid this, set the \f[C]SOURCE_DATE_EPOCH\f[R] environment variable,
7490+and the timestamp will be taken from it instead of the current time.
7491+\f[C]SOURCE_DATE_EPOCH\f[R] should contain an integer unix timestamp
7492+(specifying the number of second since midnight UTC January 1, 1970).
7493+.PP
7494+Some document formats also include a unique identifier.
7495+For EPUB, this can be set explicitly by setting the \f[C]identifier\f[R]
7496+metadata field (see EPUB Metadata, above).
74567497.SH A NOTE ON SECURITY
74577498.PP
74587499If you use pandoc to convert user-contributed content in a web