INSTALL

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