| 1 | Configuration from CVS | 
|---|
| 2 | ====================== | 
|---|
| 3 |  | 
|---|
| 4 | If you're using source checked out from CVS, rather than a source | 
|---|
| 5 | distribution tarball, please be aware that you can use ./autogen.sh in | 
|---|
| 6 | place of ./configure below. | 
|---|
| 7 |  | 
|---|
| 8 | Because this is a cross-platform project, the source templates for | 
|---|
| 9 | the autoconf scripts are sequestered in the 'makefiles' directory. | 
|---|
| 10 | Running './autogen.sh' will copy them into their conventional places at | 
|---|
| 11 | the lop level. If you already see the files there, you don't need to | 
|---|
| 12 | worry about this step. | 
|---|
| 13 |  | 
|---|
| 14 | Basic Installation | 
|---|
| 15 | ================== | 
|---|
| 16 |  | 
|---|
| 17 | These are generic installation instructions. | 
|---|
| 18 |  | 
|---|
| 19 | The `configure' shell script attempts to guess correct values for | 
|---|
| 20 | various system-dependent variables used during compilation.  It uses | 
|---|
| 21 | those values to create a `Makefile' in each directory of the package. | 
|---|
| 22 | It may also create one or more `.h' files containing system-dependent | 
|---|
| 23 | definitions.  Finally, it creates a shell script `config.status' that | 
|---|
| 24 | you can run in the future to recreate the current configuration, a file | 
|---|
| 25 | `config.cache' that saves the results of its tests to speed up | 
|---|
| 26 | reconfiguring, and a file `config.log' containing compiler output | 
|---|
| 27 | (useful mainly for debugging `configure'). | 
|---|
| 28 |  | 
|---|
| 29 | If you need to do unusual things to compile the package, please try | 
|---|
| 30 | to figure out how `configure' could check whether to do them, and mail | 
|---|
| 31 | diffs or instructions to the address given in the `README' so they can | 
|---|
| 32 | be considered for the next release.  If at some point `config.cache' | 
|---|
| 33 | contains results you don't want to keep, you may remove or edit it. | 
|---|
| 34 |  | 
|---|
| 35 | The file `configure.in' is used to create `configure' by a program | 
|---|
| 36 | called `autoconf'.  You only need `configure.in' if you want to change | 
|---|
| 37 | it or regenerate `configure' using a newer version of `autoconf'. | 
|---|
| 38 |  | 
|---|
| 39 | The simplest way to compile this package is: | 
|---|
| 40 |  | 
|---|
| 41 | 1. `cd' to the directory containing the package's source code and type | 
|---|
| 42 | `./configure' to configure the package for your system.  If you're | 
|---|
| 43 | using `csh' on an old version of System V, you might need to type | 
|---|
| 44 | `sh ./configure' instead to prevent `csh' from trying to execute | 
|---|
| 45 | `configure' itself. | 
|---|
| 46 |  | 
|---|
| 47 | Running `configure' takes awhile.  While running, it prints some | 
|---|
| 48 | messages telling which features it is checking for. | 
|---|
| 49 |  | 
|---|
| 50 | 2. Type `make' to compile the package. | 
|---|
| 51 |  | 
|---|
| 52 | 3. Optionally, type `make check' to run any self-tests that come with | 
|---|
| 53 | the package. | 
|---|
| 54 |  | 
|---|
| 55 | 4. Type `make install' to install the programs and any data files and | 
|---|
| 56 | documentation. | 
|---|
| 57 |  | 
|---|
| 58 | 5. You can remove the program binaries and object files from the | 
|---|
| 59 | source code directory by typing `make clean'.  To also remove the | 
|---|
| 60 | files that `configure' created (so you can compile the package for | 
|---|
| 61 | a different kind of computer), type `make distclean'.  There is | 
|---|
| 62 | also a `make maintainer-clean' target, but that is intended mainly | 
|---|
| 63 | for the package's developers.  If you use it, you may have to get | 
|---|
| 64 | all sorts of other programs in order to regenerate files that came | 
|---|
| 65 | with the distribution. | 
|---|
| 66 |  | 
|---|
| 67 | Compilers and Options | 
|---|
| 68 | ===================== | 
|---|
| 69 |  | 
|---|
| 70 | Some systems require unusual options for compilation or linking that | 
|---|
| 71 | the `configure' script does not know about.  You can give `configure' | 
|---|
| 72 | initial values for variables by setting them in the environment.  Using | 
|---|
| 73 | a Bourne-compatible shell, you can do that on the command line like | 
|---|
| 74 | this: | 
|---|
| 75 | CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure | 
|---|
| 76 |  | 
|---|
| 77 | Or on systems that have the `env' program, you can do it like this: | 
|---|
| 78 | env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure | 
|---|
| 79 |  | 
|---|
| 80 | Compiling For Multiple Architectures | 
|---|
| 81 | ==================================== | 
|---|
| 82 |  | 
|---|
| 83 | You can compile the package for more than one kind of computer at the | 
|---|
| 84 | same time, by placing the object files for each architecture in their | 
|---|
| 85 | own directory.  To do this, you must use a version of `make' that | 
|---|
| 86 | supports the `VPATH' variable, such as GNU `make'.  `cd' to the | 
|---|
| 87 | directory where you want the object files and executables to go and run | 
|---|
| 88 | the `configure' script.  `configure' automatically checks for the | 
|---|
| 89 | source code in the directory that `configure' is in and in `..'. | 
|---|
| 90 |  | 
|---|
| 91 | If you have to use a `make' that does not supports the `VPATH' | 
|---|
| 92 | variable, you have to compile the package for one architecture at a time | 
|---|
| 93 | in the source code directory.  After you have installed the package for | 
|---|
| 94 | one architecture, use `make distclean' before reconfiguring for another | 
|---|
| 95 | architecture. | 
|---|
| 96 |  | 
|---|
| 97 | Installation Names | 
|---|
| 98 | ================== | 
|---|
| 99 |  | 
|---|
| 100 | By default, `make install' will install the package's files in | 
|---|
| 101 | `/usr/local/bin', `/usr/local/man', etc.  You can specify an | 
|---|
| 102 | installation prefix other than `/usr/local' by giving `configure' the | 
|---|
| 103 | option `--prefix=PATH'. | 
|---|
| 104 |  | 
|---|
| 105 | You can specify separate installation prefixes for | 
|---|
| 106 | architecture-specific files and architecture-independent files.  If you | 
|---|
| 107 | give `configure' the option `--exec-prefix=PATH', the package will use | 
|---|
| 108 | PATH as the prefix for installing programs and libraries. | 
|---|
| 109 | Documentation and other data files will still use the regular prefix. | 
|---|
| 110 |  | 
|---|
| 111 | In addition, if you use an unusual directory layout you can give | 
|---|
| 112 | options like `--bindir=PATH' to specify different values for particular | 
|---|
| 113 | kinds of files.  Run `configure --help' for a list of the directories | 
|---|
| 114 | you can set and what kinds of files go in them. | 
|---|
| 115 |  | 
|---|
| 116 | If the package supports it, you can cause programs to be installed | 
|---|
| 117 | with an extra prefix or suffix on their names by giving `configure' the | 
|---|
| 118 | option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. | 
|---|
| 119 |  | 
|---|
| 120 | Optional Features | 
|---|
| 121 | ================= | 
|---|
| 122 |  | 
|---|
| 123 | Some packages pay attention to `--enable-FEATURE' options to | 
|---|
| 124 | `configure', where FEATURE indicates an optional part of the package. | 
|---|
| 125 | They may also pay attention to `--with-PACKAGE' options, where PACKAGE | 
|---|
| 126 | is something like `gnu-as' or `x' (for the X Window System).  The | 
|---|
| 127 | `README' should mention any `--enable-' and `--with-' options that the | 
|---|
| 128 | package recognizes. | 
|---|
| 129 |  | 
|---|
| 130 | For packages that use the X Window System, `configure' can usually | 
|---|
| 131 | find the X include and library files automatically, but if it doesn't, | 
|---|
| 132 | you can use the `configure' options `--x-includes=DIR' and | 
|---|
| 133 | `--x-libraries=DIR' to specify their locations. | 
|---|
| 134 |  | 
|---|
| 135 | Specifying the System Type | 
|---|
| 136 | ========================== | 
|---|
| 137 |  | 
|---|
| 138 | There may be some features `configure' can not figure out | 
|---|
| 139 | automatically, but needs to determine by the type of host the package | 
|---|
| 140 | will run on.  Usually `configure' can figure that out, but if it prints | 
|---|
| 141 | a message saying it can not guess the host type, give it the | 
|---|
| 142 | `--host=TYPE' option.  TYPE can either be a short name for the system | 
|---|
| 143 | type, such as `sun4', or a canonical name with three fields: | 
|---|
| 144 | CPU-COMPANY-SYSTEM | 
|---|
| 145 |  | 
|---|
| 146 | See the file `config.sub' for the possible values of each field.  If | 
|---|
| 147 | `config.sub' isn't included in this package, then this package doesn't | 
|---|
| 148 | need to know the host type. | 
|---|
| 149 |  | 
|---|
| 150 | If you are building compiler tools for cross-compiling, you can also | 
|---|
| 151 | use the `--target=TYPE' option to select the type of system they will | 
|---|
| 152 | produce code for and the `--build=TYPE' option to select the type of | 
|---|
| 153 | system on which you are compiling the package. | 
|---|
| 154 |  | 
|---|
| 155 | Sharing Defaults | 
|---|
| 156 | ================ | 
|---|
| 157 |  | 
|---|
| 158 | If you want to set default values for `configure' scripts to share, | 
|---|
| 159 | you can create a site shell script called `config.site' that gives | 
|---|
| 160 | default values for variables like `CC', `cache_file', and `prefix'. | 
|---|
| 161 | `configure' looks for `PREFIX/share/config.site' if it exists, then | 
|---|
| 162 | `PREFIX/etc/config.site' if it exists.  Or, you can set the | 
|---|
| 163 | `CONFIG_SITE' environment variable to the location of the site script. | 
|---|
| 164 | A warning: not all `configure' scripts look for a site script. | 
|---|
| 165 |  | 
|---|
| 166 | Operation Controls | 
|---|
| 167 | ================== | 
|---|
| 168 |  | 
|---|
| 169 | `configure' recognizes the following options to control how it | 
|---|
| 170 | operates. | 
|---|
| 171 |  | 
|---|
| 172 | `--cache-file=FILE' | 
|---|
| 173 | Use and save the results of the tests in FILE instead of | 
|---|
| 174 | `./config.cache'.  Set FILE to `/dev/null' to disable caching, for | 
|---|
| 175 | debugging `configure'. | 
|---|
| 176 |  | 
|---|
| 177 | `--help' | 
|---|
| 178 | Print a summary of the options to `configure', and exit. | 
|---|
| 179 |  | 
|---|
| 180 | `--quiet' | 
|---|
| 181 | `--silent' | 
|---|
| 182 | `-q' | 
|---|
| 183 | Do not print messages saying which checks are being made.  To | 
|---|
| 184 | suppress all normal output, redirect it to `/dev/null' (any error | 
|---|
| 185 | messages will still be shown). | 
|---|
| 186 |  | 
|---|
| 187 | `--srcdir=DIR' | 
|---|
| 188 | Look for the package's source code in directory DIR.  Usually | 
|---|
| 189 | `configure' can determine that directory automatically. | 
|---|
| 190 |  | 
|---|
| 191 | `--version' | 
|---|
| 192 | Print the version of Autoconf used to generate the `configure' | 
|---|
| 193 | script, and exit. | 
|---|
| 194 |  | 
|---|
| 195 | `configure' also accepts some other, not widely useful, options. | 
|---|