summaryrefslogtreecommitdiff
path: root/doc/install.mdwn
diff options
context:
space:
mode:
authorGravatar Nathan Collins <nathan.collins@gmail.com>2012-06-03 15:05:59 -0700
committerGravatar Nathan Collins <nathan.collins@gmail.com>2012-06-05 20:36:42 -0700
commitf5261f60c3d4462088768959014189a3aa61ff30 (patch)
tree53b430c5f96f96dfdfc87955f5f6f5d986f5f717 /doc/install.mdwn
parentd41c1134cb1f49529b294407efd24061c8219347 (diff)
Make standalone man-page installation possible
The `cabal install git-annex` doesn't install the man pages, and the Makefile only installed the man pages as part of a full build/install. So, I factored out the documentation parts of the Makefile.
Diffstat (limited to 'doc/install.mdwn')
-rw-r--r--doc/install.mdwn22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/install.mdwn b/doc/install.mdwn
index fe0522aa0..1f4b54f54 100644
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -20,6 +20,28 @@ As a haskell package, git-annex can be installed using cabal. For example:
The above downloads the latest release. Alternatively, you can [[download]]
it yourself and [[manually_build_with_cabal|install/cabal]].
+### Man pages
+
+Cabal does not install the man pages. Do:
+
+ cd /tmp
+ cabal unpack git-annex
+ cd git-annex*
+ make install-mans PREFIX=~/.cabal
+
+to install man pages under ~/.cabal/share/man (or $PREFIX/share/man
+generally). If ~/.cabal/bin is on your PATH, and you're on a Debian
+derivative, you're probably set.
+
+On Debian systems, `manpath` will print the paths searched for manual
+pages. The paths searched are inferred from your PATH. Experiments
+indicate that, on Ubuntu, D/share/man will be searched for manual
+pages whenever D/bin is on your PATH. So, having ~/.cabal/bin on your
+PATH is enough to make the above example work. The `man manpath` does
+not document this, but see
+http://linux.derkeiler.com/Mailing-Lists/Debian/2003-08/0956.html for
+some other special cases.
+
## Installation by hand
To build and use git-annex, you will need: