2012-10-26 01:03:52 +02:00
# HexChat ReadMe
X-Chat ("xchat") Copyright (c) 1998-2010 By Peter Zelezny.
HexChat ("hexchat") Copyright (c) 2009-2012 By Berke Viktor.
This program is released under the GPL v2 with the additional exemption
that compiling, linking, and/or using OpenSSL is allowed. You may
provide binary packages linked to the OpenSSL libraries, provided that
all other requirements of the GPL are met.
See file COPYING for details.
2012-10-28 11:01:25 +01:00
For building instructions, see [Building ](http://www.hexchat.org/developers/building ).
2012-10-26 01:03:52 +02:00
## What is it?
HexChat is an IRC client for Windows and UNIX operating systems. I.R.C. is
2012-10-28 11:01:25 +01:00
Internet Relay Chat, see [IRCHelp.org ](http://irchelp.org ) for more information about IRC
2012-10-26 01:03:52 +02:00
in general. HexChat runs on most BSD and POSIX compliant operating systems.
## Requirements:
* GTK+ 2.10
* GLib 2.12
HexChat is known to work on, at least:
* Windows XP/Vista/7/8
* Linux
* FreeBSD
* OpenBSD
* NetBSD
* Solaris
* AIX
* IRIX
* DEC/Compaq Tru64 UNIX
* HP-UX 10.20 and 11
* OS X
## Notes for packagers:
If you need your packages to work on i386, you don't need to compile with
--disable-mmx, because it's also checked at run-time.
## Python Scripts:
2012-10-28 11:01:25 +01:00
Scripts for XChat 1.8.x are not compatible, a brand new interface has been written. For more info, see the [HexChat Python Interface ](https://github.com/hexchat/hexchat/blob/master/share/doc/python.md ).
2012-10-26 01:03:52 +02:00
Consider using the Python interface for your scripts, it's a very nice
API, allows for loading/unloading individual scripts, and gives you
almost all the features of the C-Plugin API.
## Perl Scripts:
2012-10-28 11:01:25 +01:00
Perl 5.8 or newer is required. For more info, see the [HexChat Perl Interface ](https://github.com/hexchat/hexchat/blob/master/share/doc/perl.md ).
2012-10-26 01:03:52 +02:00
Scripts for XChat 1.8.x are compatible with the following exceptions:
* IRC::command will not interpret %C, %B, %U etc.
* user_list and user_list_short:
If a user has both op and voice, only the op flag will be 1.
* add_user_list/sub_user_list/clear_user_list
These functions do nothing.
* notify_list
Not implemented. Always returns an empty list.
* server_list
Lists servers that are not connected aswell.
* Some print events may have new names and some were added.
* Text printed by scripts must now be UTF8.
* Text passed to scripts (via add_message_handler) will be encoded in UTF8.
## Autoloading Scripts and Plugins:
The root of your HexChat config is:
* Windows: %APPDATA%\HexChat
* Unix: ~/.config/hexchat
2012-10-28 14:43:41 +01:00
Referred to as < config> from now. HexChat automatically loads, at startup:
* < config>/addons/*.lua Lua scripts
* < config>/addons/*.pl Perl scripts
* < config>/addons/*.py Python scripts
* < config>/addons/*.tcl Tcl scripts
* < config>/addons/*.dll Plugins (Windows)
* < config>/addons/*.so Plugins (Unix)
2012-10-26 01:03:52 +02:00
## Control Codes:
* %% - A single percentage sign
* %C - Control-C (mIRC color code)
* %B - Bold Text
* %U - Underline Text
* %R - Reverse Text
* %O - Reset all Text attributes
* %XXX - ASCII XXX (where XXX is a decimal 3 digit number, e.g.: %007 sends a BEEP)
%Cforeground,background will produce a color code, e.g.: %C03,10
2012-11-04 01:21:23 +01:00
These are now disabled by default (see _Settings_ `->` _Preferences_ `->` _Input Box_ ).
2012-10-26 01:03:52 +02:00
Instead you can insert the real codes via ctrl-k, ctrl-b and ctrl-o.
