summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2008-08-10 22:24:43 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2008-08-10 22:24:43 +0000
commit79359605d154fd77578aea42adc65b9281ef463d (patch)
tree4d5565baf89da7f2cfa64816f265303eda52e720
parent09440d0328a397b3e63e2d09049fbcf5c0881ee1 (diff)
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
-rw-r--r--man/man1/hsmarkdown.1.md4
-rw-r--r--man/man1/html2markdown.1.md12
-rw-r--r--man/man1/pandoc.1.md24
3 files changed, 21 insertions, 19 deletions
diff --git a/man/man1/hsmarkdown.1.md b/man/man1/hsmarkdown.1.md
index 8aad2474c..a197ef2ca 100644
--- a/man/man1/hsmarkdown.1.md
+++ b/man/man1/hsmarkdown.1.md
@@ -15,9 +15,9 @@ hsmarkdown [*input-file*]...
`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.
+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
+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
diff --git a/man/man1/html2markdown.1.md b/man/man1/html2markdown.1.md
index 905bdd0d0..73e3420dd 100644
--- a/man/man1/html2markdown.1.md
+++ b/man/man1/html2markdown.1.md
@@ -14,15 +14,15 @@ html2markdown [*pandoc-options*] [\-- *special-options*] [*input-file* or
# DESCRIPTION
`html2markdown` converts *input-file* or *URL* (or text
-from STDIN) from HTML to markdown-formatted plain 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`
+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
+from *stdin*, UTF-8 is assumed. A character encoding may be specified
explicitly using the `-e` special option.
# OPTIONS
@@ -36,7 +36,7 @@ a complete list. The following options are most relevant:
top of markdown output.
-o *FILE*, \--output=*FILE*
-: Write output to *FILE* instead of STDOUT.
+: Write output to *FILE* instead of *stdout*.
\--strict
: Use strict markdown syntax, with no extensions or variants.
@@ -80,9 +80,9 @@ regular `pandoc` options by the delimiter \``--`', as in
(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
+ *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
+ specified in this way, or if input is from *stdin*, UTF-8 will be
assumed.
-g *command*, \--grabber=*command*
diff --git a/man/man1/pandoc.1.md b/man/man1/pandoc.1.md
index fd243bf2d..ce2542f32 100644
--- a/man/man1/pandoc.1.md
+++ b/man/man1/pandoc.1.md
@@ -18,10 +18,10 @@ 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.
+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
+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
@@ -30,7 +30,7 @@ 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
+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,
@@ -72,15 +72,18 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
`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).
+ show), `pdf` (Portable Document Format), or `rtf` (rich text
+ format). Note that for `odt` and `pdf` output, output will not be
+ directed to *stdout*; an output filename must be specified using the
+ `-o/--output` option.
-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.
+: 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.
@@ -166,9 +169,9 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
: Specify *STRING* as a prefix to the HTML window title.
\--dump-args
-: Print information about command-line arguments to STDOUT, then exit.
+: 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
+ 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
@@ -194,8 +197,7 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`.
# SEE ALSO
`hsmarkdown`(1),
-`html2markdown`(1),
-`markdown2pdf`(1).
+`html2markdown`(1).
The *README* file distributed with Pandoc contains full documentation.
The Pandoc source code and all documentation may be downloaded from