Improved man files for pandoc and all wrappers.

git-svn-id: https://pandoc.googlecode.com/svn/trunk@57 788f1e2b-df1e-0410-8736-df70ead52e1b

6 files changed, 94 insertions, 58 deletions

diff --git a/man/man1/html2markdown.1 b/man/man1/html2markdown.1
index bb084e36e..3ff142d3e 100644
--- a/man/man1/html2markdown.1
+++ b/man/man1/html2markdown.1
@@ -1,15 +1,23 @@
-.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
 .SH NAME
 html2markdown \- converts HTML to markdown-formatted text
 .SH SYNOPSIS
-.B html2markdown [input-file or URL]
-.SH DESCRIPTION
 .B html2markdown 
-converts input-file (or text from STDIN) or URL from HTML to 
-markdown-formatted plain text.  Uses an available program
-(e.g. wget, w3m, lynx or curl) to fetch the URL.
+[
+.I input-file 
+or 
+.I URL
+]
+.SH DESCRIPTION
+.I html2markdown 
+converts 
+.I input-file 
+or 
+.I URL 
+(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.
 .SH AUTHOR
-John MacFarlane <jgm at berkeley.edu>
+John MacFarlane
 .SH "SEE ALSO"
-pandoc (1), markdown2html (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
-
+.BR pandoc (1), markdown2html (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
diff --git a/man/man1/latex2markdown.1 b/man/man1/latex2markdown.1
index 5f5229d21..9c77b03b1 100644
--- a/man/man1/latex2markdown.1
+++ b/man/man1/latex2markdown.1
@@ -1,14 +1,17 @@
-.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
 .SH NAME
 latex2markdown \- converts LaTeX to markdown-formatted text
 .SH SYNOPSIS
-.B latex2markdown [input-file]
-.SH DESCRIPTION
 .B latex2markdown 
-converts input-file (or text from STDIN) from LaTeX to markdown-formatted
-plain text.
+[
+.I input-file
+]
+.SH DESCRIPTION
+.I latex2markdown 
+converts 
+.I input-file 
+(or text from STDIN) from LaTeX to markdown-formatted plain text.
 .SH AUTHOR
-John MacFarlane <jgm at berkeley.edu>
+John MacFarlane
 .SH "SEE ALSO"
-pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), markdown2pdf (1)
-
+.BR pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), markdown2pdf (1)
diff --git a/man/man1/markdown2html.1 b/man/man1/markdown2html.1
index cc91a9a6a..300aa1a40 100644
--- a/man/man1/markdown2html.1
+++ b/man/man1/markdown2html.1
@@ -1,15 +1,19 @@
-.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
 .SH NAME
 markdown2html \- converts markdown-formatted text to HTML 
 .SH SYNOPSIS
-.B markdown2html [input-files]
-.SH DESCRIPTION
 .B markdown2html 
-converts input-files (or text from STDIN) from markdown-formatted
-plain text to HTML. 
+[
+.I input-files
+]
+.SH DESCRIPTION
+.I markdown2html 
+converts 
+.I input-files 
+(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.
 .SH AUTHOR
-John MacFarlane <jgm at berkeley.edu>
+John MacFarlane
 .SH "SEE ALSO"
-pandoc (1), html2markdown (1), markdown2latex (1), latex2markdown (1),
-markdown2pdf (1)
-
+.BR pandoc (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
diff --git a/man/man1/markdown2latex.1 b/man/man1/markdown2latex.1
index 95c3a1213..ddbbb5456 100644
--- a/man/man1/markdown2latex.1
+++ b/man/man1/markdown2latex.1
@@ -1,16 +1,19 @@
-.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
 .SH NAME
 markdown2latex \- converts markdown-formatted text to LaTeX 
 .SH SYNOPSIS
-.B markdown2latex [input-files]
-.SH DESCRIPTION
 .B markdown2latex 
-converts input-files (or text from STDIN) from markdown-formatted
+[
+.I input-files
+]
+.SH DESCRIPTION
+.I markdown2latex 
+converts 
+.I input-files 
+(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.
 .SH AUTHOR
-John MacFarlane <jgm at berkeley.edu>
+John MacFarlane
 .SH "SEE ALSO"
-pandoc (1), markdown2html (1), html2markdown (1), latex2markdown (1),
-markdown2pdf (1)
-
+.BR pandoc (1), markdown2html (1), html2markdown (1), latex2markdown (1), markdown2pdf (1)
diff --git a/man/man1/markdown2pdf.1 b/man/man1/markdown2pdf.1
index a33431353..e0e136bca 100644
--- a/man/man1/markdown2pdf.1
+++ b/man/man1/markdown2pdf.1
@@ -1,17 +1,30 @@
-.TH PANDOC 1 "NOVEMBER 2006" Linux "User Manuals"
+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
 .SH NAME
 markdown2pdf \- converts markdown-formatted text to PDF, using pdflatex 
 .SH SYNOPSIS
-.B markdown2pdf [-o|--output output-file] [input-file]
-.SH DESCRIPTION
 .B markdown2pdf 
-converts input-file (or text from STDIN) from markdown-formatted
-plain text to PDF, using pdflatex.  The name of the output file is derived
-from the input file, if it is not specified; thus, for example, if the input
-file is 'hello.txt', the output file will be 'hello.pdf'.  If the input is
-read from STDIN, the output file will be named 'stdin.pdf'.
+[
+.B -o|--output 
+.I output-file
+] [
+.I input-file
+]
+.SH DESCRIPTION
+.I markdown2pdf 
+converts 
+.I input-file 
+(or text from STDIN) from markdown-formatted
+plain text to PDF, using 
+.I pdflatex. 
+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 
+.IR hello.txt ,
+the output file will be 
+.IR hello.pdf .
+If the input is read from STDIN and no output filename is specified, 
+the output file will be named 
+.IR stdin.pdf .
 .SH AUTHOR
-John MacFarlane <jgm at berkeley.edu>
+John MacFarlane
 .SH "SEE ALSO"
-pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1),
-latex2markdown (1)
+.BR pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), pdflatex (1)
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/>.