summary refs log tree commit diff stats
path: root/plugins/tcl/README
blob: e46635ef088d72483692cc5959f43a9d755837e8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Please read this document before asking questions.

(1) WHAT IS THE TCL PLUGIN?

    The XChat Tcl Plugin adds the complete Tcl scripting language to the
    XChat 1.9.x and 2.x IRC client.  The design philosophy behind the tcl
    plugin was to give all the power of the C API. yet completely shield
    the user from all the complexities of it.  It is lightly modeled after
    after Xircon; an old windows TCL enabled client with a little bit of
    eggdrop functionality to it.

    Features:
     * Uses the popular TCL scripting language.
     * Familiar to eggdrop bot owners.
     * Adds many new XChat specific commands to the Tcl language for 
       handling of events, user commands, timers, etc. 
     * It's actually documented! (Hey, what a concept!) 
     * Works with XChat 1.9.x and 2.x. 
     * Open source (GPL) 

    The supplied documentation for Tcl Plugin commands can be 
    found in doc/tclplugin.html
    
    For a comprehensive list of IRC server tokens, see
    doc/tokens.txt


(2) HOW TO GET TCL PLUGIN

    You can always find the latest version of the Tcl Plugin at:

       http://www.scriptkitties.com/tclplugin

   You must also have Tcl 8.3 or higher installed on your system.

     Tcl can be obtained from:

       http://sourceforge.net/projects/tcl
       http://tcl.activestate.com (pre-compiled binaries)

     Tcl Man Pages

       http://tcl.activestate.com/man/

     Tcl Tutorials:

       http://hegel.ittc.ukans.edu/topics/tcltk/tutorial-noplugin/
       http://jan.netcomp.monash.edu.au/ProgrammingUnix/tcl/tcl_tut.html
       http://users.belgacom.net/bruno.champagne/tcl.html


(3) QUICK STARTUP

    SEE 'INSTALL'
eral.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
/* X-Tray
 * Copyright (C) 2005 Michael Hotaling <Mike.Hotaling@SinisterDevelopments.com>
 *
 * X-Tray is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * X-Tray is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with X-Tray; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef _H_XCHAT_H
#define _H_XCHAT_H

void					hexchat_exec			(char *);
char					*hexchat_strip_color	(char *);
void					hexchat_parse			(char *);
struct _hexchat_context	*hexchat_find_server	(int);
void					hexchat_globally_away	(TCHAR *);
void					hexchat_away			(TCHAR *);
void					hexchat_globally_back	();
void					hexchat_back			();
HMENU					setServerMenu		();

#endif