use result div in babelfish

[infobot.git] / doc / USAGE

diff --git a/doc/USAGE b/doc/USAGE
index 9f19658119385ccd2279bebd099555981a484091..23786fee9982bc3d994f4417eb0e36382eca6a2d 100644 (file)
--- a/doc/USAGE
+++ b/doc/USAGE
@@ -1,14 +1,82 @@
-==========================================================================
-=      ===  ========     ====     ===        ==      ====     ===        =
-=  ===  ==  =======  ===  ==  ===  =====  =====  ===  ==  ===  =====  ====
-=      ===  =======  ===  ==  ===  =====  =====      ===  ===  =====  ====
-=  ===  ==  =======  ===  ==  ===  =====  =====  ===  ==  ===  =====  ====
-=      ===       ===     ====     ======  =====      ====     ======  ====
-==========================================================================
-
-                    ======================================
-                                USER COMMANDS
-                    ======================================
+# $Id$
+
+############
+# EXAMPLES #
+############
+
+DCC CHAT:
+.+chan #chan
+.chanset #chan +autojoin
+.chanset +autojoin
+.chanunset -autojoin
+.chanset -autojoin
+
+for list of configuration options, run:
+        ./scripts/findparam.pl
+
+
+=====
+<me> infobot: hex2ip aaBBcD12
+<infobot> me: AABBCD12 = 170.187.205.18 
+
+<me> infobot: test is testing
+<infobot> me: okay
+<me> infobot: testing?
+<infobot> testing is testing
+
+<me> infobot: tests is <REPLY> testing
+<infobot> me: okay
+<me> infobot: tests?
+<infobot> testing
+
+<me> infobot: cough is <ACTION> coughs
+<infobot> me: okay
+<me> infobot: cough
+* infobot/#infobot coughs
+
+<me> infobot: test is <REPLY> What's (one|two|three|four|five|six)
+       times (seven|eight|nine|ten|eleven|twelve)?
+<infobot> okay, me
+<me> infobot: test
+<infobot> What's four times nine?
+<me> infobot: test?
+<infobot> What's six times ten?
+
+<me> infobot: op me is <ACTION> Mode change "+o $nick" on channel
+       $channel by $ident
+<infobot> me: okay
+<me> infobot: op me
+* infobot/#debian-bots Mode change "+o me" on channel #infobot by
+       infobot
+
+<me> infobot: no who am i is <REPLY> You are $nick!$user@$host on
+       $channel.
+<infobot> okay, me
+<me> infobot: who am i
+<infobot> You are me!me@home.org on #infobot.
+
+<me> infobot: who last spoke is <REPLY> To my knowledge, $lastspeaker
+       was the last to say something worthwhile.
+<infobot> me: okay
+<me> infobot: who last spoke
+<infobot> To my knowledge, me was the last to say something worthwhile.
+
+<me> infobot: percentage is <REPLY> you are $randpercentage% lame
+<infobot> me: okay
+<me> infobot: percentage
+<infobot> you are 79% lame
+
+<me> infobot: slap $1 is <action> slaps $1
+<infobot> me: okay, me
+<me> infobot: slap Bob
+ * infobot slaps Bob
+<me> infobot: forget cmd: slap (.*?)
+<infobot> me: i forgot cmd: slap (.*?)
+
+
+#################
+# USER COMMANDS #
+#################
 
 Command: 4op
 =============
@@ -213,14 +281,14 @@ Usage:
        chanstats [#channel]
 
 Example:
-       > blootbot: chanstats
-       <blootbot> i am on 2 channels: #blootbot #debian
-       <blootbot> i've cached 5 users distributed over 2 channels.     
+       > infobot: chanstats
+       <infobot> i am on 2 channels: #infobot #debian
+       <infobot> i've cached 5 users distributed over 2 channels.      
 
-       > blootbot: chanstats #blootbot
-       <blootbot> On #blootbot, there have been 1 Join, 1 Op and 20
+       > infobot: chanstats #infobot
+       <infobot> On #infobot, there have been 1 Join, 1 Op and 20
                PublicMsgs.
-       <blootbot> At the moment, 3 Opped and 3 Total.
+       <infobot> At the moment, 3 Opped and 3 Total.
 
 
 Command: cmdstats
@@ -358,11 +426,11 @@ Usage:
        join <#channel>[,key]
 
 Example:
-       > blootbot: join #blootbot
-       [blootbot] joining #blootbot
-       *** join/#debian blootbot (xk@router.home.org)
-       > blootbot: join #blootbot
-       [blootbot] I'm already on #blootbot...
+       > infobot: join #infobot
+       [infobot] joining #infobot
+       *** join/#debian infobot (xk@router.home.org)
+       > infobot: join #infobot
+       [infobot] I'm already on #infobot...
 
 
 
@@ -623,9 +691,9 @@ Example: DOES NOT WORK
 
 
 
-                    ======================================
-                        MISCELLANEOUS/FACTOID COMMANDS
-                    ======================================
+##################################
+# MISCELLANEOUS/FACTOID COMMANDS #
+##################################
 
 Command: forget
 =============
@@ -686,7 +754,7 @@ Usage:
        $nick--
 
 Example:
-       blootbot++
+       infobot++
        infobot--