diff options
Diffstat (limited to 'man/man1')
| -rw-r--r-- | man/man1/pandoc.1.md | 73 |
1 files changed, 54 insertions, 19 deletions
diff --git a/man/man1/pandoc.1.md b/man/man1/pandoc.1.md index a5fadb5c4..502b0b98d 100644 --- a/man/man1/pandoc.1.md +++ b/man/man1/pandoc.1.md @@ -16,13 +16,13 @@ Pandoc converts files from one markup format to another. It can read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and it can write plain text, markdown, reStructuredText, HTML, LaTeX, ConTeXt, Texinfo, groff man, MediaWiki markup, RTF, OpenDocument XML, -ODT, DocBook XML, and S5 HTML slide shows. +ODT, DocBook XML, EPUB, and Slidy or S5 HTML slide shows. If no *input-file* is specified, input is read from *stdin*. Otherwise, the *input-files* are concatenated (with a blank line between each) and used as input. Output goes to *stdout* by -default (though output to *stdout* is disabled for the `odt` output -format). For output to a file, use the `-o` option: +default (though output to *stdout* is disabled for the `odt` and +`epub` output formats). For output to a file, use the `-o` option: pandoc -o output.html input.txt @@ -53,9 +53,8 @@ markdown: the differences are described in the *README* file in the user documentation. If standard markdown syntax is desired, the `--strict` option may be used. -Pandoc uses the UTF-8 character encoding for both input and output -(unless compiled with GHC 6.12 or higher, in which case it uses -the local encoding). If your local character encoding is not UTF-8, you +Pandoc uses the UTF-8 character encoding for both input and output. +If your local character encoding is not UTF-8, you should pipe input and output through `iconv`: iconv -t utf-8 input.txt | pandoc | iconv -f utf-8 @@ -75,12 +74,13 @@ should pipe input and output through `iconv`: `html` (HTML), `latex` (LaTeX), `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup), `texinfo` (GNU Texinfo), `docbook` (DocBook XML), `opendocument` (OpenDocument XML), - `odt` (OpenOffice text document), `s5` (S5 HTML and javascript slide - show), or `rtf` (rich text format). Note that `odt` output will not - be directed to *stdout*; an output filename must be specified using - the `-o/--output` option. If `+lhs` is appended to `markdown`, - `rst`, `latex`, or `html`, the output will be rendered as literate - Haskell source. + `odt` (OpenOffice text document), `epub` (EPUB book), + `slidy` (Slidy HTML and javascript slide show), + `s5` (S5 HTML and javascript slide show), or `rtf` (rich text + format). Note that `odt` and `epub` output will not be directed to + *stdout*; an output filename must be specified using the `-o/--output` + option. If `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, + the output will be rendered as literate Haskell source. -s, \--standalone : Produce output with an appropriate header and footer (e.g. a @@ -136,8 +136,18 @@ should pipe input and output through `iconv`: : Render TeX math using the mimeTeX CGI script. If *URL* is not specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`. +\--webtex=*URL* +: Render TeX math using an external script. The formula will be + concatenated with the URL provided. If *URL* is not specified, the + Google Chart API will be used. + -i, \--incremental -: Make list items in S5 display incrementally (one by one). +: Make list items in Slidy or S5 display incrementally (one by one). + +\--offline +: Include all the CSS and javascript needed for a Slidy or S5 slide + show in the output, so that the slide show will work even when no + internet connection is available. \--xetex : Create LaTeX outut suitable for processing by XeTeX. @@ -146,6 +156,10 @@ should pipe input and output through `iconv`: : Number section headings in LaTeX, ConTeXt, or HTML output. (Default is not to number them.) +\--section-divs +: Wrap sections in `<div>` tags, and attach identifiers to the + enclosing `<div>` rather than the header itself. + \--no-wrap : Disable text wrapping in output. (Default is to wrap text.) @@ -176,7 +190,7 @@ should pipe input and output through `iconv`: \--toc, \--table-of-contents : Include an automatically generated table of contents (HTML, markdown, RTF) or an instruction to create one (LaTeX, reStructuredText). - This option has no effect on man, DocBook, or S5 output. + This option has no effect on man, DocBook, Slidy, or S5 output. \--base-header-level=*LEVEL* : Specify the base level for headers (defaults to 1). @@ -222,6 +236,26 @@ should pipe input and output through `iconv`: `--data-dir`). If this is not found either, sensible defaults will be used. +\--epub-stylesheet=*filename* +: Use the specified CSS file to style the EPUB. If no stylesheet + is specified, pandoc will look for a file `epub.css` in the + user data directory (see `--data-dir`, below). If it is not + found there, sensible defaults will be used. + +\--epub-metadata=*filename* +: Look in the specified XML file for metadata for the EPUB. + The file should contain a series of Dublin Core elements + (http://dublincore.org/documents/dces/), for example: + + <dc:rights>Creative Commons</dc:rights> + <dc:language>es-AR</dc:language> + + By default, pandoc will include the following metadata elements: + `<dc:title>` (from the document title), `<dc:creator>` (from the + document authors), `<dc:language>` (from the locale), and + `<dc:identifier id="BookId">` (a randomly generated UUID). Any of + these may be overridden by elements in the metadata file. + -D *FORMAT*, \--print-default-template=*FORMAT* : Print the default template for an output *FORMAT*. (See `-t` for a list of possible *FORMAT*s.) @@ -240,8 +274,9 @@ should pipe input and output through `iconv`: C:\Documents And Settings\USERNAME\Application Data\pandoc - in Windows. A reference ODT, `templates` directory, `s5` directory - placed in this directory will override pandoc's normal defaults. + in Windows. A `reference.odt`, `epub.css`, `templates` directory, + or `s5` directory placed in this directory will override pandoc's + normal defaults. \--dump-args : Print information about command-line arguments to *stdout*, then exit. @@ -257,11 +292,11 @@ should pipe input and output through `iconv`: : Ignore command-line arguments (for use in wrapper scripts). Regular Pandoc options are not ignored. Thus, for example, -: pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1 + pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1 -: is equivalent to + is equivalent to -: pandoc -o foo.html -s + pandoc -o foo.html -s -v, \--version : Print version. |