diff --git a/man/pandoc-lua.1 b/man/pandoc-lua.1 --- a/man/pandoc-lua.1 +++ b/man/pandoc-lua.1 @@ -1,6 +1,8 @@ -.\" Automatically generated by Pandoc 3.9.0.2 +.\" Automatically generated by Pandoc 3.10 .\" -.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.9.0.2" "Pandoc User\[cq]s Guide" +.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.10" "Pandoc User\[cq]s Guide" +.SH NAME +pandoc\-lua \- Lua interface to pandoc API .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/man/pandoc-server.1 b/man/pandoc-server.1 --- a/man/pandoc-server.1 +++ b/man/pandoc-server.1 @@ -1,6 +1,8 @@ -.\" Automatically generated by Pandoc 3.9.0.2 +.\" Automatically generated by Pandoc 3.10 .\" -.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.9.0.2" "Pandoc User\[cq]s Guide" +.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.10" "Pandoc User\[cq]s Guide" +.SH NAME +pandoc\-server \- web server exposing pandoc API .SH SYNOPSIS \f[CR]pandoc\-server\f[R] [\f[I]options\f[R]] .SH DESCRIPTION @@ -131,6 +133,10 @@ \f[CR]abbreviations\f[R] (file path) List of strings to be regarded as abbreviations when parsing Markdown. See \f[CR]\-\-abbreviations\f[R] in \f[CR]pandoc(1)\f[R] for details. +.TP +\f[CR]typst\-inputs\f[R] (JSON map) +Inputs to be provided to the typst evaluator. +See \f[CR]\-\-typst\-input\f[R] in \f[CR]pandoc(1)\f[R] for details. .TP \f[CR]standalone\f[R] (boolean, default false) If true, causes a standalone document to be produced, using the default diff --git a/man/pandoc.1 b/man/pandoc.1 --- a/man/pandoc.1 +++ b/man/pandoc.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.9.0.2 +.\" Automatically generated by Pandoc 3.10 .\" -.TH "pandoc" "1" "2026\-03\-19" "pandoc 3.9.0.2" "Pandoc User\[cq]s Guide" +.TH "pandoc" "1" "2026\-06\-03" "pandoc 3.10" "Pandoc User\[cq]s Guide" .SH NAME pandoc - general markup converter .SH SYNOPSIS @@ -539,6 +539,26 @@ .EE .RE .TP +\f[CR]\-\-sandbox[=true|false]\f[R] +Run pandoc in a sandbox, limiting IO operations in readers and writers +to reading the files specified on the command line. +Note that this option does not limit IO operations by filters or in the +production of PDF documents. +But it does offer security against, for example, disclosure of files +through the use of \f[CR]include\f[R] directives. +Anyone using pandoc on untrusted user input should use this option. +.RS +.PP +Note: some readers and writers (e.g., \f[CR]docx\f[R]) need access to +data files. +If these are stored on the file system, then pandoc will not be able to +find them when run in \f[CR]\-\-sandbox\f[R] mode and will raise an +error. +For these applications, we recommend using a pandoc binary compiled with +the \f[CR]embed_data_files\f[R] option, which causes the data files to +be baked into the binary instead of being stored on the file system. +.RE +.TP \f[CR]\-\-verbose\f[R] Give verbose debugging output. .TP @@ -791,6 +811,14 @@ LaTeX. The strings may not contain spaces. .TP +\f[CR]\-\-typst\-input=\f[R]\f[I]KEY\f[R][\f[CR]=\f[R]\f[I]VAL\f[R]] +Set a parameter value that will be made available to the typst parser in +\f[CR]sys.inputs\f[R], like \f[CR]\-\-input\f[R] in the \f[CR]typst\f[R] +CLI. +Either \f[CR]:\f[R] or \f[CR]=\f[R] may be used to separate +\f[I]KEY\f[R] from \f[I]VAL\f[R]. +Values containing spaces must be quoted. +.TP \f[CR]\-\-trace[=true|false]\f[R] Print diagnostic output tracing parser progress to stderr. This option is intended for use by developers in diagnosing performance @@ -835,11 +863,11 @@ added to the list. If it already has another kind of value, it will be made into a list containing the previous and the new value. -For example, \f[CR]\-V keyword=Joe \-V author=Sue\f[R] makes +For example, \f[CR]\-V author=Joe \-V author=Sue\f[R] makes \f[CR]author\f[R] contain a list of strings: \f[CR]Joe\f[R] and \f[CR]Sue\f[R]. .TP -\f[CR]\-\-variable\-json=\f[R]\f[I]KEY\f[R][\f[CR]=\f[R]:\f[I]JSON\f[R]] +\f[CR]\-\-variable\-json=\f[R]\f[I]KEY\f[R][\f[CR]=\f[R]\f[I]JSON\f[R]] Set the template variable \f[I]KEY\f[R] to the value specified by a JSON string (this may be a boolean, a string, a list, or a mapping; a number will be treated as a string). @@ -851,26 +879,6 @@ \f[I]KEY\f[R] from \f[I]VAL\f[R]. If the variable already has a value, this value will be replaced. .TP -\f[CR]\-\-sandbox[=true|false]\f[R] -Run pandoc in a sandbox, limiting IO operations in readers and writers -to reading the files specified on the command line. -Note that this option does not limit IO operations by filters or in the -production of PDF documents. -But it does offer security against, for example, disclosure of files -through the use of \f[CR]include\f[R] directives. -Anyone using pandoc on untrusted user input should use this option. -.RS -.PP -Note: some readers and writers (e.g., \f[CR]docx\f[R]) need access to -data files. -If these are stored on the file system, then pandoc will not be able to -find them when run in \f[CR]\-\-sandbox\f[R] mode and will raise an -error. -For these applications, we recommend using a pandoc binary compiled with -the \f[CR]embed_data_files\f[R] option, which causes the data files to -be baked into the binary instead of being stored on the file system. -.RE -.TP \f[CR]\-D\f[R] \f[I]FORMAT\f[R], \f[CR]\-\-print\-default\-template=\f[R]\f[I]FORMAT\f[R] Print the system default template for an output \f[I]FORMAT\f[R]. (See \f[CR]\-t\f[R] for a list of possible \f[I]FORMAT\f[R]s.) @@ -940,13 +948,10 @@ .RS .PP Note that if you are producing a PDF via \f[CR]ms\f[R] and using (the -default) \f[CR]pdfroff\f[R] as a \f[CR]\-\-pdf\-engine\f[R], the table -of contents will appear at the beginning of the document, before the -title. -If you would prefer it to be at the end of the document, use the option -\f[CR]\-\-pdf\-engine\-opt=\-\-no\-toc\-relocation\f[R]. -If \f[CR]groff\f[R] is used as the \f[CR]\-\-pdf\-engine\f[R], the table -of contents will always appear at the end of the document. +default) \f[CR]groff\f[R] as a \f[CR]\-\-pdf\-engine\f[R], the table of +contents will appear at the end of the document. +If you would prefer it to be at the beginning of the document, before +the title, you can use \f[CR]\-\-pdf\-engine=pdfroff\f[R]. .RE .TP \f[CR]\-\-toc\-depth=\f[R]\f[I]NUMBER\f[R] @@ -1348,8 +1353,8 @@ To produce a custom \f[CR]reference.docx\f[R], first get a copy of the default \f[CR]reference.docx\f[R]: \f[CR]pandoc \-o custom\-reference.docx \-\-print\-default\-data\-file reference.docx\f[R]. -Then open \f[CR]custom\-reference.docx\f[R] in Word, modify the styles -as you wish, and save the file. +Then open \f[CR]custom\-reference.docx\f[R] in Word or LibreOffice, +modify the styles as you wish, and save the file. For best results, do not make changes to this file other than modifying the styles used by pandoc: .PP @@ -1639,7 +1644,7 @@ print\-css.rocks for a good introduction to PDF generation from HTML/CSS) .IP \(bu 2 -\f[CR]\-t ms\f[R]: \f[CR]pdfroff\f[R] +\f[CR]\-t ms\f[R]: \f[CR]groff\f[R] .IP \(bu 2 \f[CR]\-t typst\f[R]: \f[CR]typst\f[R] .PP @@ -2032,6 +2037,9 @@ \-\-abbreviations abbrevs.txt abbreviations: abbrevs.txt + \-\-typst\-input foo=bar typst\-inputs: + foo: bar + \-\-trace trace: true .EE @@ -3635,13 +3643,13 @@ .TP input formats \f[CR]markdown\f[R], \f[CR]latex\f[R], \f[CR]rst\f[R], -\f[CR]mediawiki\f[R], \f[CR]textile\f[R] +\f[CR]mediawiki\f[R], \f[CR]textile\f[R], \f[CR]man\f[R] .TP output formats \f[CR]markdown\f[R], \f[CR]muse\f[R] .TP enabled by default in -\f[CR]markdown\f[R], \f[CR]muse\f[R] +\f[CR]markdown\f[R], \f[CR]muse\f[R], \f[CR]man\f[R] .PP The default algorithm used to derive the identifier from the heading text is: @@ -4617,21 +4625,21 @@ two spaces. .PP A term may have multiple definitions, and each definition may consist of -one or more block elements (paragraph, code block, list, etc.), each -indented four spaces or one tab stop. -The body of the definition (not including the first line) should be -indented four spaces. -However, as with other Markdown lists, you can \(lqlazily\(rq omit -indentation except at the beginning of a paragraph or other block -element: +one or more indented block elements (paragraph, code block, list, etc.). +The blocks in the definition shoud be indented to the column of the +first non\-space content after the \f[CR]:\f[R] or \f[CR]\(ti\f[R] +marker, or (if the \f[CR]four_space_rule\f[R] extension is enabled) four +spaces or one tab stop. +As with other Markdown lists, you can \(lqlazily\(rq omit indentation in +paragraph continuation lines: .IP .EX Term 1 -: Definition +: Definition with lazy continuation. - Second paragraph of the definition. + Second paragraph of the definition. .EE .PP If you leave space before the definition (as in the example above), the @@ -5270,10 +5278,11 @@ \(ga\(ga\(ga .EE .PP -Note: the \f[CR]yaml_metadata_block\f[R] extension works with -\f[CR]commonmark\f[R] as well as \f[CR]markdown\f[R] (and it is enabled -by default in \f[CR]gfm\f[R] and \f[CR]commonmark_x\f[R]). -However, in these formats the following restrictions apply: +Note: the \f[CR]yaml_metadata_block\f[R] extension works not just with +\f[CR]markdown\f[R] but with \f[CR]commonmark\f[R] (and it is enabled by +default in \f[CR]gfm\f[R] and \f[CR]commonmark_x\f[R]). +However, in \f[CR]commonmark\f[R], \f[CR]gfm\f[R], and +\f[CR]commonmark_x\f[R], the following restrictions apply: .IP \(bu 2 The YAML metadata block must occur at the beginning of the document (and there can be only one). @@ -5778,6 +5787,12 @@ in square brackets. (There cannot be space between the two unless the \f[CR]spaced_reference_links\f[R] extension is enabled.) +If the label is empty (\f[CR][]\f[R]), then it will be implicitly be +taken to be the same as the link text; thus \f[CR][foo][]\f[R] is +equivalent to \f[CR][foo][foo]\f[R]. +(If the \f[CR]shortcut_reference_links\f[R] extension is enabled, the +empty \f[CR][]\f[R] may be omitted.) +.PP The link definition consists of the bracketed label, followed by a colon and a space, followed by the URL, and optionally (after a space) a link title either in quotes or in parentheses. @@ -5785,16 +5800,22 @@ \f[CR]citations\f[R] extension is enabled): citations take precedence over link labels. .PP -Here are some examples: +Here are some examples of reference links and link definitions; .IP .EX -[my label 1]: /foo/bar.html \(dqMy title, optional\(dq -[my label 2]: /foo -[my label 3]: https://fsf.org (The Free Software Foundation) -[my label 4]: /bar#special \(aqA title in single quotes\(aq +See [the website *I* built][my website]. + +See [my website][] and [the bar page][1] and +the [home page of the FSF][fsf]. + +[my website]: http://foo.bar.baz +[1]: /foo/bar.html \(dqMy title, optional\(dq +[fsf]: https://fsf.org (The Free Software Foundation) +[special page]: /bar#special \(aqA title in single quotes\(aq .EE .PP -The URL may optionally be surrounded by angle brackets: +The URL in a link definition may optionally be surrounded by angle +brackets: .IP .EX [my label 5]: @@ -5816,21 +5837,13 @@ [Foo]: /bar/baz .EE .PP -In an \f[I]implicit\f[R] reference link, the second pair of brackets is -empty: -.IP -.EX -See [my website][]. - -[my website]: http://foo.bar.baz -.EE +The link definition may come either before or after a reference link +that uses the label. .PP -Note: In \f[CR]Markdown.pl\f[R] and most other Markdown implementations, -reference link definitions cannot occur in nested constructions such as -list items or block quotes. +Note: In some Markdown implementations, reference link definitions +cannot occur in nested constructions such as list items or block quotes. Pandoc lifts this arbitrary\-seeming restriction. -So the following is fine in pandoc, though not in most other -implementations: +So the following is fine in pandoc, though not in all implementations: .IP .EX > My block [quote]. diff --git a/pandoc-cli.cabal b/pandoc-cli.cabal --- a/pandoc-cli.cabal +++ b/pandoc-cli.cabal @@ -1,6 +1,6 @@ cabal-version: 2.4 name: pandoc-cli -version: 3.9.0.2 +version: 3.10 build-type: Simple license: GPL-2.0-or-later license-file: COPYING.md @@ -69,7 +69,7 @@ buildable: True -- Note: we always link to an exact version of pandoc, with the -- same version as this package: - build-depends: pandoc == 3.9.0.2, text + build-depends: pandoc == 3.10, text other-modules: PandocCLI.Lua , PandocCLI.Server