<big><b>Building the Toolkit</b></big>
<br /> <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 /> <br />
The building instructions for all platforms are also included in the Toolkit
<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 /> <br /> <br />
<b><a name="unix"></a>Building on Unix & Linux</b>
<br /> <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 /> <br />
To build Toolkit on Unix systems, give commands:
to enable run-time debugging.
<br /> <br />
-<tt>--with-gmp=PATH</tt>
+<tt>--with-iconv[=DIR]</tt>
<br /> <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.
+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 /> <br />
-<tt>--without-irssi</tt><br />
-<tt>--without-silcd</tt>
+<tt>--without-pthreads</tt>
<br /> <br />
-By default the SILC Toolkit will also build the Irssi SILC client and
-the SILC Server which use the SILC Toolkit as well. If you do not
-wish to compile these applications you can give --without-irssi to
-not compile Irssi SILC client (irssi/ directory) and/or --without-silcd
-to not compile SILC Server (silcd/ directory). Other applications
-the Toolkit does not build automatically.
+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 /> <br />
<tt>--disable-asm</tt>
option to the `configure' script. This will assure that assembler
optimized code is not compiled in.
-<br /> <br />
-<tt>--disable-threads</tt>
-
-<br /> <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
-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 /> <br />
<tt>--enable-ipv6</tt>
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 /> <br />
+<tt>--disable-cpu-optimizations</tt>
+
+<br /> <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 /> <br />
After compilation you can install the Toolkit into your system by giving
the command:
Toolkit package.
<br /> <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'
+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 /> <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 /> <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 /> <br /> <br />
<b><a name="macosx"></a>Building on Mac OS X</b>
<tt>./configure --help</tt>
<br /> <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 /> <br />
<tt>
-cd lib/<br />
make
</tt>
<br /> <br />
<tt>make install</tt>
+
+<br /> <br /> <br />
+<b><a name="symbian"></a>Building on Symbian OS</b>
+
+<br /> <br />
+The build environment for Symbian OS requires Carbide.c++ and MS Windows.
+
+<br /> <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 /> <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 /> <br />
+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 /> <br />
+After installation import the Toolkit project to Carbide.c++ from the
+symbian/ subdirectory in the Toolkit package.
+
+<br /> <br />
+Please read the README.SYMBIAN from the SILC Runtime Toolkit package for
+complete building instructions.
projects / runtime.git / blobdiff