PISG/docs/FORMATS

FORMATS - supported logfile formats by pisg
------------------

This file contains a list of the different logfile formats which pisg
supports. It also includes a sample line for these formats.

If you don't have access to any of the clients/bots or you use some other
IRC client/bot which isn't supported, then it's fairly easy to add support
for a new IRC log format if you have some Perl knowledge, take a look at
modules/Pisg/Parser/Format/Template.pm. If you don't have any Perl
knowledge, then mail a sample logfile to the mailinglist (preferred as a
link to the logfile)

* mIRC:
  - A client for Windows (www.mirc.com)
  
  - If you want to create mIRC logfiles with your eggdrop, you can get some TCL
    which does it all for you (also logrotating and much more).

    MEL (mIRCStats Eggdrop Logger) can be downloaded from the following URL:

    http://mel.angelbears.org/

    Remember to timestamp your logs, or it wont work, the timestamp must be
    in [HH:MM] or [HH:MM:SS] format.
    
  - In order to use this, format must be set to 'mIRC'.

  Example:
        [23:44] <Christina> Hello world

* X-Chat:
  -  A client for Linux (www.xchat.org)
    
  -  In order to use this, format must be set to 'xchat'.

  Example:
        18:01:43 <Ben> Hello world

* Eggdrop:
  - A cool and advanced IRC bot for Linux (www.eggheads.org)

  - In order to use this, format must be set to 'eggdrop'.

  You might want to change the logfile-suffix in order for pisg to parse the
  files in the correct order when using 'logdir':
  set logfile-suffix ".%Y%m%d" instead of the standard format
  set logfile-suffix ".%d%b%Y".
  

  Example:
        [00:02] <Jenny> Hello world
     
* Grufti:
  - A bot which I'm not really familiar with (www.grufti.com)
  - The author has actually made something like pisg called 'gruftistats',
    but someone mailed me and told me that it hadn't been maintained for
    over a year, and it had some problems..

  - In order to use this, format must be set to 'grufti'
  
  Example:
        [00:17] <John> Hello world

* bxlog:
  - A logging script for BitchX (console client - see scripts.bitchx.com)
   
  - In order to use this, format must be set to 'bxlog'

  Example:
        [31 Dec/11:26] <John> Hello world

* mbot:
  - C-Based IRC Bot (http://darksun.com.pt/mbot/)

  - In order to use this, format must be set to 'mbot'

  Example:
        Thu Aug 23 12:59:40 2001 <John> Hello world

* irssi:
  - Console IRC client (www.irssi.org)
  
  - Logfiles must be using the default theme in irssi.

  - In order to use this, format must be set to 'irssi'

  Example:
        17:40 <@John> Hello world
        
* psybnc:
  - IRC bouncer (http://www.psychoid.lam3rz.de/)

  - In order to use this, format must be set to 'psybnc'

  Example:
  2001-08-19-23-14-06:#LINUX.DE::stelb!user@host.org PRIVMSG #linux.de :hi!
    
* winbot:
  - Windows-based IRC bot (http://www.winbot.co.uk/)

  - In order to use this, format must be set to 'winbot'

  Example:
  15:32.58 17/10/2001  <Azhrarn/#darkgalaxy> This is a normal line.

* zbot:
  - Bot written in C++ (http://zcbot.sourceforge.net/)

  - In order to use this, format must be set to 'zcbot'

  Example:
  12/11/01 22:05:42 :Keitaro!KOala_v5@EVYRV4A4.ipt.aol.com PRIVMSG #alsa-station :Re all :-)

* ircle:
  - IRC client for Mac OS X

  - Support for this format is not completely done yet.

  - In order to use this, format must be set to 'ircle'

  Example:
  6:35 PM:   Sinnikal: thats gross

* infobot:
  - bot written in Perl (http://www.infobot.org)

  - In order to use this, format must be set to 'infobot'

* Trillian:
  - Trillian's IRC component. (http://www.trillian.cc)

  Note: Your Logs must be timestamped in the format [%h:%m] or [%h:%m:%s]
  This is set in Preferences -> General -> Windows -> Display in your Trillian Client
  Tested with Trillian Version 0.70

  - In order to use this, format must be set to 'Trillian'

* bobot++:
  - IRC bot written in C++. (http://pltplp.net/bobot++/)

  - In order to use this, format must be set to 'bobot'

  Example:
  [13/12/2001 - 20:38] <NazoZzz> hello world