Makefile: update check-docs target
[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
DK
8 $ make prefix=/usr all doc info ;# as yourself
9 # make prefix=/usr install install-doc 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
55667714
JN
16Alternatively you can use autoconf generated ./configure script to
17set up install paths (via config.mak.autogen), so you can write instead
18
3900145e 19 $ make configure ;# as yourself
55667714
JN
20 $ ./configure --prefix=/usr ;# as yourself
21 $ make all doc ;# as yourself
22 # make install install-doc ;# as root
23
24
c538d2d3
LT
25Issues 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
215a7ad1 33 places, you can always replace "git commit" with "git-commit"
a6080a0a 34 instead.
c538d2d3
LT
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
62a64d1a
MV
41 NOTE: As of gnuit-4.9.2, the GNU interactive tools package has been
42 renamed. You can compile gnuit with the --disable-transition
43 option and then it will not conflict with git.
44
3c767a08
JH
45 - You can use git after building but without installing if you
46 wanted to. Various git commands need to find other git
47 commands and scripts to do their work, so you would need to
48 arrange a few environment variables to tell them that their
49 friends will be found in your built source area instead of at
50 their standard installation area. Something like this works
51 for me:
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
LT
58 - Git is reasonably self-sufficient, but does depend on a few external
59 programs and libraries:
60
61 - "zlib", the compression library. Git won't build without it.
62
726f9bce
JH
63 - "openssl". Unless you specify otherwise, you'll get the SHA1
64 library from here.
c538d2d3
LT
65
66 If you don't have openssl, you can use one of the SHA1 libraries
67 that come with git (git includes the one from Mozilla, and has
765ac8ec 68 its own PowerPC and ARM optimized ones too - see the Makefile).
c538d2d3 69
215a7ad1
JH
70 - "libcurl" and "curl" executable. git-http-fetch and
71 git-fetch use them. If you do not use http
addf88e4 72 transfer, you are probably OK if you do not have
99cff830 73 them.
c538d2d3 74
3402f1d6
JH
75 - expat library; git-http-push uses it for remote lock
76 management over DAV. Similar to "curl" above, this is optional.
77
addf88e4 78 - "wish", the Tcl/Tk windowing shell is used in gitk to show the
726f9bce 79 history graphically, and in git-gui.
663a5ed5
HB
80
81 - "ssh" is used to push and pull over the net
3cab3594
JH
82
83 - "perl" and POSIX-compliant shells are needed to use most of
84 the barebone Porcelainish scripts.
85
3cab3594
JH
86 - Some platform specific issues are dealt with Makefile rules,
87 but depending on your specific installation, you may not
88 have all the libraries/tools needed, or you may have
89 necessary libraries at unusual locations. Please look at the
90 top of the Makefile to see what can be adjusted for your needs.
cd8c4589
JR
91 You can place local settings in config.mak and the Makefile
92 will include them. Note that config.mak is not distributed;
93 the name is reserved for local settings.
eff351c9 94
a90918e8
JH
95 - To build and install documentation suite, you need to have
96 the asciidoc/xmlto toolchain. Because not many people are
97 inclined to install the tools, the default build target
98e79f63
DK
98 ("make all") does _not_ build them.
99
100 Building and installing the info file additionally requires
101 makeinfo and docbook2X. Version 0.8.3 is known to work.
102
103 The documentation is written for AsciiDoc 7, but "make
104 ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
a90918e8
JH
105
106 Alternatively, pre-formatted documentation are available in
107 "html" and "man" branches of the git repository itself. For
108 example, you could:
eff351c9
BF
109
110 $ mkdir manual && cd manual
5c94f87e 111 $ git init
efc7fa53 112 $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
eff351c9
BF
113 while read a b
114 do
115 echo $a >.git/$b
116 done
117 $ cp .git/refs/heads/man .git/refs/heads/master
118 $ git checkout
119
120 to checkout the pre-built man pages. Also in this repository:
121
122 $ git checkout html
123
124 would instead give you a copy of what you see at:
125
126 http://www.kernel.org/pub/software/scm/git/docs/
2ec39eda
JH
127
128 It has been reported that docbook-xsl version 1.72 and 1.73 are
129 buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
130 the patch in contrib/patches/docbook-xsl-manpages-charmap.patch