Updated INSTALL on building man pages.

Closes #1788.
This commit is contained in:
John MacFarlane 2014-12-07 09:42:25 -08:00
parent 068bdbbc91
commit 1a130fa48e

21
INSTALL
View file

@ -44,12 +44,7 @@ Quick install
[Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-Install#The_cabal-install_configuration_file)
5. Make sure the `$CABALDIR/share/man/man1` directory is in your `MANPATH`.
You should now be able to access the `pandoc` man page:
man pandoc
6. If you want to process citations with pandoc, you will also need to
5. If you want to process citations with pandoc, you will also need to
install a separate package, `pandoc-citeproc`. This can be installed
using cabal:
@ -71,6 +66,20 @@ Quick install
--extra-include-dirs=/usr/local/Cellar/icu4c/51.1/include \
-funicode_collation text-icu pandoc-citeproc
The cabal installation procedure does not generate man pages.
To build the `pandoc` man pages, build pandoc with the
`make-pandoc-man-pages` flag, and then use the command
`make-pandoc-man-pages` from the pandoc source directory.
This will create the man pages in `man/man1` and `man/man5`.
To build the `pandoc-citeproc` man pages, go to the pandoc-citeproc
build directory, and
cd man
make
The man page will be created in the `man1` subdirectory.
[GHC]: http://www.haskell.org/ghc/
[Haskell platform]: http://hackage.haskell.org/platform/
[cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall