summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-06-28 14:39:17 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2015-06-28 14:39:17 -0700
commitfe625e053d078e03d824a1df746196b8a2c697b1 (patch)
tree0129bded228d952594d06a8ed675154d05909abc /README
parent3e5b4faaf2a99950991ff7b16c0e0b06234b9792 (diff)
New method for producing man pages.
This change adds `--man1` and `--man5` options to pandoc, so pandoc can generate its own man pages. It removes the old overly complex method of building a separate executable (but not installing it) just to create the man pages. The man pages are no longer automatically created in the build process. The man/ directory has been removed. The man page templates have been moved to data/. New unexported module: Text.Pandoc.ManPages. Text.Pandoc.Data now exports readmeFile, and `readDataFile` knows how to find README. Closes #2190.
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index 5671b821e..9023dded1 100644
--- a/README
+++ b/README
@@ -240,6 +240,14 @@ General options
`epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory
placed in this directory will override pandoc's normal defaults.
+`--man1`
+
+: Write `pandoc.1` man page to *stdout*.
+
+`--man5`
+
+: Write `pandoc_markdown.5` man page to *stdout*.
+
`--verbose`
: Give verbose debugging output. Currently this only has an effect