aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/pandoc.1122
1 files changed, 79 insertions, 43 deletions
diff --git a/man/pandoc.1 b/man/pandoc.1
index fb88a6745..50335cc3c 100644
--- a/man/pandoc.1
+++ b/man/pandoc.1
@@ -1,7 +1,7 @@
.\"t
-.\" Automatically generated by Pandoc 2.10
+.\" Automatically generated by Pandoc 2.10.1
.\"
-.TH "Pandoc User\[aq]s Guide" "" "June 29, 2020" "pandoc 2.10" ""
+.TH "Pandoc User\[aq]s Guide" "" "July 23, 2020" "pandoc 2.10.1" ""
.hy
.SH NAME
pandoc - general markup converter
@@ -229,6 +229,8 @@ Specify input format.
.IP \[bu] 2
\f[C]commonmark\f[R] (CommonMark Markdown)
.IP \[bu] 2
+\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
+.IP \[bu] 2
\f[C]creole\f[R] (Creole 1.0)
.IP \[bu] 2
\f[C]csv\f[R] (CSV table)
@@ -313,6 +315,8 @@ Specify output format.
.IP \[bu] 2
\f[C]commonmark\f[R] (CommonMark Markdown)
.IP \[bu] 2
+\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
+.IP \[bu] 2
\f[C]context\f[R] (ConTeXt)
.IP \[bu] 2
\f[C]docbook\f[R] or \f[C]docbook4\f[R] (DocBook 4)
@@ -936,7 +940,7 @@ 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
+\f[B]\f[CB]--no-check-certificate\f[B]\f[R]
Disable the certificate verification to allow access to unsecure HTTP
resources (for example when the certificate is no longer valid or self
signed).
@@ -1017,7 +1021,7 @@ become \f[C]\[rs]part{..}\f[R], while second-level headings remain as
their default type.
.TP
\f[B]\f[CB]-N\f[B]\f[R], \f[B]\f[CB]--number-sections\f[B]\f[R]
-Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
+Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
By default, sections are not numbered.
Sections with class \f[C]unnumbered\f[R] will never be numbered, even if
\f[C]--number-sections\f[R] is specified.
@@ -1196,6 +1200,8 @@ Verbatim Char
Footnote Reference
.IP \[bu] 2
Hyperlink
+.IP \[bu] 2
+Section Number
.PP
Table style:
.IP \[bu] 2
@@ -3131,20 +3137,18 @@ This is handy for reading web pages formatted using MathJax, for
example.
.SS Raw HTML/TeX
.PP
-The following extensions (especially how they affect Markdown
-input/output) are also described in more detail in their respective
-sections of Pandoc\[aq]s Markdown.
-.SS Extension: \f[C]raw_html\f[R]
-.PP
-When converting from HTML, parse elements to raw HTML which are not
-representable in pandoc\[aq]s AST.
+The following extensions are described in more detail in their
+respective sections of Pandoc\[aq]s Markdown:
+.IP \[bu] 2
+\f[C]raw_html\f[R] allows HTML elements which are not representable in
+pandoc\[aq]s AST to be parsed as raw HTML.
By default, this is disabled for HTML input.
-.SS Extension: \f[C]raw_tex\f[R]
-.PP
-Allows raw LaTeX, TeX, and ConTeXt to be included in a document.
-.PP
+.IP \[bu] 2
+\f[C]raw_tex\f[R] allows raw LaTeX, TeX, and ConTeXt to be included in a
+document.
This extension can be enabled/disabled for the following formats (in
addition to \f[C]markdown\f[R]):
+.RS 2
.TP
input formats
\f[C]latex\f[R], \f[C]org\f[R], \f[C]textile\f[R], \f[C]html\f[R]
@@ -3162,24 +3166,20 @@ possible outputs when several options are given, you will get best
results if you disable \f[C]raw_html\f[R] and \f[C]raw_tex\f[R] when
converting to formats like \f[C]docx\f[R] which don\[aq]t allow raw
\f[C]html\f[R] or \f[C]tex\f[R].
-.SS Extension: \f[C]native_divs\f[R]
-.PP
-This extension is enabled by default for HTML input.
-This means that \f[C]div\f[R]s are parsed to pandoc native elements.
-(Alternatively, you can parse them to raw HTML using
-\f[C]-f html-native_divs+raw_html\f[R].)
-.PP
-When converting HTML to Markdown, for example, you may want to drop all
-\f[C]div\f[R]s and \f[C]span\f[R]s:
-.IP
-.nf
-\f[C]
-pandoc -f html-native_divs-native_spans -t markdown
-\f[R]
-.fi
-.SS Extension: \f[C]native_spans\f[R]
-.PP
-Analogous to \f[C]native_divs\f[R] above.
+.RE
+.IP \[bu] 2
+\f[C]native_divs\f[R] causes HTML \f[C]div\f[R] elements to be parsed as
+native pandoc Div blocks.
+If you want them to be parsed as raw HTML, use
+\f[C]-f html-native_divs+raw_html\f[R].
+.IP \[bu] 2
+\f[C]native_spans\f[R] causes HTML \f[C]span\f[R] elements to be parsed
+as native pandoc Span inlines.
+If you want them to be parsed as raw HTML, use
+\f[C]-f html-native_spans+raw_html\f[R].
+If you want to drop all \f[C]div\f[R]s and \f[C]span\f[R]s when
+converting HTML to Markdown, you can use
+\f[C]pandoc -f html-native_divs-native_spans -t markdown\f[R].
.SS Literate Haskell support
.SS Extension: \f[C]literate_haskell\f[R]
.PP
@@ -3289,6 +3289,13 @@ input formats
.PP
In the \f[C]muse\f[R] input format, this enables Text::Amuse extensions
to Emacs Muse markup.
+.SS Extension: \f[C]raw_markdown\f[R]
+.PP
+In the \f[C]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 targetting \f[C]ipynb\f[R] or a
+markdown-based output format.
.SS Extension: \f[C]citations\f[R]
.PP
Some aspects of Pandoc\[aq]s Markdown citation syntax are also accepted
@@ -5909,6 +5916,39 @@ pandoc, but may be enabled by adding \f[C]+EXTENSION\f[R] to the format
name, where \f[C]EXTENSION\f[R] is the name of the extension.
Thus, for example, \f[C]markdown+hard_line_breaks\f[R] is Markdown with
hard line breaks.
+.SS Extension: \f[C]attributes\f[R]
+.PP
+Allows attributes to be attached to any inline or block-level element.
+The syntax for the attributes is the same as that used in
+\f[C]header_attributes\f[R].
+.IP \[bu] 2
+Attributes that occur immediately after an inline element affect that
+element.
+If they follow a space, then they belong to the space.
+(Hence, this option subsumes \f[C]inline_code_attributes\f[R] and
+\f[C]link_attributes\f[R].)
+.IP \[bu] 2
+Attributes that occur immediately before a block element, on a line by
+themselves, affect that element.
+.IP \[bu] 2
+Consecutive attribute specifiers may be used, either for blocks or for
+inlines.
+Their attributes will be combined.
+.IP \[bu] 2
+Attributes that occur at the end of the text of a Setext or ATX heading
+(separated by whitespace from the text) affect the heading element.
+(Hence, this option subsumes \f[C]header_attributes\f[R].)
+.IP \[bu] 2
+Attributes that occur after the opening fence in a fenced code block
+affect the code block element.
+(Hence, this option subsumes \f[C]fenced_code_attributes\f[R].)
+.IP \[bu] 2
+Attributes that occur at the end of a reference link definition affect
+links that refer to that definition.
+.PP
+Note that pandoc\[aq]s AST does not currently allow attributes to be
+attached to arbitrary elements.
+Hence a Span or Div container will be added if needed.
.SS Extension: \f[C]old_dashes\f[R]
.PP
Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
@@ -6105,11 +6145,12 @@ The extensions can, however, all be individually disabled.
Also, \f[C]raw_tex\f[R] only affects \f[C]gfm\f[R] output, not input.
.TP
\f[B]\f[CB]gfm\f[B]\f[R] (GitHub-Flavored Markdown)
-\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]fenced_code_blocks\f[R],
-\f[C]auto_identifiers\f[R], \f[C]gfm_auto_identifiers\f[R],
-\f[C]backtick_code_blocks\f[R], \f[C]autolink_bare_uris\f[R],
-\f[C]space_in_atx_header\f[R], \f[C]intraword_underscores\f[R],
-\f[C]strikeout\f[R], \f[C]task_lists\f[R], \f[C]emoji\f[R],
+\f[C]pipe_tables\f[R], \f[C]raw_html\f[R], \f[C]native_divs\f[R],
+\f[C]fenced_code_blocks\f[R], \f[C]auto_identifiers\f[R],
+\f[C]gfm_auto_identifiers\f[R], \f[C]backtick_code_blocks\f[R],
+\f[C]autolink_bare_uris\f[R], \f[C]space_in_atx_header\f[R],
+\f[C]intraword_underscores\f[R], \f[C]strikeout\f[R],
+\f[C]task_lists\f[R], \f[C]emoji\f[R],
\f[C]shortcut_reference_links\f[R], \f[C]angle_brackets_escapable\f[R],
\f[C]lists_without_preceding_blankline\f[R].
.SH PRODUCING SLIDE SHOWS WITH PANDOC
@@ -6782,11 +6823,6 @@ T}@T{
frontmatter
T}
T{
-titlepage
-T}@T{
-frontmatter
-T}
-T{
appendix
T}@T{
backmatter