INSTALL

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