INSTALL.txt

   1 ccache installation
   2 ===================
   3
   4
   5 Building code from a release archive
   6 ------------------------------------
   7
   8 Prerequisites
   9 ~~~~~~~~~~~~~
  10
  11 To build ccache, you need:
  12
  13 - A C compiler (for instance GCC)
  14
  15 It is also recommended that you have:
  16
  17 - zlib <http://www.zlib.net> (if you don't have zlib installed, ccache will
  18   use a bundled copy)
  19
  20
  21 Installation
  22 ~~~~~~~~~~~~
  23
  24 To compile and install ccache, run these commands:
  25
  26     ./configure
  27     make
  28     make install
  29
  30 You may set the installation directory and other parameters by options to
  31 ``./configure''. To see them, run ``./configure --help''.
  32
  33 There are two ways to use ccache. You can either prefix your compilation
  34 commands with ``ccache'' or you can create a symbolic link (named as your
  35 compiler) to ccache. The first method is most convenient if you just want to
  36 try out ccache or wish to use it for some specific projects. The second method
  37 is most useful for when you wish to use ccache for all your compilations.
  38
  39 To install for usage by the first method just copy ccache to somewhere in your
  40 path.
  41
  42 To install for the second method, do something like this:
  43
  44     cp ccache /usr/local/bin/
  45     ln -s ccache /usr/local/bin/gcc
  46     ln -s ccache /usr/local/bin/g++
  47     ln -s ccache /usr/local/bin/cc
  48     ln -s ccache /usr/local/bin/c++
  49
  50 And so forth. This will work as long as ``/usr/local/bin'' comes before the
  51 path to the compiler (which is usually in ``/usr/bin''). After installing you
  52 may wish to run ``which gcc'' to make sure that the correct link is being used.
  53
  54 NOTE: Do not use a hard link, use a symbolic link. A hard link will cause
  55 ``interesting'' problems.
  56
  57
  58 Building code from the source code repository
  59 ---------------------------------------------
  60
  61 In addition to the prerequisites mentioned above, you also need:
  62
  63 - AsciiDoc (http://www.methods.co.nz/asciidoc/) to build the documentation.
  64 - Autoconf (http://www.gnu.org/software/autoconf/)
  65
  66 To debug and run the performance test suite you'll also need:
  67
  68 - Perl (http://www.perl.org/)
  69 - Python (http://www.python.org/)
  70
  71 Run "./autogen.sh" and then follow the steps mentioned under "Installation"
  72 above.