updates

diff --git a/TODO b/TODO
index 1d5f3a69a4ed8b2250c102941de176f167e1489e..826dd824547b6ef303fcd25b847a76e683b1b1fb 100644 (file)
--- a/TODO
+++ b/TODO
@@ -41,9 +41,5 @@ Manual (Do these to 0.9.x).
    example), and how external projects can use Toolkit without gluing into
    it (how to link etc), debugging, architecture, types, etc.
 
- o Write "Platform Implementations" document to describe what platforms
-   Toolkit support, what has been implemented, what has not been, what
-   works differently etc.
-
  o Searching of predefined keywords, exact and partial matches (would be 
    nice).

diff --git a/lib/doc/LIBINDEX b/lib/doc/LIBINDEX
index 59524bfbc86b68710506151684783d1a9d4bcb0f..7dd0302de48742fe31516605acf9fd88c2a4da41 100644 (file)
--- a/lib/doc/LIBINDEX
+++ b/lib/doc/LIBINDEX
@@ -28,6 +28,13 @@ of the Toolkit always delivers the latest version of this reference manual.
 <li><a href="intro_reference.html">Introduction to the Manual</a><br />
 <li><a href="programming_conv.html">Programming Conventions</a><br />
 <li><a href="building.html">Building the Toolkit</a>
+<li><a href="platforms.html">Platform Implementations</a>
+
+<br /><br />
+<b>Guides & Tutorials</b>
+<br /><br />
+<li><a href="silcclient_using.html">Getting Started with SILC Client Library</a>
+<li><a href="silcrng_intro.html">Introduction to SILC Random Number Generator</a>
 
 <br /><br />
 <b>Toolkit Reference</b>

diff --git a/lib/doc/platforms.html b/lib/doc/platforms.html
new file mode 100644 (file)
index 0000000..0502733
--- /dev/null
+++ b/lib/doc/platforms.html
@@ -0,0 +1,60 @@
+<big><b>Platform Implementations</b></big>
+
+<br />&nbsp;<br />
+This document describes the implementation issues with different platforms
+that the SILC Toolkit support.  Some of the supported platforms does not
+support all the features delivered with the Toolkit or they may behave
+differently from other platforms.  This document descibres these
+differences between platforms.
+
+<br />&nbsp;<br />
+<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>
+
+<br />&nbsp;<br />&nbsp;<br />
+<b>Supported Platforms</b>
+
+<br />&nbsp;<br />
+SILC Toolkit supports by default all Unix and Linux platforms, Windows 
+platforms from Windows 98 and newer, and Mac OS X.  In the future there is
+also plans to add support for other platforms such as Symbian OS (EPOC).
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="unix"></a>Unix Implementation</b>
+
+<br />&nbsp;<br />
+All features and components delivered with the SILC Toolkit work on all
+Unix and Linux platforms.  There are no special Unix platform related
+implementation issues with current version of SILC Toolkit.
+
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="windows"></a>Windows Implementation</b>
+
+<br />&nbsp;<br />
+By default all features and components delivered with SILC Toolkit are
+supported on Windows.  However, there are some certain issues with the
+Windows version of the SILC Toolkit.
+
+<br />&nbsp;<br />
+<li>Toolkit users should not use <tt>silc_client_run</tt> function to
+execute the Client Library.  Instead the <tt>silc_client_run_one</tt> should
+be used, for example as an timer task and the Windows application's own
+message loop should be used as the main message loop.
+
+<li>The function <tt>silc_net_create_connection_async</tt> is not actually
+asynchronous on Windows, but synchronous and it will block the process
+while the connection is created.  This means also that the function
+<tt>silc_client_connect_to_server</tt> is not asynchronous but
+synchronous.
+
+
+<br />&nbsp;<br />&nbsp;<br />
+<b><a name="macosx"></a>Mac OS X Implementations</b>
+
+<br />&nbsp;<br />
+All features and components delivered with the SILC Toolkit work on Mac
+OS X platform.  There are no special Mac OS X platform related
+implementation issues with current version of SILC Toolkit.
+