files/infobot.help

   1 # Revised: 20071016
   2 #  Author: Tim Riker <Tim@Rikers.org>
   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 "* infobot does the hokey-pokey"
   8
   9 alternation: The || symbol in an entry causes an infobot 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 (GMT)
  19 dollar variables: $day         - day of week (full name, locale)
  20 dollar variables: $factoids    - factoid count
  21 dollar variables: $host        - hostname of factoid requester
  22 dollar variables: $ident       - bot nick
  23 dollar variables: $lastspeaker - ...
  24 dollar variables: $memusage    - ...
  25 dollar variables: $rand        - random number, also $rand100.2
  26 dollar variables: $randnick    - random nick
  27 dollar variables: $startTime   - start time
  28 dollar variables: $time        - current time (GMT)
  29 dollar variables: $uptime      - ...
  30 dollar variables: $user        - username of factoid requester
  31 dollar variables: $who         - nick of factoid requester
  32
  33 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.
  34 corrections: you can append stuff to a factoid with "also". "x is also at ..."
  35
  36 math: D: math expresions can be evaluated. This uses Perl syntax.
  37 math: E: 1+1
  38 math: + - add
  39 math: - - subtract
  40 math: * - multiply
  41 math: / - division
  42 math: ** - to the power
  43 math: pi - pi
  44 math: & - and
  45 math: | = or
  46 math: ^ - xor
  47
  48 redirection: If a factoid x contains simply "<reply> see y", then when asked for x, I will deliver factoidor command result y instead.
  49
  50 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".
  51
  52 # now the commands...
  53
  54 adduser: D: Administrative command to add new user to the .users file
  55 adduser: U: ## <user> <mask>
  56 adduser: E: ## bloot bloot!bloot@example.com
  57
  58 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)
  59
  60 babelfish: D: Frontend to babelfish translating service provided by http://babelfish.altavista.com/ Note that utf8 is used for non-ascii characters.
  61 babelfish: U: x <fromLang> <toLang> <words>
  62 babelfish: U: translate <fromLang> <toLang> <words>
  63 babelfish: E: x en de your cars rock
  64
  65 -ban: D: FIXME:
  66 -ban: U: ## <mask|user>
  67 -ban: E: ## *!*@owns.org
  68 -ban: E: ## MoronMan
  69
  70 +ban: D: FIXME:
  71 +ban: U: ## <mask|user> [chan] [time] [reason]
  72 +ban: E: ## *!*@owns.org #bots 60 stop flooding.
  73 +ban: E: ## *!*@*microsoft.com STOOPID
  74 +ban: E: ## MoronMan
  75
  76 botmail: D: Send someone botmail
  77 botmail: U: ## {for <who>[:] <message>}|stats|check|read
  78 botmail: E: ## for infobot: you rock!
  79 botmail: E: ## stats
  80 botmail: E: ## check
  81 botmail: E: ## read
  82
  83 -chan: D: Leave a channel permanently
  84 -chan: U: ## -#channel
  85 -chan: E: ## -#botpark
  86
  87 +chan: D: Join a channel permanently
  88 +chan: U: ## #channel
  89 +chan: E: ## #botpark
  90
  91 chaninfo: D: Display channel statistics on Op, Ban, Deop, Unban, Part, Join, SignOff, PublicMsg, Kick and Topic
  92 chaninfo: U: ## [#channel]
  93 chaninfo: E: ##
  94 chaninfo: E: ## #botpark
  95
  96 chanset: D: set a variable for a channel
  97 chanset: U: ## [#chan] [what] [val]
  98 chanset: E: ## #c +test
  99 chanset: E: ## #c -test
 100 chanset: E: ## #c test
 101 chanset: E: ## #c test 0
 102 chanset: E: ## #c test testing123
 103
 104 chanunset: D: remove a variable from a channel
 105 chanunset: U: ## <#chan> [what]
 106 chanunset: E: ## #c
 107 chanunset: E: ## #c test
 108
 109 chattr: D: Change flags on a user (see "help flags")
 110 chattr: U: ## <user> [flags]
 111 chattr: E: ## bloot +nmo
 112 chattr: E: ## bloot -ot
 113 chattr: E: ## bloot
 114
 115 chnick: D: rename a nick (user) entry
 116 chnick: U: ## [nick] <new-nick>
 117 chnick: E: ## moron
 118 chnick: E: ## owner eleet
 119
 120 chpass: D: Change a user's password
 121 chpass: U: ## [user] <pass>
 122 chpass: E: ## testing
 123 chpass: E: ## testing test0R
 124
 125 contents: D: Debian Contents search only (no Packages)
 126 contents: U: ## <string> [dist]
 127 contents: E: ## strings.h
 128 contents: E: ## x11amp potato
 129
 130 cookie: I can feed your appetite with random factoids.
 131
 132 cpustats: cpustats dumps the bot's cpu usage this session
 133
 134 crypt: It's good that you thought about encryption. I can do it for you.
 135 crypt: U: ## <salt> <string>
 136 crypt: E: ## 69 changeme
 137 crypt: E: ## $1$abcde changeme
 138
 139 cycle: D: Causes me to cycle in the channel it's said, or in the named channel
 140 cycle: U: ## [channel]
 141 cycle: E: ##
 142 cycle: E: ## #botpark
 143
 144 dauthor: D: Find Debian package maintainers, and list the packages they maintain
 145 dauthor: U: ## <string> [dist]
 146 dauthor: E: ## Wichert
 147 dauthor: E: ## Wichert potato
 148
 149 dbugs: D: Show the current count of release critical bugs (latest versions)
 150 dbugs: U: ##
 151
 152 deluser: D: Administrative command to remove a user from the .users file
 153 deluser: U: ## <user>
 154 deluser: E: ## bloot
 155
 156 ddesc: D: Search the Description: lines in Debian packages
 157 ddesc: U: ## <string> [dist]
 158 ddesc: E: ## mule
 159 ddesc: E: ## mule potato
 160
 161 dfind: D: Debian Packages (fallback to Contents) search
 162 dfind: U: ## <string> [dist]
 163 dfind: E: ## strings.h
 164 dfind: E: ## x11amp potato
 165
 166 dict: D: DICT Protocol Client - likely dicts: elements web1913 wn gazetteer jargon foldoc easton hitchcock devils world02 vera
 167 dict: U: ## [entry num] <query>[/dict]
 168 dict: E: ## linux
 169 dict: E: ## 33 set/wn
 170
 171 dns: D: Query DNS
 172 dns: U: ## <host|ip>
 173 dns: E: ## debian.org
 174 dns: E: ## 3.1.33.7
 175
 176 do: D: operator command to do things in a channel
 177 do: U: ## <chan> <what>
 178
 179 dstats: D: Show basic stats on the current size of the Debian distros
 180 dstats: U: ## [dist]
 181 dstats: E: ##
 182 dstats: E: ## potato
 183
 184 factinfo: D: View statistical information about a particular factoid.
 185 factinfo: U: ## <factoid>
 186 factinfo: E: ## test
 187
 188 factstats: D: Display statistical data (max of 15) about factoids.
 189 factstats: U: ## <type>
 190 factstats: == author    -- top author of factoids.
 191 factstats: == deadredir -- ??
 192 factstats: == duplicate -- duplicate factoids.
 193 factstats: == listfix   -- ??
 194 factstats: == locked    -- locked factoids.
 195 factstats: == new       -- recent addition of factoids.
 196 factstats: == nullfactoids -- ??
 197 factstats: == partdupe  -- initial partial duplicate factoids.
 198 factstats: == profanity -- possibly offensive factoids.
 199 factstats: == redir     -- redirection in factoids.
 200 factstats: == reqrate   -- ??
 201 factstats: == requested -- most requested factoids.
 202 factstats: == requesters -- most requested factoids.
 203 factstats: == seefix    -- ??
 204 factstats: == toolong   -- factoid {key|value} exceeding specified length.
 205 factstats: == tooshort  -- factoid {key|value} shorter than specified length.
 206 factstats: == total     -- ??
 207 factstats: == unrequest -- unrequested factoids.
 208 factstats: == vandalism -- ??
 209 factstats: E: ## new
 210
 211 forget: If I have an old/redundant factoid x, "forget x" will cause me to erase it.
 212
 213 freshmeat: D: Frontend to www.freshmeat.net
 214 freshmeat: U: ## <query>
 215 freshmeat: E: ## infobot
 216
 217 hex: D: Convert ascii to hex
 218 hex: U: ## <string>
 219 hex: E: ## carrot
 220
 221 httpdtype: D: Get httpd server software version / configuration
 222 httpdtype: U: ## <hostname>
 223 httpdtype: E: ## example.com
 224
 225 ignore: D: ignore list management
 226 ignore: E: ## [mask chan expire comment]
 227 ignore: E: addignore guu!*@*
 228
 229 ircstats: ircstats dumps some status information on the bot's IRC connection
 230
 231 join: U: ## <#chan> [key]
 232 join: E: ## #botpark
 233 join: E: ## #botpark rules
 234
 235 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?"
 236
 237 kernel: D: Frontend to linux.kernel.org's finger response.
 238 kernel: U: ##
 239
 240 kick: U: ## <nick> [#chan] [message]
 241 kick: E: ## oznoid
 242 kick: E: ## larne #botpark
 243 kick: E: ## john #foo go away!
 244
 245 lart: D: Luser Attitude Readjustment Tool
 246 lart: U: ## [#chan] <who>
 247 lart: E: ## lenzo infobot's bugginess
 248 lart: E: ## #perl everyone perl \=\= lamerville
 249
 250 lc: D: lower case a given string
 251 lc: U: ## <string>
 252 lc: E: ## When will infobot achieve world domination?
 253
 254 listauth: D: Search the factoid extension db by creator
 255 listauth: U: ## <search>
 256 listauth: E: ## xk
 257
 258 listkeys: D: Search the factoid database by key (factoid)
 259 listkeys: U: ## <regex>
 260 listkeys: E: ## infobot
 261
 262 listvalues: D: Search the factoid database by value (description)
 263 listvalues: U: ## <regex>
 264 listvalues: E: ## infobot
 265
 266 literal: used to get a raw factoid contents. Use _default to ignore factoidSearch path.
 267 literal: U: ## [_default|prefix] <factoid>
 268 literal: E: ## infobot
 269
 270 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
 271
 272 lock: D: Factoid locking to prevent removal by others
 273 lock: U: ## <factoid>
 274 lock: E: ## abuse
 275 lock: N: By default, only registered "ops" on the bots or factoids matching the user's nick are able to lock factoids.
 276 lock: N: Requires factoid extension (extra) support enabled.
 277
 278 md5: D: calculates the md5sum of a given string
 279 md5: U: ## <string>
 280 md5: E: ## When will infobot achieve world domination?
 281
 282 mode: set modes for a channel
 283 mode: U: ## <#chan> <mode>
 284 mode: E: ## #botpark +t
 285 mode: E: ## #botpark -i
 286
 287 news: D: News functions
 288 news: U: ## [chan] <add,del,mod,set,latest,read,help>
 289
 290 news add: D: Add news items
 291 news add: U: news [chan] add <title>
 292 news add: E: news add This is a test
 293 news add: see _news set Text_ aswell
 294
 295 news set: D: Set stuff for news item
 296 news set: U: news [chan] set <item> <what> [value]
 297 news set:    valid <what>: Expire, Text
 298 news set: E: news set 1 Text ok, this works
 299 news set: E: news set test Text and this is a test
 300 news set: E: news set test Text
 301
 302 news set expire: D: Set expire for news item
 303 news set expire: U: news [chan] expire <what> <value>
 304 news set expire: value can be: Xd Xh Xm Xs
 305 news set expire: value can be: never
 306 news set expire: news expire 1 3days
 307 news set expire: news expire 2 +20d
 308 news set expire: news expire Test 30d 20h 10m 5s
 309 news set expire: news expire TEST never
 310
 311 news del: D: Delete news item (requires +o or be author)
 312 news del: U: news [chan] del <item>
 313 news del: E: news del 1
 314 news del: E: news del test
 315
 316 news mod: D: Modify a news item (todo: modify Text aswell)
 317 news mod: E: news [chan] mod <item> s/<from>/<to>/[g]
 318 news mod: E: news mod 1 s/test/Test/
 319 news mod: E: news mod test s/test/Test/g
 320
 321 nickometer: D: Measures the lame-ness of a nick or channel
 322 nickometer: U: ## {nick,channel}
 323 nickometer: E: ## unknown_lamer
 324 nickometer: E: ## #botpark
 325
 326 onjoin: D: get/set OnJoin message (needs chan option +OnJoin)
 327 onjoin: U: ## [#chan|_default] [-]<nick> [message]
 328 onjoin: E: ## infobot Hey! It's another infobot!
 329
 330 ord: D: Convert ascii to decimal
 331 ord: U: ## <single character>
 332 ord: E: ## c
 333
 334 page: D: Send someone a pager message
 335 page: U: ## <who> <message>
 336 page: E: ## infobot you rock!
 337 page: NOTE: this uses the "<who>'s pager" factoids for the From: and To: addresses of the format "example's pager" is "mailto:me@example.com"
 338
 339 part: D: Leave a channel (DCC only)
 340 part: U: ## <#channel>
 341 part: E: ## #botpark
 342 part: NOTE: /kick is an alternative
 343
 344 piglatin: D: translates english text into piglatin
 345 piglatin: U: ## <string>
 346 piglatin: E: ## When will infobot achieve world domination?
 347
 348 quote: D: Frontend to yahoo's online stock market share listing
 349 quote: U: ## <query...>
 350 quote: E: ## RHAT,MSFT
 351
 352 rename: D: Factoid renaming
 353 rename: U: ## 'from' 'to'
 354 rename: E: ## 'infobot' 'infobot'
 355
 356 reverse: D: reverses a given string
 357 reverse: U: ## <string>
 358 reverse: E: ## When will infobot achieve world domination?
 359
 360 rot13: D: ROT13's a given string
 361 rot13: U: ## <string>
 362 rot13: E: ## guvf vf n ynzr rknzcyr
 363
 364 say: D: operator command to say things in a channel
 365 say: U: ## <chan> <what>
 366
 367 scramble: D: scrambles a given string
 368 scramble: U: ## <string>
 369 scramble: E: ## When will infobot achieve world domination?
 370
 371 search: U: ## <engine> for <string>
 372 search: E: ## google for infobot
 373
 374 seen: D: Report last seen time for somebody
 375 seen: U: ## <nick>
 376 seen: E: ## infobot
 377
 378 slashdot: D: News for nerds, Stuff that matters. [tm] (shows the headlines)
 379 slashdot: U: ##
 380
 381 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.
 382
 383 status: status dumps general status information
 384
 385 tell: D: Tell someone about a factoid or command
 386 tell: U: ## <who> -?about <what>
 387 tell: E: ## me about infobot
 388 tell: E: ## someone -about testing
 389
 390 topic add: D: Add your own topic
 391 topic add: U: ## <topic>
 392 topic add: E: ## This is a test
 393
 394 topic del: D: Delete one or two subtopics
 395 topic del: U: ## <#>
 396 topic del: E: ## 1
 397 topic del: E: ## 1-3,5
 398 topic del: E: ## last
 399
 400 topic mod: D: Search and replace strings in the topic
 401 topic mod: U: ## <REGEX>
 402 topic mod: E: ## s/test/TEST/
 403 topic mod: E: ## s#msg test#/msg test#g
 404
 405 topic mv: D: Move subtopics around.
 406 topic mv: U: ## <#> <before|after|swap> <#>
 407 topic mv: E: ## 1 after 2
 408 topic mv: E: ## first before last
 409
 410 topic restore: D: Restores the topic to an earlier version
 411 topic restore: U: ## <#>
 412 topic restore: E: ## 3
 413
 414 topic: Usage for 'topic [#chan] <params>':
 415 topic:   ---------------- __Subtopic__:
 416 topic:   add <TOPIC>    - Append <TOPIC> to topic.
 417 topic:   del <#>        - Remove subtopic <#> from topic.
 418 topic:   list           - Display subtopics.
 419 topic:   mod s/old/new/ - Search and replace topic.
 420 topic:   mv <ARGS>      - 'topic mv'.
 421 topic:   shuffle        - Randomly organize subtopics.
 422 topic:   ---------------- __Topic__
 423 topic:   history        - Show previous topics.
 424 topic:   restore <#>    - Restore topic to <#>.
 425 topic:   rehash         - Rehash changes to topic.
 426 topic:   info           - Who and time info.
 427 topic:   ---------------- __Misc__
 428 topic:   about          - Read the file :)
 429 topic:   help           - This screen.
 430
 431 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.
 432 topic: NOTE: commands can be preceeded? with '-' in order not to enforce changes to topic.
 433 topic: End of help.
 434
 435 uc: D: upper case a given string
 436 uc: U: ## <string>
 437 uc: E: ## When will infobot achieve world domination?
 438
 439 unforget: If a factoid has been forgotten, "unforget x" will cause me to unerase it.
 440
 441 unlobotomy: Not possible in real life, an unlobotomy will bring me back to life in the case of a lobotomy.
 442
 443 unlock: D: Factoid unlocking to allow removal by others.
 444 unlock: U: ## <factoid>
 445 unlock: E: ## abuse
 446
 447 uptime: D: Show the current uptime, and the top 3 uptimes recorded
 448 uptime: U: ##
 449
 450 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).
 451
 452 wikipedia: D: Frontend to the Wikipedia at http://www.wikipedia.org/wiki/ Note that utf8 is used for non-ascii characters.
 453 wikipedia: U: ## <topic>
 454 wikipedia: U: wiki <topic>
 455 wikipedia: E: wiki irc
 456
 457 wtf: D: Interface to the BSD wtf command
 458 wtf: U: ## <abbreviation>
 459 wtf: E: ## iirc
 460
 461 -host: D: admin command to remove hostmask from a user account
 462 -host: U: ## [user] <mask>
 463 -host: E: ## *!*@owns.org
 464 -host: E: ## owner leet!leet@*.heh.org
 465
 466 +host: D: admin command to list or add hostmasks to a user account
 467 +host: U: ## [user] [<mask>]
 468 +host: E: ## owner
 469 +host: E: ## *!*@owns.org
 470 +host: E: ## owner leet!leet@*.heh.org
 471
 472 flags: D: Flags for chattr command
 473 flags: D: "A" - bot administration over /msg (default is only via DCC CHAT)
 474 flags: D: "O" - dynamic ops (as on channel). (automatic +o)
 475 flags: D: "T" - add topics.
 476 flags: D: "a" - ask/request factoid.
 477 flags: D: "m" - modify factoid. (includes renaming)
 478 flags: D: "n" - bot owner, can "reload"
 479 flags: D: "o" - master of bot (automatic +amrt)
 480 flags: D:        - can search on factoid strings shorter than 2 chars
 481 flags: D:        - can tell bot to join new channels
 482 flags: D:        - can [un]lock factoids
 483 flags: D: "r" - remove factoid.
 484 flags: D: "t" - teach/add factoid.
 485 flags: D: "s" - Bypass +silent on channels
 486
 487 rssfeeds: D: rssfeeds is used to control the RSS Feed tracking module
 488 rssfeeds: U: rssfeeds [command]
 489 rssfeeds: E: rssfeeds flush
 490 rssfeeds: D: flush - Will erase the cache file. (Must be chattr +o)
 491 rssfeeds: D: update - Force a manual update of the feeds. (Must be chattr +o)
 492
 493 # vim:ts=4:sw=4:expandtab:tw=80