Mac OS X >= 10.7 support

[runtime.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 41f338845e41ca71bcd81899d2de8ae6242e45bd..370c15318b400ceb3ce8d34d85d3d145231b57a0 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,15 +1,60 @@
 Quick Installation
 ==================
 
-To configure and compile SILC package give the comands:
+   To configure and compile SILC Runtime Toolkit give the commands:
 
        ./configure
        make
        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.
+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-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'
+
+   If you have trouble compiling the assembler optimized code in the
+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.
+
+`--enable-debug'
+
+   If you would like to enable the debugging for the compiled programs
+you can give this option to the `configure'.
+
+`--enable-ipv6'
+
+   The `configure' will attempt to check for IPv6 support in your system.
+However, if it fails, but you still want to compile in the IPv6 support
+you can give --enable-ipv6 option to force the IPv6 support.
+
+`--disable-cpu-optimizations'
+ 
+   By default the configure script will attempt to detect the type of your 
+CPU and enable any features specific to your CPU that could optimize the 
+performance of the Toolkit. If you are creating binary package that should 
+work on any CPU (and not only your CPU) you should diable these 
+optimizations. If you compile it for yourself only, keeping the 
+optimizations enabled is recommended.
+ 
 
 Basic Installation
 ==================