t3700-add: fix dependence on stdout and stderr buffering
[git/git.git] / INSTALL
CommitLineData
c538d2d3
LT
1
2 Git installation
3
4Normally you can just do "make" followed by "make install", and that
5will install the git programs in your own ~/bin/ directory. If you want
6to do a global install, you can do
7
98e79f63 8 $ make prefix=/usr all doc info ;# as yourself
414851a4 9 # make prefix=/usr install install-doc install-html install-info ;# as root
c538d2d3 10
c44922a7
JH
11(or prefix=/usr/local, of course). Just like any program suite
12that uses $prefix, the built results have some paths encoded,
13which are derived from $prefix, so "make all; make prefix=/usr
14install" would not work.
c538d2d3 15
5beb577d
BG
16The beginning of the Makefile documents many variables that affect the way
17git is built. You can override them either from the command line, or in a
18config.mak file.
19
55667714
JN
20Alternatively you can use autoconf generated ./configure script to
21set up install paths (via config.mak.autogen), so you can write instead
22
3900145e 23 $ make configure ;# as yourself
55667714
JN
24 $ ./configure --prefix=/usr ;# as yourself
25 $ make all doc ;# as yourself
414851a4 26 # make install install-doc install-html;# as root
55667714
JN
27
28
c538d2d3
LT
29Issues of note:
30
a958d8ed
JH
31 - Ancient versions of GNU Interactive Tools (pre-4.9.2) installed a
32 program "git", whose name conflicts with this program. But with
33 version 4.9.2, after long hiatus without active maintenance (since
34 around 1997), it changed its name to gnuit and the name conflict is no
35 longer a problem.
36
25032ccd 37 NOTE: When compiled with backward compatibility option, the GNU
a958d8ed
JH
38 Interactive Tools package still can install "git", but you can build it
39 with --disable-transition option to avoid this.
62a64d1a 40
90458012
MO
41 - You can use git after building but without installing if you want
42 to test drive it. Simply run git found in bin-wrappers directory
43 in the build directory, or prepend that directory to your $PATH.
44 This however is less efficient than running an installed git, as
45 you always need an extra fork+exec to run any git subcommand.
46
47 It is still possible to use git without installing by setting a few
48 environment variables, which was the way this was done
49 traditionally. But using git found in bin-wrappers directory in
50 the build directory is far simpler. As a historical reference, the
51 old way went like this:
3c767a08
JH
52
53 GIT_EXEC_PATH=`pwd`
54 PATH=`pwd`:$PATH
f7661ce0 55 GITPERLLIB=`pwd`/perl/blib/lib
6fcca938 56 export GIT_EXEC_PATH PATH GITPERLLIB
3c767a08 57
c538d2d3 58 - Git is reasonably self-sufficient, but does depend on a few external
5beb577d
BG
59 programs and libraries. Git can be used without most of them by adding
60 the approriate "NO_<LIBRARY>=YesPlease" to the make command line or
61 config.mak file.
c538d2d3
LT
62
63 - "zlib", the compression library. Git won't build without it.
64
26d94439
BG
65 - "ssh" is used to push and pull over the net.
66
67 - A POSIX-compliant shell is required to run many scripts needed
68 for everyday use (e.g. "bisect", "pull").
69
70 - "Perl" is needed to use some of the features (e.g. preparing a
71 partial commit using "git add -i/-p", interacting with svn
5beb577d
BG
72 repositories with "git svn"). If you can live without these, use
73 NO_PERL.
26d94439 74
5beb577d
BG
75 - "openssl" library is used by git-imap-send to use IMAP over SSL.
76 If you don't need it, use NO_OPENSSL.
c538d2d3 77
5beb577d
BG
78 By default, git uses OpenSSL for SHA1 but it will use it's own
79 library (inspired by Mozilla's) with either NO_OPENSSL or
80 BLK_SHA1. Also included is a version optimized for PowerPC
81 (PPC_SHA1).
c538d2d3 82
5beb577d 83 - "libcurl" library is used by git-http-fetch and git-fetch. You
1d53f90e 84 might also want the "curl" executable for debugging purposes.
5beb577d
BG
85 If you do not use http:// or https:// repositories, you do not
86 have to have them (use NO_CURL).
c538d2d3 87
5beb577d
BG
88 - "expat" library; git-http-push uses it for remote lock
89 management over DAV. Similar to "curl" above, this is optional
90 (with NO_EXPAT).
3402f1d6 91
5beb577d
BG
92 - "wish", the Tcl/Tk windowing shell is used in gitk to show the
93 history graphically, and in git-gui. If you don't want gitk or
94 git-gui, you can use NO_TCLTK.
663a5ed5 95
3cab3594
JH
96 - Some platform specific issues are dealt with Makefile rules,
97 but depending on your specific installation, you may not
98 have all the libraries/tools needed, or you may have
99 necessary libraries at unusual locations. Please look at the
100 top of the Makefile to see what can be adjusted for your needs.
cd8c4589
JR
101 You can place local settings in config.mak and the Makefile
102 will include them. Note that config.mak is not distributed;
103 the name is reserved for local settings.
eff351c9 104
a90918e8
JH
105 - To build and install documentation suite, you need to have
106 the asciidoc/xmlto toolchain. Because not many people are
107 inclined to install the tools, the default build target
98e79f63
DK
108 ("make all") does _not_ build them.
109
414851a4
MG
110 "make doc" builds documentation in man and html formats; there are
111 also "make man", "make html" and "make info". Note that "make html"
112 requires asciidoc, but not xmlto. "make man" (and thus make doc)
113 requires both.
114
115 "make install-doc" installs documentation in man format only; there
116 are also "make install-man", "make install-html" and "make
117 install-info".
118
98e79f63
DK
119 Building and installing the info file additionally requires
120 makeinfo and docbook2X. Version 0.8.3 is known to work.
121
a325a1a7
MV
122 Building and installing the pdf file additionally requires
123 dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work.
124
98e79f63
DK
125 The documentation is written for AsciiDoc 7, but "make
126 ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
a90918e8 127
414851a4 128 Alternatively, pre-formatted documentation is available in
a90918e8
JH
129 "html" and "man" branches of the git repository itself. For
130 example, you could:
eff351c9
BF
131
132 $ mkdir manual && cd manual
5c94f87e 133 $ git init
efc7fa53 134 $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
eff351c9
BF
135 while read a b
136 do
137 echo $a >.git/$b
138 done
139 $ cp .git/refs/heads/man .git/refs/heads/master
140 $ git checkout
141
142 to checkout the pre-built man pages. Also in this repository:
143
144 $ git checkout html
145
146 would instead give you a copy of what you see at:
147
148 http://www.kernel.org/pub/software/scm/git/docs/
2ec39eda 149
b1a46b70
MH
150 There are also "make quick-install-doc", "make quick-install-man"
151 and "make quick-install-html" which install preformatted man pages
152 and html documentation.
6fe570de
MG
153 This does not require asciidoc/xmlto, but it only works from within
154 a cloned checkout of git.git with these two extra branches, and will
155 not work for the maintainer for obvious chicken-and-egg reasons.
156
2ec39eda
JH
157 It has been reported that docbook-xsl version 1.72 and 1.73 are
158 buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
159 the patch in contrib/patches/docbook-xsl-manpages-charmap.patch