7935960 · typeable/pandoc

git.iko.soy/typeable/pandoc

Updated man page sources with pdf output option, minor cosmetic changes.

git-svn-id: https://pandoc.googlecode.com/svn/trunk@1398 788f1e2b-df1e-0410-8736-df70ead52e1b

commit79359605d154fd77578aea42adc65b9281ef463d authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateSun 10 Aug 2008, 22:24 (18 years ago) parent09440d0

3 files changed+21−19

compare with master

unifiedsplit

man/man1/hsmarkdown.1.md+2−2 man/man1/html2markdown.1.md+6−6 man/man1/pandoc.1.md+13−11

man/man1/hsmarkdown.1.md+2−2

@@ -15,9 +15,9 @@ hsmarkdown [*input-file*]...

1515`hsmarkdown` converts markdown-formatted text to HTML. It is designed

1616to be usable as a drop-in replacement for John Gruber's `Markdown.pl`.

1717

18−If no *input-file* is specified, input is read from STDIN.

18+If no *input-file* is specified, input is read from *stdin*.

1919Otherwise, the *input-files* are concatenated (with a blank

20−line between each) and used as input. Output goes to STDOUT by

20+line between each) and used as input. Output goes to *stdout* by

2121default. For output to a file, use shell redirection:

2222

2323 hsmarkdown input.txt > output.html

man/man1/html2markdown.1.md+6−6

@@ -14,15 +14,15 @@ html2markdown [*pandoc-options*] [\-- *special-options*] [*input-file* or

1414# DESCRIPTION

1515

1616`html2markdown` converts *input-file* or *URL* (or text

17−from STDIN) from HTML to markdown-formatted plain text.

17+from *stdin*) from HTML to markdown-formatted plain text.

1818If a URL is specified, `html2markdown` uses an available program

1919(e.g. wget, w3m, lynx or curl) to fetch its contents. Output is sent

20−to STDOUT unless an output file is specified using the `-o`

20+to *stdout* unless an output file is specified using the `-o`

2121option.

2222

2323`html2markdown` uses the character encoding specified in the

2424"Content-type" meta tag. If this is not present, or if input comes

25−from STDIN, UTF-8 is assumed. A character encoding may be specified

25+from *stdin*, UTF-8 is assumed. A character encoding may be specified

2626explicitly using the `-e` special option.

2727

2828# OPTIONS

@@ -36,7 +36,7 @@ a complete list. The following options are most relevant:

3636 top of markdown output.

3737

3838-o *FILE*, \--output=*FILE*

39−: Write output to *FILE* instead of STDOUT.

39+: Write output to *FILE* instead of *stdout*.

4040

4141\--strict

4242: Use strict markdown syntax, with no extensions or variants.

@@ -80,9 +80,9 @@ regular `pandoc` options by the delimiter \``--`', as in

8080 (Note: *encoding* will be passed to `iconv`; a list of

8181 available encodings may be obtained using `iconv -l`.)

8282 If this option is not specified and input is not from

83− STDIN, `html2markdown` will try to extract the character encoding

83+ *stdin*, `html2markdown` will try to extract the character encoding

8484 from the "Content-type" meta tag. If no character encoding is

85− specified in this way, or if input is from STDIN, UTF-8 will be

85+ specified in this way, or if input is from *stdin*, UTF-8 will be

8686 assumed.

8787

8888-g *command*, \--grabber=*command*

man/man1/pandoc.1.md+13−11

@@ -18,10 +18,10 @@ it can write markdown, reStructuredText, HTML, LaTeX, ConTeXt, Texinfo,

1818groff man, MediaWiki markup, RTF, OpenDocument XML, ODT, DocBook XML,

1919and S5 HTML slide shows.

2020

21−If no *input-file* is specified, input is read from STDIN.

21+If no *input-file* is specified, input is read from *stdin*.

2222Otherwise, the *input-files* are concatenated (with a blank

23−line between each) and used as input. Output goes to STDOUT by

24−default (though output to STDOUT is disabled for the `odt` output

23+line between each) and used as input. Output goes to *stdout* by

24+default (though output to *stdout* is disabled for the `odt` output

2525format). For output to a file, use the `-o` option:

2626

2727 pandoc -o output.html input.txt

@@ -30,7 +30,7 @@ The input and output formats may be specified using command-line options

3030(see **OPTIONS**, below, for details). If these formats are not

3131specified explicitly, Pandoc will attempt to determine them

3232from the extensions of the input and output filenames. If input comes

33−from STDIN or from a file with an unknown extension, the input is assumed

33+from *stdin* or from a file with an unknown extension, the input is assumed

3434to be markdown. If no output filename is specified using the `-o`

3535option, or if a filename is specified but its extension is unknown,

3636the output will default to HTML. Thus, for example,

@@ -72,15 +72,18 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.

7272 `mediawiki` (MediaWiki markup), `texinfo` (GNU Texinfo),

7373 `docbook` (DocBook XML), `opendocument` (OpenDocument XML),

7474 `odt` (OpenOffice text document), `s5` (S5 HTML and javascript slide

75− show), or `rtf` (rich text format).

75+ show), `pdf` (Portable Document Format), or `rtf` (rich text

76+ format). Note that for `odt` and `pdf` output, output will not be

77+ directed to *stdout*; an output filename must be specified using the

78+ `-o/--output` option.

7679

7780-s, \--standalone

7881: Produce output with an appropriate header and footer (e.g. a

7982 standalone HTML, LaTeX, or RTF file, not a fragment).

8083

8184-o *FILE*, \--output=*FILE*

82−: Write output to *FILE* instead of STDOUT. If *FILE* is

83− \``-`', output will go to STDOUT.

85+: Write output to *FILE* instead of *stdout*. If *FILE* is

86+ \``-`', output will go to *stdout*.

8487

8588-p, \--preserve-tabs

8689: Preserve tabs instead of converting them to spaces.

@@ -166,9 +169,9 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.

166169: Specify *STRING* as a prefix to the HTML window title.

167170

168171\--dump-args

169−: Print information about command-line arguments to STDOUT, then exit.

172+: Print information about command-line arguments to *stdout*, then exit.

170173 The first line of output contains the name of the output file specified

171− with the `-o` option, or \``-`' (for STDOUT) if no output file was

174+ with the `-o` option, or \``-`' (for *stdout*) if no output file was

172175 specified. The remaining lines contain the command-line arguments,

173176 one per line, in the order they appear. These do not include regular

174177 Pandoc options and their arguments, but do include any options appearing

@@ -194,8 +197,7 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.

194197# SEE ALSO

195198

196199`hsmarkdown`(1),

197−`html2markdown`(1),

198−`markdown2pdf`(1).

200+`html2markdown`(1).

199201The *README* file distributed with Pandoc contains full documentation.

200202

201203The Pandoc source code and all documentation may be downloaded from