summaryrefslogtreecommitdiff
path: root/man/man1/markdown2pdf.1.md
diff options
context:
space:
mode:
authordr@jones.dk <dr@jones.dk>2010-03-22 12:40:10 +0100
committerdr@jones.dk <dr@jones.dk>2010-03-22 12:40:10 +0100
commit96d4f941026a8eca3ba211facdc8ce66b2ab38bb (patch)
treeaae68ec157e85fe9590d1dd5216fc6b7916e08d3 /man/man1/markdown2pdf.1.md
parent789d0772d8b5d9c066fb8624bd51576cbde5e30b (diff)
Imported Upstream version 1.5.0.1
Diffstat (limited to 'man/man1/markdown2pdf.1.md')
-rw-r--r--man/man1/markdown2pdf.1.md43
1 files changed, 27 insertions, 16 deletions
diff --git a/man/man1/markdown2pdf.1.md b/man/man1/markdown2pdf.1.md
index 0bc8329d7..3947ef8da 100644
--- a/man/man1/markdown2pdf.1.md
+++ b/man/man1/markdown2pdf.1.md
@@ -13,14 +13,15 @@ markdown2pdf [*options*] [*input-file*]...
# DESCRIPTION
`markdown2pdf` converts *input-file* (or text from standard
-input) from markdown-formatted plain text to PDF, using `pdflatex`.
-If no output filename is specified (using the `-o` option),
-the name of the output file is derived from the input file; thus, for
-example, if the input file is *hello.txt*, the output file will be
-*hello.pdf*. If the input is read from STDIN and no output filename
-is specified, the output file will be named *stdin.pdf*. If multiple
-input files are specified, they will be concatenated before conversion,
-and the name of the output file will be derived from the first input file.
+input) from markdown-formatted plain text to PDF, using `pandoc`
+and `pdflatex`. If no output filename is specified (using the `-o`
+option), the name of the output file is derived from the input file;
+thus, for example, if the input file is *hello.txt*, the output file
+will be *hello.pdf*. If the input is read from STDIN and no output
+filename is specified, the output file will be named *stdin.pdf*. If
+multiple input files are specified, they will be concatenated before
+conversion, and the name of the output file will be derived from the
+first input file.
Input is assumed to be in the UTF-8 character encoding. If your
local character encoding is not UTF-8, you should pipe input
@@ -35,20 +36,31 @@ packages are not included in your latex setup, they can be obtained from
# OPTIONS
-`markdown2pdf` is a wrapper around `pandoc`, so all of
-`pandoc`'s options can be used with `markdown2pdf` as well.
-See `pandoc`(1) for a complete list.
-The following options are most relevant:
-
-o *FILE*, \--output=*FILE*
: Write output to *FILE*.
\--strict
: Use strict markdown syntax, with no extensions or variants.
+\--xetex
+: Use xelatex instead of pdflatex to create the PDF.
+
-N, \--number-sections
: Number section headings in LaTeX output. (Default is not to number them.)
+\--template=*FILE*
+: Use *FILE* as a custom template for the generated document. Implies
+ `-s`. See the section TEMPLATES in `pandoc`(1) for information about
+ template syntax. Use `pandoc -D latex` to print the default LaTeX
+ template.
+
+-V KEY=VAL, \--variable=*KEY:VAL*
+: Set the template variable KEY to the value VAL when rendering the
+ document in standalone mode. This is only useful when the
+ `--template` option is used to specify a custom template, since
+ pandoc automatically sets the variables used in the default
+ templates.
+
-H *FILE*, \--include-in-header=*FILE*
: Include (LaTeX) contents of *FILE* at the end of the header. Implies
`-s`.
@@ -60,9 +72,8 @@ The following options are most relevant:
: Include (LaTeX) contents of *FILE* at the end of the document body.
-C *FILE*, \--custom-header=*FILE*
-: Use contents of *FILE*
- as the LaTeX document header (overriding the default header, which can be
- printed using `pandoc -D latex`). Implies `-s`.
+: Use contents of *FILE* as the document header. *Note: This option is
+ deprecated. Users should transition to using `--template` instead.*
# SEE ALSO