Update man page.
This commit is contained in:
John MacFarlane
parent
e649b69564
commit
ba2793e4fa
1 changed files with 54 additions and 13 deletions
67
man/pandoc.1
67
man/pandoc.1
|
|
@ -1,7 +1,7 @@
|
|||
'\" t
|
||||
.\" Automatically generated by Pandoc 2.11.4
|
||||
.\"
|
||||
.TH "Pandoc User\[cq]s Guide" "" "January 21, 2021" "pandoc 2.11.4" ""
|
||||
.TH "Pandoc User\[cq]s Guide" "" "March 4, 2021" "pandoc 2.12" ""
|
||||
.hy
|
||||
.SH NAME
|
||||
pandoc - general markup converter
|
||||
|
|
@ -172,13 +172,12 @@ You can then test it with \f[C]pdflatex test.tex\f[R].
|
|||
When using LaTeX, the following packages need to be available (they are
|
||||
included with all recent versions of TeX Live): \f[C]amsfonts\f[R],
|
||||
\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode-math\f[R],
|
||||
\f[C]ifxetex\f[R], \f[C]ifluatex\f[R], \f[C]listings\f[R] (if the
|
||||
\f[C]--listings\f[R] option is used), \f[C]fancyvrb\f[R],
|
||||
\f[C]longtable\f[R], \f[C]booktabs\f[R], \f[C]graphicx\f[R] (if the
|
||||
document contains images), \f[C]hyperref\f[R], \f[C]xcolor\f[R],
|
||||
\f[C]ulem\f[R], \f[C]geometry\f[R] (with the \f[C]geometry\f[R] variable
|
||||
set), \f[C]setspace\f[R] (with \f[C]linestretch\f[R]), and
|
||||
\f[C]babel\f[R] (with \f[C]lang\f[R]).
|
||||
\f[C]iftex\f[R], \f[C]listings\f[R] (if the \f[C]--listings\f[R] option
|
||||
is used), \f[C]fancyvrb\f[R], \f[C]longtable\f[R], \f[C]booktabs\f[R],
|
||||
\f[C]graphicx\f[R] (if the document contains images),
|
||||
\f[C]hyperref\f[R], \f[C]xcolor\f[R], \f[C]ulem\f[R], \f[C]geometry\f[R]
|
||||
(with the \f[C]geometry\f[R] variable set), \f[C]setspace\f[R] (with
|
||||
\f[C]linestretch\f[R]), and \f[C]babel\f[R] (with \f[C]lang\f[R]).
|
||||
The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the PDF engine
|
||||
requires \f[C]fontspec\f[R].
|
||||
\f[C]lualatex\f[R] uses \f[C]selnolig\f[R].
|
||||
|
|
@ -1614,6 +1613,11 @@ T}@T{
|
|||
PandocPDFError
|
||||
T}
|
||||
T{
|
||||
44
|
||||
T}@T{
|
||||
PandocXMLError
|
||||
T}
|
||||
T{
|
||||
47
|
||||
T}@T{
|
||||
PandocPDFProgramNotFoundError
|
||||
|
|
@ -1674,6 +1678,11 @@ T}@T{
|
|||
PandocIpynbDecodingError
|
||||
T}
|
||||
T{
|
||||
94
|
||||
T}@T{
|
||||
PandocUnsupportedCharsetError
|
||||
T}
|
||||
T{
|
||||
97
|
||||
T}@T{
|
||||
PandocCouldNotFindDataFileError
|
||||
|
|
@ -1773,8 +1782,11 @@ data-dir:
|
|||
verbosity: INFO
|
||||
log-file: log.json
|
||||
|
||||
# citeproc, natbib, or biblatex
|
||||
# citeproc, natbib, or biblatex. This only affects LaTeX
|
||||
# output. If you want to use citeproc to format citations,
|
||||
# you should also set \[aq]citeproc: true\[aq] (see above).
|
||||
cite-method: citeproc
|
||||
|
||||
# part, chapter, section, or default:
|
||||
top-level-division: chapter
|
||||
abbreviations:
|
||||
|
|
@ -2134,9 +2146,9 @@ ${ styles.html() }
|
|||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
(If a partial is not found in the directory of the template, it will
|
||||
also be sought in the \f[C]templates\f[R] subdirectory of the user data
|
||||
directory.)
|
||||
(If a partial is not found in the directory of the template and the
|
||||
template path is given as a relative path, it will also be sought in the
|
||||
\f[C]templates\f[R] subdirectory of the user data directory.)
|
||||
.PP
|
||||
Partials may optionally be applied to variables using a colon:
|
||||
.IP
|
||||
|
|
@ -3928,6 +3940,9 @@ begin with a space.
|
|||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Inline formatting (such as emphasis) is allowed in the content, but not
|
||||
block-level formatting (such as block quotes or lists).
|
||||
.PP
|
||||
This syntax is borrowed from reStructuredText.
|
||||
.SS Lists
|
||||
.SS Bullet lists
|
||||
|
|
@ -5048,7 +5063,9 @@ delimiters.
|
|||
.PP
|
||||
For display math, use \f[C]$$\f[R] delimiters.
|
||||
(In this case, the delimiters may be separated from the formula by
|
||||
whitespace.)
|
||||
whitespace.
|
||||
However, there can be no blank lines betwen the opening and closing
|
||||
\f[C]$$\f[R] delimiters.)
|
||||
.PP
|
||||
TeX math will be printed in all output formats.
|
||||
How it is rendered depends on the output format:
|
||||
|
|
@ -6938,6 +6955,16 @@ A string value.
|
|||
\f[B]\f[CB]rights\f[B]\f[R]
|
||||
A string value.
|
||||
.TP
|
||||
\f[B]\f[CB]belongs-to-collection\f[B]\f[R]
|
||||
A string value.
|
||||
identifies the name of a collection to which the EPUB Publication
|
||||
belongs.
|
||||
.TP
|
||||
\f[B]\f[CB]group-position\f[B]\f[R]
|
||||
The \f[C]group-position\f[R] field indicates the numeric position in
|
||||
which the EPUB Publication belongs relative to other works belonging to
|
||||
the same \f[C]belongs-to-collection\f[R] field.
|
||||
.TP
|
||||
\f[B]\f[CB]cover-image\f[B]\f[R]
|
||||
A string value (path to cover image).
|
||||
.TP
|
||||
|
|
@ -7453,6 +7480,20 @@ need to specify a template manually using \f[C]--template\f[R] or add a
|
|||
new default template with the name
|
||||
\f[C]default.NAME_OF_CUSTOM_WRITER.lua\f[R] to the \f[C]templates\f[R]
|
||||
subdirectory of your user data directory (see Templates).
|
||||
.SH REPRODUCIBLE BUILDS
|
||||
.PP
|
||||
Some of the document formats pandoc targets (such as EPUB, docx, and
|
||||
ODT) include build timestamps in the generated document.
|
||||
That means that the files generated on successive builds will differ,
|
||||
even if the source does not.
|
||||
To avoid this, set the \f[C]SOURCE_DATE_EPOCH\f[R] environment variable,
|
||||
and the timestamp will be taken from it instead of the current time.
|
||||
\f[C]SOURCE_DATE_EPOCH\f[R] should contain an integer unix timestamp
|
||||
(specifying the number of second since midnight UTC January 1, 1970).
|
||||
.PP
|
||||
Some document formats also include a unique identifier.
|
||||
For EPUB, this can be set explicitly by setting the \f[C]identifier\f[R]
|
||||
metadata field (see EPUB Metadata, above).
|
||||
.SH A NOTE ON SECURITY
|
||||
.PP
|
||||
If you use pandoc to convert user-contributed content in a web
|
||||
|
|
|
|||
Loading…
Reference in a new issue