debian/README

   1         chiark-tcl - some useful Tcl bindings
   2         -------------------------------------
   3
   4 This package contains, basically, shared libraries
   5   chiark_tcl_<something>-1.so
   6 in /usr/lib.
   7
   8 Each of these is a Tcl extension which can be loaded into a Tcl
   9 interpreter with
  10   load chiark_tcl_<something>-1.so
  11 and then the new commands will immediately be available.
  12
  13 The documentation for each extension is regrettably rather sketchy but
  14 the following information should be enough to get you started:
  15
  16   <something>.tct
  17
  18       This is the input file to the automatic Tcl<->C glue generator
  19       used by all of the extensions provided in this package.  This
  20       lists the commands and subcommands available.
  21
  22   <something>.[ch].txt
  23
  24       Some of the extensions have additional usage documentation in a
  25       source code comment.  This comment has been mechanically
  26       extracted from the source file for your comfort and convenience.
  27
  28 To gain an understanding of the way the *.tct files work, take a
  29 look at adns.c.txt which describes the `adns' command provided by
  30 the adns binding.
  31
  32 Note that the file /usr/lib/libchiark_tcl-1.so is NOT an amalgam of
  33 all of the extensions.  It is a set of common routines which will be
  34 loaded automatically when required.  Each extension must be loaded
  35 explicitly with the Tcl `load' command to bring the additional
  36 commands into the Tcl command namespace.
  37
  38 To use the adns and nettle bindings you need to have the appropriate
  39 libraries installed too, although these are not listed as
  40 dependencies.  Programs which use these extensions should list
  41 dependencies on (currently) libadns1 and libnettle2.  Regrettably,
  42 there is no clear way to get the dependencies completely correct in
  43 the case where chiark-tcl is rebuilt against some other versions of
  44 adns and/or nettle.