aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorroktas <roktas@788f1e2b-df1e-0410-8736-df70ead52e1b>2006-12-12 07:04:09 +0000
committerroktas <roktas@788f1e2b-df1e-0410-8736-df70ead52e1b>2006-12-12 07:04:09 +0000
commit426cbadfef6c26323faedcab2cd5ea7efa64d1bb (patch)
treee16afb28eec790226a7b0524b8fb325594232e5c /man
parent6411ea7466f67f94816c541a22abb7249d36c377 (diff)
downloadpandoc-426cbadfef6c26323faedcab2cd5ea7efa64d1bb.tar.gz
Merge changes in branches/wrappers into trunk.
[in trunk] svn merge -r105:HEAD \ https://pandoc.googlecode.com/svn/branches/wrappers git-svn-id: https://pandoc.googlecode.com/svn/trunk@177 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man')
-rw-r--r--man/man1/html2markdown.163
-rw-r--r--man/man1/latex2markdown.134
-rw-r--r--man/man1/markdown2html.135
-rw-r--r--man/man1/markdown2latex.132
-rw-r--r--man/man1/markdown2pdf.141
-rw-r--r--man/man1/pandoc.129
6 files changed, 132 insertions, 102 deletions
diff --git a/man/man1/html2markdown.1 b/man/man1/html2markdown.1
index b24f340ab..6cdba595c 100644
--- a/man/man1/html2markdown.1
+++ b/man/man1/html2markdown.1
@@ -1,33 +1,60 @@
-.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
+.TH HTML2MARKDOWN 1 "November 21, 2006" Pandoc "User Manuals"
.SH NAME
html2markdown \- converts HTML to markdown-formatted text
.SH SYNOPSIS
-\fBhtml2markdown\fR [ \fIinput-file\fR or \fIURL\fR ]
+\fBhtml2markdown\fR [\fIoptions\fR] [\fIinput\-file\fR or \fIURL\fR]
+[\fB\-\-\fR] [\fIpandoc\-opts\fR]
.SH DESCRIPTION
-\fBhtml2markdown\fR converts \fIinput-file\fR or \fIURL\fR
-(or text from STDIN) from HTML to markdown-formatted plain text.
-It uses an available program (e.g. wget, w3m, lynx or curl) to fetch
-the contents of the URL.
+\fBhtml2markdown\fR converts \fIinput\-file\fR or \fIURL\fR (or text
+from STDIN) from HTML to markdown\-formatted plain text.
+If a URL is specified, \fBhtml2markdown\fR uses an available program
+(e.g. wget, w3m, lynx or curl) to fetch its contents. Output is sent
+to STDOUT.
.PP
\fBhtml2markdown\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
+.B \-e \fIencoding\fR
+Assume the character encoding \fIencoding\fR in reading the HTML.
+(Note: \fIencoding\fR will be passed to \fBiconv\fR; a list of
+available encodings may be obtained using `\fBiconv \-l\fR'.)
+If the \fB\-e\fR option is not specified, the encoding will be
+determined as follows: If input is from STDIN, the local encoding
+will be assumed. Otherwise, \fBhtml2markdown\fR will try to
+extract the character encoding from the "Content-type" meta tag.
+If no character encoding is specified in this way, UTF-8 will be
+assumed for a URL argument, and the local encoding will be assumed
+for a file argument.
+.TP
+.B \-g \fIcommand\fR
+Use \fIcommand\fR to fetch the contents of a URL. (By default,
+\fBhtml2markdown\fR searches for an available program or text-based
+browser to fetch the contents of a URL.) For example:
+.IP
+html2markdown \-g 'wget \-\-user=foo \-\-password=bar' mysite.com
+.TP
+.B \-n
+Disable automatic fetching of contents when URLs are specified as
+arguments.
+.TP
+.I pandoc\-opts
+Any options appearing after \fIinput\-file\fR or \fIURL\fR on the
+command line will be passed directly to \fBpandoc\fR. If no
+\fIinput-file\fR or \fIURL\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
-html2markdown input.txt -- -R
-.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.
+html2markdown input.txt \-\- \-R
.SH "SEE ALSO"
\fBpandoc\fR(1),
\fBmarkdown2html\fR(1),
\fBmarkdown2latex\fR(1),
\fBlatex2markdown\fR(1),
-\fBmarkdown2pdf\fR(1)
+\fBmarkdown2pdf\fR(1),
+\fBiconv\fR(1)
.SH AUTHOR
-John MacFarlane
+John MacFarlane and Recai Oktas
diff --git a/man/man1/latex2markdown.1 b/man/man1/latex2markdown.1
index 086cb4272..6e7e9e033 100644
--- a/man/man1/latex2markdown.1
+++ b/man/man1/latex2markdown.1
@@ -1,26 +1,28 @@
-.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
+.TH LATEX2MARKDOWN 1 "November 21, 2006" Pandoc "User Manuals"
.SH NAME
-latex2markdown \- converts LaTeX to markdown-formatted text
+latex2markdown \- converts LaTeX to markdown\-formatted text
.SH SYNOPSIS
-\fBlatex2markdown\fR [ \fIinput-file\fR ]
+\fBlatex2markdown\fR [\fIoptions\fR] [\fIinput\-file\fR]
+[\fB\-\-\fR] [\fIpandoc\-opts\fR]
.SH DESCRIPTION
-\fBlatex2markdown\fR converts \fIinput-file\fR
-(or text from STDIN) from LaTeX to markdown-formatted plain text.
+\fBlatex2markdown\fR converts \fIinput\-file\fR
+(or text from STDIN) from LaTeX to markdown\-formatted plain text.
+Output is sent to STDOUT.
.PP
\fBlatex2markdown\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
-latex2markdown input.txt -- -R
-.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.
+latex2markdown input.txt \-\- \-R
.SH "SEE ALSO"
\fBpandoc\fR(1),
\fBmarkdown2html\fR(1),
@@ -28,4 +30,4 @@ for a list of options that may be used.
\fBmarkdown2latex\fR(1),
\fBmarkdown2pdf\fR(1)
.SH AUTHOR
-John MacFarlane
+John MacFarlane and Recai Oktas
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
diff --git a/man/man1/markdown2latex.1 b/man/man1/markdown2latex.1
index 136d6ae84..3039192d1 100644
--- a/man/man1/markdown2latex.1
+++ b/man/man1/markdown2latex.1
@@ -1,27 +1,29 @@
-.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
+.TH MARKDOWN2LATEX 1 "November 21, 2006" Pandoc "User Manuals"
.SH NAME
markdown2latex \- converts markdown-formatted text to LaTeX
.SH SYNOPSIS
-\fBmarkdown2latex\fR [ \fIinput-files\fR ]
+\fBmarkdown2latex\fR [\fIoptions\fR] [\fIinput\-file\fR]...
+[\fB\-\-\fR] [\fIpandoc\-opts\fR]
.SH DESCRIPTION
-\fBmarkdown2latex\fR converts \fIinput-files\fR (or text from STDIN)
-from markdown-formatted plain text to LaTeX. If multiple files are
+\fBmarkdown2latex\fR converts \fIinput\-file\fR (or text from STDIN)
+from markdown\-formatted plain text to LaTeX. If multiple files are
specified, they will be combined to make a single LaTeX document.
+Output is sent to STDOUT.
.PP
\fBmarkdown2latex\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
-markdown2latex input.txt -- --custom-header=letterhead.tex
-.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.
+markdown2latex input.txt \-\- \-\-custom\-header=letterhead.tex
.SH "SEE ALSO"
\fBpandoc\fR(1),
\fBmarkdown2html\fR(1),
@@ -29,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
diff --git a/man/man1/markdown2pdf.1 b/man/man1/markdown2pdf.1
index 4254e7119..99aa50a28 100644
--- a/man/man1/markdown2pdf.1
+++ b/man/man1/markdown2pdf.1
@@ -1,38 +1,37 @@
-.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
+.TH MARKDOWN2PDF 1 "November 21, 2006" Pandoc "User Manuals"
.SH NAME
markdown2pdf \- converts markdown-formatted text to PDF, using pdflatex
.SH SYNOPSIS
-\fBmarkdown2pdf\fR [ \fB-o|--output\fR \fIoutput-file\fR ]
-[ \fIinput-file\fR ]
+\fBmarkdown2pdf\fR [\fIoptions\fR] [\fB\-o\fR \fIoutput-file\fR]
+[\fIinput-file\fR]... [\fB\-\-\fR] [\fIpandoc\-opts\fR]
.SH DESCRIPTION
-\fBmarkdown2pdf\fR converts \fIinput-file\fR (or text from STDIN) from
-markdown-formatted plain text to PDF, using \fBpdflatex\fR. If no output
+\fBmarkdown2pdf\fR converts \fIinput\-file\fR (or text from STDIN) from
+markdown\-formatted plain text to PDF, using \fBpdflatex\fR. If no output
filename is specified, the name of the output file is derived from the
input file; thus, for example, if the input file is \fIhello.txt\fR,
the output file will be \fIhello.pdf\fR. If the input is read from STDIN
and no output filename is specified, the output file will be named
-\fIstdin.pdf\fR.
+\fIstdin.pdf\fR. If multiple input files are specified, they will be
+concatenated before conversion, and the name of the output file will be
+derived from the first input file.
.PP
\fBmarkdown2pdf\fR is a wrapper for \fBpandoc\fR.
.SH OPTIONS
.TP
-.B \-o FILENAME, \-\-output=FILENAME
-Specify name of output (PDF) file.
-.TP
-.B \-h, \-\-help
+.B \-h
Show usage message.
.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 \-o \fIoutput-file\fR
+Specify name of output (PDF) file.
+.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
-markdown2pdf input.txt -- --custom-header=letterhead.tex
-.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.
+markdown2pdf input.txt \-\- \-\-custom\-header=letterhead.tex
.SH "SEE ALSO"
\fBpandoc\fR(1),
\fBmarkdown2html\fR(1),
@@ -41,4 +40,4 @@ for a list of options that may be used.
\fBlatex2markdown\fR(1),
\fBpdflatex\fR(1)
.SH AUTHOR
-John MacFarlane
+John MacFarlane and Recai Oktas
diff --git a/man/man1/pandoc.1 b/man/man1/pandoc.1
index 0d0c1b09f..5f632de90 100644
--- a/man/man1/pandoc.1
+++ b/man/man1/pandoc.1
@@ -1,36 +1,35 @@
-.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
+.TH PANDOC 1 "November 21, 2006" Pandoc "User Manuals"
.SH NAME
pandoc \- general markup converter
.SH SYNOPSIS
-\fBpandoc\fR [ \fIoptions\fR ] [ \fIinput-files\fR ]
-
+\fBpandoc\fR [\fIoptions\fR] [\fIinput\-file\fR]...
.SH DESCRIPTION
\fIPandoc\fR converts files from one markup format to another. It can
read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and
it can write markdown, reStructuredText, HTML, LaTeX, RTF, and S5 HTML
slide shows.
.PP
-If no \fIinput-files\fR are specified, input is read from STDIN. Otherwise,
-the \fIinput-files\fR are concatenated (with a blank line between each)
+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. If you want output to a file,
use shell redirection:
.IP
.B pandoc input.txt > output.html
.PP
The default behavior of \fIPandoc\fR is to convert the input from
-markdown-formatted plain text to HTML. Different input and output
-formats can be specified using command-line options. For example,
+markdown\-formatted plain text to HTML. Different input and output
+formats can be specified using command\-line options. For example,
.IP
-.B pandoc -f latex -t markdown chap1.tex > chap1.txt
+.B pandoc \-f latex \-t markdown chap1.tex > chap1.txt
.PP
-converts \fIchap1.tex\fR from LaTeX to markdown-formatted plain text.
-See below for a detailed list of command-line options.
+converts \fIchap1.tex\fR from LaTeX to markdown\-formatted plain text.
+See below for a detailed list of command\-line options.
.PP
-\fIPandoc\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
+\fIPandoc\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:
.IP
-.B iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
+.B iconv \-t utf\-8 input.txt | pandoc | iconv \-f utf\-8
.SH OPTIONS
.TP
@@ -40,7 +39,7 @@ Print version.
.B \-h, \-\-help
Show usage message.
.TP
-.B \-f FORMAT, \-r FORMAT, --from=FORMAT, --read=FORMAT
+.B \-f FORMAT, \-r FORMAT, \-\-from=FORMAT, \-\-read=FORMAT
Specify input format.
.I FORMAT
can be
@@ -56,7 +55,7 @@ or
.I latex
(LaTeX).
.TP
-.B \-t FORMAT, \-w FORMAT, --to=FORMAT, --write=FORMAT
+.B \-t FORMAT, \-w FORMAT, \-\-to=FORMAT, \-\-write=FORMAT
Specify output format.
.I FORMAT
can be