files/blootbot.help

   1 # Revised: 19991109.
   2 #  Author: xk
   3 ###
   4
   5 main: I learn mainly by observing declarative statements such as "x is at http://www.xxx.com", and then reply when people ask things like "where can i find x?"
   6
   7 action: This is used to override the usual response. "x is <action> does the hokey-pokey". When asked about x, the bot does this "* blootbot does the hokey-pokey"
   8
   9 alternation: The || symbol in an entry causes an blootbot to choose one of the replies at random. "X is Y||Z" will produce "X is Y" or "X is Z" randomly.
  10
  11 author: oznoid (mailto:lenzo@ri.cmu.edu) is my original author.
  12
  13 dollar variables: D: To be used in factoids
  14 dollar variables: $Fdunno      - ...
  15 dollar variables: $Fquestion   - ...
  16 dollar variables: $Fupdate     - ...
  17 dollar variables: $channel     - channel from which the factoid was requested
  18 dollar variables: $date        - current date
  19 dollar variables: $factoids    - factoid count
  20 dollar variables: $host        - hostname of factoid requester
  21 dollar variables: $ident       - bot nick
  22 dollar variables: $lastspeaker - ...
  23 dollar variables: $memusage    - ...
  24 dollar variables: $rand        - random number, also $rand100.2
  25 dollar variables: $randnick    - random nick
  26 dollar variables: $startTime   - start time
  27 dollar variables: $time        - current time
  28 dollar variables: $uptime      - ...
  29 dollar variables: $user        - username of factoid requester
  30 dollar variables: $who         - nick of factoid requester
  31
  32 corrections: If I come back with "...but x is at http://xx.xx.xx" or something like that, and you want to change the entry, use "no, x is at http://sdfsdfsdf".  The "No," tells me to supercede the existing value.
  33 corrections: you can append stuff to a factoid with "also". "x is also at ..."
  34
  35 math: D: math expresions can be evaluated. This uses Perl syntax.
  36 math: E: 1+1
  37 math: + - add
  38 math: - - subtract
  39 math: * - multiply
  40 math: / - division
  41 math: ** - to the power
  42 math: pi - pi
  43 math: & - and
  44 math: | = or
  45 math: ^ - xor
  46
  47 redirection: If a factoid x contains simply "<reply> see y", then when asked for x, I will deliver factoidor command result y instead.
  48
  49 reply: There is a special tag, <reply>, that is used to override the usual response.  Usually, a response is "X is Y", but it can be made "Y" by making the entry "X is <reply> Y".
  50
  51 # now the commands...
  52 addressing: It is a good idea if I stay in REQUIRE mode so that I won't yell out random crap if I listen in too hard.  Currently there is no way to turn this off on-the-fly. (REQUIRE mode requires me to be addressed by name if I am to respond)
  53
  54 babelfish: D: Frontend to babelfish translating service provided by http://babelfish.altavista.com/ Note that utf8 is used for non-ascii characters.
  55 babelfish: U: x <fromLang> <toLang> <words>
  56 babelfish: U: translate <fromLang> <toLang> <words>
  57 babelfish: E: x en de your cars rock
  58
  59 chaninfo: D: Display channel statistics on Op, Ban, Deop, Unban, Part, Join, SignOff, PublicMsg, Kick and Topic
  60 chaninfo: U: ## [#channel]
  61 chaninfo: E: ##
  62 chaninfo: E: ## #debian
  63
  64 chanset: D: set a variable for a channel
  65 chanset: U: ## [#chan] [what] [val]
  66 chanset: E: ## #c +test
  67 chanset: E: ## #c -test
  68 chanset: E: ## #c test
  69 chanset: E: ## #c test testing123
  70
  71 chanunset: D: remove a variable from a channel
  72 chanunset: U: ## <#chan> [what]
  73 chanunset: E: ## #c
  74 chanunset: E: ## #c test
  75
  76 chattr: D: Change flags on a user
  77 chattr: U: ## <user> [flags]
  78 chattr: E: ## bloot +nmo
  79 chattr: E: ## bloot -ot
  80 chattr: E: ## bloot
  81
  82 chnick: D: rename a nick (user) entry
  83 chnick: U: ## [nick] <new-nick>
  84 chnick: E: ## moron
  85 chnick: E: ## owner eleet
  86
  87 chpass: D: Change a user's password
  88 chpass: U: ## [user] <pass>
  89 chpass: E: ## testing
  90 chpass: E: ## testing test0R
  91
  92 contents: D: Debian Contents search only (no Packages)
  93 contents: U: ## <string> [dist]
  94 contents: E: ## strings.h
  95 contents: E: ## x11amp potato
  96
  97 cookie: I can feed your appetite with random factoids.
  98
  99 cpustats: cpustats dumps the bot's cpu usage this session
 100
 101 crypt: It's good that you thought about encryption. I can do it for you.
 102 crypt: U: ## <salt> <string>
 103 crypt: E: ## 69 changeme
 104
 105 cycle: D: Causes me to cycle in the channel it's said, or in the named channel
 106 cycle: U: ## [channel]
 107 cycle: E: ##
 108 cycle: E: ## #debian-bots
 109
 110 dauthor: D: Find Debian package maintainers, and list the packages they maintain
 111 dauthor: U: ## <string> [dist]
 112 dauthor: E: ## Wichert
 113 dauthor: E: ## Wichert potato
 114
 115 dbugs: D: Show the current count of release critical bugs (latest versions)
 116 dbugs: U: ##
 117
 118 ddesc: D: Search the Description: lines in Debian packages
 119 ddesc: U: ## <string> [dist]
 120 ddesc: E: ## mule
 121 ddesc: E: ## mule potato
 122
 123 dict: D: DICT Protocol Client
 124 dict: U: ## <query>
 125 dict: E: ## AI
 126 dict: E: ## 1 linux
 127
 128 dfind: D: Debian Packages (fallback to Contents) search
 129 dfind: U: ## <string> [dist]
 130 dfind: E: ## strings.h
 131 dfind: E: ## x11amp potato
 132
 133 dstats: D: Show basic stats on the current size of the Debian distros
 134 dstats: U: ## [dist]
 135 dstats: E: ##
 136 dstats: E: ## potato
 137
 138 factinfo: D: View statistical information about a particular factoid.
 139 factinfo: U: ## <factoid>
 140 factinfo: E: ## test
 141
 142 factstats: D: Display statistical data (max of 15) about factoids.
 143 factstats: U: ## <type>
 144 factstats: == author    -- top author of factoids.
 145 factstats: == deadredir -- ??
 146 factstats: == duplicate -- duplicate factoids.
 147 factstats: == listfix   -- ??
 148 factstats: == locked    -- locked factoids.
 149 factstats: == new       -- recent addition of factoids.
 150 factstats: == nullfactoids -- ??
 151 factstats: == partdupe  -- initial partial duplicate factoids.
 152 factstats: == profanity -- possibly offensive factoids.
 153 factstats: == redir     -- redirection in factoids.
 154 factstats: == reqrate   -- ??
 155 factstats: == requested -- most requested factoids.
 156 factstats: == requesters -- most requested factoids.
 157 factstats: == seefix    -- ??
 158 factstats: == toolong   -- factoid {key|value} exceeding specified length.
 159 factstats: == tooshort  -- factoid {key|value} shorter than specified length.
 160 factstats: == total     -- ??
 161 factstats: == unrequest -- unrequested factoids.
 162 factstats: == vandalism -- ??
 163 factstats: E: ## new
 164
 165 forget: If I have an old/redundant factoid x, "forget x" will cause me to erase it.
 166
 167 freshmeat: D: Frontend to www.freshmeat.net
 168 freshmeat: U: ## <query>
 169 freshmeat: E: ## blootbot
 170
 171 hex: D: Convert ascii to hex
 172 hex: U: ## <string>
 173 hex: E: ## carrot
 174
 175 ignore: D: FIXME
 176 ignore: E: ## [mask chan expire comment]
 177
 178 ircstats: ircstats dumps some status information on the bot's IRC connection
 179
 180 join: U: ## <#chan> [key]
 181 join: E: ## #debian
 182 join: E: ## #debian rules
 183
 184 karma: Karma is a community rating system.  Use "X++" to increase the karma, or "X--" to decrease it.  Ask for ratings using "karma for X?"
 185
 186 kernel: D: Frontend to linux.kernel.org's finger response.
 187 kernel: U: ##
 188
 189 kick: U: ## <nick> [#chan] [message]
 190 kick: E: ## oznoid
 191 kick: E: ## larne #debian
 192 kick: E: ## john #foo go away!
 193
 194 lart: D: Luser Attitude Readjustment Tool
 195 lart: U: ## [#chan] <who>
 196 lart: E: ## lenzo infobot's bugginess
 197 lart: E: ## #perl everyone perl \=\= lamerville
 198
 199 listauth: D: Search the factoid extension db by creator
 200 listauth: U: ## <search>
 201 listauth: E: ## xk
 202
 203 listkeys: D: Search the factoid database by key (factoid)
 204 listkeys: U: ## <regex>
 205 listkeys: E: ## blootbot
 206
 207 listvalues: D: Search the factoid database by value (description)
 208 listvalues: U: ## <regex>
 209 listvalues: E: ## blootbot
 210
 211 literal: used to get a raw factoid contents
 212 literal: U: ## <factoid>
 213 literal: E: ## blootbot
 214
 215 lobotomy: I can be given a lobotomy ([o] is required) if people start to abuse me.  To bring me back to life, give me an unlobotomy
 216
 217 lock: D: Factoid locking to prevent removal by others
 218 lock: U: ## <factoid>
 219 lock: E: ## abuse
 220 lock: N: By default, only registered "ops" on the bots or factoids matching the user's nick are able to lock factoids.
 221 lock: N: Requires factoid extension (extra) support enabled.
 222
 223 mode: set modes for a channel
 224 mode: U: ## <#chan> <mode>
 225 mode: E: ## #debian +t
 226 mode: E: ## #debian -i
 227
 228 news: D: News functions
 229 news: U: ## [chan] <add,del,mod,set,latest,read,help>
 230
 231 news add: D: Add news items
 232 news add: U: news [chan] add <title>
 233 news add: E: news add This is a test
 234 news add: see _news set Text_ aswell
 235
 236 news set: D: Set stuff for news item
 237 news set: U: news [chan] set <item> <what> [value]
 238 news set:    valid <what>: Expire, Text
 239 news set: E: news set 1 Text ok, this works
 240 news set: E: news set test Text and this is a test
 241 news set: E: news set test Text
 242
 243 news set expire: D: Set expire for news item
 244 news set expire: U: news [chan] expire <what> <value>
 245 news set expire: value can be: Xd Xh Xm Xs
 246 news set expire: value can be: never
 247 news set expire: news expire 1 3days
 248 news set expire: news expire 2 +20d
 249 news set expire: news expire Test 30d 20h 10m 5s
 250 news set expire: news expire TEST never
 251
 252 news del: D: Delete news item (requires +o or be author)
 253 news del: U: news [chan] del <item>
 254 news del: E: news del 1
 255 news del: E: news del test
 256
 257 news mod: D: Modify a news item (todo: modify Text aswell)
 258 news mod: E: news [chan] mod <item> s/<from>/<to>/[g]
 259 news mod: E: news mod 1 s/test/Test/
 260 news mod: E: news mod test s/test/Test/g
 261
 262 nickometer: D: Measures the lame-ness of a nick or channel
 263 nickometer: U: ## {nick,channel}
 264 nickometer: E: ## unknown_lamer
 265 nickometer: E: ## #debian-bots
 266
 267 nslookup: D: Query DNS
 268 nslookup: U: ## <host|ip>
 269 nslookup: E: ## debian.org
 270 nslookup: E: ## 3.1.33.7
 271
 272 ord: D: Convert ascii to decimal
 273 ord: U: ## <single character>
 274 ord: E: ## c
 275
 276 part: D: Leave a channel (DCC only)
 277 part: U: ## <#channel>
 278 part: E: ## #debian
 279 part: NOTE: /kick is an alternative
 280
 281 quote: D: Frontend to yahoo's online stock market share listing
 282 quote: U: ## <query...>
 283 quote: E: ## RHAT,MSFT
 284
 285 rename: D: Factoid renaming
 286 rename: U: ## 'from' 'to'
 287 rename: E: ## 'infobot' 'blootbot'
 288
 289 rot13: D: ROT13's the given string
 290 rot13: U: ## <string>
 291 rot13: E: ## guvf vf n ynzr rknzcyr
 292
 293 search: U: ## <engine> for <string>
 294 search: E: ## google for blootbot
 295
 296 seen: D: Report last seen time for somebody
 297 seen: U: ## <nick>
 298 seen: E: ## blootbot
 299
 300 slashdot: D: News for nerds, Stuff that matters. [tm] (shows the headlines)
 301 slashdot: U: ##
 302
 303 spell: You've guessed it right, I'm a spell checker. Give me any word and I can confirm whether it's good or bad.
 304
 305 status: status dumps general status information
 306
 307 tell: D: Tell someone about a factoid or command
 308 tell: U: tell <who> -?about <what>
 309 tell: E: tell me about blootbot
 310 tell: E: tell someone -about testing
 311
 312 topic add: D: Add your own topic
 313 topic add: U: ## <topic>
 314 topic add: E: ## This is a test
 315
 316 topic del: D: Delete one or two subtopics
 317 topic del: U: ## <#>
 318 topic del: E: ## 1
 319 topic del: E: ## 1-3,5
 320 topic del: E: ## last
 321
 322 topic mod: D: Search and replace strings in the topic
 323 topic mod: U: ## <REGEX>
 324 topic mod: E: s/test/TEST/
 325 topic mod: E: s#msg test#/msg test#g
 326
 327 topic mv: D: Move subtopics around.
 328 topic mv: U: ## <#> <before|after|swap> <#>
 329 topic mv: E: ## 1 after 2
 330 topic mv: E: ## first before last
 331
 332 topic restore: D: Restores the topic to an earlier version
 333 topic restore: U: ## <#>
 334 topic restore: E: ## 3
 335
 336 topic: Usage for 'topic [#chan] <params>':
 337 topic:   ---------------- __Subtopic__:
 338 topic:   add <TOPIC>    - Append <TOPIC> to topic.
 339 topic:   del <#>        - Remove subtopic <#> from topic.
 340 topic:   list           - Display subtopics.
 341 topic:   mod s/old/new/ - Search and replace topic.
 342 topic:   mv <ARGS>      - 'topic mv'.
 343 topic:   shuffle        - Randomly organize subtopics.
 344 topic:   ---------------- __Topic__
 345 topic:   history        - Show previous topics.
 346 topic:   restore <#>    - Restore topic to <#>.
 347 topic:   rehash         - Rehash changes to topic.
 348 topic:   info           - Who and time info.
 349 topic:   ---------------- __Misc__
 350 topic:   about          - Read the file :)
 351 topic:   help           - This screen.
 352
 353 topic: NOTE: #chan arg is only required if command is sent over private message to nick, otherwise it is not needed if sent to the channel.
 354 topic: NOTE: commands can be preceeded? with '-' in order not to enforce changes to topic.
 355 topic: End of help.
 356
 357 unforget: If a factoid has been forgotten, "unforget x" will cause me to unerase it.
 358
 359 unlobotomy: Not possible in real life, an unlobotomy will bring me back to life in the case of a lobotomy.
 360
 361 unlock: D: Factoid unlocking to allow removal by others.
 362 unlock: U: ## <factoid>
 363 unlock: E: ## abuse
 364
 365 uptime: D: Show the current uptime, and the top 3 uptimes recorded
 366 uptime: U: ##
 367
 368 wantnick: If someone's taken my nick (I hope not) and I'm using some temporary nick, I can change back to my original nick if it's not taken (again).
 369
 370 -ban: D: FIXME.
 371 -ban: U: ## <mask|user>
 372 -ban: E: ## *!*@owns.org
 373 -ban: E: ## MoronMan
 374
 375 -host: D: FIXME.
 376 -host: U: ## [user] <mask>
 377 -host: E: ## *!*@owns.org
 378 -host: E: ## owner leet!leet@*.heh.org
 379
 380 +ban: D: FIXME.
 381 +ban: U: ## <mask|user> [chan] [time] [reason]
 382 +ban: E: ## *!*@owns.org #bots 60 stop flooding.
 383 +ban: E: ## *!*@*microsoft.com STOOPID
 384 +ban: E: ## MoronMan
 385
 386 +host: D: FIXME.
 387 +host: U: ## [user] <mask>
 388 +host: E: ## *!*@owns.org
 389 +host: E: ## owner leet!leet@*.heh.org