~ubuntu-branches/ubuntu/quantal/pandoc/quantal

« back to all changes in this revision

Viewing changes to man/man1/markdown2pdf.1.md

  • Committer: Package Import Robot
  • Author(s): Clint Adams, Kiwamu Okabe, Jonas Smedegaard, Clint Adams
  • Date: 2012-03-04 20:35:25 UTC
  • mfrom: (3.1.12 sid)
  • Revision ID: package-import@ubuntu.com-20120304203525-9rr3xli9gxlefshr
Tags: 1.9.1.1-1
* New upstream release.

[ Kiwamu Okabe ]
* Allow DM uploads.
* New debian/watch file to scan pandoc 1.9
* Bump standards-version to 3.9.3.
* Move maintenance to Haskell team, with Jonas and Kiwamu as
  uploaders.
* Add new (build-)dependencies:
  + libghc-blaze-html-*
  + libghc-temporary-*
  + libghc-zlib-*
  Drop obsolete (build-)dependency:
  + libghc-deepseq-*
  Tighten build-dependencies:
  + libghc-http-dev
  + libghc-texmath-dev
  + libghc-pandoc-types-dev
  + libghc-json-dev
  + libghc-highlighting-kate-dev

[ Jonas Smedegaard ]
* Newline-delimit uploaders field.
* Update copyright file:
  + Extend copyright years.
  + Adapt a Files section.
  + Bump copyright format to final version 1.0.
* Update long descriptions:
  + Mention newly supported output formats:
    - Word Docx
    - AsciiDoc
    - DZSlides.
  + Explicitly mention output formats XHTML and HTML 5.
  + Explicitly mention out put (sub)format LaTeX beamer.
  + No longer mention markdown2pdf: Dropped upstream.

[ Clint Adams ]
* Move -doc build dependencies to Build-Depends-Indep.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
% MARKDOWN2PDF(1) Pandoc User Manuals
2
 
% John MacFarlane, Paulo Tanimoto, and Recai Oktas
3
 
% January 29, 2011
4
 
 
5
 
# NAME
6
 
 
7
 
markdown2pdf - converts markdown-formatted text to PDF, using pdflatex 
8
 
 
9
 
# SYNOPSIS
10
 
 
11
 
markdown2pdf [*options*] [*input-file*]...
12
 
 
13
 
# DESCRIPTION
14
 
 
15
 
`markdown2pdf` converts *input-file* (or text from standard 
16
 
input) from markdown-formatted plain text to PDF, using `pandoc`
17
 
and `pdflatex`. If no output filename is specified (using the `-o`
18
 
option), the name of the output file is derived from the input file;
19
 
thus, for example, if the input file is *hello.txt*, the output file
20
 
will be *hello.pdf*. If the input is read from STDIN and no output
21
 
filename is specified, the output file will be named *stdin.pdf*. If
22
 
multiple input files are specified, they will be concatenated before
23
 
conversion, and the name of the output file will be derived from the
24
 
first input file.
25
 
 
26
 
Input is assumed to be in the UTF-8 character encoding.  If your
27
 
local character encoding is not UTF-8, you should pipe input
28
 
through `iconv`:
29
 
 
30
 
    iconv -t utf-8 input.txt | markdown2pdf
31
 
 
32
 
`markdown2pdf` assumes that the `unicode`, `array`, `fancyvrb`,
33
 
`graphicx`, and `ulem` packages are in latex's search path. If these
34
 
packages are not included in your latex setup, they can be obtained from
35
 
<http://ctan.org>.
36
 
 
37
 
# OPTIONS
38
 
 
39
 
-o *FILE*, \--output=*FILE*
40
 
:   Write output to *FILE*.
41
 
 
42
 
\--strict
43
 
:   Use strict markdown syntax, with no extensions or variants.
44
 
 
45
 
-N, \--number-sections
46
 
:   Number section headings in LaTeX output.  (Default is not to number them.)
47
 
 
48
 
\--listings
49
 
:   Use listings package for LaTeX code blocks
50
 
 
51
 
\--template=*FILE*
52
 
:   Use *FILE* as a custom template for the generated document. Implies
53
 
    `-s`. See the section TEMPLATES in `pandoc`(1) for information about
54
 
    template syntax.  Use `pandoc -D latex` to print the default LaTeX
55
 
    template.
56
 
 
57
 
-V KEY=VAL, \--variable=*KEY:VAL*
58
 
:   Set the template variable KEY to the value VAL when rendering the
59
 
    document in standalone mode.  Use this to set the font size when
60
 
    using the default LaTeX template: `-V fontsize=12pt`.
61
 
 
62
 
-H *FILE*, \--include-in-header=*FILE*
63
 
:   Include (LaTeX) contents of *FILE* at the end of the header.  Implies
64
 
    `-s`.
65
 
 
66
 
-B *FILE*, \--include-before-body=*FILE*
67
 
:   Include (LaTeX) contents of *FILE* at the beginning of the document body.
68
 
 
69
 
-A *FILE*, \--include-after-body=*FILE*
70
 
:   Include (LaTeX) contents of *FILE* at the end of the document body.
71
 
 
72
 
\--bibliography=*FILE*
73
 
:   Specify bibliography database to be used in resolving
74
 
    citations. The database type will be determined from the
75
 
    extension of *FILE*, which may be `.xml` (MODS format),
76
 
    `.bib` (BibTeX format), or `.json` (citeproc JSON).
77
 
 
78
 
\--csl=*FILE*
79
 
:   Specify [CSL] style to be used in formatting citations and
80
 
    the bibliography. If *FILE* is not found, pandoc will look
81
 
    for it in
82
 
 
83
 
        $HOME/.csl
84
 
 
85
 
    in unix and
86
 
 
87
 
        C:\Documents And Settings\USERNAME\Application Data\csl
88
 
 
89
 
    in Windows. If the `--csl` option is not specified, pandoc
90
 
    will use a default style:  either `default.csl` in the
91
 
    user data directory (see `--data-dir`), or, if that is
92
 
    not present, the Chicago author-date style.
93
 
 
94
 
\--data-dir*=DIRECTORY*
95
 
:   Specify the user data directory to search for pandoc data files.
96
 
    If this option is not specified, the default user data directory
97
 
    will be used:
98
 
 
99
 
        $HOME/.pandoc
100
 
 
101
 
    in unix and
102
 
 
103
 
        C:\Documents And Settings\USERNAME\Application Data\pandoc
104
 
 
105
 
    in Windows. A `reference.odt`, `epub.css`, `templates` directory,
106
 
    or `s5` directory placed in this directory will override pandoc's
107
 
    normal defaults.
108
 
 
109
 
\--xetex
110
 
:   Use xelatex instead of pdflatex to create the PDF.
111
 
 
112
 
\--luatex
113
 
:   Use lualatex instead of pdflatex to create the PDF.
114
 
 
115
 
# SEE ALSO
116
 
 
117
 
`pandoc`(1), `pdflatex`(1)
118
 
 
119
 
[CSL]: CitationStyles.org
120