hexchat/README

116 lines
3.1 KiB
Plaintext
Raw Normal View History

2012-07-14 07:04:45 +04:00
HexChat README
2012-09-02 15:32:08 +04:00
~~~~~~~~~~~~~~
2011-02-24 06:14:30 +03:00
X-Chat ("xchat") Copyright (c) 1998-2010 By Peter Zelezny.
2012-07-14 22:56:00 +04:00
HexChat ("hexchat") Copyright (c) 2009-2012 By Berke Viktor.
2011-02-24 06:14:30 +03:00
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
2012-07-14 07:04:45 +04:00
all other requirements of the GPL are met.
2011-02-24 06:14:30 +03:00
See file COPYING for details.
2012-07-19 14:10:06 +04:00
For building instructions, see http://www.hexchat.org/developers/building
2011-02-24 06:14:30 +03:00
What is it?
~~~~~~~~~~~
2012-09-24 01:32:25 +04:00
HexChat is an IRC client for Windows and UNIX operating systems. I.R.C. is
Internet Relay Chat, see http://irchelp.org for more information about IRC
in general. HexChat runs on most BSD and POSIX compliant operating systems.
2011-02-24 06:14:30 +03:00
Requirements:
~~~~~~~~~~~~~
2012-09-24 01:37:04 +04:00
* GTK+ 2.10
* GLib 2.12
2011-02-24 06:14:30 +03:00
2012-07-14 07:04:45 +04:00
HexChat is known to work on, at least:
2011-02-24 06:14:30 +03:00
* Windows XP/Vista/7/8
* Linux
* FreeBSD
* OpenBSD
* NetBSD
* Solaris
* AIX
* IRIX
* DEC/Compaq Tru64 UNIX
* HP-UX 10.20 and 11
* MacOS X
2011-02-24 06:14:30 +03:00
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:
~~~~~~~~~~~~~~~
Scripts for 1.8.x are not compatible, and a brand new interface has be
written. Documentation can be found here: http://xchat.org/docs/.
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-07-14 22:50:00 +04:00
Perl 5.8 or newer is required.
2011-02-24 06:14:30 +03:00
Scripts for 1.8.x are compatible with the following exceptions:
* IRC::command will not interpret %C, %B, %U etc.
2011-02-24 06:14:30 +03:00
* user_list and user_list_short:
2011-02-24 06:14:30 +03:00
If a user has both op and voice, only the op flag will be 1.
* add_user_list/sub_user_list/clear_user_list
2011-02-24 06:14:30 +03:00
These functions do nothing.
* notify_list
2011-02-24 06:14:30 +03:00
Not implemented. Always returns an empty list.
* server_list
2011-02-24 06:14:30 +03:00
Lists servers that are not connected aswell.
* Some print events may have new names and some were added.
2011-02-24 06:14:30 +03:00
* Text printed by scripts must now be UTF8.
2011-02-24 06:14:30 +03:00
* Text passed to scripts (via add_message_handler) will be encoded in UTF8.
2011-02-24 06:14:30 +03:00
2012-09-02 15:32:08 +04:00
Autoloading Scripts and Plugins:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The root of your HexChat config is:
* Windows: %APPDATA%\HexChat
* Unix: ~/.config/hexchat
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)
2011-02-24 06:14:30 +03: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)
(Eg: %007 sends a BEEP)
%Cforeground,background will produce a color code, eg: %C03,10
These are now disabled by default (see Settings > Prefs > Input Box).
Instead you can insert the real codes via ctrl-k, ctrl-b and ctrl-o.