path: root/INSTALL
diff options
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2008-09-06 18:33:39 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2008-09-06 18:33:39 +0000
commit2cecca73ea76f4c18ddd64be738ad709a321a30c (patch)
tree7c2abccd2e69d58fd5adfdad853a6fbb8b39a9ee /INSTALL
parentfc24c79db6ca54bfd5e2a99e12421d7749514faa (diff)
Updated INSTALL in light of new dependencies (utf8-string and zip-archive).
git-svn-id: 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'INSTALL')
1 files changed, 36 insertions, 2 deletions
diff --git a/INSTALL b/INSTALL
index 9707683ae..f97301aa1 100644
@@ -20,7 +20,7 @@ to to [install Cabal] separately. You can check your Cabal version using
If you're running MacOS X, you can also install GHC using [MacPorts] or [Fink].
If you're on a [debian]-based linux system (such as [Ubuntu]), you can get
-GHC and the required libraries using `apt-get`:
+GHC and some required libraries using `apt-get`:
sudo apt-get install ghc6 libghc6-xhtml-dev libghc6-mtl-dev libghc6-network-dev
@@ -33,6 +33,31 @@ GHC and the required libraries using `apt-get`:
+Installing prerequisites
+Pandoc needs the `utf8-string` and `zip-archive` to compile.
+Check your packaging system to see if they are included.
+If not, you will need to compile them from source.
+On \*nix systems, the easiest way to do this is to install
+the [cabal-install] tool. See the section [Quick Installation
+on Unix] for instructions.
+[Quick Installation on Unix]:
+Once you've got `cabal-install` installed, you can install the
+needed libraries by doing
+ cabal install utf8-string
+ cabal install zip-archive
+Alternatively, you can install these libraries using the [standard
+Cabal method], but you will have to install their dependencies manually.
+[standard Cabal method]:
Getting the source
@@ -63,6 +88,14 @@ Installing Pandoc using Make
If you get "Unknown modifier" errors, it is probably because `make`
on your system is not [GNU `make`]. Try using `gmake` instead.
+ If you get a message saying that the `zip-archive` or `utf8-string`
+ libraries cannot be found, and you have installed these using
+ `cabal-install`, it is probably because by default `cabal-install`
+ installs libraries to the user's directory rather than globally.
+ Try again with
+ CABALOPTS=--user make
3. See if it worked (optional, but recommended):
make test
@@ -117,7 +150,8 @@ Installing pandoc using Cabal
Change to the directory containing the pandoc source, and type:
- runhaskell Setup.hs configure
+ runhaskell Setup.hs configure # add --user if you have installed
+ # prerequisites locally with cabal-install
runhaskell Setup.hs build
runhaskell Setup.hs haddock # optional, to build library documentation
runhaskell Setup.hs install # this one as root or sudo