summaryrefslogtreecommitdiff
path: root/man/man1/pandoc.1
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2006-11-01 06:32:52 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2006-11-01 06:32:52 +0000
commitb8d960d1b9e09d4104f79d4c1ff0fc427391be33 (patch)
tree9635f58406c406b4e700b9b6d48279a0567a9950 /man/man1/pandoc.1
parent51536ca88814aa21bf3f38eb5d87f51858b7501b (diff)
Improved man files for pandoc and all wrappers.
git-svn-id: https://pandoc.googlecode.com/svn/trunk@57 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man/man1/pandoc.1')
-rw-r--r--man/man1/pandoc.131
1 files changed, 18 insertions, 13 deletions
diff --git a/man/man1/pandoc.1 b/man/man1/pandoc.1
index 447b09033..fdf79a8a7 100644
--- a/man/man1/pandoc.1
+++ b/man/man1/pandoc.1
@@ -2,7 +2,8 @@
.SH NAME
pandoc \- general markup converter
.SH SYNOPSIS
-.B pandoc [
+.B pandoc
+[
.I options
] [
.I input-files
@@ -19,8 +20,8 @@ If no
are specified, input is read from STDIN. Otherwise, the
.I input-files
are concatenated (with a blank line between each) and used
-as input. Output goes to STDOUT. Use redirection to produce
-a file:
+as input. Output goes to STDOUT. If you want output to a file,
+use shell redirection:
.IP
.B pandoc input.txt > output.html
.PP
@@ -29,14 +30,20 @@ The default behavior of
is to convert the
input from markdown-formatted plain text to HTML. Different
input and output formats can be specified using command-line
-options.
+options. For example,
+.IP
+.B pandoc -f latex -t markdown chap1.tex > chap1.txt
+.PP
+converts
+.I chap1.tex
+from LaTeX to markdown-formatted plain text.
+See below for a detailed list of command-line options.
.PP
.I Pandoc
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
-.B iconv
-:
+.BR iconv :
.IP
.B iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
@@ -119,7 +126,7 @@ is the pathname of the style sheet.
Include contents of
.I FILENAME
at the end of the header. Implies
-.B \-s.
+.BR \-s .
.TP
.B \-B FILENAME, \-\-include-before-body=FILENAME
Include contents of
@@ -138,7 +145,7 @@ as the document header (overriding the default header, which can be
printed by using the
.B \-D
option). Implies
-.B \-s.
+.BR \-s .
.TP
.B \-D FORMAT, \-\-print-default-header=FORMAT
Print the default header for
@@ -156,13 +163,11 @@ as a prefix to the HTML window title.
John MacFarlane
.SH "SEE ALSO"
-markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1), iconv (1)
+.BR markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1), iconv (1)
The
-.B README
+.I README
file distributed with Pandoc contains full documentation.
The Pandoc source code and all documentation may be downloaded from
-.B http://sophos.berkeley.edu/macfarlane/pandoc/
-.
-
+<http://sophos.berkeley.edu/macfarlane/pandoc/>.