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