Intro
=====

shirc is a shell irc-like system.
It started as a mean to write a collective article about free software.

It could be used to chat with more then 4 users on a single host, where
ytalk would give very limited space for each. All conversations are logged
in a world-readable-and-writeable file, so everybody can read or fake the
logs...

User defined commands are supported, thus allowing users to define encryption
filters for input and output (introducing a bit more privacy then the core
system offers).

If you have 'splitvt' installed you'll get a comfortable interface,
otherwise you'll have mixed input/output. You can get splitvt from:
http://www.devolution.com/~slouken/projects/splitvt/

Extending
=========

To define a new command you just define a shell function whose name is
composed by the literal `CMD_' and the command name. For example, to
provide a "/scream" command you'd define a shell command "CMD_scream".
To have the /help command show an help line for you newly defined command
you have to write that line starting with #HELP#. Well, now you can stick
all these commands in a file and /load them from within shirc. 

Files
=====

The $HOME/.shirc/onstart file will be sourced at startup. All the shirc commands
contained therein will be executed

The $HOME/.shirc/onjoin file will be sourced after each of our joins

CVS access
==========

Development version can be retrived from CVS repository:

	cvs -d:pserver:cvs@flip.keybit.net:/home/cvsroot login
	cvs -d:pserver:cvs@flip.keybit.net:/home/cvsroot co shirc

 Name                    Last modified       Size  Description

 Parent Directory        16-Nov-2007 14:09      -  
 README.txt              08-Jun-2005 16:55     2k  
 packages/               24-Nov-2006 23:44      -  
 shirc-0.6/              24-Nov-2006 23:44      -  
 shirc-0.7/              24-Nov-2006 23:44      -  
 shirc-0.8/              24-Nov-2006 23:44      -  
 shirc-0.9.1/            24-Nov-2006 23:44      -  
 shirc-0.9.2/            24-Nov-2006 23:44      -  
 shirc-0.9/              24-Nov-2006 23:44      -  

0.9.2
	- sourced systemwide onstart and onjoin hooks

	- bug fixed in directory permissions set

0.9.1
	- bug fixed in shirc-link 

0.9
	- Automatic splitvt detection, shirc-splitvt obsoleted, internal
	  splitvt usage cleaner (removes FIFO after usage).

	- New shirc-link script, for inter-hosts channel linkage

	- Joins/parts encoded as files in a 'users' directory
	  instead of written to a 'users' file. You can use
	  the update_userfiles script to update format.

	- Topic report mimate irc style.

	- Bug fixes

0.8
	- /users renamed to /names (irc-compatible)

	- Added /motd command

	- User files locked before modification

	- Install procedure will ask for prefix and
	  will just *suggest* to install conf and motd

	- Added note about shirc-splitvt in manual.

	- Bug fixes

0.7
	- load command refuses to load a module multiple times

	- prompt string printed to stderr (for splitvt wrapper niceness)

	- added 'invite' module

	- version shown on help

0.6
	- Fixed a bug that made the shell interpret messages
	  directed to channels (expanding ??, * and the like)

	- Made prompt be written to stderr

	- Added a splitvt wrapper

0.5

	- Written a manual !

	- Made a simple install-sh script

	- Fixed a bug in CMD_load

	- Tried to convince a minix system to run it with `ash'
	  (almost done!)

	- A config file is used. You can specify which one
	  with the SHIRC_CONF environment variable

	- Modules are looked for in SHIRC_MODPATH, channels log
	  are stored in SHIRC_CHDIR (set in SHIRC_CONF)

	- NEW: module rot13

0.4
	- NEW: when joining a channel the file $HOME/.shirc/onjoin
	       will be parsed for shirc commands

	- Main loop is now a function `parsestream'

	- Reduced the set of core commands

	- All commands are now shell functions with name CMD_<commandname>

	- The command /load <mod> can be used to load modules for shirc
 
	- The command /source <file> will read shirc commands from <file>