path: root/man/man1/hsmarkdown.1
diff options
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-01-02 02:58:54 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-01-02 02:58:54 +0000
commit5387ebd8db3b8cf98befd75d9aa42716acaf8dec (patch)
tree31357b758f45c39339b315e72456d6dfb40c3f4f /man/man1/hsmarkdown.1
parent89f2468f38d7b85d78fe1d94bab7cc8ea46152d0 (diff)
Added 'hsmarkdown' wrapper, designed to be used as a drop-in
replacement for It calls pandoc with the options '--from markdown --to html --strict' and disallows other options. (Any command-line options will be interpreted as arguments.) git-svn-id: 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man/man1/hsmarkdown.1')
1 files changed, 36 insertions, 0 deletions
diff --git a/man/man1/hsmarkdown.1 b/man/man1/hsmarkdown.1
new file mode 100644
index 000000000..3db8a8b45
--- /dev/null
+++ b/man/man1/hsmarkdown.1
@@ -0,0 +1,36 @@
+.TH HSMARKDOWN 1 "January 1, 2007" Pandoc "User Manuals"
+hsmarkdown \- convert markdown-formatted text to HTML
+\fBhsmarkdown\fR [\fIinput\-file\fR]...
+\fBhsmarkdown\fR converts markdown-formatted text to HTML. It is designed
+to be usable as a drop-in replacement for John Gruber's \\fR.
+If no \fIinput\-file\fR is specified, input is read from STDIN.
+Otherwise, the \fIinput\-files\fR 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:
+.B hsmarkdown input.txt > output.html
+\fBhsmarkdown\fR 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 \fBiconv\fR:
+.B iconv \-t utf\-8 input.txt | hsmarkdown | iconv \-f utf\-8
+\fBhsmarkdown\fR is implemented as a wrapper around \fBpandoc\fR(1). It
+calls \fBpandoc\fR with the options \fB\-\-from markdown \-\-to html
+\-\-strict\fR and disables all other options. (Command-line options
+will be interpreted as filenames, as they are by \\fR.)
+file distributed with Pandoc contains full documentation.
+The Pandoc source code and all documentation may be downloaded from
+John MacFarlane