Go to file
Berke Viktor de1a2a7b33 Version bump 2012-10-14 00:58:54 +02:00
plugins Fix misspelled words 2012-10-13 22:55:35 +02:00
po Several German fixes and some further translations 2012-07-29 22:54:35 +03:00
src Compatibility for Automake 1.12.4+ 2012-10-13 22:26:35 +02:00
win32 Accept license agreement by default 2012-10-13 18:55:43 +02:00
.gitignore Ignore Mono built HTM 2012-10-05 01:17:31 +02:00
COPYING add xchat r1489 2011-02-24 04:14:30 +01:00
COPYING.rtf initial x86 installer 2011-08-18 02:26:24 +02:00
ChangeLog Add info about HexChat changelog 2012-07-27 17:00:23 +02:00
HACKING more XChat to HexChat renaming 2012-07-14 06:04:45 +03:00
Makefile.am Fix compilation on Red Hat (Phr33d0m) 2012-07-30 16:05:34 +02:00
README Update Python and Perl descriptions 2012-09-23 23:45:15 +02:00
acinclude.m4 On my system (openSUSE 12.2 / GNU bash, version 4.2.24(1)-release (x86_64-suse-linux-gnu) ), the shell doesn't like that the '=' character in 'if test...' doesn't have spaces around it. This causes the test to always be true, and thus the AS_AC_EXPAND macro only expands once. This led to two #define's in config.h containing broken values: HEXCHATSHAREDIR and DBUS_SERVICES_DIR. 2012-09-20 22:04:14 +08:00
autogen.sh Don't suggest --enable-maintainer-mode, noone's using it anyway 2012-07-23 10:54:23 +02:00
config.h Version bump 2012-10-14 00:58:54 +02:00
config.rpath add xchat r1489 2011-02-24 04:14:30 +01:00
configure.ac Version bump 2012-10-14 00:58:54 +02:00
faq.html Update notes about config changes 2012-07-26 23:42:33 +02:00
hexchat-b.svg Update logos thanks to TingPing, now only WizardImage is left 2012-07-16 22:53:28 +02:00
hexchat.desktop more XChat to HexChat renaming 2012-07-14 06:04:45 +03:00
hexchat.ico Update logos thanks to TingPing, now only WizardImage is left 2012-07-16 22:53:28 +02:00
hexchat.png Update logos thanks to TingPing, now only WizardImage is left 2012-07-16 22:53:28 +02:00
hexchat.spec Complete the rebranding of the D-Bus plugin 2012-07-18 15:18:43 +02:00
hexchat.svg Update logos thanks to TingPing, now only WizardImage is left 2012-07-16 22:53:28 +02:00
version.txt Version bump 2012-10-14 00:58:54 +02:00

README

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.

 For building instructions, see http://www.hexchat.org/developers/building


What is it?
~~~~~~~~~~~
 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.


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
 * MacOS 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:
~~~~~~~~~~~~~~~
 Scripts for XChat 1.8.x are not compatible, a brand new interface has been
 written. The documentation can be found here:

 https://github.com/hexchat/hexchat/wiki/Python-Interface

 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:
~~~~~~~~~~~~~
 Perl 5.8 or newer is required. The documentation can be found here:

 https://github.com/hexchat/hexchat/wiki/Perl-Interface

 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

 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)


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.