INSTALL

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