aboutsummaryrefslogtreecommitdiff
path: root/pandoc-cli
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2024-09-09 22:14:43 -0700
committerJohn MacFarlane <[email protected]>2024-09-09 22:14:43 -0700
commit6f6a73684411dbd0daec23466659328eb174c31f (patch)
treed7dd54dffc3706e6a544b4ead5bcb298cc9b4d61 /pandoc-cli
parent103149d75dfcc451abe39ceb1a3e165679169bbe (diff)
Update man pages.
Diffstat (limited to 'pandoc-cli')
-rw-r--r--pandoc-cli/man/pandoc-lua.14
-rw-r--r--pandoc-cli/man/pandoc-server.14
-rw-r--r--pandoc-cli/man/pandoc.168
3 files changed, 58 insertions, 18 deletions
diff --git a/pandoc-cli/man/pandoc-lua.1 b/pandoc-cli/man/pandoc-lua.1
index 54b9564e9..d0c4a68d5 100644
--- a/pandoc-cli/man/pandoc-lua.1
+++ b/pandoc-cli/man/pandoc-lua.1
@@ -1,6 +1,6 @@
-.\" Automatically generated by Pandoc 3.3
+.\" Automatically generated by Pandoc 3.4
.\"
-.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.3" "Pandoc User\[cq]s Guide"
+.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.4" "Pandoc User\[cq]s Guide"
.SH SYNOPSIS
\f[CR]pandoc\-lua\f[R] [\f[I]options\f[R]] [\f[I]script\f[R]
[\f[I]args\f[R]]]
diff --git a/pandoc-cli/man/pandoc-server.1 b/pandoc-cli/man/pandoc-server.1
index 9c1e6e609..f4aba4ee5 100644
--- a/pandoc-cli/man/pandoc-server.1
+++ b/pandoc-cli/man/pandoc-server.1
@@ -1,6 +1,6 @@
-.\" Automatically generated by Pandoc 3.3
+.\" Automatically generated by Pandoc 3.4
.\"
-.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.3" "Pandoc User\[cq]s Guide"
+.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.4" "Pandoc User\[cq]s Guide"
.SH SYNOPSIS
\f[CR]pandoc\-server\f[R] [\f[I]options\f[R]]
.SH DESCRIPTION
diff --git a/pandoc-cli/man/pandoc.1 b/pandoc-cli/man/pandoc.1
index 22cc7b9c7..755b23fb7 100644
--- a/pandoc-cli/man/pandoc.1
+++ b/pandoc-cli/man/pandoc.1
@@ -1,6 +1,6 @@
-.\" Automatically generated by Pandoc 3.3
+.\" Automatically generated by Pandoc 3.4
.\"
-.TH "pandoc" "1" "July 28, 2024" "pandoc 3.3" "Pandoc User\[cq]s Guide"
+.TH "pandoc" "1" "September 9, 2024" "pandoc 3.4" "Pandoc User\[cq]s Guide"
.SH NAME
pandoc - general markup converter
.SH SYNOPSIS
@@ -157,7 +157,9 @@ document contains images), \f[CR]bookmark\f[R], \f[CR]xcolor\f[R],
\f[CR]soul\f[R], \f[CR]geometry\f[R] (with the \f[CR]geometry\f[R]
variable set), \f[CR]setspace\f[R] (with \f[CR]linestretch\f[R]), and
\f[CR]babel\f[R] (with \f[CR]lang\f[R]).
-If \f[CR]CJKmainfont\f[R] is set, \f[CR]xeCJK\f[R] is needed.
+If \f[CR]CJKmainfont\f[R] is set, \f[CR]xeCJK\f[R] is needed if
+\f[CR]xelatex\f[R] is used, else \f[CR]luatexja\f[R] is needed if
+\f[CR]lualatex\f[R] is used.
\f[CR]framed\f[R] is required if code is highlighted in a scheme that
use a colored background.
The use of \f[CR]xelatex\f[R] or \f[CR]lualatex\f[R] as the PDF engine
@@ -306,6 +308,8 @@ Specify output format.
\f[I]FORMAT\f[R] can be:
.RS
.IP \[bu] 2
+\f[CR]ansi\f[R] (text with ANSI escape codes, for terminal viewing)
+.IP \[bu] 2
\f[CR]asciidoc\f[R] (modern AsciiDoc as interpreted by AsciiDoctor)
.IP \[bu] 2
\f[CR]asciidoc_legacy\f[R] (AsciiDoc as interpreted by
@@ -1072,6 +1076,16 @@ Currently this option only affects the \f[CR]markdown\f[R],
In slide formats, specifying \f[CR]\-\-reference\-location=section\f[R]
will cause notes to be rendered at the bottom of a slide.
.TP
+\f[CR]\-\-figure\-caption\-position=above\f[R]|\f[CR]below\f[R]
+Specify whether figure captions go above or below figures (default is
+\f[CR]below\f[R]).
+This option only affects HTML, LaTeX, Docx, ODT, and Typst output.
+.TP
+\f[CR]\-\-table\-caption\-position=above\f[R]|\f[CR]below\f[R]
+Specify whether table captions go above or below tables (default is
+\f[CR]above\f[R]).
+This option only affects HTML, LaTeX, Docx, ODT, and Typst output.
+.TP
\f[CR]\-\-markdown\-headings=setext\f[R]|\f[CR]atx\f[R]
Specify whether to use ATX\-style (\f[CR]#\f[R]\-prefixed) or
Setext\-style (underlined) headings for level 1 and 2 headings in
@@ -1107,17 +1121,19 @@ Sections with class \f[CR]unnumbered\f[R] will never be numbered, even
if \f[CR]\-\-number\-sections\f[R] is specified.
.TP
\f[CR]\-\-number\-offset=\f[R]\f[I]NUMBER\f[R][\f[CR],\f[R]\f[I]NUMBER\f[R]\f[CR],\f[R]\f[I]\&...\f[R]]
-Offset for section headings in HTML output (ignored in other output
-formats).
-The first number is added to the section number for top\-level headings,
-the second for second\-level headings, and so on.
-So, for example, if you want the first top\-level heading in your
-document to be numbered \[lq]6\[rq], specify
+Offsets for section heading numbers.
+The first number is added to the section number for level\-1 headings,
+the second for level\-2 headings, and so on.
+So, for example, if you want the first level\-1 heading in your document
+to be numbered \[lq]6\[rq] instead of \[lq]1\[rq], specify
\f[CR]\-\-number\-offset=5\f[R].
If your document starts with a level\-2 heading which you want to be
numbered \[lq]1.5\[rq], specify \f[CR]\-\-number\-offset=1,4\f[R].
-Offsets are 0 by default.
+\f[CR]\-\-number\-offset\f[R] only directly affects the number of the
+first section heading in a document; subsequent numbers increment in the
+normal way.
Implies \f[CR]\-\-number\-sections\f[R].
+Currently this feature only affects HTML and Docx output.
.TP
\f[CR]\-\-listings[=true|false]\f[R]
Use the \f[CR]listings\f[R] package for LaTeX code blocks.
@@ -1501,8 +1517,8 @@ depending on the output format specified using \f[CR]\-t/\-\-to\f[R]:
.IP \[bu] 2
\f[CR]\-t context\f[R]: \f[CR]context\f[R]
.IP \[bu] 2
-\f[CR]\-t html\f[R]: \f[CR]wkhtmltopdf\f[R] (other options:
-\f[CR]prince\f[R], \f[CR]weasyprint\f[R], \f[CR]pagedjs\-cli\f[R]; see
+\f[CR]\-t html\f[R]: \f[CR]weasyprint\f[R] (other options:
+\f[CR]prince\f[R], \f[CR]wkhtmltopdf\f[R], \f[CR]pagedjs\-cli\f[R]; see
print\-css.rocks for a good introduction to PDF generation from
HTML/CSS)
.IP \[bu] 2
@@ -1538,6 +1554,14 @@ filters or Lua filters (see \f[CR]\-\-filter\f[R],
\f[CR]\-\-lua\-filter\f[R]): these transformations are applied in the
order they appear on the command line.
For more information, see the section on Citations.
+.RS
+.PP
+Note: if your target format is \f[CR]markdown\f[R], \f[CR]org\f[R], or
+\f[CR]typst\f[R], you will need to disable the \f[CR]citations\f[R]
+extension (e.g., \f[CR]\-t markdown\-citations\f[R]) to see the rendered
+citations and bibliography.
+Otherwise the format\[cq]s own citation syntax will be used.
+.RE
.TP
\f[CR]\-\-bibliography=\f[R]\f[I]FILE\f[R]
Set the \f[CR]bibliography\f[R] field in the document\[cq]s metadata to
@@ -1958,6 +1982,8 @@ or \f[CR]{type: citeproc}\f[R].
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-self\-contained self\-contained: true
+ \-\-link\-images link\-images: true
+
\-\-html\-q\-tags html\-q\-tags: true
\-\-ascii ascii: true
@@ -1966,6 +1992,12 @@ or \f[CR]{type: citeproc}\f[R].
\-\-reference\-location block reference\-location: block
+
+ \-\-figure\-caption\-position=above figure\-caption\-position: above
+
+ table\-caption\-position: below
+ \-\-table\-caption\-position=below
+
\-\-markdown\-headings atx markdown\-headings: atx
\-\-list\-tables list\-tables: true
@@ -2941,9 +2973,11 @@ KOMA\-Script classes, such as \f[CR]scrartcl\f[R] or \f[CR]scrbook\f[R].
\f[CR]mainfont\f[R], \f[CR]sansfont\f[R], \f[CR]monofont\f[R], \f[CR]mathfont\f[R], \f[CR]CJKmainfont\f[R], \f[CR]CJKsansfont\f[R], \f[CR]CJKmonofont\f[R]
font families for use with \f[CR]xelatex\f[R] or \f[CR]lualatex\f[R]:
take the name of any system font, using the \f[CR]fontspec\f[R] package.
-\f[CR]CJKmainfont\f[R] uses the \f[CR]xecjk\f[R] package.
+\f[CR]CJKmainfont\f[R] uses the \f[CR]xecjk\f[R] package if
+\f[CR]xelatex\f[R] is used, or the \f[CR]luatexja\f[R] package if
+\f[CR]lualatex\f[R] is used.
.TP
-\f[CR]mainfontoptions\f[R], \f[CR]sansfontoptions\f[R], \f[CR]monofontoptions\f[R], \f[CR]mathfontoptions\f[R], \f[CR]CJKoptions\f[R]
+\f[CR]mainfontoptions\f[R], \f[CR]sansfontoptions\f[R], \f[CR]monofontoptions\f[R], \f[CR]mathfontoptions\f[R], \f[CR]CJKoptions\f[R], \f[CR]luatexjapresetoptions\f[R]
options to use with \f[CR]mainfont\f[R], \f[CR]sansfont\f[R],
\f[CR]monofont\f[R], \f[CR]mathfont\f[R], \f[CR]CJKmainfont\f[R] in
\f[CR]xelatex\f[R] and \f[CR]lualatex\f[R].
@@ -3654,9 +3688,15 @@ included as raw Markdown blocks (allowing lossless round\-tripping)
rather than being parsed.
Use this only when you are targeting \f[CR]ipynb\f[R] or a
Markdown\-based output format.
+.SS Extension: \f[CR]citations\f[R] (typst)
+When the \f[CR]citations\f[R] extension is enabled in \f[CR]typst\f[R]
+(as it is by default), \f[CR]typst\f[R] citations will be parsed as
+native pandoc citations, and native pandoc citations will be rendered as
+\f[CR]typst\f[R] citations.
.SS Extension: \f[CR]citations\f[R] (org)
When the \f[CR]citations\f[R] extension is enabled in \f[CR]org\f[R],
org\-cite and org\-ref style citations will be parsed as native pandoc
+citations, and org\-cite citations will be used to render native pandoc
citations.
.SS Extension: \f[CR]citations\f[R] (docx)
When \f[CR]citations\f[R] is enabled in \f[CR]docx\f[R], citations