aboutsummaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL27
1 files changed, 20 insertions, 7 deletions
diff --git a/INSTALL b/INSTALL
index eb9b2b030..32f71c42d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -24,6 +24,15 @@ Quick install
This procedure will install the released version of pandoc,
which will be downloaded automatically from HackageDB.
+
+ If this step fails, and you are using an older version
+ of the Haskell Platform, e.g. on Debian stable, you may need to
+ upgrade your version of cabal:
+
+ cabal install cabal-install
+ ~/.cabal/bin/cabal update
+ ~/.cabal/bin/cabal install pandoc
+
If you want to install a modified or development version
of pandoc instead, switch to the source directory and do
as above, but without the 'pandoc':
@@ -44,12 +53,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 +75,16 @@ 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-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
@@ -200,4 +214,3 @@ To use a smaller sample size so the benchmarks run faster:
To run just the markdown benchmarks:
cabal bench --benchmark-options='markdown'
-