INSTALL: explain how to build documentation
[git/git.git] / INSTALL
2 Git installation
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 ;# as yourself
9 # make prefix=/usr install install-doc ;# 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 Alternatively you can use autoconf generated ./configure script to
17 set up install paths (via config.mak.autogen), so you can write instead
19 $ make configure ;# as yourself
20 $ ./configure --prefix=/usr ;# as yourself
21 $ make all doc ;# as yourself
22 # make install install-doc ;# as root
25 Issues of note:
27 - git normally installs a helper script wrapper called "git", which
28 conflicts with a similarly named "GNU interactive tools" program.
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.
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.
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:
49 GIT_EXEC_PATH=`pwd`
50 PATH=`pwd`:$PATH
51 GITPERLLIB=`pwd`/perl/blib/lib
54 - Git is reasonably self-sufficient, but does depend on a few external
55 programs and libraries:
57 - "zlib", the compression library. Git won't build without it.
59 - "openssl". The git-rev-list program uses bignum support from
60 openssl, and unless you specify otherwise, you'll also get the
61 SHA1 library from here.
63 If you don't have openssl, you can use one of the SHA1 libraries
64 that come with git (git includes the one from Mozilla, and has
65 its own PowerPC and ARM optimized ones too - see the Makefile).
67 - "libcurl" and "curl" executable. git-http-fetch and
68 git-fetch use them. If you do not use http
69 transfer, you are probably OK if you do not have
70 them.
72 - expat library; git-http-push uses it for remote lock
73 management over DAV. Similar to "curl" above, this is optional.
75 - "wish", the Tcl/Tk windowing shell is used in gitk to show the
76 history graphically
78 - "ssh" is used to push and pull over the net
80 - "perl" and POSIX-compliant shells are needed to use most of
81 the barebone Porcelainish scripts.
83 - Some platform specific issues are dealt with Makefile rules,
84 but depending on your specific installation, you may not
85 have all the libraries/tools needed, or you may have
86 necessary libraries at unusual locations. Please look at the
87 top of the Makefile to see what can be adjusted for your needs.
88 You can place local settings in config.mak and the Makefile
89 will include them. Note that config.mak is not distributed;
90 the name is reserved for local settings.
92 - To build and install documentation suite, you need to have
93 the asciidoc/xmlto toolchain. Because not many people are
94 inclined to install the tools, the default build target
95 ("make all") does _not_ build them. The documentation is
96 written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc"
97 will let you format with AsciiDoc 8.
99 Alternatively, pre-formatted documentation are available in
100 "html" and "man" branches of the git repository itself. For
101 example, you could:
103 $ mkdir manual && cd manual
104 $ git init
105 $ git fetch-pack git:// man html |
106 while read a b
107 do
108 echo $a >.git/$b
109 done
110 $ cp .git/refs/heads/man .git/refs/heads/master
111 $ git checkout
113 to checkout the pre-built man pages. Also in this repository:
115 $ git checkout html
117 would instead give you a copy of what you see at: