plugins/tcl/README

   1 Please read this document before asking questions.
   2
   3 (1) WHAT IS THE TCL PLUGIN?
   4
   5     The XChat Tcl Plugin adds the complete Tcl scripting language to the
   6     XChat 1.9.x and 2.x IRC client.  The design philosophy behind the tcl
   7     plugin was to give all the power of the C API. yet completely shield
   8     the user from all the complexities of it.  It is lightly modeled after
   9     after Xircon; an old windows TCL enabled client with a little bit of
  10     eggdrop functionality to it.
  11
  12     Features:
  13      * Uses the popular TCL scripting language.
  14      * Familiar to eggdrop bot owners.
  15      * Adds many new XChat specific commands to the Tcl language for
  16        handling of events, user commands, timers, etc.
  17      * It's actually documented! (Hey, what a concept!)
  18      * Works with XChat 1.9.x and 2.x.
  19      * Open source (GPL)
  20
  21     The supplied documentation for Tcl Plugin commands can be
  22     found in doc/tclplugin.html
  23
  24     For a comprehensive list of IRC server tokens, see
  25     doc/tokens.txt
  26
  27
  28 (2) HOW TO GET TCL PLUGIN
  29
  30     You can always find the latest version of the Tcl Plugin at:
  31
  32        http://www.scriptkitties.com/tclplugin
  33
  34    You must also have Tcl 8.3 or higher installed on your system.
  35
  36      Tcl can be obtained from:
  37
  38        http://sourceforge.net/projects/tcl
  39        http://tcl.activestate.com (pre-compiled binaries)
  40
  41      Tcl Man Pages
  42
  43        http://tcl.activestate.com/man/
  44
  45      Tcl Tutorials:
  46
  47        http://hegel.ittc.ukans.edu/topics/tcltk/tutorial-noplugin/
  48        http://jan.netcomp.monash.edu.au/ProgrammingUnix/tcl/tcl_tut.html
  49        http://users.belgacom.net/bruno.champagne/tcl.html
  50
  51
  52 (3) QUICK STARTUP
  53
  54     SEE 'INSTALL'
  55