summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorBerke Viktor <bviktor@hexchat.org>2012-07-26 20:53:59 +0200
committerBerke Viktor <bviktor@hexchat.org>2012-07-26 20:53:59 +0200
commitec301a5a5486898cb4d9854a56eb866f1b93f634 (patch)
treec0cec2f567df7e1f62fc0168b2fe3cc68c9d8954 /README
parent7f831646bb8c31966e0f3ff77d40ce66711daa99 (diff)
Auto-load user plugins and scripts from <config>/addons
On Unix leave $(libdir)/hexchat/plugins for plugin packagers, on Windows
prevent users from modifying Program Files by ignoring everything except
bundled plugins
Diffstat (limited to 'README')
-rw-r--r--README60
1 files changed, 32 insertions, 28 deletions
diff --git a/README b/README
index 935e441c..93ef6691 100644
--- a/README
+++ b/README
@@ -26,17 +26,17 @@ Requirements:
 
  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
+ * 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:
@@ -60,38 +60,42 @@ Perl Scripts:
  Perl 5.8 or newer is required.
  Scripts for 1.8.x are compatible with the following exceptions:
 
-* IRC::command will not interpret %C, %B, %U etc.
+ * IRC::command will not interpret %C, %B, %U etc.
 
-* user_list and user_list_short:
+ * 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
+ * add_user_list/sub_user_list/clear_user_list
   These functions do nothing.
 
-* notify_list
+ * notify_list
   Not implemented. Always returns an empty list.
 
-* server_list
+ * server_list
   Lists servers that are not connected aswell.
 
-* Some print events may have new names and some were added.
+ * Some print events may have new names and some were added.
 
-* Text printed by scripts must now be UTF8.
+ * Text printed by scripts must now be UTF8.
 
-* Text passed to scripts (via add_message_handler) will be encoded in UTF8.
+ * Text passed to scripts (via add_message_handler) will be encoded in UTF8.
 
 
 Autoloading Scripts and Plugins
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- HexChat automatically loads, at startup:
-
-	~/.config/hexchat/scripts/*.lua Lua scripts
-	~/.config/hexchat/scripts/*.pl Perl scripts
-	~/.config/hexchat/scripts/*.py Python scripts
-	~/.config/hexchat/scripts/*.tcl Tcl scripts
-	~/.config/hexchat/*.so Plugins
-	$(libdir)/hexchat/plugins/*.so plugins
-	(this usually translates to /usr/lib/hexchat/plugins/*.so)
+ 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: