diff options
Diffstat (limited to 'man/man1/markdown2html.1')
| -rw-r--r-- | man/man1/markdown2html.1 | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/man/man1/markdown2html.1 b/man/man1/markdown2html.1 index d6243182a..33d063321 100644 --- a/man/man1/markdown2html.1 +++ b/man/man1/markdown2html.1 @@ -1,28 +1,29 @@ -.TH PANDOC 1 "November 1, 2006" Linux "User Manuals" +.TH MARKDOWN2HTML 1 "November 21, 2006" Pandoc "User Manuals" .SH NAME -markdown2html \- converts markdown-formatted text to HTML +markdown2html \- converts markdown\-formatted text to HTML .SH SYNOPSIS -\fBmarkdown2html\fR [ \fIinput-files\fR ] +\fBmarkdown2html\fR [\fIoptions\fR] [\fIinput\-file\fR]... +[\fB\-\-\fR] [\fIpandoc\-opts\fR] .SH DESCRIPTION -\fBmarkdown2html\fR converts \fIinput-files\fR -(or text from STDIN) from markdown-formatted plain text to HTML. +\fBmarkdown2html\fR converts \fIinput\-file\fR +(or text from STDIN) from markdown\-formatted plain text to HTML. If multiple files are specified, they will be combined to make a single -HTML document. +HTML document. Output is sent to STDOUT. .PP \fBmarkdown2html\fR is a wrapper for \fBpandoc\fR. .SH OPTIONS .TP -.B \-\- -Any options appearing after ` \-\- ' on the command line will be passed -directly to \fBpandoc\fR. See \fBpandoc\fR(1) for a list of options -that may be used. Options specified in this way will override -PANDOC_OPTS (see below). Example: +.B \-h +Show usage message. +.TP +.I pandoc\-opts +Any options appearing after \fIinput\-file\fR... on the command line +will be passed directly to \fBpandoc\fR. If no \fIinput-file\fR +is specified, these options must be preceded by ` \fB\-\-\fR '. +(In other cases, ` \fB\-\-\fR ' is optional.) See \fBpandoc\fR(1) +for a list of options that may be used. Example: .IP -markdown2html input.txt -- --css=main.css -S -.SH ENVIRONMENT -Any command-line options contained in the PANDOC_OPTS environment variable -will be passed directly to \fBpandoc\fR. See \fBpandoc\fR(1) -for a list of options that may be used. +markdown2html input.txt \-\- \-\-css=main.css \-S .SH "SEE ALSO" \fBpandoc\fR(1), \fBhtml2markdown\fR(1), @@ -30,4 +31,4 @@ for a list of options that may be used. \fBlatex2markdown\fR(1), \fBmarkdown2pdf\fR(1) .SH AUTHOR -John MacFarlane +John MacFarlane and Recai Oktas |