README

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