Merge branch 'mh/work-tree'
[git] / INSTALL
1
2                 Git installation
3
4 Normally you can just do "make" followed by "make install", and that
5 will install the git programs in your own ~/bin/ directory.  If you want
6 to do a global install, you can do
7
8         $ make prefix=/usr all doc info ;# as yourself
9         # make prefix=/usr install install-doc install-info ;# as root
10
11 (or prefix=/usr/local, of course).  Just like any program suite
12 that uses $prefix, the built results have some paths encoded,
13 which are derived from $prefix, so "make all; make prefix=/usr
14 install" would not work.
15
16 Alternatively you can use autoconf generated ./configure script to
17 set up install paths (via config.mak.autogen), so you can write instead
18
19         $ make configure ;# as yourself
20         $ ./configure --prefix=/usr ;# as yourself
21         $ make all doc ;# as yourself
22         # make install install-doc ;# as root
23
24
25 Issues of note:
26
27  - git normally installs a helper script wrapper called "git", which
28    conflicts with a similarly named "GNU interactive tools" program.
29
30    Tough.  Either don't use the wrapper script, or delete the old GNU
31    interactive tools.  None of the core git stuff needs the wrapper,
32    it's just a convenient shorthand and while it is documented in some
33    places, you can always replace "git commit" with "git-commit"
34    instead.
35
36    But let's face it, most of us don't have GNU interactive tools, and
37    even if we had it, we wouldn't know what it does.  I don't think it
38    has been actively developed since 1997, and people have moved over to
39    graphical file managers.
40
41  - You can use git after building but without installing if you
42    wanted to.  Various git commands need to find other git
43    commands and scripts to do their work, so you would need to
44    arrange a few environment variables to tell them that their
45    friends will be found in your built source area instead of at
46    their standard installation area.  Something like this works
47    for me:
48
49         GIT_EXEC_PATH=`pwd`
50         PATH=`pwd`:$PATH
51         GITPERLLIB=`pwd`/perl/blib/lib
52         export GIT_EXEC_PATH PATH GITPERLLIB
53
54  - Git is reasonably self-sufficient, but does depend on a few external
55    programs and libraries:
56
57         - "zlib", the compression library. Git won't build without it.
58
59         - "openssl".  Unless you specify otherwise, you'll get the SHA1
60           library from here.
61
62           If you don't have openssl, you can use one of the SHA1 libraries
63           that come with git (git includes the one from Mozilla, and has
64           its own PowerPC and ARM optimized ones too - see the Makefile).
65
66         - "libcurl" and "curl" executable.  git-http-fetch and
67           git-fetch use them.  If you do not use http
68           transfer, you are probably OK if you do not have
69           them.
70
71         - expat library; git-http-push uses it for remote lock
72           management over DAV.  Similar to "curl" above, this is optional.
73
74         - "wish", the Tcl/Tk windowing shell is used in gitk to show the
75           history graphically, and in git-gui.
76
77         - "ssh" is used to push and pull over the net
78
79         - "perl" and POSIX-compliant shells are needed to use most of
80           the barebone Porcelainish scripts.
81
82         - "cpio" is used by git-merge for saving and restoring the index,
83           and by git-clone when doing a local (possibly hardlinked) clone.
84
85  - Some platform specific issues are dealt with Makefile rules,
86    but depending on your specific installation, you may not
87    have all the libraries/tools needed, or you may have
88    necessary libraries at unusual locations.  Please look at the
89    top of the Makefile to see what can be adjusted for your needs.
90    You can place local settings in config.mak and the Makefile
91    will include them.  Note that config.mak is not distributed;
92    the name is reserved for local settings.
93
94  - To build and install documentation suite, you need to have
95    the asciidoc/xmlto toolchain.  Because not many people are
96    inclined to install the tools, the default build target
97    ("make all") does _not_ build them.
98
99    Building and installing the info file additionally requires
100    makeinfo and docbook2X.  Version 0.8.3 is known to work.
101
102    The documentation is written for AsciiDoc 7, but "make
103    ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
104
105    Alternatively, pre-formatted documentation are available in
106    "html" and "man" branches of the git repository itself.  For
107    example, you could:
108
109         $ mkdir manual && cd manual
110         $ git init
111         $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
112           while read a b
113           do
114             echo $a >.git/$b
115           done
116         $ cp .git/refs/heads/man .git/refs/heads/master
117         $ git checkout
118
119    to checkout the pre-built man pages.  Also in this repository:
120
121         $ git checkout html
122
123    would instead give you a copy of what you see at:
124
125         http://www.kernel.org/pub/software/scm/git/docs/
126
127    It has been reported that docbook-xsl version 1.72 and 1.73 are
128    buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
129    the patch in contrib/patches/docbook-xsl-manpages-charmap.patch