From: Pekka Riikonen Date: Wed, 8 Jan 2003 13:26:12 +0000 (+0000) Subject: updates X-Git-Tag: silc.client.0.9.11~2 X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=commitdiff_plain;h=34992da6c4db991966a4ae1f497afe0dd194bd58 updates --- diff --git a/TODO b/TODO index 1d5f3a69..826dd824 100644 --- 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 59524bfb..7dd0302d 100644 --- a/lib/doc/LIBINDEX +++ b/lib/doc/LIBINDEX @@ -28,6 +28,13 @@ of the Toolkit always delivers the latest version of this reference manual.
  • Introduction to the Manual
  • Programming Conventions
  • Building the Toolkit +
  • Platform Implementations + +

    +Guides & Tutorials +

    +
  • Getting Started with SILC Client Library +
  • Introduction to SILC Random Number Generator

    Toolkit Reference diff --git a/lib/doc/platforms.html b/lib/doc/platforms.html new file mode 100644 index 00000000..0502733e --- /dev/null +++ b/lib/doc/platforms.html @@ -0,0 +1,60 @@ +Platform Implementations + +
     
    +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. + +
     
    +
  • Building on Unix & Linux
    +
  • Building on Windows
    +
  • Building on Mac OS X + +
     
     
    +Supported Platforms + +
     
    +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). + +
     
     
    +Unix Implementation + +
     
    +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. + + +
     
     
    +Windows Implementation + +
     
    +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. + +
     
    +
  • Toolkit users should not use silc_client_run function to +execute the Client Library. Instead the silc_client_run_one 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. + +
  • The function silc_net_create_connection_async 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 +silc_client_connect_to_server is not asynchronous but +synchronous. + + +
     
     
    +Mac OS X Implementations + +
     
    +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. +