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 -ban: D: FIXME:
  60 -ban: U: ## <mask|user>
  61 -ban: E: ## *!*@owns.org
  62 -ban: E: ## MoronMan
  63
  64 +ban: D: FIXME:
  65 +ban: U: ## <mask|user> [chan] [time] [reason]
  66 +ban: E: ## *!*@owns.org #bots 60 stop flooding.
  67 +ban: E: ## *!*@*microsoft.com STOOPID
  68 +ban: E: ## MoronMan
  69
  70 -chan: D: Leave a channel permanently
  71 -chan: U: ## -#channel
  72 -chan: E: ## -#botpark
  73
  74 +chan: D: Join a channel permanently
  75 +chan: U: ## #channel
  76 +chan: E: ## #botpark
  77
  78 chaninfo: D: Display channel statistics on Op, Ban, Deop, Unban, Part, Join, SignOff, PublicMsg, Kick and Topic
  79 chaninfo: U: ## [#channel]
  80 chaninfo: E: ##
  81 chaninfo: E: ## #botpark
  82
  83 chanset: D: set a variable for a channel
  84 chanset: U: ## [#chan] [what] [val]
  85 chanset: E: ## #c +test
  86 chanset: E: ## #c -test
  87 chanset: E: ## #c test
  88 chanset: E: ## #c test testing123
  89
  90 chanunset: D: remove a variable from a channel
  91 chanunset: U: ## <#chan> [what]
  92 chanunset: E: ## #c
  93 chanunset: E: ## #c test
  94
  95 chattr: D: Change flags on a user (see @regFlagsUser in source)
  96 chattr: U: ## <user> [flags]
  97 chattr: E: ## bloot +nmo
  98 chattr: E: ## bloot -ot
  99 chattr: E: ## bloot
 100
 101 chnick: D: rename a nick (user) entry
 102 chnick: U: ## [nick] <new-nick>
 103 chnick: E: ## moron
 104 chnick: E: ## owner eleet
 105
 106 chpass: D: Change a user's password
 107 chpass: U: ## [user] <pass>
 108 chpass: E: ## testing
 109 chpass: E: ## testing test0R
 110
 111 contents: D: Debian Contents search only (no Packages)
 112 contents: U: ## <string> [dist]
 113 contents: E: ## strings.h
 114 contents: E: ## x11amp potato
 115
 116 cookie: I can feed your appetite with random factoids.
 117
 118 cpustats: cpustats dumps the bot's cpu usage this session
 119
 120 crypt: It's good that you thought about encryption. I can do it for you.
 121 crypt: U: ## <salt> <string>
 122 crypt: E: ## 69 changeme
 123
 124 cycle: D: Causes me to cycle in the channel it's said, or in the named channel
 125 cycle: U: ## [channel]
 126 cycle: E: ##
 127 cycle: E: ## #botpark
 128
 129 dauthor: D: Find Debian package maintainers, and list the packages they maintain
 130 dauthor: U: ## <string> [dist]
 131 dauthor: E: ## Wichert
 132 dauthor: E: ## Wichert potato
 133
 134 dbugs: D: Show the current count of release critical bugs (latest versions)
 135 dbugs: U: ##
 136
 137 ddesc: D: Search the Description: lines in Debian packages
 138 ddesc: U: ## <string> [dist]
 139 ddesc: E: ## mule
 140 ddesc: E: ## mule potato
 141
 142 dict: D: DICT Protocol Client
 143 dict: U: ## <query>
 144 dict: E: ## AI
 145 dict: E: ## 1 linux
 146
 147 dfind: D: Debian Packages (fallback to Contents) search
 148 dfind: U: ## <string> [dist]
 149 dfind: E: ## strings.h
 150 dfind: E: ## x11amp potato
 151
 152 dstats: D: Show basic stats on the current size of the Debian distros
 153 dstats: U: ## [dist]
 154 dstats: E: ##
 155 dstats: E: ## potato
 156
 157 factinfo: D: View statistical information about a particular factoid.
 158 factinfo: U: ## <factoid>
 159 factinfo: E: ## test
 160
 161 factstats: D: Display statistical data (max of 15) about factoids.
 162 factstats: U: ## <type>
 163 factstats: == author    -- top author of factoids.
 164 factstats: == deadredir -- ??
 165 factstats: == duplicate -- duplicate factoids.
 166 factstats: == listfix   -- ??
 167 factstats: == locked    -- locked factoids.
 168 factstats: == new       -- recent addition of factoids.
 169 factstats: == nullfactoids -- ??
 170 factstats: == partdupe  -- initial partial duplicate factoids.
 171 factstats: == profanity -- possibly offensive factoids.
 172 factstats: == redir     -- redirection in factoids.
 173 factstats: == reqrate   -- ??
 174 factstats: == requested -- most requested factoids.
 175 factstats: == requesters -- most requested factoids.
 176 factstats: == seefix    -- ??
 177 factstats: == toolong   -- factoid {key|value} exceeding specified length.
 178 factstats: == tooshort  -- factoid {key|value} shorter than specified length.
 179 factstats: == total     -- ??
 180 factstats: == unrequest -- unrequested factoids.
 181 factstats: == vandalism -- ??
 182 factstats: E: ## new
 183
 184 forget: If I have an old/redundant factoid x, "forget x" will cause me to erase it.
 185
 186 freshmeat: D: Frontend to www.freshmeat.net
 187 freshmeat: U: ## <query>
 188 freshmeat: E: ## blootbot
 189
 190 hex: D: Convert ascii to hex
 191 hex: U: ## <string>
 192 hex: E: ## carrot
 193
 194 httpdtype: D: Get httpd server software version / configuration
 195 httpdtype: U: ## <hostname>
 196 httpdtype: E: ## example.com
 197
 198 ignore: D: FIXME:
 199 ignore: E: ## [mask chan expire comment]
 200
 201 ircstats: ircstats dumps some status information on the bot's IRC connection
 202
 203 join: U: ## <#chan> [key]
 204 join: E: ## #botpark
 205 join: E: ## #botpark rules
 206
 207 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?"
 208
 209 kernel: D: Frontend to linux.kernel.org's finger response.
 210 kernel: U: ##
 211
 212 kick: U: ## <nick> [#chan] [message]
 213 kick: E: ## oznoid
 214 kick: E: ## larne #botpark
 215 kick: E: ## john #foo go away!
 216
 217 lart: D: Luser Attitude Readjustment Tool
 218 lart: U: ## [#chan] <who>
 219 lart: E: ## lenzo infobot's bugginess
 220 lart: E: ## #perl everyone perl \=\= lamerville
 221
 222 listauth: D: Search the factoid extension db by creator
 223 listauth: U: ## <search>
 224 listauth: E: ## xk
 225
 226 listkeys: D: Search the factoid database by key (factoid)
 227 listkeys: U: ## <regex>
 228 listkeys: E: ## blootbot
 229
 230 listvalues: D: Search the factoid database by value (description)
 231 listvalues: U: ## <regex>
 232 listvalues: E: ## blootbot
 233
 234 literal: used to get a raw factoid contents
 235 literal: U: ## <factoid>
 236 literal: E: ## blootbot
 237
 238 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
 239
 240 lock: D: Factoid locking to prevent removal by others
 241 lock: U: ## <factoid>
 242 lock: E: ## abuse
 243 lock: N: By default, only registered "ops" on the bots or factoids matching the user's nick are able to lock factoids.
 244 lock: N: Requires factoid extension (extra) support enabled.
 245
 246 mode: set modes for a channel
 247 mode: U: ## <#chan> <mode>
 248 mode: E: ## #botpark +t
 249 mode: E: ## #botpark -i
 250
 251 news: D: News functions
 252 news: U: ## [chan] <add,del,mod,set,latest,read,help>
 253
 254 news add: D: Add news items
 255 news add: U: news [chan] add <title>
 256 news add: E: news add This is a test
 257 news add: see _news set Text_ aswell
 258
 259 news set: D: Set stuff for news item
 260 news set: U: news [chan] set <item> <what> [value]
 261 news set:    valid <what>: Expire, Text
 262 news set: E: news set 1 Text ok, this works
 263 news set: E: news set test Text and this is a test
 264 news set: E: news set test Text
 265
 266 news set expire: D: Set expire for news item
 267 news set expire: U: news [chan] expire <what> <value>
 268 news set expire: value can be: Xd Xh Xm Xs
 269 news set expire: value can be: never
 270 news set expire: news expire 1 3days
 271 news set expire: news expire 2 +20d
 272 news set expire: news expire Test 30d 20h 10m 5s
 273 news set expire: news expire TEST never
 274
 275 news del: D: Delete news item (requires +o or be author)
 276 news del: U: news [chan] del <item>
 277 news del: E: news del 1
 278 news del: E: news del test
 279
 280 news mod: D: Modify a news item (todo: modify Text aswell)
 281 news mod: E: news [chan] mod <item> s/<from>/<to>/[g]
 282 news mod: E: news mod 1 s/test/Test/
 283 news mod: E: news mod test s/test/Test/g
 284
 285 nickometer: D: Measures the lame-ness of a nick or channel
 286 nickometer: U: ## {nick,channel}
 287 nickometer: E: ## unknown_lamer
 288 nickometer: E: ## #botpark
 289
 290 nslookup: D: Query DNS
 291 nslookup: U: ## <host|ip>
 292 nslookup: E: ## debian.org
 293 nslookup: E: ## 3.1.33.7
 294
 295 ord: D: Convert ascii to decimal
 296 ord: U: ## <single character>
 297 ord: E: ## c
 298
 299 part: D: Leave a channel (DCC only)
 300 part: U: ## <#channel>
 301 part: E: ## #botpark
 302 part: NOTE: /kick is an alternative
 303
 304 quote: D: Frontend to yahoo's online stock market share listing
 305 quote: U: ## <query...>
 306 quote: E: ## RHAT,MSFT
 307
 308 rename: D: Factoid renaming
 309 rename: U: ## 'from' 'to'
 310 rename: E: ## 'infobot' 'blootbot'
 311
 312 rot13: D: ROT13's the given string
 313 rot13: U: ## <string>
 314 rot13: E: ## guvf vf n ynzr rknzcyr
 315
 316 search: U: ## <engine> for <string>
 317 search: E: ## google for blootbot
 318
 319 seen: D: Report last seen time for somebody
 320 seen: U: ## <nick>
 321 seen: E: ## blootbot
 322
 323 slashdot: D: News for nerds, Stuff that matters. [tm] (shows the headlines)
 324 slashdot: U: ##
 325
 326 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.
 327
 328 status: status dumps general status information
 329
 330 tell: D: Tell someone about a factoid or command
 331 tell: U: tell <who> -?about <what>
 332 tell: E: tell me about blootbot
 333 tell: E: tell someone -about testing
 334
 335 topic add: D: Add your own topic
 336 topic add: U: ## <topic>
 337 topic add: E: ## This is a test
 338
 339 topic del: D: Delete one or two subtopics
 340 topic del: U: ## <#>
 341 topic del: E: ## 1
 342 topic del: E: ## 1-3,5
 343 topic del: E: ## last
 344
 345 topic mod: D: Search and replace strings in the topic
 346 topic mod: U: ## <REGEX>
 347 topic mod: E: s/test/TEST/
 348 topic mod: E: s#msg test#/msg test#g
 349
 350 topic mv: D: Move subtopics around.
 351 topic mv: U: ## <#> <before|after|swap> <#>
 352 topic mv: E: ## 1 after 2
 353 topic mv: E: ## first before last
 354
 355 topic restore: D: Restores the topic to an earlier version
 356 topic restore: U: ## <#>
 357 topic restore: E: ## 3
 358
 359 topic: Usage for 'topic [#chan] <params>':
 360 topic:   ---------------- __Subtopic__:
 361 topic:   add <TOPIC>    - Append <TOPIC> to topic.
 362 topic:   del <#>        - Remove subtopic <#> from topic.
 363 topic:   list           - Display subtopics.
 364 topic:   mod s/old/new/ - Search and replace topic.
 365 topic:   mv <ARGS>      - 'topic mv'.
 366 topic:   shuffle        - Randomly organize subtopics.
 367 topic:   ---------------- __Topic__
 368 topic:   history        - Show previous topics.
 369 topic:   restore <#>    - Restore topic to <#>.
 370 topic:   rehash         - Rehash changes to topic.
 371 topic:   info           - Who and time info.
 372 topic:   ---------------- __Misc__
 373 topic:   about          - Read the file :)
 374 topic:   help           - This screen.
 375
 376 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.
 377 topic: NOTE: commands can be preceeded? with '-' in order not to enforce changes to topic.
 378 topic: End of help.
 379
 380 unforget: If a factoid has been forgotten, "unforget x" will cause me to unerase it.
 381
 382 unlobotomy: Not possible in real life, an unlobotomy will bring me back to life in the case of a lobotomy.
 383
 384 unlock: D: Factoid unlocking to allow removal by others.
 385 unlock: U: ## <factoid>
 386 unlock: E: ## abuse
 387
 388 uptime: D: Show the current uptime, and the top 3 uptimes recorded
 389 uptime: U: ##
 390
 391 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).
 392
 393 -host: D: FIXME:
 394 -host: U: ## [user] <mask>
 395 -host: E: ## *!*@owns.org
 396 -host: E: ## owner leet!leet@*.heh.org
 397
 398 +host: D: FIXME:
 399 +host: U: ## [user] <mask>
 400 +host: E: ## *!*@owns.org
 401 +host: E: ## owner leet!leet@*.heh.org