path: root/man/man1/
diff options
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-07-01 23:26:20 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-07-01 23:26:20 +0000
commit5fbe057d27f62546b403969cc184c103ee9dd281 (patch)
tree1db287228aaddf9726e397e0383ee9d9dcb1bba1 /man/man1/
parente6f67fcc57872bf0e4574a0163f91f1ac259cd9f (diff)
Man pages are now generated from markdown templates,
using pandoc's man page writer. Removed man pages from repository, added (.md) templates. Modified Makefile to generate man pages as part of the build process. git-svn-id: 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man/man1/')
1 files changed, 68 insertions, 0 deletions
diff --git a/man/man1/ b/man/man1/
new file mode 100644
index 000000000..045adc2c1
--- /dev/null
+++ b/man/man1/
@@ -0,0 +1,68 @@
+% John MacFarlane and Recai Oktas
+% June 30, 2007
+markdown2pdf - converts markdown-formatted text to PDF, using pdflatex
+**markdown2pdf [*options*] [*input-file*]...**
+`markdown2pdf` converts *input-file* (or text from standard
+input) from markdown-formatted plain text to PDF, using `pdflatex`.
+If no output filename is specified (using the `-o` option),
+the name of the output file is derived from the input file; thus, for
+example, if the input file is *hello.txt*, the output file will be
+*hello.pdf*. If the input is read from STDIN and no output filename
+is specified, the output file will be named *stdin.pdf*. 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.
+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
+output through `iconv`:
+ iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
+`markdown2pdf` 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 <>.
+`markdown2pdf` is a wrapper around `pandoc`, so all of
+`pandoc`'s options can be used with `markdown2pdf` as well.
+See `pandoc`(1) for a complete list.
+The following options are most relevant:
+-o *FILE*, --output=*FILE*
+: Write output to *FILE*.
+: Use strict markdown syntax, with no extensions or variants.
+-N, --number-sections
+: Number section headings in LaTeX output. (Default is not to number them.)
+-H *FILE*, --include-in-header=*FILE*
+: Include (LaTeX) contents of *FILE* at the end of the header. Implies
+ `-s`.
+-B *FILE*, --include-before-body=*FILE*
+: Include (LaTeX) contents of *FILE* at the beginning of the document body.
+-A *FILE*, --include-after-body=*FILE*
+: Include (LaTeX) contents of *FILE* at the end of the document body.
+-C *FILE*, --custom-header=*FILE*
+: Use contents of *FILE*
+ as the LaTeX document header (overriding the default header, which can be
+ printed using `pandoc -D latex`). Implies `-s`.
+`pandoc`(1), `pdflatex`(1)