README.CVS

   1 Anonymous CVS Access
   2 ====================
   3
   4 Anonymous CVS access is now available to SILC CVS repository. The
   5 repository includes everything related to SILC project; source codes,
   6 documentation and web pages.
   7
   8 Also note that this is the closest to real time development you can get
   9 thus you cannot expect that the source tree would work or even compile.
  10 While it is our intention that the trunk would always at least compile
  11 there might be situations when it will not.
  12
  13
  14 Howto Checkout The Source Tree
  15 ==============================
  16
  17 The repository can be checked out by using anonymous pserver with CVS.
  18 There are no password restrictions in the SILC anonymous CVS repository.
  19
  20 For those who are using sh/ksh/bash the check out is done as follows:
  21
  22 export CVSROOT=:pserver:cvs@cvs.silcnet.org:/cvs/silc
  23 cvs login
  24 cvs co silc
  25
  26 For those who are using csh/tcsh the check out is done as follows:
  27
  28 setenv CVSROOT :pserver:cvs@cvs.silcnet.org:/cvs/silc
  29 cvs login
  30 cvs co silc
  31
  32 If you don't want to set $CVSROOT environment variable you can set the
  33 path to the cvs as command line options:
  34
  35 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc login
  36 cvs -d:pserver:cvs@cvs.silcnet.org:/cvs/silc co silc
  37
  38 What ever method you decide to use, after you have done cvs login you will
  39 be prompted for password:
  40
  41         CVS password: silc
  42
  43 Type the password "silc" and press Enter.
  44
  45 The actual SILC source tree is checked out using the cvs co silc command,
  46 described above. This command will fetch the source tree and save it into
  47 directory named silc. SILC CVS repository currently does not have any
  48 branches thus this will check out the trunk. The size of the trunk is
  49 currently about 8 Mb but will grow in the future.
  50
  51
  52 What SILC Source Tree Includes
  53 ==============================
  54
  55 SILC Source tree includes a lot more stuff that appears in public
  56 distribution.  The source tree includes, for example, internal scripts,
  57 configuration files, SILC webpages etc.  These never appear on a public
  58 distribution.
  59
  60 Following directories currently exist in SILC source tree.
  61
  62   doc/
  63
  64         Includes all the SILC documentation.  Some of the documentation
  65         are generated when distribution is generated.  The automatically
  66         generated files must never be commited to CVS.
  67
  68   includes/
  69
  70         Includes SILC include files.
  71
  72   irssi/
  73
  74         Includes the Irssi SILC Client.
  75
  76   lib/
  77
  78         Includes SILC libraries.  There maybe libraries on the CVS that
  79         does not appear on public distribution.
  80
  81   lib/contrib/
  82
  83         Contrib directory for routines that some of the platforms might
  84         not have.  In that case these routines are provided by the SILC.
  85
  86   lib/silcclient/
  87
  88         The SILC Client library. Implementation of the SILC Client without
  89         the user interface.  The library provides an interface for user
  90         interface designers.
  91
  92   lib/silccore/
  93
  94         The SILC Protocol Core library.  Implementation of all the core
  95         components of the SILC Protocol.  This is used by all the SILC
  96         applications.
  97
  98   lib/silccrypt/
  99
 100         The SILC Crypto library. Provides all cryptographic algorithms
 101         used in the SILC.  Provides also the Cryptographically strong
 102         random number generator.
 103
 104   lib/silcmath/
 105
 106         The SILC Math library. Provides the Math and MP routines for
 107         SILC applications.  The MP library is actually the GMP.
 108
 109   lib/silsim/
 110
 111         The SILC Modules library.  Provides the dynamically loadable
 112         modules.
 113
 114   lib/silcske/
 115
 116         The SILC Key Exchange (SKE) library.  Implementation of the
 117         SKE protocol.  This is used by all SILC applications.
 118
 119   lib/silcutil/
 120
 121         The SILC Utility library.  Provides various utility functions
 122         for the applications.
 123
 124   lib/silcutil/unix/
 125
 126         The SILC Utility library.  Provides various Unix specific utility
 127         functions for the applications.
 128
 129   lib/silcutil/win32/
 130
 131         The SILC Utility library.  Provides various WIN32 specific utility
 132         functions for the applications.
 133
 134   public_html/
 135
 136         Includes the official SILC web pages and everything that relates
 137         to them.  This directory never appears on public distribution.
 138
 139   silc/
 140
 141         Includes an example implementation of ncurses based SILC client.
 142         It won't compile with current Toolkit since it is not being
 143         updated.  It is still good example for Toolkit programmer to
 144         figure out how to use SILC Toolkit.
 145
 146   silcer/
 147
 148         Includes an example implementation of GUI (Gnome) base SILC
 149         client.  Please read silcer/README for more information.
 150
 151   silcd/
 152
 153         Includes SILC server.  There can be some extra files that will
 154         never appear in public distribution, such as, configuration files.
 155
 156   win32/
 157
 158         Includes win32 Toolkit specific files.  It includes MSVC++
 159         Workspace files.  The win32/tests includes example code for
 160         use of SILC Toolkit and SILC Client Library on Win32 GUI
 161         application.
 162
 163
 164 Howto Compile SILC Source Tree
 165 ==============================
 166
 167 After checkout from CVS the SILC source tree must be prepared for
 168 configuration and compilation.  To compile the source tree, give,
 169
 170         ./prepare
 171         ./configure --enable-debug
 172         make
 173
 174 The ./prepare script is included in to the source tree and it never
 175 appears in public distribution.  The script prepares the source tree
 176 by creating configuration scripts and Makefiles.  The prepare must be
 177 run every time you make some changes to configuration scripts (however,
 178 making changes to Makefile.am's does not require running ./prepare).
 179
 180 As a developer you should read the ./configure script's help by
 181 giving ./configure --help and study all of its different options.  Also,
 182 you should configure the script with --enable-debug option as it
 183 compiles SILC with -g (debugging) option and it enables the
 184 SILC_LOG_DEBUG* scripts.  Warning is due here:  The debugging produced
 185 by both cilent and server is very heavy, thus it is common to test
 186 the programs as follows:
 187
 188         ./silc -d "*" -f configfile 2>log
 189         ./silcd -d "*" -f configfile 2>log
 190
 191 The -d option enables the debug printing.  The argument for the -d option
 192 is a string that is used to match the output debug.  The example "*" will
 193 match for everything, and all debugs will be printed.  If you want to
 194 limit the debugs you want to printout you can give for example a string
 195 like "*server*,*rng*" to match all functions, and filenames that has
 196 "server" or "rng" string in them.  Others will not be printed out.  You
 197 can freely define regural expressions as debug string.
 198
 199
 200 Howto Clean SILC Source Tree
 201 ============================
 202
 203 To entirely clear the source tree to the state after it was checked out
 204 from CVS, give,
 205
 206         ./prepare-clean
 207
 208 This calls `make distclean' plus removes automatically generated files
 209 by hand.  It also removes *.log files. However, it will not remove
 210 any other files you might have created.
 211
 212
 213 Makefiles and configuration files
 214 =================================
 215
 216 Developers should never directly write a Makefile.  All Makefiles are
 217 always automatically generated by ./prepare and later by ./configure
 218 scripts.  Instead, developers must write Makefile.am files.  There
 219 are plenty of examples what they should look like.  If you change
 220 Makefile.am during development you don't have to run ./prepare, just
 221 run normal make.
 222
 223 Configuration files are the files that ./prepare automatically generates
 224 and what will be included into public distribution.  ./prepare creates
 225 for example the ./configure script that is not commited to the CVS.
 226 `configure.in' is the file that developers must edit to change ./configure
 227 script.  After changing one must run  ./prepare.