summaryrefslogtreecommitdiff
path: root/man/man1/html2markdown.1.md
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-07-01 23:26:20 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-07-01 23:26:20 +0000
commit5fbe057d27f62546b403969cc184c103ee9dd281 (patch)
tree1db287228aaddf9726e397e0383ee9d9dcb1bba1 /man/man1/html2markdown.1.md
parente6f67fcc57872bf0e4574a0163f91f1ac259cd9f (diff)
Man pages are now generated from markdown templates,
using pandoc's man page writer. Removed man pages from repository, added (.md) templates. Modified Makefile to generate man pages as part of the build process. git-svn-id: https://pandoc.googlecode.com/svn/trunk@609 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man/man1/html2markdown.1.md')
-rw-r--r--man/man1/html2markdown.1.md93
1 files changed, 93 insertions, 0 deletions
diff --git a/man/man1/html2markdown.1.md b/man/man1/html2markdown.1.md
new file mode 100644
index 000000000..f83a4b2c4
--- /dev/null
+++ b/man/man1/html2markdown.1.md
@@ -0,0 +1,93 @@
+% HTML2MARKDOWN
+% John MacFarlane and Recai Oktas
+% June 30, 2007
+
+# 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.
+
+-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)