SILC Runtime Toolkit 1.2 Beta 1
[runtime.git] / lib / doc / building.html
index 35745dac9e2dc1dee55e6789f2b34665e1bbd8d1..88c83b46f66b421ad0298d9704a46409928cbf10 100644 (file)
@@ -1,11 +1,11 @@
 <big><b>Building the Toolkit</b></big>
 
 <br />&nbsp;<br />
-SILC Toolkit works on various platforms, such as on several Unix systems and
-on Windows.  Building of the Toolkit on some platform may differ from the
-other.  This document describes how to build the Toolkit from the sources,
-to create linkable libraries and binaries, on all platforms the Toolkit
-support.
+SILC Runtime Toolkit works on various platforms, such as on several Unix 
+systems and on Windows.  Building of the Toolkit on some platform may 
+differ from the other.  This document describes how to build the Toolkit 
+from the sources, to create linkable libraries and binaries, on all 
+platforms the Toolkit support.
 
 <br />&nbsp;<br />
 The building instructions for all platforms are also included in the Toolkit
@@ -23,13 +23,8 @@ README.MACOSX for building on Mac OS X.
 <b><a name="unix"></a>Building on Unix & Linux</b>
 
 <br />&nbsp;<br />
-Building the Toolkit on Unix will produce binaries of all libraries, and
-SILC Client and SILC Server.  The Toolkit package includes also Client and
-Server as an example applications, and they are compiled automatically.
-The libraries are compiled to provide staticly linkable libraries.  Two
-libraries are produced: libsilc.a and libsilcclient.a.  The libsilc.a includes
-everything else except the Client library.  The libsilcclient.a includes
-only the Client library.
+On Unix systems both statically and dynamically linkable libraries are 
+built by default.
 
 <br />&nbsp;<br />
 To build Toolkit on Unix systems, give commands:
@@ -60,15 +55,6 @@ you can give this option to the `configure'.  It is recommended to use
 this option when you are doing development with Toolkit.  It is helpful
 to enable run-time debugging.
 
-<br />&nbsp;<br />
-<tt>--with-gmp[=DIR]</tt>
-
-<br />&nbsp;<br />
-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[=DIR] option to the `configure'. The DIR is the upper
-path in your system which contains lib/ and include/ for GMP library.
-
 <br />&nbsp;<br />
 <tt>--with-iconv[=DIR]</tt>
 
@@ -105,6 +91,17 @@ 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.
 
+<br />&nbsp;<br />
+<tt>--disable-cpu-optimizations</tt>
+
+<br />&nbsp;<br />
+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.
+
 <br />&nbsp;<br />
 After compilation you can install the Toolkit into your system by giving
 the command:
@@ -126,25 +123,10 @@ Toolkit package.
 <br />&nbsp;<br />
 The Toolkit package includes ready MSVC++ Workspace files, that will
 automatically compile the Toolkit.  The MSVC++ workspace and project files
-resides in the win32/ subdirectory of the Toolkit package.  The `silc.dsw'
+resides in the win32/ subdirectory of the Toolkit package.  The `srt.dsw'
 file is the workspace file that automatically supports compiling the Toolkit
-and to generate the SILC Core DLL and SILC Client DLL libraries.
-
-<br />&nbsp;<br />
-The SILC Core DLL is named as libsilc and will generate libsilc.dll, and
-the SILC Client DLL is named as libsilcclient and will generate
-libsilcclient.dll.  Both of the projects also automatically generates
-libsilc.lib and libsilcclient.lib import libraries that may be used to
-link against a client application.
-
-<br />&nbsp;<br />
-Generally you do not need to do any specific settings to compile the
-Toolkit.  However, you must compile the libsilc before compiling the
-libsilclient, since the SILC Client DLL depends on the SILC Core DLL.
-You may compile the DLLs as either Release or Debug version.  Just select
-the preferred method of compilation.  The Debug version will compile the
-SILC Toolkit with run-time debugging support, which is recommended when
-doing development with the Toolkit.
+and to generate the SILC Runtime DLL (libsrt.dll).  You may also compile 
+debug version by selecteing the Debug compilation method.
 
 <br />&nbsp;<br />&nbsp;<br />
 <b><a name="macosx"></a>Building on Mac OS X</b>
@@ -169,14 +151,10 @@ command:
 <tt>./configure --help</tt>
 
 <br />&nbsp;<br />
-If you do not want to compile the applications, or they do not compile on
-your system, you can also choose to compile only the libraries, and skip
-all applications.  In this case, before giving the "make" command, go
-to the lib/ subdirectory, and give "make" command there:
+To compile, give:
 
 <br />&nbsp;<br />
 <tt>
-cd lib/<br />
 make
 </tt>
 
@@ -206,16 +184,16 @@ CTags and the SDK.  Perl and the SDK are required, but CTags is
 optional and if necessary can be omitted.
 
 <br />&nbsp;<br />
-The SILC Toolkit is generic C and C++ code and should work with any
+The Toolkit is generic C and C++ code and should work with any
 SDK.  If you don't have SDK already installed, install the latest
 version you can find.  The links to SDKs are found in the Carbide.c++
 instructions after installation.  If you already have SDK in your
 system, you should use that.
 
 <br />&nbsp;<br />
-After installation import the SILC Toolkit project to Carbide.c++ from the
-symbian/ subdirectory in the SILC Toolkit package.
+After installation import the Toolkit project to Carbide.c++ from the
+symbian/ subdirectory in the Toolkit package.
 
 <br />&nbsp;<br />
-Please read the README.SYMBIAN from the SILC Toolkit package for complete
-building instructions.
+Please read the README.SYMBIAN from the SILC Runtime Toolkit package for 
+complete building instructions.