git-annex/doc/install/cabal.mdwn

As a haskell package, git-annex can be installed using cabal.

Start by installing the [Haskell Platform][]. In Debian, this is as
simple as:

    sudo apt-get install haskell-platform

 [Haskell Platform]: http://hackage.haskell.org/platform/

## minimal build

This builds git-annex without some features that require C libraries, that
can be harder to get installed. This is plenty to get started using it,
although it does not include the assistant or webapp.

	cabal update
	PATH=$HOME/bin:$PATH
	cabal install git-annex --bindir=$HOME/bin -f"-assistant -webapp -webdav -pairing -xmpp -dns"

## full build

To build with all features enabled, including the assistant and webapp,
you will need to install several C libraries and their headers,
including libgnutls, libgsasl, libxml2, and zlib. Then run:

	cabal update
	PATH=$HOME/bin:$PATH
	cabal install c2hs --bindir=$HOME/bin
	cabal install git-annex --bindir=$HOME/bin

## building from git checkout

But maybe you want something newer (or older). Then [[download]] the version
you want, and use cabal as follows inside its source tree:

	cabal update
	PATH=$HOME/bin:$PATH
	cabal install c2hs --bindir=$HOME/bin
	cabal install --only-dependencies
	cabal configure
	cabal build
	cabal install --bindir=$HOME/bin
reorg 2013-05-13 17:40:41 +00:00			`As a haskell package, git-annex can be installed using cabal.`

document explicitely how to install the haskell platform on Debian 2013-07-30 16:10:49 +00:00			`Start by installing the [Haskell Platform][]. In Debian, this is as`
			`simple as:`

			`sudo apt-get install haskell-platform`

			`[Haskell Platform]: http://hackage.haskell.org/platform/`
Revert "avoid pulling in unneeded dependencies when the assistant is disabled" Cabal does not seem to have a way to check if flag A is set and then, if flag B is set, add a dep. Instead, it makes flag B get unset if the dep is not available. 2013-07-16 15:29:43 +00:00
			`## minimal build`

			`This builds git-annex without some features that require C libraries, that`
			`can be harder to get installed. This is plenty to get started using it,`
			`although it does not include the assistant or webapp.`
move manual cabal install into its own page, and simplify it 2012-04-13 15:15:27 +00:00
			`cabal update`
improve cabal instructions to handle installing c2hs 2012-12-09 15:51:45 +00:00			`PATH=$HOME/bin:$PATH`
Revert "avoid pulling in unneeded dependencies when the assistant is disabled" Cabal does not seem to have a way to check if flag A is set and then, if flag B is set, add a dep. Instead, it makes flag B get unset if the dep is not available. 2013-07-16 15:29:43 +00:00			`cabal install git-annex --bindir=$HOME/bin -f"-assistant -webapp -webdav -pairing -xmpp -dns"`
move manual cabal install into its own page, and simplify it 2012-04-13 15:15:27 +00:00
Revert "avoid pulling in unneeded dependencies when the assistant is disabled" Cabal does not seem to have a way to check if flag A is set and then, if flag B is set, add a dep. Instead, it makes flag B get unset if the dep is not available. 2013-07-16 15:29:43 +00:00			`## full build`
improve cabal install instructions to not need lots of C libs 2013-07-12 15:54:39 +00:00
Revert "avoid pulling in unneeded dependencies when the assistant is disabled" Cabal does not seem to have a way to check if flag A is set and then, if flag B is set, add a dep. Instead, it makes flag B get unset if the dep is not available. 2013-07-16 15:29:43 +00:00			`To build with all features enabled, including the assistant and webapp,`
			`you will need to install several C libraries and their headers,`
			`including libgnutls, libgsasl, libxml2, and zlib. Then run:`
improve cabal install instructions to not need lots of C libs 2013-07-12 15:54:39 +00:00
Revert "avoid pulling in unneeded dependencies when the assistant is disabled" Cabal does not seem to have a way to check if flag A is set and then, if flag B is set, add a dep. Instead, it makes flag B get unset if the dep is not available. 2013-07-16 15:29:43 +00:00			`cabal update`
			`PATH=$HOME/bin:$PATH`
improve cabal install instructions to not need lots of C libs 2013-07-12 15:54:39 +00:00			`cabal install c2hs --bindir=$HOME/bin`
			`cabal install git-annex --bindir=$HOME/bin`

			`## building from git checkout`

move manual cabal install into its own page, and simplify it 2012-04-13 15:15:27 +00:00			`But maybe you want something newer (or older). Then [[download]] the version`
			`you want, and use cabal as follows inside its source tree:`

			`cabal update`
improve cabal instructions to handle installing c2hs 2012-12-09 15:51:45 +00:00			`PATH=$HOME/bin:$PATH`
update cabal install instructions to get c2hs installed for gnuidn 2012-11-28 18:03:35 +00:00			`cabal install c2hs --bindir=$HOME/bin`
add cabal command to install build deps 2012-04-13 15:37:49 +00:00			`cabal install --only-dependencies`
move manual cabal install into its own page, and simplify it 2012-04-13 15:15:27 +00:00			`cabal configure`
			`cabal build`
			`cabal install --bindir=$HOME/bin`