source: GTP/trunk/Lib/Vis/Preprocessing/src/sparsehash/INSTALL @ 2162

Revision 2162, 9.7 KB checked in by mattausch, 18 years ago (diff)

improved hash performance with google hashmap

Line 
1Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
2Foundation, Inc.
3
4   This file is free documentation; the Free Software Foundation gives
5unlimited permission to copy, distribute and modify it.
6
7
8Non-generic Instructions
9========================
10
11You can specify in what namespace the google hashtable routines
12(sparse_hash_map et al.) will be defined.  The default is to define
13them in std.  To define them in another namespace, run with
14
15   --enable-namespace=another_namespace
16
17To define the hashtable routines in the main namespace (that is, in no
18namespace at all), run with
19
20   --disable-namespace
21
22
23Basic Installation
24==================
25
26   These are generic installation instructions.
27
28   The `configure' shell script attempts to guess correct values for
29various system-dependent variables used during compilation.  It uses
30those values to create a `Makefile' in each directory of the package.
31It may also create one or more `.h' files containing system-dependent
32definitions.  Finally, it creates a shell script `config.status' that
33you can run in the future to recreate the current configuration, and a
34file `config.log' containing compiler output (useful mainly for
35debugging `configure').
36
37   It can also use an optional file (typically called `config.cache'
38and enabled with `--cache-file=config.cache' or simply `-C') that saves
39the results of its tests to speed up reconfiguring.  (Caching is
40disabled by default to prevent problems with accidental use of stale
41cache files.)
42
43   If you need to do unusual things to compile the package, please try
44to figure out how `configure' could check whether to do them, and mail
45diffs or instructions to the address given in the `README' so they can
46be considered for the next release.  If you are using the cache, and at
47some point `config.cache' contains results you don't want to keep, you
48may remove or edit it.
49
50   The file `configure.ac' (or `configure.in') is used to create
51`configure' by a program called `autoconf'.  You only need
52`configure.ac' if you want to change it or regenerate `configure' using
53a newer version of `autoconf'.
54
55The simplest way to compile this package is:
56
57  1. `cd' to the directory containing the package's source code and type
58     `./configure' to configure the package for your system.  If you're
59     using `csh' on an old version of System V, you might need to type
60     `sh ./configure' instead to prevent `csh' from trying to execute
61     `configure' itself.
62
63     Running `configure' takes awhile.  While running, it prints some
64     messages telling which features it is checking for.
65
66  2. Type `make' to compile the package.
67
68  3. Optionally, type `make check' to run any self-tests that come with
69     the package.
70
71  4. Type `make install' to install the programs and any data files and
72     documentation.
73
74  5. You can remove the program binaries and object files from the
75     source code directory by typing `make clean'.  To also remove the
76     files that `configure' created (so you can compile the package for
77     a different kind of computer), type `make distclean'.  There is
78     also a `make maintainer-clean' target, but that is intended mainly
79     for the package's developers.  If you use it, you may have to get
80     all sorts of other programs in order to regenerate files that came
81     with the distribution.
82
83Compilers and Options
84=====================
85
86   Some systems require unusual options for compilation or linking that
87the `configure' script does not know about.  Run `./configure --help'
88for details on some of the pertinent environment variables.
89
90   You can give `configure' initial values for configuration parameters
91by setting variables in the command line or in the environment.  Here
92is an example:
93
94     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
95
96   *Note Defining Variables::, for more details.
97
98Compiling For Multiple Architectures
99====================================
100
101   You can compile the package for more than one kind of computer at the
102same time, by placing the object files for each architecture in their
103own directory.  To do this, you must use a version of `make' that
104supports the `VPATH' variable, such as GNU `make'.  `cd' to the
105directory where you want the object files and executables to go and run
106the `configure' script.  `configure' automatically checks for the
107source code in the directory that `configure' is in and in `..'.
108
109   If you have to use a `make' that does not support the `VPATH'
110variable, you have to compile the package for one architecture at a
111time in the source code directory.  After you have installed the
112package for one architecture, use `make distclean' before reconfiguring
113for another architecture.
114
115Installation Names
116==================
117
118   By default, `make install' will install the package's files in
119`/usr/local/bin', `/usr/local/man', etc.  You can specify an
120installation prefix other than `/usr/local' by giving `configure' the
121option `--prefix=PATH'.
122
123   You can specify separate installation prefixes for
124architecture-specific files and architecture-independent files.  If you
125give `configure' the option `--exec-prefix=PATH', the package will use
126PATH as the prefix for installing programs and libraries.
127Documentation and other data files will still use the regular prefix.
128
129   In addition, if you use an unusual directory layout you can give
130options like `--bindir=PATH' to specify different values for particular
131kinds of files.  Run `configure --help' for a list of the directories
132you can set and what kinds of files go in them.
133
134   If the package supports it, you can cause programs to be installed
135with an extra prefix or suffix on their names by giving `configure' the
136option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
137
138Optional Features
139=================
140
141   Some packages pay attention to `--enable-FEATURE' options to
142`configure', where FEATURE indicates an optional part of the package.
143They may also pay attention to `--with-PACKAGE' options, where PACKAGE
144is something like `gnu-as' or `x' (for the X Window System).  The
145`README' should mention any `--enable-' and `--with-' options that the
146package recognizes.
147
148   For packages that use the X Window System, `configure' can usually
149find the X include and library files automatically, but if it doesn't,
150you can use the `configure' options `--x-includes=DIR' and
151`--x-libraries=DIR' to specify their locations.
152
153Specifying the System Type
154==========================
155
156   There may be some features `configure' cannot figure out
157automatically, but needs to determine by the type of machine the package
158will run on.  Usually, assuming the package is built to be run on the
159_same_ architectures, `configure' can figure that out, but if it prints
160a message saying it cannot guess the machine type, give it the
161`--build=TYPE' option.  TYPE can either be a short name for the system
162type, such as `sun4', or a canonical name which has the form:
163
164     CPU-COMPANY-SYSTEM
165
166where SYSTEM can have one of these forms:
167
168     OS KERNEL-OS
169
170   See the file `config.sub' for the possible values of each field.  If
171`config.sub' isn't included in this package, then this package doesn't
172need to know the machine type.
173
174   If you are _building_ compiler tools for cross-compiling, you should
175use the `--target=TYPE' option to select the type of system they will
176produce code for.
177
178   If you want to _use_ a cross compiler, that generates code for a
179platform different from the build platform, you should specify the
180"host" platform (i.e., that on which the generated programs will
181eventually be run) with `--host=TYPE'.
182
183Sharing Defaults
184================
185
186   If you want to set default values for `configure' scripts to share,
187you can create a site shell script called `config.site' that gives
188default values for variables like `CC', `cache_file', and `prefix'.
189`configure' looks for `PREFIX/share/config.site' if it exists, then
190`PREFIX/etc/config.site' if it exists.  Or, you can set the
191`CONFIG_SITE' environment variable to the location of the site script.
192A warning: not all `configure' scripts look for a site script.
193
194Defining Variables
195==================
196
197   Variables not defined in a site shell script can be set in the
198environment passed to `configure'.  However, some packages may run
199configure again during the build, and the customized values of these
200variables may be lost.  In order to avoid this problem, you should set
201them in the `configure' command line, using `VAR=value'.  For example:
202
203     ./configure CC=/usr/local2/bin/gcc
204
205will cause the specified gcc to be used as the C compiler (unless it is
206overridden in the site shell script).
207
208`configure' Invocation
209======================
210
211   `configure' recognizes the following options to control how it
212operates.
213
214`--help'
215`-h'
216     Print a summary of the options to `configure', and exit.
217
218`--version'
219`-V'
220     Print the version of Autoconf used to generate the `configure'
221     script, and exit.
222
223`--cache-file=FILE'
224     Enable the cache: use and save the results of the tests in FILE,
225     traditionally `config.cache'.  FILE defaults to `/dev/null' to
226     disable caching.
227
228`--config-cache'
229`-C'
230     Alias for `--cache-file=config.cache'.
231
232`--quiet'
233`--silent'
234`-q'
235     Do not print messages saying which checks are being made.  To
236     suppress all normal output, redirect it to `/dev/null' (any error
237     messages will still be shown).
238
239`--srcdir=DIR'
240     Look for the package's source code in directory DIR.  Usually
241     `configure' can determine that directory automatically.
242
243`configure' also accepts some other, not widely useful, options.  Run
244`configure --help' for more details.
245
Note: See TracBrowser for help on using the repository browser.