path: root/man/man1/pandoc.1
diff options
Diffstat (limited to 'man/man1/pandoc.1')
1 files changed, 55 insertions, 15 deletions
diff --git a/man/man1/pandoc.1 b/man/man1/pandoc.1
index 0faf1cc00..702e684ed 100644
--- a/man/man1/pandoc.1
+++ b/man/man1/pandoc.1
@@ -1,4 +1,4 @@
-.TH PANDOC 1 "January 29, 2011" "Pandoc"
+.TH PANDOC 1 "July 30, 2011" "Pandoc"
pandoc - general markup converter
@@ -263,9 +263,11 @@ the HTML template.
-.B \f[C]--mathjax=\f[]\f[I]URL\f[]
+.B \f[C]--mathjax\f[][=\f[I]URL\f[]]
Use MathJax to display embedded TeX math in HTML output.
The \f[I]URL\f[] should point to the \f[C]MathJax.js\f[] load script.
+If a \f[I]URL\f[] is not provided, a link to the MathJax CDN will be
@@ -304,11 +306,6 @@ connection is available.
-.B \f[C]--xetex\f[]
-Create LaTeX outut suitable for processing by XeTeX.
.B \f[C]--chapters\f[]
Treat top-level headers as chapters in LaTeX, ConTeXt, and DocBook
@@ -397,18 +394,22 @@ Specify the base level for headers (defaults to 1).
Use \f[I]FILE\f[] as a custom template for the generated document.
Implies \f[C]--standalone\f[].
See Templates below for a description of template syntax.
+If no extension is specified, an extension corresponding to the writer
+will be added, so that \f[C]--template=special\f[] looks for
+\f[C]special.html\f[] for HTML output.
+If the template is not found, pandoc will search for it in the user data
+directory (see \f[C]--data-dir\f[]).
If this option is not used, a default template appropriate for the
-output format will be used.
-See also \f[C]-D/--print-default-template\f[].
+output format will be used (see \f[C]-D/--print-default-template\f[]).
.B \f[C]-V\f[] \f[I]KEY=VAL\f[], \f[C]--variable=\f[]\f[I]KEY:VAL\f[]
Set the template variable \f[I]KEY\f[] to the value \f[I]VAL\f[] when
rendering the document in standalone mode.
-This is only useful when the \f[C]--template\f[] option is used to
-specify a custom template, since pandoc automatically sets the variables
-used in the default templates.
+This is generally only useful when the \f[C]--template\f[] option is
+used to specify a custom template, since pandoc automatically sets the
+variables used in the default templates.
@@ -475,6 +476,13 @@ If it is not found there, sensible defaults will be used.
+.B \f[C]--epub-cover-image=\f[]\f[I]FILE\f[]
+Use the specified image as the EPUB cover.
+It is recommended that the image be less than 1000px in width and
.B \f[C]--epub-metadata=\f[]\f[I]FILE\f[]
Look in the specified XML file for metadata for the EPUB.
The file should contain a series of Dublin Core elements, as documented
@@ -551,6 +559,16 @@ style: either \f[C]default.csl\f[] in the user data directory (see
author-date style.
+.B \f[C]--natbib\f[]
+Use natbib for citations in LaTeX output.
+.B \f[C]--biblatex\f[]
+Use biblatex for citations in LaTeX output.
.B \f[C]--data-dir=\f[]\f[I]DIRECTORY\f[]
Specify the user data directory to search for pandoc data files.
If this option is not specified, the default user data directory will be
@@ -639,7 +657,7 @@ where \f[C]FORMAT\f[] is the name of the output format.
A custom template can be specified using the \f[C]--template\f[] option.
You can also override the system default templates for a given output
format \f[C]FORMAT\f[] by putting a file
-\f[C]templates/FORMAT.template\f[] in the user data directory (see
+\f[C]templates/default.FORMAT\f[] in the user data directory (see
\f[C]--data-dir\f[], above).
Templates may contain \f[I]variables\f[].
@@ -710,6 +728,17 @@ date of document, as specified in title block
language code for HTML documents
+.B \f[C]slidy-url\f[]
+base URL for Slidy documents (defaults to
+.B \f[C]s5-url\f[]
+base URL for S5 documents (defaults to \f[C]ui/default\f[])
Variables may be set at the command line using the
\f[C]-V/--variable\f[] option.
@@ -753,6 +782,14 @@ items:
$for(author)$$author$$sep$,\ $endfor$
+If you use custom templates, you may need to revise them as pandoc
+We recommend tracking the changes in the default templates, and
+modifying your custom templates accordingly.
+An easy way to do this is to fork the pandoc-templates repository
+(\f[C]\f[]) and merge in changes
+after each pandoc release.
You can use Pandoc to produce an HTML + javascript slide presentation
@@ -810,7 +847,9 @@ The file produced by pandoc with the \f[C]-s/--standalone\f[] option
embeds a link to javascripts and CSS files, which are assumed to be
available at the relative path \f[C]ui/default\f[] (for S5) or at the
Slidy website at \f[C]\f[] (for Slidy).
-If the \f[C]--offline\f[] option is specified, the scripts and CSS will
+(These paths can be changed by setting the \f[C]slidy-url\f[] or
+\f[C]s5-url\f[] variables; see \f[C]--variable\f[], above.)
+ If the \f[C]--offline\f[] option is specified, the scripts and CSS will
be included directly in the generated file, so that it may be used
@@ -904,7 +943,8 @@ This software carries no warranty of any kind.
Other contributors include Recai Oktaş, Paulo Tanimoto, Peter Wang,
Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public,
Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton,
-Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner.
+Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub,
+Christopher Sawicki, Kelsey Hightower.
For a complete description of pandoc's extensions to standard markdown,
see \f[C]pandoc_markdown\f[] (5).