1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
|
.\" Hey, EMACS: -*- nroff -*-
.TH COMPILERCACHE 1 "January 7, 2002" "1.0.10" "Compilercache Manual"
.SH NAME
compilercache \- a caching wrapper around compilers to speed up compilations
.SH SYNOPSIS
.B /usr/lib/compilercache/cc
.RI [ options ] " files" ...
.br
.B /usr/lib/compilercache/gcc
.RI [ options ] " files" ...
.br
.B /usr/lib/compilercache/c++
.RI [ options ] " files" ...
.br
.B /usr/lib/compilercache/g++
.RI [ options ] " files" ...
.SH DESCRIPTION
.B Compilercache
is a set of wrappers around C and C++ compilers. Each
time you compile something, the wrapper puts the result of the
compilation into a cache. And once you compile the same thing again,
the result will be picked from the cache instead of being recompiled.
.PP
There are three design criteria in
.BR compilercache ,
shown in descending order of priority:
.IP 1)
the compilercache may NEVER return an output file that is not
bitwise the same as if the original compiler would have been run.
.IP 2)
the compilercache shall do exactly the same thing as the original
compiler, only the time consumption is sometimes much less.
.IP 3)
the compilercache shall use the files from the cache as often as
possible and not unnecessarily recompile.
.PP
It is absolutely top priority that 1) and 2) are ALWAYS met under ALL
circumstances.
.SH USAGE
To use
.B compilercache
you should call the commands in
.I /usr/lib/compilercache
instead of the regular compilers. The easiest way to do so,
is to add
.I /usr/lib/compilercache
to the PATH variable. For Bourne-Shell variants this is done
with a command like
.sp
.RS
.I PATH="/usr/lib/compilercache:$PATH"
.RE
To hook new compilers into the
.B compilercache
system, just add the corresponding link in
.I /usr/lib/compilercache
(or in
.I $COMPILERCACHEBINDIR
if this ist set). Example: to add gcc-3.2 support you could use the
commands
.RS
.I cd /usr/lib/compilercache
.br
.I ln -s compilercache gcc-3.2
.br
.I ln -s compilercache g++-3.2
.RE
.SH FILES
.TP
.I /etc/compilercacherc
system wide configuration file.
.TP
.I $HOME/.compilercacherc
per user configuration file.
.TP
.I $(HOME)/.compilercache/cache/
default cache location. If it grows too large, you may remove files
from this directory without ill effects.
.TP
.I $(HOME)/.compilercache/temp/
default location for temporary files.
.SH ENVIRONMENT
If you set the
.I NOCOMPILERCACHE
environment variable, the cache will not be used. This helps to
temporarily disable compilercache without modifying the configuration
file.
.SH SEE ALSO
.I /usr/share/doc/compilercache/README.gz
.SH AUTHOR
.B Compilercache
was written by Erik Thiele <erikyyy@erikyyy.de>.
.PP
This manual page was written by Jochen Voss <voss@debian.org>.
|