* Removed old reference to chanServ_ops in docs

[infobot.git] / doc / USAGE

diff --git a/doc/USAGE b/doc/USAGE
index 9f19658119385ccd2279bebd099555981a484091..02b60efca194a0792665a2718128546b37730317 100644 (file)
--- a/doc/USAGE
+++ b/doc/USAGE
@@ -1,14 +1,79 @@
-==========================================================================
-=      ===  ========     ====     ===        ==      ====     ===        =
-=  ===  ==  =======  ===  ==  ===  =====  =====  ===  ==  ===  =====  ====
-=      ===  =======  ===  ==  ===  =====  =====      ===  ===  =====  ====
-=  ===  ==  =======  ===  ==  ===  =====  =====  ===  ==  ===  =====  ====
-=      ===       ===     ====     ======  =====      ====     ======  ====
-==========================================================================
-
-                    ======================================
-                                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> blootbot: test is testing
+<blootbot> me: okay
+<me> blootbot: testing?
+<blootbot> testing is testing
+
+<me> blootbot: tests is <REPLY> testing
+<blootbot> me: okay
+<me> blootbot: tests?
+<blootbot> testing
+
+<me> blootbot: cough is <ACTION> coughs
+<blootbot> me: okay
+<me> blootbot: cough
+* blootbot/#blootbot coughs
+
+<me> blootbot: test is <REPLY> What's (one|two|three|four|five|six)
+       times (seven|eight|nine|ten|eleven|twelve)?
+<blootbot> okay, me
+<me> blootbot: test
+<blootbot> What's four times nine?
+<me> blootbot: test?
+<blootbot> What's six times ten?
+
+<me> blootbot: op me is <ACTION> Mode change "+o $nick" on channel
+       $channel by $ident
+<blootbot> me: okay
+<me> blootbot: op me
+* blootbot/#debian-bots Mode change "+o me" on channel #blootbot by
+       blootbot
+
+<me> blootbot: no who am i is <REPLY> You are $nick!$user@$host on
+       $channel.
+<blootbot> okay, me
+<me> blootbot: who am i
+<blootbot> You are me!me@home.org on #blootbot.
+
+<me> blootbot: who last spoke is <REPLY> To my knowledge, $lastspeaker
+       was the last to say something worthwhile.
+<blootbot> me: okay
+<me> blootbot: who last spoke
+<blootbot> To my knowledge, me was the last to say something worthwhile.
+
+<me> blootbot: percentage is <REPLY> you are $randpercentage% lame
+<blootbot> me: okay
+<me> blootbot: percentage
+<blootbot> you are 79% lame
+
+<me> blootbot: slap $1 is <action> slaps $1
+<blootbot> me: okay, me
+<me> blootbot: slap Bob
+ * blootbot slaps Bob
+<me> blootbot: forget cmd: slap (.*?)
+<blootbot> me: i forgot cmd: slap (.*?)
+
+
+#################
+# USER COMMANDS #
+#################
 
 Command: 4op
 =============
@@ -623,9 +688,9 @@ Example: DOES NOT WORK
 
 
 
-                    ======================================
-                        MISCELLANEOUS/FACTOID COMMANDS
-                    ======================================
+##################################
+# MISCELLANEOUS/FACTOID COMMANDS #
+##################################
 
 Command: forget
 =============