Merge branch 'dr/ceiling'
[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    Let's face it, most of us don't have GNU interactive tools, and even
31    if we had it, we wouldn't know what it does.  I don't think it has
32    been actively developed since 1997, and people have moved over to
33    graphical file managers.
34
35    In addition, as of gnuit-4.9.2, the GNU interactive tools package has
36    been renamed. You can compile gnuit with the --disable-transition
37    option and then it will not conflict with git.
38
39  - You can use git after building but without installing if you
40    wanted to.  Various git commands need to find other git
41    commands and scripts to do their work, so you would need to
42    arrange a few environment variables to tell them that their
43    friends will be found in your built source area instead of at
44    their standard installation area.  Something like this works
45    for me:
46
47         GIT_EXEC_PATH=`pwd`
48         PATH=`pwd`:$PATH
49         GITPERLLIB=`pwd`/perl/blib/lib
50         export GIT_EXEC_PATH PATH GITPERLLIB
51
52  - Git is reasonably self-sufficient, but does depend on a few external
53    programs and libraries:
54
55         - "zlib", the compression library. Git won't build without it.
56
57         - "openssl".  Unless you specify otherwise, you'll get the SHA1
58           library from here.
59
60           If you don't have openssl, you can use one of the SHA1 libraries
61           that come with git (git includes the one from Mozilla, and has
62           its own PowerPC and ARM optimized ones too - see the Makefile).
63
64         - libcurl library; git-http-fetch and git-fetch use them.  You
65           might also want the "curl" executable for debugging purposes.
66           If you do not use http transfer, you are probably OK if you
67           do not have them.
68
69         - expat library; git-http-push uses it for remote lock
70           management over DAV.  Similar to "curl" above, this is optional.
71
72         - "wish", the Tcl/Tk windowing shell is used in gitk to show the
73           history graphically, and in git-gui.
74
75         - "ssh" is used to push and pull over the net
76
77         - "perl" and POSIX-compliant shells are needed to use most of
78           the barebone Porcelainish scripts.
79
80  - Some platform specific issues are dealt with Makefile rules,
81    but depending on your specific installation, you may not
82    have all the libraries/tools needed, or you may have
83    necessary libraries at unusual locations.  Please look at the
84    top of the Makefile to see what can be adjusted for your needs.
85    You can place local settings in config.mak and the Makefile
86    will include them.  Note that config.mak is not distributed;
87    the name is reserved for local settings.
88
89  - To build and install documentation suite, you need to have
90    the asciidoc/xmlto toolchain.  Because not many people are
91    inclined to install the tools, the default build target
92    ("make all") does _not_ build them.
93
94    Building and installing the info file additionally requires
95    makeinfo and docbook2X.  Version 0.8.3 is known to work.
96
97    The documentation is written for AsciiDoc 7, but "make
98    ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
99
100    Alternatively, pre-formatted documentation are available in
101    "html" and "man" branches of the git repository itself.  For
102    example, you could:
103
104         $ mkdir manual && cd manual
105         $ git init
106         $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
107           while read a b
108           do
109             echo $a >.git/$b
110           done
111         $ cp .git/refs/heads/man .git/refs/heads/master
112         $ git checkout
113
114    to checkout the pre-built man pages.  Also in this repository:
115
116         $ git checkout html
117
118    would instead give you a copy of what you see at:
119
120         http://www.kernel.org/pub/software/scm/git/docs/
121
122    It has been reported that docbook-xsl version 1.72 and 1.73 are
123    buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
124    the patch in contrib/patches/docbook-xsl-manpages-charmap.patch