aboutsummaryrefslogtreecommitdiff
path: root/man/man1
diff options
context:
space:
mode:
Diffstat (limited to 'man/man1')
-rw-r--r--man/man1/html2markdown.11
-rw-r--r--man/man1/latex2markdown.11
-rw-r--r--man/man1/markdown2html.11
-rw-r--r--man/man1/markdown2latex.11
-rw-r--r--man/man1/markdown2pdf.127
-rw-r--r--man/man1/markdown2rst.11
-rw-r--r--man/man1/markdown2rtf.11
-rw-r--r--man/man1/markdown2s5.11
-rw-r--r--man/man1/pandoc.150
-rw-r--r--man/man1/rst2markdown.11
-rw-r--r--man/man1/web2markdown.13
11 files changed, 33 insertions, 55 deletions
diff --git a/man/man1/html2markdown.1 b/man/man1/html2markdown.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/html2markdown.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/latex2markdown.1 b/man/man1/latex2markdown.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/latex2markdown.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/markdown2html.1 b/man/man1/markdown2html.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/markdown2html.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/markdown2latex.1 b/man/man1/markdown2latex.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/markdown2latex.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/markdown2pdf.1 b/man/man1/markdown2pdf.1
index c15131a42..423ac6546 100644
--- a/man/man1/markdown2pdf.1
+++ b/man/man1/markdown2pdf.1
@@ -6,14 +6,13 @@ markdown2pdf \- converts markdown-formatted text to PDF, using pdflatex
.SH DESCRIPTION
\fBmarkdown2pdf\fR converts \fIinput\-file\fR (or text from standard
input) 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. 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.
+If no output filename is specified (using the \fB\-o\fR option),
+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. 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
Input is assumed to be in the UTF\-8 character encoding. If your
local character encoding is not UTF\-8, you should pipe input and
@@ -21,11 +20,11 @@ output through \fBiconv\fR:
.IP
.B iconv \-t utf\-8 input.txt | pandoc | iconv \-f utf\-8
.PP
-\fBmarkdown2pdf\fR assumes that the 'unicode' package
-is in latex's search path. If this package is not included in your
-latex setup, it can be obtained from <http://ctan.org>.
+\fBmarkdown2pdf\fR assumes that the 'unicode' and 'fancyvrb' packages
+are in latex's search path. If these packages are not included in your
+latex setup, they can be obtained from <http://ctan.org>.
.PP
-\fBmarkdown2pdf\fR is a wrapper around \fBmarkdown2latex\fR.
+\fBmarkdown2pdf\fR is a wrapper around \fBpandoc\fR.
.SH OPTIONS
.TP
.B \-o FILE, \-\-output=FILE
@@ -37,10 +36,6 @@ Preserve tabs instead of converting them to spaces.
.B \-\-tab-stop=\fITABSTOP\fB
Specify tab stop (default is 4).
.TP
-.B \-R, \-\-parse-raw
-Parse untranslatable LaTeX environments as raw LaTeX,
-instead of ignoring them.
-.TP
.B \-N, \-\-number-sections
Number section headings in LaTeX output. (Default is not to number them.)
.TP
diff --git a/man/man1/markdown2rst.1 b/man/man1/markdown2rst.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/markdown2rst.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/markdown2rtf.1 b/man/man1/markdown2rtf.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/markdown2rtf.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/markdown2s5.1 b/man/man1/markdown2s5.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/markdown2s5.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/pandoc.1 b/man/man1/pandoc.1
index 82c9ae321..f6280f463 100644
--- a/man/man1/pandoc.1
+++ b/man/man1/pandoc.1
@@ -1,8 +1,6 @@
.TH PANDOC 1 "December 15, 2006" Pandoc "User Manuals"
.SH NAME
-pandoc, markdown2html, markdown2latex, markdown2rst, markdown2rtf,
-markdown2s5, html2markdown2, latex2markdown, rst2markdown \- general
-markup converter
+pandoc \- general markup converter
.SH SYNOPSIS
\fBpandoc\fR [\fIoptions\fR] [\fIinput\-file\fR]...
.SH DESCRIPTION
@@ -13,41 +11,37 @@ slide shows.
.PP
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 standard
-output. If you want output to a file, use the \fB\-o\fR option or
-shell redirection:
+line between each) and used as input. Output goes to STDOUT by
+default. For output to a file, use the \fB\-o\fR option:
.IP
.B pandoc \-o output.html input.txt
-.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,
+The input and output formats may be specified using command-line options
+(see \fBOPTIONS\fR, below, for details). If these formats are not
+specified explicitly, \fIPandoc\fR 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
+to be markdown. If no output filename is specified using the \fB\-o\fR
+option, or if a filename is specified but its extension is unknown,
+the output will default to HTML. Thus, for example,
.IP
-.B pandoc \-f latex \-t markdown chap1.tex > chap1.txt
+.B pandoc -o 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.txt\fR from markdown to LaTeX. And
+.IP
+.B pandoc README
.PP
-For convenience, eight variant programs are available:
-\fBmarkdown2html\fR (same as \fBpandoc \-w html\fR),
-\fBmarkdown2latex\fR (same as \fBpandoc \-w latex\fR),
-\fBmarkdown2rst\fR (same as \fBpandoc \-w rst\fR),
-\fBmarkdown2rtf\fR (same as \fBpandoc \-w rtf\fR),
-\fBmarkdown2s5\fR (same as \fBpandoc \-w s5\fR),
-\fBhtml2markdown\fR (same as \fBpandoc \-r html \-w markdown\fR),
-\fBlatex2markdown\fR (same as \fBpandoc \-r latex \-w markdown\fR),
-and \fBrst2markdown\fR (same as \fBpandoc \-r rst \-w markdown\fR).
-These programs take an appropriately restricted subset of \fBpandoc\fR's
-options. (Run them with the \fB-h\fR flag for a full list of allowed
-options.)
+converts \fIREADME\fR from markdown to HTML.
.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
and output through \fBiconv\fR:
.IP
.B iconv \-t utf\-8 input.txt | pandoc | iconv \-f utf\-8
+.PP
+\fIPandoc\fR's HTML parser is not very forgiving. If your input is
+HTML, consider running it through \fBtidy\fR(1) before passing it
+to Pandoc. Or use \fBweb2markdown\fR(1), a wrapper around \fBpandoc\fR.
.SH OPTIONS
.TP
@@ -158,9 +152,7 @@ Show usage message.
.SH "SEE ALSO"
\fBweb2markdown\fR(1),
-\fBmarkdown2pdf\fR(1),
-\fBiconv\fR(1)
-
+\fBmarkdown2pdf\fR(1).
The
.I README
file distributed with Pandoc contains full documentation.
diff --git a/man/man1/rst2markdown.1 b/man/man1/rst2markdown.1
deleted file mode 100644
index 7b82576d6..000000000
--- a/man/man1/rst2markdown.1
+++ /dev/null
@@ -1 +0,0 @@
-.so man1/pandoc.1
diff --git a/man/man1/web2markdown.1 b/man/man1/web2markdown.1
index a570cfc97..242b50671 100644
--- a/man/man1/web2markdown.1
+++ b/man/man1/web2markdown.1
@@ -16,7 +16,7 @@ option.
from STDIN, UTF-8 is assumed. A character encoding may be specified
explicitly using the \fB\-e\fR option.
.PP
-\fBweb2markdown\fR is a wrapper for \fBhtml2markdown\fR.
+\fBweb2markdown\fR is a wrapper for \fBpandoc\fR.
.SH OPTIONS
.TP
.B \-s, \-\-standalone
@@ -76,7 +76,6 @@ web2markdown \-g 'wget \-\-user=foo \-\-password=bar' mysite.com
.SH "SEE ALSO"
\fBpandoc\fR(1),
-\fBhtml2markdown\fR(1),
\fBiconv\fR(1)
.SH AUTHOR
John MacFarlane and Recai Oktas