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
8 $ make prefix=/usr all doc info ;# as yourself
9 # make prefix=/usr install install-doc install-html install-info ;# as root
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.
16 The beginning of the Makefile documents many variables that affect the way
17 git is built. You can override them either from the command line, or in a
20 Alternatively you can use autoconf generated ./configure script to
21 set up install paths (via config.mak.autogen), so you can write instead
23 $ make configure ;# as yourself
24 $ ./configure --prefix=/usr ;# as yourself
25 $ make all doc ;# as yourself
26 # make install install-doc install-html;# as root
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
37 NOTE: When compiled with backward compatibility option, the GNU
38 Interactive Tools package still can install "git", but you can build it
39 with --disable-transition option to avoid this.
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.
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:
55 GITPERLLIB=`pwd`/perl/blib/lib
56 export GIT_EXEC_PATH PATH GITPERLLIB
58 - Git is reasonably self-sufficient, but does depend on a few external
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
63 - "zlib", the compression library. Git won't build without it.
65 - "ssh" is used to push and pull over the net.
67 - A POSIX-compliant shell is required to run many scripts needed
68 for everyday use (e.g. "bisect", "pull").
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
72 repositories with "git svn"). If you can live without these, use
75 - "openssl" library is used by git-imap-send to use IMAP over SSL.
76 If you don't need it, use NO_OPENSSL.
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
83 - "libcurl" library is used by git-http-fetch and git-fetch. You
84 might also want the "curl" executable for debugging purposes.
85 If you do not use http:// or https:// repositories, you do not
86 have to have them (use NO_CURL).
88 - "expat" library; git-http-push uses it for remote lock
89 management over DAV. Similar to "curl" above, this is optional
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.
96 - A gettext library is used by default for localizing Git. The
97 primary target is GNU libintl, but the Solaris gettext
98 implementation also works.
100 We need a gettext.h on the system for C code, gettext.sh (or
101 Solaris gettext(1)) for shell scripts, and libintl-perl for Perl
104 Set NO_GETTEXT to disable localization support and make Git only
105 use English. Under autoconf the configure script will do this
106 automatically if it can't find libintl on the system.
108 - Some platform specific issues are dealt with Makefile rules,
109 but depending on your specific installation, you may not
110 have all the libraries/tools needed, or you may have
111 necessary libraries at unusual locations. Please look at the
112 top of the Makefile to see what can be adjusted for your needs.
113 You can place local settings in config.mak and the Makefile
114 will include them. Note that config.mak is not distributed;
115 the name is reserved for local settings.
117 - To build and install documentation suite, you need to have
118 the asciidoc/xmlto toolchain. Because not many people are
119 inclined to install the tools, the default build target
120 ("make all") does _not_ build them.
122 "make doc" builds documentation in man and html formats; there are
123 also "make man", "make html" and "make info". Note that "make html"
124 requires asciidoc, but not xmlto. "make man" (and thus make doc)
127 "make install-doc" installs documentation in man format only; there
128 are also "make install-man", "make install-html" and "make
131 Building and installing the info file additionally requires
132 makeinfo and docbook2X. Version 0.8.3 is known to work.
134 Building and installing the pdf file additionally requires
135 dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work.
137 The documentation is written for AsciiDoc 7, but "make
138 ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
140 Alternatively, pre-formatted documentation is available in
141 "html" and "man" branches of the git repository itself. For
144 $ mkdir manual && cd manual
146 $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
151 $ cp .git/refs/heads/man .git/refs/heads/master
154 to checkout the pre-built man pages. Also in this repository:
158 would instead give you a copy of what you see at:
160 http://www.kernel.org/pub/software/scm/git/docs/
162 There are also "make quick-install-doc", "make quick-install-man"
163 and "make quick-install-html" which install preformatted man pages
164 and html documentation.
165 This does not require asciidoc/xmlto, but it only works from within
166 a cloned checkout of git.git with these two extra branches, and will
167 not work for the maintainer for obvious chicken-and-egg reasons.
169 It has been reported that docbook-xsl version 1.72 and 1.73 are
170 buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
171 the patch in contrib/patches/docbook-xsl-manpages-charmap.patch
173 Users attempting to build the documentation on Cygwin may need to ensure
174 that the /etc/xml/catalog file looks something like this:
176 <?xml version="1.0"?>
177 <!DOCTYPE catalog PUBLIC
178 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
179 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"
181 <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
183 uriStartString = "http://docbook.sourceforge.net/release/xsl/current"
184 rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets"
187 uriStartString="http://www.oasis-open.org/docbook/xml/4.5"
188 rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5"
192 This can be achieved with the following two xmlcatalog commands:
196 http://docbook.sourceforge.net/release/xsl/current \
197 /usr/share/sgml/docbook/xsl-stylesheets \
202 http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
203 /usr/share/sgml/docbook/xml-dtd-4.5 \