summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2009-08-14 09:20:29 +0200
committerJonas Smedegaard <dr@jones.dk>2009-08-14 09:20:29 +0200
commit88b315ccee666385e1a4c52e2eb5fb0b0ffe8d60 (patch)
tree53a5d7e250479fb7e8b2a48dd75093d8c569b233 /man
Imported Upstream version 1.2.1
Diffstat (limited to 'man')
-rw-r--r--man/man1/hsmarkdown.1.md42
-rw-r--r--man/man1/html2markdown.1.md95
-rw-r--r--man/man1/markdown2pdf.1.md69
-rw-r--r--man/man1/pandoc.1.md222
4 files changed, 428 insertions, 0 deletions
diff --git a/man/man1/hsmarkdown.1.md b/man/man1/hsmarkdown.1.md
new file mode 100644
index 000000000..a197ef2ca
--- /dev/null
+++ b/man/man1/hsmarkdown.1.md
@@ -0,0 +1,42 @@
+% HSMARKDOWN(1) Pandoc User Manuals
+% John MacFarlane
+% January 8, 2008
+
+# NAME
+
+hsmarkdown - convert markdown-formatted text to HTML
+
+# SYNOPSIS
+
+hsmarkdown [*input-file*]...
+
+# DESCRIPTION
+
+`hsmarkdown` converts markdown-formatted text to HTML. It is designed
+to be usable as a drop-in replacement for John Gruber's `Markdown.pl`.
+
+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. For output to a file, use shell redirection:
+
+ hsmarkdown input.txt > output.html
+
+`hsmarkdown` 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 | hsmarkdown | iconv -f utf-8
+
+`hsmarkdown` is implemented as a wrapper around `pandoc`(1). It
+calls `pandoc` with the options `--from markdown --to html
+--strict` and disables all other options. (Command-line options
+will be interpreted as filenames, as they are by `Markdown.pl`.)
+
+# SEE ALSO
+
+`pandoc`(1). The *README*
+file distributed with Pandoc contains full documentation.
+
+The Pandoc source code and all documentation may be downloaded from
+<http://johnmacfarlane.net/pandoc/>.
diff --git a/man/man1/html2markdown.1.md b/man/man1/html2markdown.1.md
new file mode 100644
index 000000000..73e3420dd
--- /dev/null
+++ b/man/man1/html2markdown.1.md
@@ -0,0 +1,95 @@
+% HTML2MARKDOWN(1) Pandoc User Manuals
+% John MacFarlane and Recai Oktas
+% January 8, 2008
+
+# NAME
+
+html2markdown - converts HTML to markdown-formatted text
+
+# SYNOPSIS
+
+html2markdown [*pandoc-options*] [\-- *special-options*] [*input-file* or
+*URL*]
+
+# DESCRIPTION
+
+`html2markdown` converts *input-file* or *URL* (or text
+from *stdin*) from HTML to markdown-formatted plain text.
+If a URL is specified, `html2markdown` uses an available program
+(e.g. wget, w3m, lynx or curl) to fetch its contents. Output is sent
+to *stdout* unless an output file is specified using the `-o`
+option.
+
+`html2markdown` uses the character encoding specified in the
+"Content-type" meta tag. If this is not present, or if input comes
+from *stdin*, UTF-8 is assumed. A character encoding may be specified
+explicitly using the `-e` special option.
+
+# OPTIONS
+
+`html2markdown` is a wrapper for `pandoc`, so all of
+`pandoc`'s options may be used. See `pandoc`(1) for
+a complete list. The following options are most relevant:
+
+-s, \--standalone
+: Include title, author, and date information (if present) at the
+ top of markdown output.
+
+-o *FILE*, \--output=*FILE*
+: Write output to *FILE* instead of *stdout*.
+
+\--strict
+: Use strict markdown syntax, with no extensions or variants.
+
+\--reference-links
+: Use reference-style links, rather than inline links, in writing markdown
+ or reStructuredText.
+
+-R, \--parse-raw
+: Parse untranslatable HTML codes as raw HTML.
+
+\--no-wrap
+: Disable text wrapping in output. (Default is to wrap text.)
+
+-H *FILE*, \--include-in-header=*FILE*
+: Include contents of *FILE* at the end of the header. Implies
+ `-s`.
+
+-B *FILE*, \--include-before-body=*FILE*
+: Include contents of *FILE* at the beginning of the document body.
+
+-A *FILE*, \--include-after-body=*FILE*
+: Include contents of *FILE* at the end of the document body.
+
+-C *FILE*, \--custom-header=*FILE*
+: Use contents of *FILE*
+ as the document header (overriding the default header, which can be
+ printed using `pandoc -D markdown`). Implies `-s`.
+
+# SPECIAL OPTIONS
+
+In addition, the following special options may be used. The special
+options must be separated from the `html2markdown` command and any
+regular `pandoc` options by the delimiter \``--`', as in
+
+ html2markdown -o foo.txt -- -g 'curl -u bar:baz' -e latin1 \
+ www.foo.com
+
+-e *encoding*, \--encoding=*encoding*
+: Assume the character encoding *encoding* in reading HTML.
+ (Note: *encoding* will be passed to `iconv`; a list of
+ available encodings may be obtained using `iconv -l`.)
+ If this option is not specified and input is not from
+ *stdin*, `html2markdown` will try to extract the character encoding
+ from the "Content-type" meta tag. If no character encoding is
+ specified in this way, or if input is from *stdin*, UTF-8 will be
+ assumed.
+
+-g *command*, \--grabber=*command*
+: Use *command* to fetch the contents of a URL. (By default,
+ `html2markdown` searches for an available program or text-based
+ browser to fetch the contents of a URL.)
+
+# SEE ALSO
+
+`pandoc`(1), `iconv`(1)
diff --git a/man/man1/markdown2pdf.1.md b/man/man1/markdown2pdf.1.md
new file mode 100644
index 000000000..0bc8329d7
--- /dev/null
+++ b/man/man1/markdown2pdf.1.md
@@ -0,0 +1,69 @@
+% MARKDOWN2PDF(1) Pandoc User Manuals
+% John MacFarlane and Recai Oktas
+% January 8, 2008
+
+# NAME
+
+markdown2pdf - converts markdown-formatted text to PDF, using pdflatex
+
+# SYNOPSIS
+
+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 is assumed to be in the UTF-8 character encoding. If your
+local character encoding is not UTF-8, you should pipe input
+through `iconv`:
+
+ iconv -t utf-8 input.txt | markdown2pdf
+
+`markdown2pdf` assumes that the `unicode`, `array`, `fancyvrb`,
+`graphicx`, and `ulem` packages are in latex's search path. If these
+packages are not included in your latex setup, they can be obtained from
+<http://ctan.org>.
+
+# 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.
+
+-N, \--number-sections
+: Number section headings in LaTeX output. (Default is not to number them.)
+
+-H *FILE*, \--include-in-header=*FILE*
+: Include (LaTeX) contents of *FILE* at the end of the header. Implies
+ `-s`.
+
+-B *FILE*, \--include-before-body=*FILE*
+: Include (LaTeX) contents of *FILE* at the beginning of the document body.
+
+-A *FILE*, \--include-after-body=*FILE*
+: 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`.
+
+# SEE ALSO
+
+`pandoc`(1), `pdflatex`(1)
diff --git a/man/man1/pandoc.1.md b/man/man1/pandoc.1.md
new file mode 100644
index 000000000..9a0907321
--- /dev/null
+++ b/man/man1/pandoc.1.md
@@ -0,0 +1,222 @@
+% PANDOC(1) Pandoc User Manuals
+% John MacFarlane
+% January 8, 2008
+
+# NAME
+
+pandoc - general markup converter
+
+# SYNOPSIS
+
+pandoc [*options*] [*input-file*]...
+
+# DESCRIPTION
+
+Pandoc converts files from one markup format to another. It can
+read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and
+it can write markdown, reStructuredText, HTML, LaTeX, ConTeXt, Texinfo,
+groff man, MediaWiki markup, RTF, OpenDocument XML, ODT, DocBook XML,
+and 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:
+
+ pandoc -o output.html input.txt
+
+The input and output formats may be specified using command-line options
+(see **OPTIONS**, below, for details). If these formats are not
+specified explicitly, Pandoc will attempt to determine them
+from the extensions of the input and output filenames. If input comes
+from *stdin* or from a file with an unknown extension, the input is assumed
+to be markdown. If no output filename is specified using the `-o`
+option, or if a filename is specified but its extension is unknown,
+the output will default to HTML. Thus, for example,
+
+ pandoc -o chap1.tex chap1.txt
+
+converts *chap1.txt* from markdown to LaTeX. And
+
+ pandoc README
+
+converts *README* from markdown to HTML.
+
+Pandoc's version of markdown is an extended variant of standard
+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.
+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
+
+Pandoc's HTML parser is not very forgiving. If your input is
+HTML, consider running it through `tidy`(1) before passing it
+to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
+
+# OPTIONS
+
+-f *FORMAT*, -r *FORMAT*, \--from=*FORMAT*, \--read=*FORMAT*
+: Specify input format. *FORMAT* can be
+ `native` (native Haskell), `markdown` (markdown or plain text),
+ `rst` (reStructuredText), `html` (HTML), or `latex` (LaTeX).
+ If `+lhs` is appended to `markdown`, `rst`, or `latex`, the input
+ will be treated as literate Haskell source.
+
+-t *FORMAT*, -w *FORMAT*, \--to=*FORMAT*, \--write=*FORMAT*
+: Specify output format. *FORMAT* can be `native` (native Haskell),
+ `markdown` (markdown or plain text), `rst` (reStructuredText),
+ `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.
+
+-s, \--standalone
+: Produce output with an appropriate header and footer (e.g. a
+ standalone HTML, LaTeX, or RTF file, not a fragment).
+
+-o *FILE*, \--output=*FILE*
+: Write output to *FILE* instead of *stdout*. If *FILE* is
+ \``-`', output will go to *stdout*.
+
+-p, \--preserve-tabs
+: Preserve tabs instead of converting them to spaces.
+
+\--tab-stop=*TABSTOP*
+: Specify tab stop (default is 4).
+
+\--strict
+: Use strict markdown syntax, with no extensions or variants.
+
+\--reference-links
+: Use reference-style links, rather than inline links, in writing markdown
+ or reStructuredText.
+
+-R, \--parse-raw
+: Parse untranslatable HTML codes and LaTeX environments as raw HTML
+ or LaTeX, instead of ignoring them.
+
+-S, \--smart
+: Use smart quotes, dashes, and ellipses. (This option is significant
+ only when the input format is `markdown`. It is selected automatically
+ when the output format is `latex` or `context`.)
+
+-m*URL*, \--latexmathml=*URL*
+: Use LaTeXMathML to display embedded TeX math in HTML output.
+ To insert a link to a local copy of the `LaTeXMathML.js` script,
+ provide a *URL*. If no *URL* is provided, the contents of the
+ script will be inserted directly into the HTML header.
+
+\--jsmath=*URL*
+: Use jsMath to display embedded TeX math in HTML output.
+ The *URL* should point to the jsMath load script; if provided,
+ it will be linked to in the header of standalone HTML documents.
+
+\--gladtex
+: Enclose TeX math in `<eq>` tags in HTML output. These can then
+ be processed by gladTeX to produce links to images of the typeset
+ formulas.
+
+\--mimetex=*URL*
+: 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`.
+
+-i, \--incremental
+: Make list items in S5 display incrementally (one by one).
+
+-N, \--number-sections
+: Number section headings in LaTeX output. (Default is not to number
+ them.)
+
+\--no-wrap
+: Disable text wrapping in output. (Default is to wrap text.)
+
+\--sanitize-html
+: Sanitizes HTML (in markdown or HTML input) using a whitelist.
+ Unsafe tags are replaced by HTML comments; unsafe attributes
+ are omitted. URIs in links and images are also checked against a
+ whitelist of URI schemes.
+
+\--email-obfuscation=*none|javascript|references*
+: Specify a method for obfuscating `mailto:` links in HTML documents.
+ *none* leaves `mailto:` links as they are. *javascript* obfuscates
+ them using javascript. *references* obfuscates them by printing their
+ letters as decimal or hexadecimal character references.
+ If `--strict` is specified, *references* is used regardless of the
+ presence of this option.
+
+\--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.
+
+-c *CSS*, \--css=*CSS*
+: Link to a CSS style sheet. *CSS* is the pathname of the style sheet.
+
+-H *FILE*, \--include-in-header=*FILE*
+: Include contents of *FILE* at the end of the header. Implies `-s`.
+
+-B *FILE*, \--include-before-body=*FILE*
+: Include contents of *FILE* at the beginning of the document body.
+
+-A *FILE*, \--include-after-body=*FILE*
+: Include contents of *FILE* at the end of the document body.
+
+-C *FILE*, \--custom-header=*FILE*
+: Use contents of *FILE* as the document header (overriding the
+ default header, which can be printed by using the `-D` option).
+ Implies `-s`.
+
+-D *FORMAT*, \--print-default-header=*FORMAT*
+: Print the default header for *FORMAT* (`html`, `s5`, `latex`,
+ `context`, `docbook`, `man`, `markdown`, `opendocument`,
+ `rst`, `rtf`).
+
+-T *STRING*, \--title-prefix=*STRING*
+: Specify *STRING* as a prefix to the HTML window title.
+
+\--dump-args
+: Print information about command-line arguments to *stdout*, then exit.
+ The first line of output contains the name of the output file specified
+ with the `-o` option, or \``-`' (for *stdout*) if no output file was
+ specified. The remaining lines contain the command-line arguments,
+ one per line, in the order they appear. These do not include regular
+ Pandoc options and their arguments, but do include any options appearing
+ after a \``--`' separator at the end of the line.
+ This option is intended primarily for use in wrapper scripts.
+
+\--ignore-args
+: 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
+
+: is equivalent to
+
+: pandoc -o foo.html -s
+
+-v, \--version
+: Print version.
+
+-h, \--help
+: Show usage message.
+
+# SEE ALSO
+
+`hsmarkdown`(1),
+`html2markdown`(1),
+`markdown2pdf` (1).
+The *README* file distributed with Pandoc contains full documentation.
+
+The Pandoc source code and all documentation may be downloaded from
+<http://johnmacfarlane.net/pandoc/>.
+