diff options
| author | John MacFarlane <[email protected]> | 2024-02-14 09:12:30 -0800 |
|---|---|---|
| committer | John MacFarlane <[email protected]> | 2024-02-14 09:12:30 -0800 |
| commit | 132508d447e0999352337bf15ebc5bc5bf5c0a7e (patch) | |
| tree | f69456916974665f28d5ed8b4377e9f418e39a63 /pandoc-cli | |
| parent | 32e26b168924dd7adc5261406eea456485394ea9 (diff) | |
Update man page.
Diffstat (limited to 'pandoc-cli')
| -rw-r--r-- | pandoc-cli/man/pandoc-lua.1 | 4 | ||||
| -rw-r--r-- | pandoc-cli/man/pandoc-server.1 | 4 | ||||
| -rw-r--r-- | pandoc-cli/man/pandoc.1 | 126 |
3 files changed, 98 insertions, 36 deletions
diff --git a/pandoc-cli/man/pandoc-lua.1 b/pandoc-cli/man/pandoc-lua.1 index 61221f06a..53a8a9a56 100644 --- a/pandoc-cli/man/pandoc-lua.1 +++ b/pandoc-cli/man/pandoc-lua.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.11.1 +.\" Automatically generated by Pandoc 3.1.12 .\" -.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.1.11.1" "Pandoc User\[cq]s Guide" +.TH "pandoc-lua" "1" "September 22, 2022" "pandoc 3.1.12" "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 4ff778203..be3f0f07c 100644 --- a/pandoc-cli/man/pandoc-server.1 +++ b/pandoc-cli/man/pandoc-server.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.11.1 +.\" Automatically generated by Pandoc 3.1.12 .\" -.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.1.11.1" "Pandoc User\[cq]s Guide" +.TH "pandoc-server" "1" "August 15, 2022" "pandoc 3.1.12" "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 4d02c4943..7c106e28d 100644 --- a/pandoc-cli/man/pandoc.1 +++ b/pandoc-cli/man/pandoc.1 @@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 3.1.11.1 +.\" Automatically generated by Pandoc 3.1.12 .\" -.TH "pandoc" "1" "January 5, 2024" "pandoc 3.1.11.1" "Pandoc User\[cq]s Guide" +.TH "pandoc" "1" "February 14, 2024" "pandoc 3.1.12" "Pandoc User\[cq]s Guide" .SH NAME pandoc - general markup converter .SH SYNOPSIS @@ -217,6 +217,8 @@ Specify input format. .IP \[bu] 2 \f[CR]tsv\f[R] (TSV table) .IP \[bu] 2 +\f[CR]djot\f[R] (Djot markup) +.IP \[bu] 2 \f[CR]docbook\f[R] (DocBook) .IP \[bu] 2 \f[CR]docx\f[R] (Word docx) @@ -324,6 +326,8 @@ Specify output format. .IP \[bu] 2 \f[CR]csljson\f[R] (CSL JSON bibliography) .IP \[bu] 2 +\f[CR]djot\f[R] (Djot markup) +.IP \[bu] 2 \f[CR]docbook\f[R] or \f[CR]docbook4\f[R] (DocBook 4) .IP \[bu] 2 \f[CR]docbook5\f[R] (DocBook 5) @@ -852,7 +856,7 @@ from the source document (that is, where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well). In \f[CR]ipynb\f[R] output, this option affects wrapping of the contents -of markdown cells. +of Markdown cells. .TP \f[CR]\-\-columns=\f[R]\f[I]NUMBER\f[R] Specify length of lines in characters. @@ -969,6 +973,11 @@ Search path components that come later on the command line will be searched before those that come earlier, so \f[CR]\-\-resource\-path foo:bar \-\-resource\-path baz:bim\f[R] is equivalent to \f[CR]\-\-resource\-path baz:bim:foo:bar\f[R]. +Note that this option only has an effect when pandoc itself needs to +find an image (e.g., in producing a PDF or docx, or when +\f[CR]\-\-embed\-resources\f[R] is used.) +It will not cause image paths to be rewritten in other cases (e.g., when +pandoc is generating LaTeX or HTML). .TP \f[CR]\-\-request\-header=\f[R]\f[I]NAME\f[R]\f[CR]:\f[R]\f[I]VAL\f[R] Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] when @@ -1693,14 +1702,14 @@ Fields that are omitted will just have their regular default values. So a defaults file can be as simple as one line: .IP .EX -verbosity: INFO +verbosity\f[B]:\f[R] INFO .EE .PP In fields that expect a file path (or list of file paths), the following syntax may be used to interpolate environment variables: .IP .EX -csl: ${HOME}/mycsldir/special.csl +csl\f[B]:\f[R] ${HOME}/mycsldir/special.csl .EE .PP \f[CR]${USERDATA}\f[R] may also be used; this will always resolve to the @@ -1713,12 +1722,12 @@ file itself. This allows you to refer to resources contained in that directory: .IP .EX -epub\-cover\-image: ${.}/cover.jpg -epub\-metadata: ${.}/meta.xml -resource\-path: -\- . # the working directory from which pandoc is run -\- ${.}/images # the images subdirectory of the directory - # containing this defaults file +epub\-cover\-image\f[B]:\f[R] ${.}/cover.jpg +epub\-metadata\f[B]:\f[R] ${.}/meta.xml +resource\-path\f[B]:\f[R] +\f[B]\-\f[R] .\f[I] # the working directory from which pandoc is run\f[R] +\f[B]\-\f[R] ${.}/images\f[I] # the images subdirectory of the directory\f[R] +\f[I] # containing this defaults file\f[R] .EE .PP This environment variable interpolation syntax \f[I]only\f[R] works in @@ -2910,6 +2919,25 @@ mainfontoptions: .EE .RE .TP +\f[CR]mainfontfallback\f[R], \f[CR]sansfontfallback\f[R], \f[CR]monofontfallback\f[R] +fonts to try if a glyph isn\[cq]t found in \f[CR]mainfont\f[R], +\f[CR]sansfont\f[R], or \f[CR]monofont\f[R] respectively. +These are lists. +The font name must be followed by a colon and optionally a set of +options, for example: +.RS +.IP +.EX +\-\-\- +mainfontfallback: + \- \[dq]FreeSans:\[dq] + \- \[dq]NotoColorEmoji:mode=harf\[dq] +\&... +.EE +.PP +Font fallbacks currently only work with \f[CR]lualatex\f[R]. +.RE +.TP \f[CR]babelfonts\f[R] a map of Babel language names (e.g.\ \f[CR]chinese\f[R]) to the font to be used with the language: @@ -3017,6 +3045,12 @@ include list of figures, list of tables font families: take the name of any system font (see ConTeXt Font Switching) .TP +\f[CR]mainfontfallback\f[R], \f[CR]sansfontfallback\f[R], \f[CR]monofontfallback\f[R] +list of fonts to try, in order, if a glyph is not found in the main +font. +Use \f[CR]\[rs]definefallbackfamily\f[R]\-compatible font name syntax. +Emoji fonts are unsupported. +.TP \f[CR]margin\-left\f[R], \f[CR]margin\-right\f[R], \f[CR]margin\-top\f[R], \f[CR]margin\-bottom\f[R] sets margins, if \f[CR]layout\f[R] is not used (otherwise \f[CR]layout\f[R] overrides these) @@ -3229,14 +3263,14 @@ Markdown with footnotes enabled, while \f[CR]\-\-from markdown\-footnotes\-pipe_tables\f[R] is pandoc\[cq]s Markdown without footnotes or pipe tables. .PP -The markdown reader and writer make by far the most use of extensions. +The Markdown reader and writer make by far the most use of extensions. Extensions only used by them are therefore covered in the section Pandoc\[cq]s Markdown below (see Markdown variants for \f[CR]commonmark\f[R] and \f[CR]gfm\f[R]). In the following, extensions that also work for other formats are covered. .PP -Note that markdown extensions added to the \f[CR]ipynb\f[R] format +Note that Markdown extensions added to the \f[CR]ipynb\f[R] format affect Markdown cells in Jupyter notebooks (as do command\-line options like \f[CR]\-\-markdown\-headings\f[R]). .SS Typography @@ -3402,7 +3436,7 @@ output formats \f[CR]textile\f[R], \f[CR]commonmark\f[R] .PP Note: as applied to \f[CR]ipynb\f[R], \f[CR]raw_html\f[R] and -\f[CR]raw_tex\f[R] affect not only raw TeX in markdown cells, but data +\f[CR]raw_tex\f[R] affect not only raw TeX in Markdown cells, but data with mime type \f[CR]text/html\f[R] in output cells. Since the \f[CR]ipynb\f[R] reader attempts to preserve the richest possible outputs when several options are given, you will get best @@ -3501,7 +3535,7 @@ input formats .TP output formats \f[CR]docx\f[R], \f[CR]odt\f[R], \f[CR]opendocument\f[R], -\f[CR]html\f[R] +\f[CR]html\f[R], \f[CR]latex\f[R] .SS Extension: \f[CR]native_numbering\f[R] Enables native numbering of figures and tables. Enumeration starts at 1. @@ -3562,7 +3596,7 @@ In the \f[CR]ipynb\f[R] input format, this causes Markdown cells to be 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. +Markdown\-based output format. .SS Extension: \f[CR]citations\f[R] 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 @@ -4611,7 +4645,7 @@ orange|3.09 .PP The cells of pipe tables cannot contain block elements like paragraphs and lists, and cannot span multiple lines. -If any line of the markdown source is longer than the column width (see +If any line of the Markdown source is longer than the column width (see \f[CR]\-\-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 table @@ -4757,7 +4791,7 @@ Just be sure that the YAML file begins with \f[CR]\-\-\-\f[R] and ends with \f[CR]\-\-\-\f[R] or \f[CR]...\f[R]. Alternatively, you can use the \f[CR]\-\-metadata\-file\f[R] option. Using that approach however, you cannot reference content (like -footnotes) from the main markdown input document. +footnotes) from the main Markdown input document. .PP Metadata will be taken from the fields of the YAML object and added to any existing document metadata. @@ -4860,7 +4894,7 @@ Raw content to include in the document\[cq]s header may be specified using \f[CR]header\-includes\f[R]; however, it is important to mark up this content as raw code for a particular output format, using the \f[CR]raw_attribute\f[R] extension, or it will be interpreted as -markdown. +Markdown. For example: .IP .EX @@ -5216,8 +5250,8 @@ into whereas \f[CR]Markdown.pl\f[R] will preserve it as is. .PP There is one exception to this rule: text between \f[CR]<script>\f[R], -\f[CR]<style>\f[R], and \f[CR]<textarea>\f[R] tags is not interpreted as -Markdown. +\f[CR]<style>\f[R], \f[CR]<pre>\f[R], and \f[CR]<textarea>\f[R] tags is +not interpreted as Markdown. .PP This departure from original Markdown should make it easier to mix Markdown with HTML block elements. @@ -5570,7 +5604,7 @@ the fallback is to look at the image resolution and the dpi metadata embedded in the image file. .SS Divs and Spans Using the \f[CR]native_divs\f[R] and \f[CR]native_spans\f[R] extensions -(see above), HTML syntax can be used as part of markdown to create +(see above), HTML syntax can be used as part of Markdown to create native \f[CR]Div\f[R] and \f[CR]Span\f[R] elements in the pandoc AST (as opposed to raw HTML). However, there is also nicer syntax available: @@ -5975,7 +6009,7 @@ Note that the pandoc document model does not support abbreviations, so if this extension is enabled, abbreviation keys are simply skipped (as opposed to being parsed as paragraphs). .SS Extension: \f[CR]alerts\f[R] -Supports GitHub\-style markdown alerts, like +Supports GitHub\-style Markdown alerts, like .IP .EX > [!INFO] @@ -5985,19 +6019,19 @@ Supports GitHub\-style markdown alerts, like Makes all absolute URIs into links, even when not surrounded by pointy braces \f[CR]<...>\f[R]. .SS Extension: \f[CR]mmd_link_attributes\f[R] -Parses multimarkdown style key\-value attributes on link and image +Parses MultiMarkdown\-style key\-value attributes on link and image references. This extension should not be confused with the \f[CR]link_attributes\f[R] extension. .IP .EX -This is a reference ![image][ref] with multimarkdown attributes. +This is a reference ![image][ref] with MultiMarkdown attributes. [ref]: https://path.to/image \[dq]Image title\[dq] width=20px height=30px id=myId class=\[dq]myClass1 myClass2\[dq] .EE .SS Extension: \f[CR]mmd_header_identifiers\f[R] -Parses multimarkdown style heading identifiers (in square brackets, +Parses MultiMarkdown\-style heading identifiers (in square brackets, after the heading but before any trailing \f[CR]#\f[R]s in an ATX heading). .SS Extension: \f[CR]compact_definition_lists\f[R] @@ -6024,7 +6058,7 @@ For elements that accept attributes, a \f[CR]data\-pos\f[R] attribute is added; other elements are placed in a surrounding Div or Span element with a \f[CR]data\-pos\f[R] attribute. .SS Extension: \f[CR]short_subsuperscripts\f[R] -Parse multimarkdown style subscripts and superscripts, which start with +Parse MultiMarkdown\-style subscripts and superscripts, which start with a `\[ti]' or `\[ha]' character, respectively, and include the alphanumeric sequence that follows. For example: @@ -6039,7 +6073,7 @@ or Oxygen is O\[ti]2. .EE .SS Extension: \f[CR]wikilinks_title_after_pipe\f[R] -Pandoc supports multiple markdown wikilink syntaxes, regardless of +Pandoc supports multiple Markdown wikilink syntaxes, regardless of whether the title is before or after the pipe. .PP Using \f[CR]\-\-from=markdown+wikilinks_title_after_pipe\f[R] results in @@ -6323,7 +6357,7 @@ The format of the file can be illustrated with an example: .SS Citations in note styles Pandoc\[cq]s citation processing is designed to allow you to move between author\-date, numerical, and note styles without modifying the -markdown source. +Markdown source. When you\[cq]re using a note style, avoid inserting footnotes manually. Instead, insert citations just as you would in an author\-date style\[em]for example, @@ -7065,6 +7099,34 @@ Either \f[CR]ltr\f[R] or \f[CR]rtl\f[R]. Specifies the \f[CR]page\-progression\-direction\f[R] attribute for the \f[CR]spine\f[R] element. .TP +\f[CR]accessModes\f[R] +An array of strings (schema). +Defaults to \f[CR][\[dq]textual\[dq]]\f[R]. +.TP +\f[CR]accessModeSufficient\f[R] +An array of strings (schema). +Defaults to \f[CR][\[dq]textual\[dq]]\f[R]. +.TP +\f[CR]accessibilityHazards\f[R] +An array of strings (schema). +Defaults to \f[CR][\[dq]none\[dq]]\f[R]. +.TP +\f[CR]accessibilityFeatures\f[R] +An array of strings (schema). +Defaults to +.RS +.IP +.EX +\- \[dq]alternativeText\[dq] +\- \[dq]readingOrder\[dq] +\- \[dq]structuralNavigation\[dq] +\- \[dq]tableOfContents\[dq] +.EE +.RE +.TP +\f[CR]accessibilitySummary\f[R] +A string value. +.TP \f[CR]ibooks\f[R] iBooks\-specific metadata, with the following fields: .RS @@ -7090,7 +7152,7 @@ iBooks\-specific metadata, with the following fields: For \f[CR]epub3\f[R] output, you can mark up the heading that corresponds to an EPUB chapter using the \f[CR]epub:type\f[R] attribute. For example, to set the attribute to the value \f[CR]prologue\f[R], use -this markdown: +this Markdown: .IP .EX # My chapter {epub:type=prologue} @@ -7321,8 +7383,8 @@ will prevent tabs from being turned to spaces. Pandoc will automatically highlight syntax in fenced code blocks that are marked with a language name. The Haskell library skylighting is used for highlighting. -Currently highlighting is supported only for HTML, EPUB, Docx, Ms, and -LaTeX/PDF output. +Currently highlighting is supported only for HTML, EPUB, Docx, Ms, Man, +and LaTeX/PDF output. To see a list of language names that pandoc will recognize, type \f[CR]pandoc \-\-list\-highlight\-languages\f[R]. .PP |
