make it compile on mingw32.

[silc.git] / README.CVS

diff --git a/README.CVS b/README.CVS
index 9db7980e332f52118d2fcc87bd76c793aa776d48..e7568ead1ca31985c33708f802e9e21d0c4fbb70 100644 (file)
--- a/README.CVS
+++ b/README.CVS
@@ -19,21 +19,21 @@ There are no password restrictions in the SILC anonymous CVS repository.
 
 For those who are using sh/ksh/bash the check out is done as follows:
 
-export CVSROOT=:pserver:silc@silc.pspt.fi:/storage/silc/CVS
+export CVSROOT=:pserver:cvs@cvs.silcnet.org:/cvs/silc
 cvs login
 cvs co silc
 
 For those who are using csh/tcsh the check out is done as follows:
 
-setenv CVSROOT :pserver:silc@silc.pspt.fi:/storage/silc/CVS
+setenv CVSROOT :pserver:cvs@cvs.silcnet.org:/cvs/silc
 cvs login
 cvs co silc
 
 If you don't want to set $CVSROOT environment variable you can set the
 path to the cvs as command line options:
 
-cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS login
-cvs -d:pserver:silc@silc.pspt.fi:/storage/silc/CVS co silc
+cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc login
+cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc co silc
 
 What ever method you decide to use, after you have done cvs login you will
 be prompted for password:
@@ -69,11 +69,68 @@ Following directories currently exist in SILC source tree.
 
         Includes SILC include files.
 
+  irssi/
+
+       Includes the Irssi SILC Client.
+
   lib/
 
         Includes SILC libraries.  There maybe libraries on the CVS that
         does not appear on public distribution.
 
+  lib/contrib/
+
+        Contrib directory for routines that some of the platforms might
+        not have.  In that case these routines are provided by the SILC.
+
+  lib/silcclient/
+
+        The SILC Client library. Implementation of the SILC Client without
+        the user interface.  The library provides an interface for user
+        interface designers.
+
+  lib/silccore/
+
+        The SILC Protocol Core library.  Implementation of all the core
+        components of the SILC Protocol.  This is used by all the SILC
+        applications.
+
+  lib/silccrypt/
+
+        The SILC Crypto library. Provides all cryptographic algorithms
+        used in the SILC.  Provides also the Cryptographically strong
+        random number generator.
+
+  lib/silcmath/
+
+        The SILC Math library. Provides the Math and MP routines for
+        SILC applications.  The MP library is actually the GMP.
+
+  lib/silsim/
+
+        The SILC Modules library.  Provides the dynamically loadable
+        modules.
+
+  lib/silcske/
+
+        The SILC Key Exchange (SKE) library.  Implementation of the
+        SKE protocol.  This is used by all SILC applications.
+
+  lib/silcutil/
+
+        The SILC Utility library.  Provides various utility functions
+        for the applications.
+
+  lib/silcutil/unix/
+
+        The SILC Utility library.  Provides various Unix specific utility
+        functions for the applications.
+
+  lib/silcutil/win32/
+
+        The SILC Utility library.  Provides various WIN32 specific utility
+        functions for the applications.
+
   public_html/
 
         Includes the official SILC web pages and everything that relates
@@ -81,14 +138,28 @@ Following directories currently exist in SILC source tree.
 
   silc/
 
-        Includes SILC client.  There can be some extra files that will
-        never appear in public distribution, such as, configuration files.
+       Includes an example implementation of ncurses based SILC client.
+       It won't compile with current Toolkit since it is not being 
+       updated.  It is still good example for Toolkit programmer to 
+       figure out how to use SILC Toolkit.
+
+  silcer/
+
+       Includes an example implementation of GUI (Gnome) base SILC
+       client.  Please read silcer/README for more information.
 
   silcd/
 
         Includes SILC server.  There can be some extra files that will
         never appear in public distribution, such as, configuration files.
 
+  win32/
+
+       Includes win32 Toolkit specific files.  It includes MSVC++
+       Workspace files.  The win32/tests includes example code for
+       use of SILC Toolkit and SILC Client Library on Win32 GUI 
+       application.
+
 
 Howto Compile SILC Source Tree
 ==============================
@@ -114,10 +185,16 @@ SILC_LOG_DEBUG* scripts.  Warning is due here:  The debugging produced
 by both cilent and server is very heavy, thus it is common to test
 the programs as follows:
 
-       ./silc -d -f configfile 2>log
-       ./silcd -d -f configfile 2>log
+       ./silc -d "*" -f configfile 2>log
+       ./silcd -d "*" -f configfile 2>log
 
-Do not give the -d options if you do not want to dump the debugging.
+The -d option enables the debug printing.  The argument for the -d option
+is a string that is used to match the output debug.  The example "*" will
+match for everything, and all debugs will be printed.  If you want to
+limit the debugs you want to printout you can give for example a string
+like "*server*,*rng*" to match all functions, and filenames that has
+"server" or "rng" string in them.  Others will not be printed out.  You   
+can freely define regural expressions as debug string.
 
 
 Howto Clean SILC Source Tree