README

   1 # $Id$
   2
   3                                  -------------
   4                                  -- Infobot --
   5                                  -------------
   6
   7 INTRODUCTION
   8         This bot is based upon blootbot, which was a fork of infobot-0.44.2 by
   9 Kevin Lenzo <lenzo@cs.cmu.edu>, which is now officially rebranded back to
  10 infobot!  The basis of infobot is still there but _many_ wild features have
  11 been added.  Along the way, a couple of typos were spotted in the original
  12 infobot source and fixed in this version. Without infobot, there would be no
  13 blootbot, and thus no infobot again, so all thanks to kevin for bringing
  14 infobot in the first place.
  15
  16
  17 FEATURES
  18         * Additional information stored with factoids. (factinfo)
  19         * Wide range of statistics for Bot, Factoids, IRC, Debian.
  20           (status, factstats, ircstats, chanstats, cmdstats)
  21         * Advanced topic management. (the first cool feature)
  22         * Improved factoid search, allowing search by key or value.
  23         * Freshmeat support (freshmeat.net)
  24         * Debian Contents and Packages, search and info.
  25         * ChanServ/NickServ (OPN) support.
  26         * WWW-Search (eg: google for BLAH)
  27         * Slashdot, Kernel and Freshmeat auto-update announcements.
  28         * Units conversion (provided by external module, Units-Module)
  29
  30
  31 DESIGN
  32         - Modularity. Ability to disable IRC or Factoid support.
  33         - Funky pseudo Module autoloader support
  34         - Eleet Forker() function
  35
  36
  37 IMPROVEMENTS
  38         * log file is not opened and closed for each line of data
  39                 => unblocked logging is used.
  40         * seen data is not flushed for each public message on IRC
  41                 => caching and flushing over an interval is used.
  42
  43
  44 HISTORY
  45         As of 0.99pre1, blootbot supports mysql database in the hope to
  46 increase performance and to avoid borked over dbm's which occurred when
  47 the bot crashed (??). The mysql code is far larger (or perhaps twice
  48 as many functions) than expected even though a few functions were needed
  49 for DBM due to lack of table deficiencies.
  50
  51         As of 1.0.0pre1, blootbot takes advantage of Net::IRC. The
  52 change over was fairly comfortable (95% clean). Just minor problems here
  53 and there, mostly debugging and getting it right.
  54
  55         As of 1.0.0RC2, the old style DBM (Berkeley) has been ported
  56 back. It should work in all but 3 specific (countdown, factstats unreq)
  57 cases. preliminary pgsql support has been added but someone with pgperl
  58 knowledge needs to fix it up or at least unify the module with mysql.
  59
  60         As of 1.5.0, blootbot was rebranded back to infobot.
  61
  62
  63 INSTALLATION
  64   - Read the included INSTALL file
  65
  66
  67 NOTICE
  68         Be warned that this bot consumes quite a lot of memory upon start
  69 up and during usage. Right now, 7.4megs is used for old'ish perl, 8.3megs
  70 with perl 5.005. fork() is used but don't be alarmed at the memory usage
  71 as fork(), as I was told, uses COW (copy on write).
  72
  73         WARNING: enabling wingate support may involve complaints of some
  74 sort, probably because the telnet connection isn't closed properly.
  75 However, these people do not realize the potential of open wingates.
  76
  77         Please beta test it and report bugs as I have not had the time to
  78 test all modifications properly (and extensively).  Suggestions are
  79 welcomed.
  80
  81         gp@OPN is currently working on a C version of infobot or
  82 blootbot, not based on the above source base.  Core factoid code and
  83 mysql support works - but that is it.
  84
  85
  86 MODIFICATIONS
  87         All modifications are that of the blootbot author unless otherwise
  88 specified, like none.  See 'ChangeLog' for details.  A list of future
  89 features listed in 'TODO'.
  90
  91         See 'USAGE' for complete list of commands with description
  92 (FIXME) and examples (FIXME).  Yes, it is incomplete.  It is better for
  93 you to find the cookies than for me to hand-feed them to you ;)
  94
  95         See 'EXAMPLES' for various usage of factoids and "hidden"
  96 variables.  If you're hardcore, check out 'CommandStubs.pl' and
  97 'UserExtras.pl' for cool features.
  98
  99         topic [help]            - Topic help.
 100         topic add <topic>       - Append <topic> to the current topic.
 101         topic del <#>           - Purge topic ID <#> from current topic.
 102         topic list              - List broken down summary of current topic.
 103         topic mod s/old/new/    - Modify the topic using regex.
 104                                 - Now supports , and # as delimiters.
 105         topic mv <1> <type> <2> - <type>:
 106                                         before - Move <1> before <2>
 107                                         after  - Move <1> after <2>
 108                                         swap   - Swap <1> and <2>
 109         topic shuffle           - Jumble the subtopics.
 110
 111         topic history           - Show previous channel topics.
 112         topic restore <#>       - Restore channel topic to <#> on history
 113                                   #list.
 114
 115 ==> Individual commands: NEW
 116         (lobotomy|bequiet)      -- [o] silence the bot.
 117         (unlobotomy|benoisy)    -- [o] unsilence the bot.
 118
 119         set <param> <value>     -- ...
 120         unset <param>           -- ...
 121
 122
 123 NOTES
 124         To administrate/control the bot remotely, this can only be done
 125 through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
 126 '.' otherwise it is sent to the bot chat net
 127
 128
 129 UNTESTED:
 130         - user statistics shown by 'seen'. bug in this?
 131         - User Information Services.
 132         - new wingate caching/file-read code.
 133         - disabling IRC/factoid support code.
 134         - PG supports need to be worked and thoroughly tested.
 135
 136
 137 CONTRIBUTIONS
 138         jCommons, is, netgod, mu and Mercury for attempting to break my
 139 modifications, aswell as giving suggestions and ideas in the early
 140 development stages. Bashing of modifications courtesy of larne, irq, lilo
 141 and \broken.
 142
 143         mu@OPN for the SAR (=~ s///) and Topic history patch.
 144
 145         someone emailed me a patch to fix up telnet but I accidently
 146 deleted the message together with the patch after replying to the guy. I
 147 hope to get that same guy to re-send me the patch...
 148
 149         MbM@OPN sent a patch to clean up behaviour of factoids
 150 (adding, removing, modifying).  Thanks.
 151
 152
 153 CONTACT
 154         Contributions of a patch, or anything, can be sent to
 155 <infobot-devel@lists.sourceforge.net>
 156
 157 Some Documentation is on the website. Please see it for details or
 158 visit: http://infobot.sourceforge.net/
 159
 160
 161 IRC
 162         If your looking to hang out on IRC, feel free. We can be found
 163 in the #infobot channel on irc.freenode.net. See you there!
 164
 165
 166 # vim:ts=4:sw=4:expandtab:tw=80