files/infobot.help

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