INSTALL

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