Main Page | Modules | Data Structures | File List | Globals | Related Pages

Installation

INSTALL

Basic Installation ================== These are generic installation instructions. The `configure' shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses those values to create a `Makefile' in each directory of the package. It may also create one or more `.h' files containing system-dependent definitions. Finally, it creates a shell script `config.status' that you can run in the future to recreate the current configuration, a file `config.cache' that saves the results of its tests to speed up reconfiguring, and a file `config.log' containing compiler output (useful mainly for debugging `configure'). If you need to do unusual things to compile the package, please try to figure out how `configure' could check whether to do them, and mail diffs or instructions to the address given in the `README' so they can be considered for the next release. If at some point `config.cache' contains results you don't want to keep, you may remove or edit it. The file `configure.in' is used to create `configure' by a program called `autoconf'. You only need `configure.in' if you want to change it or regenerate `configure' using a newer version of `autoconf'. The simplest way to compile this package is: 1. `cd' to the directory containing the package's source code and type `./configure' to configure the package for your system. If you're using `csh' on an old version of System V, you might need to type `sh ./configure' instead to prevent `csh' from trying to execute `configure' itself. Running `configure' takes awhile. While running, it prints some messages telling which features it is checking for. 2. Type `make' to compile the package. 3. Optionally, type `make check' to run any self-tests that come with the package. 4. Type `make install' to install the programs and any data files and documentation. 5. You can remove the program binaries and object files from the source code directory by typing `make clean'. To also remove the files that `configure' created (so you can compile the package for a different kind of computer), type `make distclean'. There is also a `make maintainer-clean' target, but that is intended mainly for the package's developers. If you use it, you may have to get all sorts of other programs in order to regenerate files that came with the distribution. Compilers and Options ===================== Some systems require unusual options for compilation or linking that the `configure' script does not know about. You can give `configure' initial values for variables by setting them in the environment. Using a Bourne-compatible shell, you can do that on the command line like this: CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure Or on systems that have the `env' program, you can do it like this: env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure Compiling For Multiple Architectures ==================================== You can compile the package for more than one kind of computer at the same time, by placing the object files for each architecture in their own directory. To do this, you must use a version of `make' that supports the `VPATH' variable, such as GNU `make'. `cd' to the directory where you want the object files and executables to go and run the `configure' script. `configure' automatically checks for the source code in the directory that `configure' is in and in `..'. If you have to use a `make' that does not supports the `VPATH' variable, you have to compile the package for one architecture at a time in the source code directory. After you have installed the package for one architecture, use `make distclean' before reconfiguring for another architecture. Installation Names ================== By default, `make install' will install the package's files in `/usr/local/bin', `/usr/local/man', etc. You can specify an installation prefix other than `/usr/local' by giving `configure' the option `--prefix=PATH'. You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you give `configure' the option `--exec-prefix=PATH', the package will use PATH as the prefix for installing programs and libraries. Documentation and other data files will still use the regular prefix. In addition, if you use an unusual directory layout you can give options like `--bindir=PATH' to specify different values for particular kinds of files. Run `configure --help' for a list of the directories you can set and what kinds of files go in them. If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving `configure' the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. Optional Features ================= Some packages pay attention to `--enable-FEATURE' options to `configure', where FEATURE indicates an optional part of the package. They may also pay attention to `--with-PACKAGE' options, where PACKAGE is something like `gnu-as' or `x' (for the X Window System). The `README' should mention any `--enable-' and `--with-' options that the package recognizes. For packages that use the X Window System, `configure' can usually find the X include and library files automatically, but if it doesn't, you can use the `configure' options `--x-includes=DIR' and `--x-libraries=DIR' to specify their locations. Specifying the System Type ========================== There may be some features `configure' can not figure out automatically, but needs to determine by the type of host the package will run on. Usually `configure' can figure that out, but if it prints a message saying it can not guess the host type, give it the `--host=TYPE' option. TYPE can either be a short name for the system type, such as `sun4', or a canonical name with three fields: CPU-COMPANY-SYSTEM See the file `config.sub' for the possible values of each field. If `config.sub' isn't included in this package, then this package doesn't need to know the host type. If you are building compiler tools for cross-compiling, you can also use the `--target=TYPE' option to select the type of system they will produce code for and the `--build=TYPE' option to select the type of system on which you are compiling the package. Sharing Defaults ================ If you want to set default values for `configure' scripts to share, you can create a site shell script called `config.site' that gives default values for variables like `CC', `cache_file', and `prefix'. `configure' looks for `PREFIX/share/config.site' if it exists, then `PREFIX/etc/config.site' if it exists. Or, you can set the `CONFIG_SITE' environment variable to the location of the site script. A warning: not all `configure' scripts look for a site script. Operation Controls ================== `configure' recognizes the following options to control how it operates. `--cache-file=FILE' Use and save the results of the tests in FILE instead of `./config.cache'. Set FILE to `/dev/null' to disable caching, for debugging `configure'. `--help' Print a summary of the options to `configure', and exit. `--quiet' `--silent' `-q' Do not print messages saying which checks are being made. To suppress all normal output, redirect it to `/dev/null' (any error messages will still be shown). `--srcdir=DIR' Look for the package's source code in directory DIR. Usually `configure' can determine that directory automatically. `--version' Print the version of Autoconf used to generate the `configure' script, and exit. `configure' also accepts some other, not widely useful, options.
00001 Basic Installation 00002 ================== 00003 00004 These are generic installation instructions. 00005 00006 The `configure' shell script attempts to guess correct values for 00007 various system-dependent variables used during compilation. It uses 00008 those values to create a `Makefile' in each directory of the package. 00009 It may also create one or more `.h' files containing system-dependent 00010 definitions. Finally, it creates a shell script `config.status' that 00011 you can run in the future to recreate the current configuration, a file 00012 `config.cache' that saves the results of its tests to speed up 00013 reconfiguring, and a file `config.log' containing compiler output 00014 (useful mainly for debugging `configure'). 00015 00016 If you need to do unusual things to compile the package, please try 00017 to figure out how `configure' could check whether to do them, and mail 00018 diffs or instructions to the address given in the `README' so they can 00019 be considered for the next release. If at some point `config.cache' 00020 contains results you don't want to keep, you may remove or edit it. 00021 00022 The file `configure.in' is used to create `configure' by a program 00023 called `autoconf'. You only need `configure.in' if you want to change 00024 it or regenerate `configure' using a newer version of `autoconf'. 00025 00026 The simplest way to compile this package is: 00027 00028 1. `cd' to the directory containing the package's source code and type 00029 `./configure' to configure the package for your system. If you're 00030 using `csh' on an old version of System V, you might need to type 00031 `sh ./configure' instead to prevent `csh' from trying to execute 00032 `configure' itself. 00033 00034 Running `configure' takes awhile. While running, it prints some 00035 messages telling which features it is checking for. 00036 00037 2. Type `make' to compile the package. 00038 00039 3. Optionally, type `make check' to run any self-tests that come with 00040 the package. 00041 00042 4. Type `make install' to install the programs and any data files and 00043 documentation. 00044 00045 5. You can remove the program binaries and object files from the 00046 source code directory by typing `make clean'. To also remove the 00047 files that `configure' created (so you can compile the package for 00048 a different kind of computer), type `make distclean'. There is 00049 also a `make maintainer-clean' target, but that is intended mainly 00050 for the package's developers. If you use it, you may have to get 00051 all sorts of other programs in order to regenerate files that came 00052 with the distribution. 00053 00054 Compilers and Options 00055 ===================== 00056 00057 Some systems require unusual options for compilation or linking that 00058 the `configure' script does not know about. You can give `configure' 00059 initial values for variables by setting them in the environment. Using 00060 a Bourne-compatible shell, you can do that on the command line like 00061 this: 00062 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 00063 00064 Or on systems that have the `env' program, you can do it like this: 00065 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 00066 00067 Compiling For Multiple Architectures 00068 ==================================== 00069 00070 You can compile the package for more than one kind of computer at the 00071 same time, by placing the object files for each architecture in their 00072 own directory. To do this, you must use a version of `make' that 00073 supports the `VPATH' variable, such as GNU `make'. `cd' to the 00074 directory where you want the object files and executables to go and run 00075 the `configure' script. `configure' automatically checks for the 00076 source code in the directory that `configure' is in and in `..'. 00077 00078 If you have to use a `make' that does not supports the `VPATH' 00079 variable, you have to compile the package for one architecture at a time 00080 in the source code directory. After you have installed the package for 00081 one architecture, use `make distclean' before reconfiguring for another 00082 architecture. 00083 00084 Installation Names 00085 ================== 00086 00087 By default, `make install' will install the package's files in 00088 `/usr/local/bin', `/usr/local/man', etc. You can specify an 00089 installation prefix other than `/usr/local' by giving `configure' the 00090 option `--prefix=PATH'. 00091 00092 You can specify separate installation prefixes for 00093 architecture-specific files and architecture-independent files. If you 00094 give `configure' the option `--exec-prefix=PATH', the package will use 00095 PATH as the prefix for installing programs and libraries. 00096 Documentation and other data files will still use the regular prefix. 00097 00098 In addition, if you use an unusual directory layout you can give 00099 options like `--bindir=PATH' to specify different values for particular 00100 kinds of files. Run `configure --help' for a list of the directories 00101 you can set and what kinds of files go in them. 00102 00103 If the package supports it, you can cause programs to be installed 00104 with an extra prefix or suffix on their names by giving `configure' the 00105 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 00106 00107 Optional Features 00108 ================= 00109 00110 Some packages pay attention to `--enable-FEATURE' options to 00111 `configure', where FEATURE indicates an optional part of the package. 00112 They may also pay attention to `--with-PACKAGE' options, where PACKAGE 00113 is something like `gnu-as' or `x' (for the X Window System). The 00114 `README' should mention any `--enable-' and `--with-' options that the 00115 package recognizes. 00116 00117 For packages that use the X Window System, `configure' can usually 00118 find the X include and library files automatically, but if it doesn't, 00119 you can use the `configure' options `--x-includes=DIR' and 00120 `--x-libraries=DIR' to specify their locations. 00121 00122 Specifying the System Type 00123 ========================== 00124 00125 There may be some features `configure' can not figure out 00126 automatically, but needs to determine by the type of host the package 00127 will run on. Usually `configure' can figure that out, but if it prints 00128 a message saying it can not guess the host type, give it the 00129 `--host=TYPE' option. TYPE can either be a short name for the system 00130 type, such as `sun4', or a canonical name with three fields: 00131 CPU-COMPANY-SYSTEM 00132 00133 See the file `config.sub' for the possible values of each field. If 00134 `config.sub' isn't included in this package, then this package doesn't 00135 need to know the host type. 00136 00137 If you are building compiler tools for cross-compiling, you can also 00138 use the `--target=TYPE' option to select the type of system they will 00139 produce code for and the `--build=TYPE' option to select the type of 00140 system on which you are compiling the package. 00141 00142 Sharing Defaults 00143 ================ 00144 00145 If you want to set default values for `configure' scripts to share, 00146 you can create a site shell script called `config.site' that gives 00147 default values for variables like `CC', `cache_file', and `prefix'. 00148 `configure' looks for `PREFIX/share/config.site' if it exists, then 00149 `PREFIX/etc/config.site' if it exists. Or, you can set the 00150 `CONFIG_SITE' environment variable to the location of the site script. 00151 A warning: not all `configure' scripts look for a site script. 00152 00153 Operation Controls 00154 ================== 00155 00156 `configure' recognizes the following options to control how it 00157 operates. 00158 00159 `--cache-file=FILE' 00160 Use and save the results of the tests in FILE instead of 00161 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 00162 debugging `configure'. 00163 00164 `--help' 00165 Print a summary of the options to `configure', and exit. 00166 00167 `--quiet' 00168 `--silent' 00169 `-q' 00170 Do not print messages saying which checks are being made. To 00171 suppress all normal output, redirect it to `/dev/null' (any error 00172 messages will still be shown). 00173 00174 `--srcdir=DIR' 00175 Look for the package's source code in directory DIR. Usually 00176 `configure' can determine that directory automatically. 00177 00178 `--version' 00179 Print the version of Autoconf used to generate the `configure' 00180 script, and exit. 00181 00182 `configure' also accepts some other, not widely useful, options.


Generated on Wed Jul 28 15:36:09 2004 for libannodex by doxygen 1.3.7