path: root/INSTALL
diff options
authorJohn MacFarlane <>2015-06-28 14:39:17 -0700
committerJohn MacFarlane <>2015-06-28 14:39:17 -0700
commitfe625e053d078e03d824a1df746196b8a2c697b1 (patch)
tree0129bded228d952594d06a8ed675154d05909abc /INSTALL
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 'INSTALL')
1 files changed, 5 insertions, 1 deletions
diff --git a/INSTALL b/INSTALL
index 3c533ee8c..53217beb0 100644
@@ -75,7 +75,11 @@ Quick install
--extra-include-dirs=/usr/local/Cellar/icu4c/51.1/include \
-funicode_collation text-icu pandoc-citeproc
-The build process will create man pages in `man/man1` and `man/man5`.
+To build the `pandoc.1` and `pandoc_markdown.5` man pages, you
+can ues pandoc itself:
+ pandoc --man1 > pandoc.1
+ pandoc --man5 > pandoc_markdown.5
To build the `pandoc-citeproc` man pages, go to the pandoc-citeproc
build directory, and