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