aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2020-06-29 13:33:57 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2020-06-29 13:33:57 -0700
commit495cc1194180659c66b64de5ac001548e73a87dd (patch)
tree6664139f7ee3eafbf545b2fd085c8a92d47e4579 /man
parent1b14b697b8e0238af758e6b1ec136d889ce43318 (diff)
downloadpandoc-495cc1194180659c66b64de5ac001548e73a87dd.tar.gz
Update manual date, generate man page.
Diffstat (limited to 'man')
-rw-r--r--man/pandoc.1136
1 files changed, 111 insertions, 25 deletions
diff --git a/man/pandoc.1 b/man/pandoc.1
index 1af5f21cd..fb88a6745 100644
--- a/man/pandoc.1
+++ b/man/pandoc.1
@@ -1,7 +1,7 @@
.\"t
-.\" Automatically generated by Pandoc 2.9.2
+.\" Automatically generated by Pandoc 2.10
.\"
-.TH "Pandoc User\[aq]s Guide" "" "March 23, 2020" "pandoc 2.9.2.1" ""
+.TH "Pandoc User\[aq]s Guide" "" "June 29, 2020" "pandoc 2.10" ""
.hy
.SH NAME
pandoc - general markup converter
@@ -255,7 +255,7 @@ if you need extensions not supported in \f[C]gfm\f[R].
.IP \[bu] 2
\f[C]jats\f[R] (JATS XML)
.IP \[bu] 2
-\f[C]jira\f[R] (Jira wiki markup)
+\f[C]jira\f[R] (Jira/Confluence wiki markup)
.IP \[bu] 2
\f[C]json\f[R] (JSON version of native AST)
.IP \[bu] 2
@@ -352,7 +352,7 @@ HTML5/XHTML polyglot markup)
.IP \[bu] 2
\f[C]jats\f[R] (alias for \f[C]jats_archiving\f[R])
.IP \[bu] 2
-\f[C]jira\f[R] (Jira wiki markup)
+\f[C]jira\f[R] (Jira/Confluence wiki markup)
.IP \[bu] 2
\f[C]json\f[R] (JSON version of native AST)
.IP \[bu] 2
@@ -481,7 +481,6 @@ eval \[dq]$(pandoc --bash-completion)\[dq]
.TP
\f[B]\f[CB]--verbose\f[B]\f[R]
Give verbose debugging output.
-Currently this only has an effect with PDF output.
.TP
\f[B]\f[CB]--quiet\f[B]\f[R]
Suppress warning messages.
@@ -936,6 +935,11 @@ making HTTP requests (for example, when a URL is given on the command
line, or when resources used in a document must be downloaded).
If you\[aq]re behind a proxy, you also need to set the environment
variable \f[C]http_proxy\f[R] to \f[C]http://...\f[R].
+.TP
+\[ga]--no-check-certificate
+Disable the certificate verification to allow access to unsecure HTTP
+resources (for example when the certificate is no longer valid or self
+signed).
.SS Options affecting specific writers
.TP
\f[B]\f[CB]--self-contained\f[B]\f[R]
@@ -1366,7 +1370,8 @@ depending on the output format specified using \f[C]-t/--to\f[R]:
\f[C]-t context\f[R]: \f[C]context\f[R]
.IP \[bu] 2
\f[C]-t html\f[R]: \f[C]wkhtmltopdf\f[R] (other options:
-\f[C]prince\f[R], \f[C]weasyprint\f[R])
+\f[C]prince\f[R], \f[C]weasyprint\f[R]; see print-css.rocks for a good
+introduction to PDF generation from HTML/CSS.)
.IP \[bu] 2
\f[C]-t ms\f[R]: \f[C]pdfroff\f[R]
.RE
@@ -2053,20 +2058,30 @@ ${ endfor }
.fi
.SS Partials
.PP
-Partials (subtemplates stored in different files) may be included using
-the syntax
+Partials (subtemplates stored in different files) may be included by
+using the name of the partial, followed by \f[C]()\f[R], for example:
+.IP
+.nf
+\f[C]
+${ styles() }
+\f[R]
+.fi
+.PP
+Partials will be sought in the directory containing the main template.
+The file name will be assumed to have the same extension as the main
+template if it lacks an extension.
+When calling the partial, the full name including file extension can
+also be used:
.IP
.nf
\f[C]
-${ boilerplate() }
+${ styles.html() }
\f[R]
.fi
.PP
-Partials will be sought in the directory containing the main template,
-and will be assumed to have the same extension as the main template if
-they lack an explicit extension.
-(If the partials are not found here, they 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, 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
@@ -2232,6 +2247,18 @@ for a textual value, number of elements for a map or array.
\f[C]reverse\f[R]: Reverses a textual value or array, and has no effect
on other values.
.IP \[bu] 2
+\f[C]first\f[R]: Returns the first value of an array, if applied to a
+non-empty array; otherwise returns the original value.
+.IP \[bu] 2
+\f[C]last\f[R]: Returns the last value of an array, if applied to a
+non-empty array; otherwise returns the original value.
+.IP \[bu] 2
+\f[C]rest\f[R]: Returns all but the first value of an array, if applied
+to a non-empty array; otherwise returns the original value.
+.IP \[bu] 2
+\f[C]allbutlast\f[R]: Returns all but the last value of an array, if
+applied to a non-empty array; otherwise returns the original value.
+.IP \[bu] 2
\f[C]chomp\f[R]: Removes trailing newlines (and breakable space).
.IP \[bu] 2
\f[C]nowrap\f[R]: Disables line wrapping on breakable spaces.
@@ -2398,7 +2425,8 @@ To turn off boolean flags that default to true in reveal.js, use
\f[C]0\f[R].
.TP
\f[B]\f[CB]revealjs-url\f[B]\f[R]
-base URL for reveal.js documents (defaults to \f[C]reveal.js\f[R])
+base URL for reveal.js documents (defaults to
+\f[C]https://unpkg.com/reveal.js\[at]\[ha]4/\f[R])
.TP
\f[B]\f[CB]s5-url\f[B]\f[R]
base URL for S5 documents (defaults to \f[C]s5/default\f[R])
@@ -3247,7 +3275,7 @@ This extension can be enabled/disabled for the following formats:
.TP
output formats
\f[C]odt\f[R], \f[C]opendocument\f[R]
-.SS Extension: \f[C]styles\f[R]
+.SS Extension: \f[C]styles\f[R] {#ext-styles}
.PP
When converting from docx, read all docx styles as divs (for paragraph
styles) and spans (for character styles) regardless of whether pandoc
@@ -4404,7 +4432,7 @@ orange|3.09
.PP
The cells of pipe tables cannot contain block elements like paragraphs
and lists, and cannot span multiple lines.
-If a pipe table contains a row whose printable content is wider than the
+If a pipe table contains a row whose Markdown content is wider than the
column width (see \f[C]--columns\f[R]), then the table will take up the
full text width and the cell contents will wrap, with the relative cell
widths determined by the number of dashes in the line separating the
@@ -4454,7 +4482,11 @@ no author, you need a blank line:
\f[C]
%
% Author
-
+\f[R]
+.fi
+.IP
+.nf
+\f[C]
% My title
%
% June 15, 2006
@@ -4479,9 +4511,17 @@ So, all of the following are equivalent:
\f[C]
% Author One
Author Two
-
+\f[R]
+.fi
+.IP
+.nf
+\f[C]
% Author One; Author Two
-
+\f[R]
+.fi
+.IP
+.nf
+\f[C]
% Author One;
Author Two
\f[R]
@@ -5398,11 +5438,12 @@ For example:
\f[R]
.fi
.IP \[bu] 2
-Dimensions are converted to inches for output in page-based formats like
-LaTeX.
-Dimensions are converted to pixels for output in HTML-like formats.
-Use the \f[C]--dpi\f[R] option to specify the number of pixels per inch.
-The default is 96dpi.
+Dimensions may be converted to a form that is compatible with the output
+format (for example, dimensions given in pixels will be converted to
+inches when converting HTML to LaTeX).
+Conversion between pixels and physical measurements is affected by the
+\f[C]--dpi\f[R] option (by default, 96 dpi is assumed, unless the image
+itself contains dpi information).
.IP \[bu] 2
The \f[C]%\f[R] unit is generally relative to some available space.
For example the above example will render to the following.
@@ -6371,6 +6412,51 @@ contents...
::::::::::::::
\f[R]
.fi
+.SS Additional columns attributes in beamer
+.PP
+The div containers with classes \f[C]columns\f[R] and \f[C]column\f[R]
+can optionally have an \f[C]align\f[R] attribute.
+The class \f[C]columns\f[R] can optionally have a \f[C]totalwidth\f[R]
+attribute or an \f[C]onlytextwidth\f[R] class.
+.IP
+.nf
+\f[C]
+:::::::::::::: {.columns align=center totalwidth=8em}
+::: {.column width=\[dq]40%\[dq]}
+contents...
+:::
+::: {.column width=\[dq]60%\[dq] align=bottom}
+contents...
+:::
+::::::::::::::
+\f[R]
+.fi
+.PP
+The \f[C]align\f[R] attributes on \f[C]columns\f[R] and \f[C]column\f[R]
+can be used with the values \f[C]top\f[R], \f[C]top-baseline\f[R],
+\f[C]center\f[R] and \f[C]bottom\f[R] to vertically align the columns.
+It defaults to \f[C]top\f[R] in \f[C]columns\f[R].
+.PP
+The \f[C]totalwidth\f[R] attribute limits the width of the columns to
+the given value.
+.IP
+.nf
+\f[C]
+:::::::::::::: {.columns align=top .onlytextwidth}
+::: {.column width=\[dq]40%\[dq] align=center}
+contents...
+:::
+::: {.column width=\[dq]60%\[dq]}
+contents...
+:::
+::::::::::::::
+\f[R]
+.fi
+.PP
+The class \f[C]onlytextwidth\f[R] sets the \f[C]totalwidth\f[R] to
+\f[C]\[rs]textwidth\f[R].
+.PP
+See Section 12.7 of the Beamer User\[aq]s Guide for more details.
.SS Frame attributes in beamer
.PP
Sometimes it is necessary to add the LaTeX \f[C][fragile]\f[R] option to