git.iko.soy/typeable/pandoc
on master help sign in
Improved man files for pandoc and all wrappers.

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

commitb8d960d1b9e09d4104f79d4c1ff0fc427391be33 authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateWed 1 Nov 2006, 06:32 (20 years ago) parent51536ca
6 files changed+94−58
compare with master
unifiedsplit
man/man1/html2markdown.1+17−9 man/man1/latex2markdown.1+11−8 man/man1/markdown2html.1+13−9 man/man1/markdown2latex.1+11−8 man/man1/markdown2pdf.1+24−11 man/man1/pandoc.1+18−13
man/man1/html2markdown.1+17−9
@@ -1,15 +1,23 @@
1−.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
1+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
22.SH NAME
33html2markdown \- converts HTML to markdown-formatted text
44.SH SYNOPSIS
5−.B html2markdown [input-file or URL]
6−.SH DESCRIPTION
75.B html2markdown
8−converts input-file (or text from STDIN) or URL from HTML to
9−markdown-formatted plain text. Uses an available program
10−(e.g. wget, w3m, lynx or curl) to fetch the URL.
6+[
7+.I input-file
8+or
9+.I URL
10+]
11+.SH DESCRIPTION
12+.I html2markdown
13+converts
14+.I input-file
15+or
16+.I URL
17+(or text from STDIN)
18+from HTML to markdown-formatted plain text. It uses an available program
19+(e.g. wget, w3m, lynx or curl) to fetch the contents of the URL.
1120.SH AUTHOR
12−John MacFarlane <jgm at berkeley.edu>
21+John MacFarlane
1322.SH "SEE ALSO"
14−pandoc (1), markdown2html (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
15−
23+.BR pandoc (1), markdown2html (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
man/man1/latex2markdown.1+11−8
@@ -1,14 +1,17 @@
1−.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
1+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
22.SH NAME
33latex2markdown \- converts LaTeX to markdown-formatted text
44.SH SYNOPSIS
5−.B latex2markdown [input-file]
6−.SH DESCRIPTION
75.B latex2markdown
8−converts input-file (or text from STDIN) from LaTeX to markdown-formatted
9−plain text.
6+[
7+.I input-file
8+]
9+.SH DESCRIPTION
10+.I latex2markdown
11+converts
12+.I input-file
13+(or text from STDIN) from LaTeX to markdown-formatted plain text.
1014.SH AUTHOR
11−John MacFarlane <jgm at berkeley.edu>
15+John MacFarlane
1216.SH "SEE ALSO"
13−pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), markdown2pdf (1)
14−
17+.BR pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), markdown2pdf (1)
man/man1/markdown2html.1+13−9
@@ -1,15 +1,19 @@
1−.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
1+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
22.SH NAME
33markdown2html \- converts markdown-formatted text to HTML
44.SH SYNOPSIS
5−.B markdown2html [input-files]
6−.SH DESCRIPTION
75.B markdown2html
8−converts input-files (or text from STDIN) from markdown-formatted
9−plain text to HTML.
6+[
7+.I input-files
8+]
9+.SH DESCRIPTION
10+.I markdown2html
11+converts
12+.I input-files
13+(or text from STDIN) from markdown-formatted plain text to HTML.
14+If multiple files are specified, they will be combined to make a single
15+HTML document.
1016.SH AUTHOR
11−John MacFarlane <jgm at berkeley.edu>
17+John MacFarlane
1218.SH "SEE ALSO"
13−pandoc (1), html2markdown (1), markdown2latex (1), latex2markdown (1),
14−markdown2pdf (1)
15−
19+.BR pandoc (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
man/man1/markdown2latex.1+11−8
@@ -1,16 +1,19 @@
1−.TH PANDOC 1 "AUGUST 2006" Linux "User Manuals"
1+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
22.SH NAME
33markdown2latex \- converts markdown-formatted text to LaTeX
44.SH SYNOPSIS
5−.B markdown2latex [input-files]
6−.SH DESCRIPTION
75.B markdown2latex
8−converts input-files (or text from STDIN) from markdown-formatted
6+[
7+.I input-files
8+]
9+.SH DESCRIPTION
10+.I markdown2latex
11+converts
12+.I input-files
13+(or text from STDIN) from markdown-formatted
914plain text to LaTeX. If multiple files are specified, they will
1015be combined to make a single LaTeX document.
1116.SH AUTHOR
12−John MacFarlane <jgm at berkeley.edu>
17+John MacFarlane
1318.SH "SEE ALSO"
14−pandoc (1), markdown2html (1), html2markdown (1), latex2markdown (1),
15−markdown2pdf (1)
16−
19+.BR pandoc (1), markdown2html (1), html2markdown (1), latex2markdown (1), markdown2pdf (1)
man/man1/markdown2pdf.1+24−11
@@ -1,17 +1,30 @@
1−.TH PANDOC 1 "NOVEMBER 2006" Linux "User Manuals"
1+.TH PANDOC 1 "November 1, 2006" Linux "User Manuals"
22.SH NAME
33markdown2pdf \- converts markdown-formatted text to PDF, using pdflatex
44.SH SYNOPSIS
5−.B markdown2pdf [-o|--output output-file] [input-file]
6−.SH DESCRIPTION
75.B markdown2pdf
8−converts input-file (or text from STDIN) from markdown-formatted
9−plain text to PDF, using pdflatex. The name of the output file is derived
10−from the input file, if it is not specified; thus, for example, if the input
11−file is 'hello.txt', the output file will be 'hello.pdf'. If the input is
12−read from STDIN, the output file will be named 'stdin.pdf'.
6+[
7+.B -o|--output
8+.I output-file
9+] [
10+.I input-file
11+]
12+.SH DESCRIPTION
13+.I markdown2pdf
14+converts
15+.I input-file
16+(or text from STDIN) from markdown-formatted
17+plain text to PDF, using
18+.I pdflatex.
19+If no output filename is specified, the name of the output file is derived
20+from the input file; thus, for example, if the input file is
21+.IR hello.txt ,
22+the output file will be
23+.IR hello.pdf .
24+If the input is read from STDIN and no output filename is specified,
25+the output file will be named
26+.IR stdin.pdf .
1327.SH AUTHOR
14−John MacFarlane <jgm at berkeley.edu>
28+John MacFarlane
1529.SH "SEE ALSO"
16−pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1),
17−latex2markdown (1)
30+.BR pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), pdflatex (1)
man/man1/pandoc.1+18−13
@@ -2,7 +2,8 @@
22.SH NAME
33pandoc \- general markup converter
44.SH SYNOPSIS
5−.B pandoc [
5+.B pandoc
6+[
67.I options
78] [
89.I input-files
@@ -19,8 +20,8 @@ If no
1920are specified, input is read from STDIN. Otherwise, the
2021.I input-files
2122are concatenated (with a blank line between each) and used
22−as input. Output goes to STDOUT. Use redirection to produce
23−a file:
23+as input. Output goes to STDOUT. If you want output to a file,
24+use shell redirection:
2425.IP
2526.B pandoc input.txt > output.html
2627.PP
@@ -29,14 +30,20 @@ The default behavior of
2930is to convert the
3031input from markdown-formatted plain text to HTML. Different
3132input and output formats can be specified using command-line
32−options.
33+options. For example,
34+.IP
35+.B pandoc -f latex -t markdown chap1.tex > chap1.txt
36+.PP
37+converts
38+.I chap1.tex
39+from LaTeX to markdown-formatted plain text.
40+See below for a detailed list of command-line options.
3341.PP
3442.I Pandoc
3543uses the UTF-8 character encoding for both input and output.
3644If your local character encoding is not UTF-8, you should pipe
3745input and output through
38−.B iconv
39−:
46+.BR iconv :
4047.IP
4148.B iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
4249
@@ -119,7 +126,7 @@ is the pathname of the style sheet.
119126Include contents of
120127.I FILENAME
121128at the end of the header. Implies
122−.B \-s.
129+.BR \-s .
123130.TP
124131.B \-B FILENAME, \-\-include-before-body=FILENAME
125132Include contents of
@@ -138,7 +145,7 @@ as the document header (overriding the default header, which can be
138145printed by using the
139146.B \-D
140147option). Implies
141−.B \-s.
148+.BR \-s .
142149.TP
143150.B \-D FORMAT, \-\-print-default-header=FORMAT
144151Print the default header for
@@ -156,13 +163,11 @@ as a prefix to the HTML window title.
156163John MacFarlane
157164
158165.SH "SEE ALSO"
159−markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1), iconv (1)
166+.BR markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1), iconv (1)
160167
161168The
162−.B README
169+.I README
163170file distributed with Pandoc contains full documentation.
164171
165172The Pandoc source code and all documentation may be downloaded from
166−.B http://sophos.berkeley.edu/macfarlane/pandoc/
167−.
168−
173+<http://sophos.berkeley.edu/macfarlane/pandoc/>.