mirror of https://github.com/moparisthebest/hexchat synced 2024-11-04 16:35:06 -05:00

History

Arnavion 863dc2e841 docs: Typo.		2013-06-27 10:53:29 -07:00
..
changelog-xchat.md	Convert XChat changelog to Markdown	2012-10-28 14:44:22 +01:00
COPYING	fix incorrect FSF address	2012-12-23 11:36:54 -08:00
fishlim.md	Further doc relocations and conversions	2012-10-28 10:49:44 +01:00
hacking.md	docs: Typo.	2013-06-27 10:53:29 -07:00
hexchat-text.md	Further doc relocations and conversions	2012-10-28 10:49:44 +01:00
readme.md	Reduce GLib requirement	2013-05-12 06:16:26 +02:00

readme.md

HexChat ReadMe

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 Building.

What is it?

HexChat is an IRC client for Windows and UNIX operating systems. I.R.C. is Internet Relay Chat, see IRCHelp.org for more information about IRC in general. HexChat runs on most BSD and POSIX compliant operating systems.

Requirements:

GTK+ 2.24
GLib 2.28

HexChat is known to work on, at least:

Windows 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:

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. For more info, see the HexChat Python Interface.

Perl Scripts:

Perl 5.8 or newer is required. For more info, see the HexChat Perl Interface.

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/*.pl Perl scripts
<config>/addons/*.py Python 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, e.g.: %007 sends a BEEP)

%Cforeground,background will produce a color code, e.g.: %C03,10

These are now disabled by default (see Settings -> Preferences -> Input Box).
Instead you can insert the real codes via ctrl-k, ctrl-b and ctrl-o.