git-annex/doc/install.mdwn

## OS-specific instructions

* [[OSX]]
* [[Debian]]
* [[Ubuntu]]
* [[Fedora]]
* [[FreeBSD]]
* [[openSUSE]]
* [[ArchLinux]]
* [[NixOS]]
* [[Gentoo]]
* [[ScientificLinux5]] - This should cover RHEL5 clones such as CentOS5 and so on
* Windows: [[sorry, not possible yet|todo/windows_support]]

## Using cabal

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

	cabal install git-annex --bindir=$HOME/bin

The above downloads the latest release. Alternatively, you can [[download]]
it yourself and [[manually_build_with_cabal|install/cabal]].

## Installation by hand

To build and use git-annex, you will need:

* Haskell stuff
  * [The Haskell Platform](http://haskell.org/platform/) (GHC 7.4 or newer)
  * [MissingH](http://github.com/jgoerzen/missingh/wiki)
  * [pcre-light](http://hackage.haskell.org/package/pcre-light)
  * [utf8-string](http://hackage.haskell.org/package/utf8-string)
  * [SHA](http://hackage.haskell.org/package/SHA)
  * [dataenc](http://hackage.haskell.org/package/dataenc)
  * [monad-control](http://hackage.haskell.org/package/monad-control)
  * [lifted-base](http://hackage.haskell.org/package/lifted-base)
  * [TestPack](http://hackage.haskell.org/cgi-bin/hackage-scripts/package/testpack)
  * [QuickCheck 2](http://hackage.haskell.org/package/QuickCheck)
  * [HTTP](http://hackage.haskell.org/package/HTTP)
  * [json](http://hackage.haskell.org/package/json)
  * [IfElse](http://hackage.haskell.org/package/IfElse)
  * [bloomfilter](http://hackage.haskell.org/package/bloomfilter)
  * [edit-distance](http://hackage.haskell.org/package/edit-distance)
  * [hS3](http://hackage.haskell.org/package/hS3) (optional)
  * [stm](http://hackage.haskell.org/package/stm)
    (optional; version 2.3 or newer)
  * [hinotify](http://hackage.haskell.org/package/hinotify)
    (optional; Linux only)
* Shell commands
  * [git](http://git-scm.com/)
  * [uuid](http://www.ossp.org/pkg/lib/uuid/)
    (or `uuidgen` from util-linux)
  * [xargs](http://savannah.gnu.org/projects/findutils/)
  * [rsync](http://rsync.samba.org/)
  * [wget](http://www.gnu.org/software/wget/) or [curl](http://http://curl.haxx.se/) (optional, but recommended)
  * [sha1sum](ftp://ftp.gnu.org/gnu/coreutils/) (optional, but recommended;
    a sha1 command will also do)
  * [gpg](http://gnupg.org/) (optional; needed for encryption)
  * [lsof](ftp://lsof.itap.purdue.edu/pub/tools/unix/lsof/)
    (optional; recommended for watch mode)
  * [ikiwiki](http://ikiwiki.info) (optional; used to build the docs)

Then just [[download]] git-annex and run: `make; make install`
more install notes 2011-02-09 04:25:22 +00:00			`## OS-specific instructions`

			`* [[OSX]]`
			`* [[Debian]]`
			`* [[Ubuntu]]`
add fedora install instructions 2011-06-02 04:51:56 +00:00			`* [[Fedora]]`
freebsd port now available 2011-06-26 23:00:46 +00:00			`* [[FreeBSD]]`
add a page for openSUSE install instructions 2011-12-24 00:13:43 +00:00			`* [[openSUSE]]`
add arch link 2012-01-02 17:44:12 +00:00			`* [[ArchLinux]]`
Added NixOS to the list of distributions that support git-annex. 2012-01-13 18:49:56 +00:00			`* [[NixOS]]`
gentoo 2012-05-02 17:18:21 +00:00			`* [[Gentoo]]`
2012-06-15 19:06:45 +00:00			`* [[ScientificLinux5]] - This should cover RHEL5 clones such as CentOS5 and so on`
reorg 2012-07-24 15:15:39 +00:00			`* Windows: [[sorry, not possible yet\|todo/windows_support]]`
more install notes 2011-02-09 04:25:22 +00:00
reorder 2011-07-02 21:29:20 +00:00			`## Using cabal`

include --bindir in all cabal install examples 2011-09-25 18:26:05 +00:00			`As a haskell package, git-annex can be installed using cabal. For example:`
reorder 2011-07-02 21:29:20 +00:00
			`cabal install git-annex --bindir=$HOME/bin`

move manual cabal install into its own page, and simplify it 2012-04-13 15:15:27 +00:00			`The above downloads the latest release. Alternatively, you can [[download]]`
			`it yourself and [[manually_build_with_cabal\|install/cabal]].`

reorder 2011-07-02 21:29:20 +00:00			`## Installation by hand`
more install notes 2011-02-09 04:25:22 +00:00
add 2010-10-19 20:32:50 +00:00			`To build and use git-annex, you will need:`

reformat 2011-06-02 05:01:14 +00:00			`* Haskell stuff`
note 7.4 needed 2012-02-04 18:44:03 +00:00			`* [The Haskell Platform](http://haskell.org/platform/) (GHC 7.4 or newer)`
fix 2011-06-02 05:01:59 +00:00			`* [MissingH](http://github.com/jgoerzen/missingh/wiki)`
reformat 2011-06-02 05:01:14 +00:00			`* [pcre-light](http://hackage.haskell.org/package/pcre-light)`
			`* [utf8-string](http://hackage.haskell.org/package/utf8-string)`
fix 2011-06-02 05:01:59 +00:00			`* [SHA](http://hackage.haskell.org/package/SHA)`
			`* [dataenc](http://hackage.haskell.org/package/dataenc)`
add monad-control to build depends Will use this to handle exceptions in the Annex monad, yay. 2011-07-07 23:10:42 +00:00			`* [monad-control](http://hackage.haskell.org/package/monad-control)`
Merge branch 'new-monad-control' Conflicts: debian/changelog 2011-12-31 00:06:15 +00:00			`* [lifted-base](http://hackage.haskell.org/package/lifted-base)`
reformat 2011-06-02 05:01:14 +00:00			`* [TestPack](http://hackage.haskell.org/cgi-bin/hackage-scripts/package/testpack)`
			`* [QuickCheck 2](http://hackage.haskell.org/package/QuickCheck)`
Drop the dependency on the haskell curl bindings, use regular haskell HTTP. 2011-07-04 23:31:45 +00:00			`* [HTTP](http://hackage.haskell.org/package/HTTP)`
basic json support This includes a generic JSONStream library built on top of Text.JSON (somewhat hackishly). It would be possible to stream out a single json document describing all actions, but it's probably better for consumers if they can expect one json document per line, so I did it that way instead. Output from external programs used for transferring files is not currently hidden when outputting json, which probably makes it not very useful there. This may be dealt with if there is demand for json output for --get or --move to be parsable. The version, status, and find subcommands have hand-crafted output and don't do json. The whereis subcommand needs to be modified to produce useful json. 2011-09-01 19:16:31 +00:00			`* [json](http://hackage.haskell.org/package/json)`
remove Utility.Conditional and use IfElse This drops the >>! and >>? with the nice low fixity. IfElse does have undocumented >>=>>! and >>=>>? operators, but I deem that too fishy. Anyway, using whenM and unlessM is easier; I sometimes mixed the operators up. 2012-01-24 19:28:13 +00:00			`* [IfElse](http://hackage.haskell.org/package/IfElse)`
finish bloom filters Add tuning, docs, etc. Not sure if status is the right place to remote size.. perhaps unused should report the size and also warn if it sees more keys than the bloom filter allows? 2012-03-12 20:18:14 +00:00			`* [bloomfilter](http://hackage.haskell.org/package/bloomfilter)`
autocorrection git-annex (but not git-annex-shell) supports the git help.autocorrect configuration setting, doing fuzzy matching using the restricted Damerau-Levenshtein edit distance, just as git does. This adds a build dependency on the haskell edit-distance library. 2012-04-12 19:34:41 +00:00			`* [edit-distance](http://hackage.haskell.org/package/edit-distance)`
Version build dependency on STM, and allow building without it, which disables the watch command. 2012-06-26 13:15:47 +00:00			`* [hS3](http://hackage.haskell.org/package/hS3) (optional)`
update 2012-06-10 20:49:36 +00:00			`* [stm](http://hackage.haskell.org/package/stm)`
Version build dependency on STM, and allow building without it, which disables the watch command. 2012-06-26 13:15:47 +00:00			`(optional; version 2.3 or newer)`
make inotify a build flag etc 2012-06-17 21:15:56 +00:00			`* [hinotify](http://hackage.haskell.org/package/hinotify)`
			`(optional; Linux only)`
update 2011-06-02 05:02:57 +00:00			`* Shell commands`
			`* [git](http://git-scm.com/)`
			`* [uuid](http://www.ossp.org/pkg/lib/uuid/)`
			(or `uuidgen` from util-linux)
			`* [xargs](http://savannah.gnu.org/projects/findutils/)`
			`* [rsync](http://rsync.samba.org/)`
The wget command will now be used in preference to curl, if available. Got tired of curl's various ugly progress bars. 2011-08-27 16:31:50 +00:00			`* [wget](http://www.gnu.org/software/wget/) or [curl](http://http://curl.haxx.se/) (optional, but recommended)`
update 2011-06-02 05:02:57 +00:00			`* [sha1sum](ftp://ftp.gnu.org/gnu/coreutils/) (optional, but recommended;`
			`a sha1 command will also do)`
			`* [gpg](http://gnupg.org/) (optional; needed for encryption)`
add lsof build deps Check for it in configure; and add a --force option for people without it who want to live dangerously. 2012-06-16 03:24:01 +00:00			`* [lsof](ftp://lsof.itap.purdue.edu/pub/tools/unix/lsof/)`
check lsof at runtime 2012-06-16 06:49:26 +00:00			`(optional; recommended for watch mode)`
update 2011-06-02 05:02:57 +00:00			`* [ikiwiki](http://ikiwiki.info) (optional; used to build the docs)`
ikiwiki is not really needed 2010-10-29 17:59:48 +00:00
nasty hack to build when hS3 is not available So, it would be nicer to just use Cabal and take advantage of its conditional compilation support. But, Cabal seems to lack good support for a package with an internal library that is used by multiple executables. It wants to build everything twice or more. That's too slow for me. Anyway, fairly soon, I expect to upgrade hS3 to a requirment, and I can just revert this. 2011-03-30 05:32:05 +00:00			Then just [[download]] git-annex and run: `make; make install`