lurc README
~~~~~~~~~~~~~
 X-Chat v1.0.0 Copyright (c) 1998-99 By Peter Zelezny.

 lurc is an X-Chat 1.0 derivative.
 lurc builds on Mr. Zelezny's original source code, and also backports
 several features from later versions of X-Chat.
 
 lurc is coded by Timothy C. McGrath, aka Hikaru/tm

 Do NOT contact Mr. Zelezny for support or assistance with this program, bug
 Hikaru instead, it's his problem.


What is it?
~~~~~~~~~~~
 lurc is an X11 (X Window System) IRC client, using the GTK+ toolkit.


Requirements:
~~~~~~~~~~~~~
 - A UNIX computer (Works on Linux, may work on others) and C compiler (gcc)
 - X11 (X Window System)
 - cmake (http://www.cmake.org/)
 - GTK+ 1.2.0+ (this is available at http://www.gtk.org)

 lurc is known to work on, at least:

	- Slackware linux 12
	- Arch Linux 0.8 'Don't Panic'


Updates?
~~~~~~~~
 http://code.google.com/p/lurc/ is the official distribution site.

 Hikaru uses this as his irc client, so patches would be appreciated.

 Development takes place on irc.oftc.net channel #lurc
 Feel free to stop by and say hello, or discuss bugs/features with us.


Some lurc features explained:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 These are just some options and behaviours that are not so obvious
 or self-explanatory.


User Commands:
~~~~~~~~~~~~~~
 This hasn't been completely documented yet.

 &1 arg 1, &2 arg 2 etc, for the individual words you typed in on the line.

 %1 %2 seems to do the same but be the start of the word to the end of the
 line.

 %c channel/dialog you're in

 ; is a separator between multiple commands but the next command must be
 right next to it, example:
 /foo ;/baz 
 will work, this will not:
 /foo ; /baz
 Control codes work in this now too.

 Some useful examples of user commands from Hikaru's client:

 sound /ctcp %c SOUND &2 ;/exec mplayer ~/wav/&2 > /dev/null

 will send a ctcp sound to the current channel/dialog with the wav file you
 typed in as well as make mplayer also play the sound locally.

 off /exec xset dpms force off;/away

 This will shut off your monitor immediately and set your client as away.
 Useful when you've gotta get up and get moving without distractions ;)


Control Codes:
~~~~~~~~~~~~~~

 %%	-	A single percentage sign
 %C	-	Control-C (mIRC color code)
 %B	-	Bold Text
 %U	-	Underline Text (seen as bold in lurc)
 %R	- 	Reverse Text (seen as bold in lurc)
 %O     -       Reset all Text attributes

 %Cforeground,background will produce a color code, eg: %C03,10


Misc keyboard shortcuts:
~~~~~~~~~~~~~~~~~~~~~~~~

alt& numbers 1-0 on keyboard will select the first to tenth tab.
alt& minus will select the previous tab
alt& equals will select the next tab
alt& ctrl& minus will move three tabs to the left
alt& ctrl& equals will move three tabs to the right
ctrl& k does the equivalent of the %C control code.
ctrl& b does the equivalent of the %B control code.
ctrl& c does the equivalent of the %O control code.
ctrl& r does the equivalent of the %R control code.

code for an underlining keyboard shortcut exists but it is disabled.


Highlighting:
~~~~~~~~~~~~~

This is about how a tab behaves when there's a message in that tab and it's
not currently active. You can change the colors for highlighting in the
Setup dialog.

There's three levels of highlighting:

- Tab Alert: In this tab, your nick or the highlight string you have defined
  in the setup dialog was mentioned by somebody. Alternatively, some channel
  or server message (like a topic change) contained your nick or said string.
  Notes:
    o In a dialog tab, any activity triggers this Alert.
    o Join and quit messages (among others, see below) are not checked for the
      hightlight string. As a consequence, putting a buddy's nickname as the 
      hightlight string will _not_ give you an Alert when he/she joins. Use the
      /NOTIFY command instead.
- Tab Activity: All types of messages that don't meet the above conditions.
- Tab Misc Activity: Four types of messages trigger this: Joins, Parts, Quits
  and Nick Changes, no matter their content (so you don't get a Tab Alert even
  if one of these contains your nick or your highlight string). The idea behind
  this is that if you want to follow the conversations on several channels, you
  want to know when people actually talk as opposed when there's just the usual
  noise in a channel that's not worth switching to the channel's tab for.
