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
  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) (NOTE: Currently broken)
  26         * Slashdot, Kernel, RSS and Freshmeat auto-update announcements
  27         * Units conversion (provided by external "units" program)
  28
  29
  30 DESIGN
  31         - Modularity. Ability to disable IRC or Factoid support
  32         - Funky pseudo Module autoloader support
  33         - Modules called via Forker() to avoid blocking
  34     - Non blocking logs
  35     - Seen data periodicaly flushed for efficiency
  36
  37
  38 HISTORY
  39         As of 0.99pre1, blootbot supports mysql database in the hope to
  40 increase performance and to avoid borked over dbm's which occurred when
  41 the bot crashed (??). The mysql code is far larger (or perhaps twice
  42 as many functions) than expected even though a few functions were needed
  43 for DBM due to lack of table deficiencies.
  44
  45         As of 1.0.0pre1, blootbot takes advantage of Net::IRC. The
  46 change over was fairly comfortable (95% clean). Just minor problems here
  47 and there, mostly debugging and getting it right.
  48
  49         As of 1.0.0RC2, the old style DBM (Berkeley) has been ported
  50 back. It should work in all but 3 specific (countdown, factstats unreq)
  51 cases. preliminary pgsql support has been added but someone with pgperl
  52 knowledge needs to fix it up or at least unify the module with mysql.
  53
  54         As of 1.5.0, blootbot was rebranded back to infobot.
  55
  56
  57 INSTALLATION
  58   - Read the included INSTALL file
  59
  60
  61 NOTICE
  62         Be warned that this bot consumes quite a lot of memory upon start
  63 up and during usage. Right now, 7.4megs is used for old'ish perl, 8.3megs
  64 with perl 5.005. fork() is used but don't be alarmed at the memory usage
  65 as fork(), as I was told, uses COW (copy on write).
  66
  67         WARNING: enabling wingate support may involve complaints of some
  68 sort, probably because the telnet connection isn't closed properly.
  69 However, these people do not realize the potential of open wingates.
  70
  71         Please beta test it and report bugs as I have not had the time to
  72 test all modifications properly (and extensively).  Suggestions are
  73 welcomed.
  74
  75
  76 MODIFICATIONS
  77         All modifications are that of the blootbot author unless otherwise
  78 specified, like none.  See 'ChangeLog' for details.  A list of future
  79 features listed in 'TODO'.
  80
  81         See 'USAGE' for complete list of commands with description
  82 (FIXME) and examples (FIXME).  Yes, it is incomplete.  It is better for
  83 you to find the cookies than for me to hand-feed them to you ;)
  84
  85         See 'EXAMPLES' for various usage of factoids and "hidden"
  86 variables.  If you're hardcore, check out 'CommandStubs.pl' and
  87 'UserExtras.pl' for cool features.
  88
  89         topic [help]            - Topic help.
  90         topic add <topic>       - Append <topic> to the current topic.
  91         topic del <#>           - Purge topic ID <#> from current topic.
  92         topic list              - List broken down summary of current topic.
  93         topic mod s/old/new/    - Modify the topic using regex.
  94                                 - Now supports , and # as delimiters.
  95         topic mv <1> <type> <2> - <type>:
  96                                         before - Move <1> before <2>
  97                                         after  - Move <1> after <2>
  98                                         swap   - Swap <1> and <2>
  99         topic shuffle           - Jumble the subtopics.
 100
 101         topic history           - Show previous channel topics.
 102         topic restore <#>       - Restore channel topic to <#> on history
 103                                   #list.
 104
 105 ==> Individual commands: NEW
 106         (lobotomy|bequiet)      -- [o] silence the bot.
 107         (unlobotomy|benoisy)    -- [o] unsilence the bot.
 108
 109         set <param> <value>     -- ...
 110         unset <param>           -- ...
 111
 112
 113 NOTES
 114         To administrate/control the bot remotely, this can only be done
 115 through DCC CHAT. /chat <BOT NICK>.  All commands must be prepended by
 116 '.' otherwise it is sent to the bot chat net
 117
 118
 119 UNTESTED:
 120         - user statistics shown by 'seen'.
 121         - User Information Services.
 122         - new wingate caching/file-read code.
 123         - disabling IRC/factoid support code.
 124         - PGSql support needs to be more 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@freenode 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@freenode sent a patch to clean up behaviour of factoids
 140 (adding, removing, modifying).  Thanks.
 141
 142
 143 CONTACT
 144         Contributions of a patch, or anything, can be sent to
 145 <infobot-devel@lists.sourceforge.net>
 146
 147 Some Documentation is on the website. Please see it for details or
 148 visit: http://infobot.sourceforge.net/
 149
 150
 151 IRC
 152         If your looking to hang out on IRC, feel free. We can be found
 153 in the #infobot channel on irc.freenode.net. See you there!
 154
 155
 156 # vim:ts=4:sw=4:expandtab:tw=80