Dogcows Code - chaz/openbox/blob - INSTALL

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