INSTALL

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