git.iko.soy/typeable/pandoc
on master help sign in
Improved man files for pandoc and all wrappers.
b8d960dfiddlosopher
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"
2.SH NAME
2.SH NAME
3html2markdown \- converts HTML to markdown-formatted text
3html2markdown \- converts HTML to markdown-formatted text
4.SH SYNOPSIS
4.SH SYNOPSIS
5−.B html2markdown [input-file or URL]
6−.SH DESCRIPTION
7.B html2markdown
5.B html2markdown
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
8−converts input-file (or text from STDIN) or URL from HTML to
17+(or text from STDIN)
9−markdown-formatted plain text. Uses an available program
18+from HTML to markdown-formatted plain text. It uses an available program
10−(e.g. wget, w3m, lynx or curl) to fetch the URL.
19+(e.g. wget, w3m, lynx or curl) to fetch the contents of the URL.
11.SH AUTHOR
20.SH AUTHOR
12−John MacFarlane <jgm at berkeley.edu>
21+John MacFarlane
13.SH "SEE ALSO"
22.SH "SEE ALSO"
14−pandoc (1), markdown2html (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
23+.BR pandoc (1), markdown2html (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
15−
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"
2.SH NAME
2.SH NAME
3latex2markdown \- converts LaTeX to markdown-formatted text
3latex2markdown \- converts LaTeX to markdown-formatted text
4.SH SYNOPSIS
4.SH SYNOPSIS
5−.B latex2markdown [input-file]
6−.SH DESCRIPTION
7.B latex2markdown
5.B latex2markdown
6+[
7+.I input-file
8+]
9+.SH DESCRIPTION
10+.I latex2markdown
11+converts
12+.I input-file
8−converts input-file (or text from STDIN) from LaTeX to markdown-formatted
13+(or text from STDIN) from LaTeX to markdown-formatted plain text.
9−plain text.
10.SH AUTHOR
14.SH AUTHOR
11−John MacFarlane <jgm at berkeley.edu>
15+John MacFarlane
12.SH "SEE ALSO"
16.SH "SEE ALSO"
13−pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), markdown2pdf (1)
17+.BR pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), markdown2pdf (1)
14−
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"
2.SH NAME
2.SH NAME
3markdown2html \- converts markdown-formatted text to HTML
3markdown2html \- converts markdown-formatted text to HTML
4.SH SYNOPSIS
4.SH SYNOPSIS
5−.B markdown2html [input-files]
6−.SH DESCRIPTION
7.B markdown2html
5.B markdown2html
6+[
7+.I input-files
8+]
9+.SH DESCRIPTION
10+.I markdown2html
11+converts
12+.I input-files
8−converts input-files (or text from STDIN) from markdown-formatted
13+(or text from STDIN) from markdown-formatted plain text to HTML.
9−plain text to HTML.
14+If multiple files are specified, they will be combined to make a single
15+HTML document.
10.SH AUTHOR
16.SH AUTHOR
11−John MacFarlane <jgm at berkeley.edu>
17+John MacFarlane
12.SH "SEE ALSO"
18.SH "SEE ALSO"
13−pandoc (1), html2markdown (1), markdown2latex (1), latex2markdown (1),
19+.BR pandoc (1), html2markdown (1), markdown2latex (1), latex2markdown (1), markdown2pdf (1)
14−markdown2pdf (1)
15−
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"
2.SH NAME
2.SH NAME
3markdown2latex \- converts markdown-formatted text to LaTeX
3markdown2latex \- converts markdown-formatted text to LaTeX
4.SH SYNOPSIS
4.SH SYNOPSIS
5−.B markdown2latex [input-files]
6−.SH DESCRIPTION
7.B markdown2latex
5.B markdown2latex
6+[
7+.I input-files
8+]
9+.SH DESCRIPTION
10+.I markdown2latex
11+converts
12+.I input-files
8−converts input-files (or text from STDIN) from markdown-formatted
13+(or text from STDIN) from markdown-formatted
9plain text to LaTeX. If multiple files are specified, they will
14plain text to LaTeX. If multiple files are specified, they will
10be combined to make a single LaTeX document.
15be combined to make a single LaTeX document.
11.SH AUTHOR
16.SH AUTHOR
12−John MacFarlane <jgm at berkeley.edu>
17+John MacFarlane
13.SH "SEE ALSO"
18.SH "SEE ALSO"
14−pandoc (1), markdown2html (1), html2markdown (1), latex2markdown (1),
19+.BR pandoc (1), markdown2html (1), html2markdown (1), latex2markdown (1), markdown2pdf (1)
15−markdown2pdf (1)
16−
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"
2.SH NAME
2.SH NAME
3markdown2pdf \- converts markdown-formatted text to PDF, using pdflatex
3markdown2pdf \- converts markdown-formatted text to PDF, using pdflatex
4.SH SYNOPSIS
4.SH SYNOPSIS
5−.B markdown2pdf [-o|--output output-file] [input-file]
6−.SH DESCRIPTION
7.B markdown2pdf
5.B markdown2pdf
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
8−converts input-file (or text from STDIN) from markdown-formatted
16+(or text from STDIN) from markdown-formatted
9−plain text to PDF, using pdflatex. The name of the output file is derived
17+plain text to PDF, using
18+.I pdflatex.
19+If no output filename is specified, the name of the output file is derived
10−from the input file, if it is not specified; thus, for example, if the input
20+from the input file; thus, for example, if the input file is
21+.IR hello.txt ,
11−file is 'hello.txt', the output file will be 'hello.pdf'. If the input is
22+the output file will be
23+.IR hello.pdf .
24+If the input is read from STDIN and no output filename is specified,
12−read from STDIN, the output file will be named 'stdin.pdf'.
25+the output file will be named
26+.IR stdin.pdf .
13.SH AUTHOR
27.SH AUTHOR
14−John MacFarlane <jgm at berkeley.edu>
28+John MacFarlane
15.SH "SEE ALSO"
29.SH "SEE ALSO"
16−pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1),
30+.BR pandoc (1), markdown2html (1), html2markdown (1), markdown2latex (1), latex2markdown (1), pdflatex (1)
17−latex2markdown (1)
man/man1/pandoc.1+18−13
@@ -2,7 +2,8 @@
2.SH NAME
2.SH NAME
3pandoc \- general markup converter
3pandoc \- general markup converter
4.SH SYNOPSIS
4.SH SYNOPSIS
5−.B pandoc [
5+.B pandoc
6+[
6.I options
7.I options
7] [
8] [
8.I input-files
9.I input-files
@@ -19,8 +20,8 @@ If no
19are specified, input is read from STDIN. Otherwise, the
20are specified, input is read from STDIN. Otherwise, the
20.I input-files
21.I input-files
21are concatenated (with a blank line between each) and used
22are concatenated (with a blank line between each) and used
22−as input. Output goes to STDOUT. Use redirection to produce
23+as input. Output goes to STDOUT. If you want output to a file,
23−a file:
24+use shell redirection:
24.IP
25.IP
25.B pandoc input.txt > output.html
26.B pandoc input.txt > output.html
26.PP
27.PP
@@ -29,14 +30,20 @@ The default behavior of
29is to convert the
30is to convert the
30input from markdown-formatted plain text to HTML. Different
31input from markdown-formatted plain text to HTML. Different
31input and output formats can be specified using command-line
32input 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.
33.PP
41.PP
34.I Pandoc
42.I Pandoc
35uses the UTF-8 character encoding for both input and output.
43uses the UTF-8 character encoding for both input and output.
36If your local character encoding is not UTF-8, you should pipe
44If your local character encoding is not UTF-8, you should pipe
37input and output through
45input and output through
38−.B iconv
46+.BR iconv :
39−:
40.IP
47.IP
41.B iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
48.B iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
42
49
@@ -119,7 +126,7 @@ is the pathname of the style sheet.
119Include contents of
126Include contents of
120.I FILENAME
127.I FILENAME
121at the end of the header. Implies
128at the end of the header. Implies
122−.B \-s.
129+.BR \-s .
123.TP
130.TP
124.B \-B FILENAME, \-\-include-before-body=FILENAME
131.B \-B FILENAME, \-\-include-before-body=FILENAME
125Include contents of
132Include contents of
@@ -138,7 +145,7 @@ as the document header (overriding the default header, which can be
138printed by using the
145printed by using the
139.B \-D
146.B \-D
140option). Implies
147option). Implies
141−.B \-s.
148+.BR \-s .
142.TP
149.TP
143.B \-D FORMAT, \-\-print-default-header=FORMAT
150.B \-D FORMAT, \-\-print-default-header=FORMAT
144Print the default header for
151Print the default header for
@@ -156,13 +163,11 @@ as a prefix to the HTML window title.
156John MacFarlane
163John MacFarlane
157
164
158.SH "SEE ALSO"
165.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)
160
167
161The
168The
162−.B README
169+.I README
163file distributed with Pandoc contains full documentation.
170file distributed with Pandoc contains full documentation.
164
171
165The Pandoc source code and all documentation may be downloaded from
172The Pandoc source code and all documentation may be downloaded from
166−.B http://sophos.berkeley.edu/macfarlane/pandoc/
173+<http://sophos.berkeley.edu/macfarlane/pandoc/>.
167−.
168−