Merge commit 'origin/silc.1.1.branch'

[silc.git] / lib / doc / building.html

diff --git a/lib/doc/building.html b/lib/doc/building.html
index c0a7f64d4ca27f57f192584d7d9ebb30d1cbf6dd..35745dac9e2dc1dee55e6789f2b34665e1bbd8d1 100644 (file)
--- a/lib/doc/building.html
+++ b/lib/doc/building.html
@@ -1,7 +1,7 @@
 <big><b>Building the Toolkit</b></big>
 
 <br />&nbsp;<br />
-SILC Toolkit works on various platforms, such as on several Unix systems and 
+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
@@ -17,6 +17,7 @@ README.MACOSX for building on Mac OS X.
 <li><a href="#unix">Building on Unix & Linux</a><br />
 <li><a href="#windows">Building on Windows</a><br />
 <li><a href="#macosx">Building on Mac OS X</a>
+<li><a href="#symbian">Building on Symbian OS</a>
 
 <br />&nbsp;<br />&nbsp;<br />
 <b><a name="unix"></a>Building on Unix & Linux</b>
@@ -60,33 +61,42 @@ this option when you are doing development with Toolkit.  It is helpful
 to enable run-time debugging.
 
 <br />&nbsp;<br />
-<tt>--with-gmp=PATH</tt>
+<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=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.
 
 <br />&nbsp;<br />
-<tt>--disable-asm</tt>
+<tt>--with-iconv[=DIR]</tt>
 
 <br />&nbsp;<br />
-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.
+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).
 
 <br />&nbsp;<br />
-<tt>--disable-threads</tt>
+<tt>--without-pthreads</tt>
 
 <br />&nbsp;<br />
-If you do not want to compile the programs with multi threads support
-you can give --disable-threads option.  This will disable the SILC Thread
+If you do not want to compile the programs with POSIX multi-threads support
+you can give --without-pthreads option.  This will disable the SILC Thread
 API and SILC Mutex API.  Furthermore if SILC Thread API is used when this
 option is used, the routines work, but do not work in threads (are run
 in the calling process and can block the process).
 
+<br />&nbsp;<br />
+<tt>--disable-asm</tt>
+
+<br />&nbsp;<br />
+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.
+
 <br />&nbsp;<br />
 <tt>--enable-ipv6</tt>
 
@@ -114,7 +124,7 @@ MinGW.  For these systems please refer to the README.WIN32 file in the
 Toolkit package.
 
 <br />&nbsp;<br />
-The Toolkit package includes ready MSVC++ Workspace files, that will 
+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'
 file is the workspace file that automatically supports compiling the Toolkit
@@ -176,3 +186,36 @@ the command:
 
 <br />&nbsp;<br />
 <tt>make install</tt>
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="symbian"></a>Building on Symbian OS</b>
+
+<br />&nbsp;<br />
+The build environment for Symbian OS requires Carbide.c++ and MS Windows.
+
+<br />&nbsp;<br />
+Download the freely available Carbide.c++ from Nokia at
+<a href="http://forum.nokia.com">http://forum.nokia.com</a>.  The exact
+hyperlink location changes often, so it is not referenced here.  It is
+usually under "Tools and SDKs" link.
+
+<br />&nbsp;<br />
+After installation a web browser is opened automatically by the
+Carbide.c++ installer.  Follow its instructions by installing the Perl,
+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
+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.
+
+<br />&nbsp;<br />
+Please read the README.SYMBIAN from the SILC Toolkit package for complete
+building instructions.