Merge commit 'origin/silc.1.1.branch'

[silc.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index ca34dbe7fbf0ea66d00df2eadb3c9d1e65dbf517..a6c12c0799ed300ab3ffda11b0aa68bcd350d49a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,7 +1,7 @@
 Quick Installation
 ==================
 
-   To configure and compile SILC package give the comands:
+   To configure and compile SILC package give the commands:
 
        ./configure
        make (or gmake)
@@ -11,20 +11,39 @@ Quick Installation
 /usr/local/silc/ directory.  System wide configuration files are installed
 into the /etc/silc/ directory.
 
-Some Configuration Options
-==========================
+You may need to add the /usr/local/silc path to your PATH environment
+variable after the installation.
+
+Configuration Options
+=====================
 
    You can give various options to the `configure' shell script.  You should
 give --help command to the `configure' to see all of them.  Here is listed
 few options that you might want to use.  Please refer to the rest of this
 file for more generic installation instructions.
 
-`--with-gmp=PATH'
+`--with-gmp[=DIR]'
 
    If you wish to use GMP library for arbitrary precision arithmetic
 library instead of using the MPI library included in the package, you can
-give the --with-gmp=PATH option to the `configure'.  The PATH is the path
-to the GMP library in your system.
+give the --with-gmp[=DIR] option to the `configure'.  The DIR is the upper
+path in your system which contains lib/ and include/ for GMP library.
+   Note that MPI is the prefered arbitrary precision arithmetic library and
+GMP can be used as a fall-back if you have problems with the MPI library
+included within this package.
+
+`--with-iconv[=DIR]'
+
+   If your system doesn't provide iconv() function in its native libraries
+(usually libc) or if this function is broken (e.g. older Solaris systems),
+you may want to use libiconv instead.  The DIR is the upper path in your
+system which contains lib/ and include/ for libiconv (e.g. /usr/local).
+
+`--without-pthreads'
+
+   If you do not want to compile the programs with POSIX multi-threads
+support you can give --without-pthreads option.  In this case all compiled
+programs will work in single thread only.
 
 `--disable-asm'
 
@@ -33,17 +52,16 @@ package or does not want to use them, you can give the --disable-asm
 option to the `configure' script.  This will assure that assembler
 optimized code is not compiled in.
 
+`--enabled-shared'
+
+   If you wish to compile and install shared libraries then enable this
+option.  By default all libraries are compiled as static libraries.
+
 `--enable-debug'
 
    If you would like to enable the debugging for the compiled programs
 you can give this option to the `configure'.
 
-`--disable-threads'
-
-   If you do not want to compile the programs with multi threads support
-you can give --disable-threads option.  In this case all compiled programs
-will work in single thread only.
-
 `--enable-ipv6'
 
    The `configure' will attempt to check for IPv6 support in your system.