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