1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/toolkit/crashreporter/google-breakpad/INSTALL Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,234 @@ 1.4 +Installation Instructions 1.5 +************************* 1.6 + 1.7 +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 1.8 +2006 Free Software Foundation, Inc. 1.9 + 1.10 +This file is free documentation; the Free Software Foundation gives 1.11 +unlimited permission to copy, distribute and modify it. 1.12 + 1.13 +Basic Installation 1.14 +================== 1.15 + 1.16 +Briefly, the shell commands `./configure; make; make install' should 1.17 +configure, build, and install this package. The following 1.18 +more-detailed instructions are generic; see the `README' file for 1.19 +instructions specific to this package. 1.20 + 1.21 + The `configure' shell script attempts to guess correct values for 1.22 +various system-dependent variables used during compilation. It uses 1.23 +those values to create a `Makefile' in each directory of the package. 1.24 +It may also create one or more `.h' files containing system-dependent 1.25 +definitions. Finally, it creates a shell script `config.status' that 1.26 +you can run in the future to recreate the current configuration, and a 1.27 +file `config.log' containing compiler output (useful mainly for 1.28 +debugging `configure'). 1.29 + 1.30 + It can also use an optional file (typically called `config.cache' 1.31 +and enabled with `--cache-file=config.cache' or simply `-C') that saves 1.32 +the results of its tests to speed up reconfiguring. Caching is 1.33 +disabled by default to prevent problems with accidental use of stale 1.34 +cache files. 1.35 + 1.36 + If you need to do unusual things to compile the package, please try 1.37 +to figure out how `configure' could check whether to do them, and mail 1.38 +diffs or instructions to the address given in the `README' so they can 1.39 +be considered for the next release. If you are using the cache, and at 1.40 +some point `config.cache' contains results you don't want to keep, you 1.41 +may remove or edit it. 1.42 + 1.43 + The file `configure.ac' (or `configure.in') is used to create 1.44 +`configure' by a program called `autoconf'. You need `configure.ac' if 1.45 +you want to change it or regenerate `configure' using a newer version 1.46 +of `autoconf'. 1.47 + 1.48 +The simplest way to compile this package is: 1.49 + 1.50 + 1. `cd' to the directory containing the package's source code and type 1.51 + `./configure' to configure the package for your system. 1.52 + 1.53 + Running `configure' might take a while. While running, it prints 1.54 + some messages telling which features it is checking for. 1.55 + 1.56 + 2. Type `make' to compile the package. 1.57 + 1.58 + 3. Optionally, type `make check' to run any self-tests that come with 1.59 + the package. 1.60 + 1.61 + 4. Type `make install' to install the programs and any data files and 1.62 + documentation. 1.63 + 1.64 + 5. You can remove the program binaries and object files from the 1.65 + source code directory by typing `make clean'. To also remove the 1.66 + files that `configure' created (so you can compile the package for 1.67 + a different kind of computer), type `make distclean'. There is 1.68 + also a `make maintainer-clean' target, but that is intended mainly 1.69 + for the package's developers. If you use it, you may have to get 1.70 + all sorts of other programs in order to regenerate files that came 1.71 + with the distribution. 1.72 + 1.73 +Compilers and Options 1.74 +===================== 1.75 + 1.76 +Some systems require unusual options for compilation or linking that the 1.77 +`configure' script does not know about. Run `./configure --help' for 1.78 +details on some of the pertinent environment variables. 1.79 + 1.80 + You can give `configure' initial values for configuration parameters 1.81 +by setting variables in the command line or in the environment. Here 1.82 +is an example: 1.83 + 1.84 + ./configure CC=c99 CFLAGS=-g LIBS=-lposix 1.85 + 1.86 + *Note Defining Variables::, for more details. 1.87 + 1.88 +Compiling For Multiple Architectures 1.89 +==================================== 1.90 + 1.91 +You can compile the package for more than one kind of computer at the 1.92 +same time, by placing the object files for each architecture in their 1.93 +own directory. To do this, you can use GNU `make'. `cd' to the 1.94 +directory where you want the object files and executables to go and run 1.95 +the `configure' script. `configure' automatically checks for the 1.96 +source code in the directory that `configure' is in and in `..'. 1.97 + 1.98 + With a non-GNU `make', it is safer to compile the package for one 1.99 +architecture at a time in the source code directory. After you have 1.100 +installed the package for one architecture, use `make distclean' before 1.101 +reconfiguring for another architecture. 1.102 + 1.103 +Installation Names 1.104 +================== 1.105 + 1.106 +By default, `make install' installs the package's commands under 1.107 +`/usr/local/bin', include files under `/usr/local/include', etc. You 1.108 +can specify an installation prefix other than `/usr/local' by giving 1.109 +`configure' the option `--prefix=PREFIX'. 1.110 + 1.111 + You can specify separate installation prefixes for 1.112 +architecture-specific files and architecture-independent files. If you 1.113 +pass the option `--exec-prefix=PREFIX' to `configure', the package uses 1.114 +PREFIX as the prefix for installing programs and libraries. 1.115 +Documentation and other data files still use the regular prefix. 1.116 + 1.117 + In addition, if you use an unusual directory layout you can give 1.118 +options like `--bindir=DIR' to specify different values for particular 1.119 +kinds of files. Run `configure --help' for a list of the directories 1.120 +you can set and what kinds of files go in them. 1.121 + 1.122 + If the package supports it, you can cause programs to be installed 1.123 +with an extra prefix or suffix on their names by giving `configure' the 1.124 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 1.125 + 1.126 +Optional Features 1.127 +================= 1.128 + 1.129 +Some packages pay attention to `--enable-FEATURE' options to 1.130 +`configure', where FEATURE indicates an optional part of the package. 1.131 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE 1.132 +is something like `gnu-as' or `x' (for the X Window System). The 1.133 +`README' should mention any `--enable-' and `--with-' options that the 1.134 +package recognizes. 1.135 + 1.136 + For packages that use the X Window System, `configure' can usually 1.137 +find the X include and library files automatically, but if it doesn't, 1.138 +you can use the `configure' options `--x-includes=DIR' and 1.139 +`--x-libraries=DIR' to specify their locations. 1.140 + 1.141 +Specifying the System Type 1.142 +========================== 1.143 + 1.144 +There may be some features `configure' cannot figure out automatically, 1.145 +but needs to determine by the type of machine the package will run on. 1.146 +Usually, assuming the package is built to be run on the _same_ 1.147 +architectures, `configure' can figure that out, but if it prints a 1.148 +message saying it cannot guess the machine type, give it the 1.149 +`--build=TYPE' option. TYPE can either be a short name for the system 1.150 +type, such as `sun4', or a canonical name which has the form: 1.151 + 1.152 + CPU-COMPANY-SYSTEM 1.153 + 1.154 +where SYSTEM can have one of these forms: 1.155 + 1.156 + OS KERNEL-OS 1.157 + 1.158 + See the file `config.sub' for the possible values of each field. If 1.159 +`config.sub' isn't included in this package, then this package doesn't 1.160 +need to know the machine type. 1.161 + 1.162 + If you are _building_ compiler tools for cross-compiling, you should 1.163 +use the option `--target=TYPE' to select the type of system they will 1.164 +produce code for. 1.165 + 1.166 + If you want to _use_ a cross compiler, that generates code for a 1.167 +platform different from the build platform, you should specify the 1.168 +"host" platform (i.e., that on which the generated programs will 1.169 +eventually be run) with `--host=TYPE'. 1.170 + 1.171 +Sharing Defaults 1.172 +================ 1.173 + 1.174 +If you want to set default values for `configure' scripts to share, you 1.175 +can create a site shell script called `config.site' that gives default 1.176 +values for variables like `CC', `cache_file', and `prefix'. 1.177 +`configure' looks for `PREFIX/share/config.site' if it exists, then 1.178 +`PREFIX/etc/config.site' if it exists. Or, you can set the 1.179 +`CONFIG_SITE' environment variable to the location of the site script. 1.180 +A warning: not all `configure' scripts look for a site script. 1.181 + 1.182 +Defining Variables 1.183 +================== 1.184 + 1.185 +Variables not defined in a site shell script can be set in the 1.186 +environment passed to `configure'. However, some packages may run 1.187 +configure again during the build, and the customized values of these 1.188 +variables may be lost. In order to avoid this problem, you should set 1.189 +them in the `configure' command line, using `VAR=value'. For example: 1.190 + 1.191 + ./configure CC=/usr/local2/bin/gcc 1.192 + 1.193 +causes the specified `gcc' to be used as the C compiler (unless it is 1.194 +overridden in the site shell script). 1.195 + 1.196 +Unfortunately, this technique does not work for `CONFIG_SHELL' due to 1.197 +an Autoconf bug. Until the bug is fixed you can use this workaround: 1.198 + 1.199 + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash 1.200 + 1.201 +`configure' Invocation 1.202 +====================== 1.203 + 1.204 +`configure' recognizes the following options to control how it operates. 1.205 + 1.206 +`--help' 1.207 +`-h' 1.208 + Print a summary of the options to `configure', and exit. 1.209 + 1.210 +`--version' 1.211 +`-V' 1.212 + Print the version of Autoconf used to generate the `configure' 1.213 + script, and exit. 1.214 + 1.215 +`--cache-file=FILE' 1.216 + Enable the cache: use and save the results of the tests in FILE, 1.217 + traditionally `config.cache'. FILE defaults to `/dev/null' to 1.218 + disable caching. 1.219 + 1.220 +`--config-cache' 1.221 +`-C' 1.222 + Alias for `--cache-file=config.cache'. 1.223 + 1.224 +`--quiet' 1.225 +`--silent' 1.226 +`-q' 1.227 + Do not print messages saying which checks are being made. To 1.228 + suppress all normal output, redirect it to `/dev/null' (any error 1.229 + messages will still be shown). 1.230 + 1.231 +`--srcdir=DIR' 1.232 + Look for the package's source code in directory DIR. Usually 1.233 + `configure' can determine that directory automatically. 1.234 + 1.235 +`configure' also accepts some other, not widely useful, options. Run 1.236 +`configure --help' for more details. 1.237 +