Merge commit 'origin/silc.1.1.branch'

[silc.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 1236d92ec685606bdab9597241b2ba57852b15df..a6c12c0799ed300ab3ffda11b0aa68bcd350d49a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,18 +1,21 @@
 Quick Installation
 ==================
 
 Quick Installation
 ==================
 

-   To configure and compile SILC package give the comands:
+   To configure and compile SILC package give the commands:

 
        ./configure
 
        ./configure

-       make (or gmake, GNU make is required)
+       make (or gmake)

        make install
 
    This will install the SILC binaries and configuration files into the
 /usr/local/silc/ directory.  System wide configuration files are installed
 into the /etc/silc/ directory.
 
        make install
 
    This will install the SILC binaries and configuration files into the
 /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
 
    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


@@ -25,8 +28,11 @@ file for more generic installation instructions.
 library instead of using the MPI library included in the package, you can
 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.
 library instead of using the MPI library included in the package, you can
 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]'
+`--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),
 
    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),


@@ -46,6 +52,11 @@ 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.
 
 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
 `--enable-debug'
 
    If you would like to enable the debugging for the compiled programs