Imported robodoc
[silc.git] / README.CVS
index d7d14aac46cb2d06b3f0319ed1403dd5651795dc..3c0f45dc744e24748b660bfb552b18aa402290be 100644 (file)
@@ -3,7 +3,7 @@ Anonymous CVS Access
 
 Anonymous CVS access is now available to SILC CVS repository. The
 repository includes everything related to SILC project; source codes,
-documentation and even these web pages.
+documentation and web pages.
 
 Also note that this is the closest to real time development you can get
 thus you cannot expect that the source tree would work or even compile.
@@ -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
@@ -94,7 +151,7 @@ Howto Compile SILC Source Tree
 ==============================
 
 After checkout from CVS the SILC source tree must be prepared for 
-configuration and compilation.  To compile the source three, give,
+configuration and compilation.  To compile the source tree, give,
 
        ./prepare
        ./configure --enable-debug
@@ -114,8 +171,10 @@ 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 -f configfile 2>log
-       ./silcd -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.
 
 
 Howto Clean SILC Source Tree