Changeset 2385:6520238f85ea for doc

Timestamp:

09/14/08 22:03:13 (4 months ago)

Author:

dunker@…

Branch:

default

Message:

last part of core plugins docs

Location:

doc/plugins

Files:

• UPGRADE (modified) (2 diffs)
• USER (modified) (23 diffs)
• USERSTATE (modified) (5 diffs)

doc/plugins/UPGRADE

@@ -10 +10 @@
 :author:  Bart Thate <bthate@gmail.com>
 :contact: IRCNET/#dunkbots
-:website: http://plugins.gozerbot.org
+:distribution: core
 :license: Public Domain
  
@@ -30 +30 @@
 | 
 
+1) *upgrade*
 
-1) upgrade
+    :description: do a svn or mercurial upgrade
 
-    do a svn or mercurial upgrade
+    :permissions: OPER .. UPGRADE
+
+    :examples:
 
     ::
 
         <user> !upgrade
-        <output> upgrading from revision 2160 .. no changes
+        <output> upgrading from revision 2384 .. no changes
+2) *upgrade-hg*
 
-3) upgrade-hg
+    :description: do a mercurial upgrade
 
-    do a mercurial upgrade
+    :permissions: OPER .. UPGRADE
+
+    :examples:
 
     ::
 
         <user> !upgrade-hg
-        <output> upgrading from revision 2160 .. no changes
+        <output> upgrading from revision 2384 .. no changes
+3) *upgrade-loud*
 
-3) upgrade-loud
+    :description: do a svn or mercurial upgrade
 
-    do a svn or mercurial upgrade
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !upgrade-loud
-        <output> upgrading from revision 2160 .. no changes
+        <output> upgrading from revision 2384 .. no changes
+4) *upgrade-svn*
 
-3) upgrade-svn
+    :description: upgrade the bot with svn
 
-    upgrade the bot with svn
+    :permissions: OPER .. UPGRADE
+
+    :examples:
 
     ::

doc/plugins/USER

@@ -10 +10 @@
 :author:  Bart Thate <bthate@gmail.com>
 :contact: IRCNET/#dunkbots
-:website: http://plugins.gozerbot.org
+:distribution: core
 :license: Public Domain
  
@@ -31 +31 @@
 | 
 
-
-1) user-add
-
-    user-add <name> <userhost> .. add <name> with <userhost> to the bot
+1) *user-add*
+
+    :description: user-add <name> <userhost> .. add <name> with <userhost> to the bot
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -40 +43 @@
         <user> !user-add dunker bart@localhost
         <output> dunker added to user database
-
-3) user-addperm (setperms)
-
-    add permission to user <name>
+2) *user-addperm (setperms)*
+
+    :description: add permission to user <name>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -49 +55 @@
         <user> !user-addperm dunker rss
         <output> RSS perm added
-
-3) user-addpermall
-
-    user-addpermall <perm> .. add <permission> to all users
+3) *user-addpermall*
+
+    :description: user-addpermall <perm> .. add <permission> to all users
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -58 +67 @@
         <user> !user-addpermall USER
         <output> USER perm added
-
-3) user-addpermit
-
-    user-addpermit <nick> <what> .. permit nick access to <what> .. use setperms to add permissions
+4) *user-addpermit (addpermit)*
+
+    :description: user-addpermit <nick> <what> .. permit nick access to <what> .. use setperms to add permissions
+
+    :permissions: USER
+
+    :examples:
 
     ::
 
         <user> !user-addpermit dunker todo
-        <output> dunker is already allowed to do todo
-
-3) user-addstatus (setstatus)
-
-    user-addstatus <name> <status>
+        <output> permit added
+5) *user-addstatus (setstatus)*
+
+    :description: user-addstatus <name> <status>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -76 +91 @@
         <user> !user-addstatus dunker #bartbot
         <output> #BARTBOT status added
-
-3) user-adduserhost (adduserhost)
-
-    user-adduserhost <name> <userhost> .. add <userhost> to userhosts of <name>
+6) *user-adduserhost (adduserhost)*
+
+    :description: user-adduserhost <name> <userhost> .. add <userhost> to userhosts of <name>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -85 +103 @@
         <user> !user-adduserhost dunker bart?@*.a2000.nl
         <output> userhost added
-
-3) user-allperm
-
-    user-allperm <perm> .. get users with <perm> permission
+7) *user-allperm*
+
+    :description: user-allperm <perm> .. get users with <perm> permission
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-allperm rss
-        <output> dunker
-
-3) user-allstatus
-
-    user-allstatus <status> ..get users with <status> status
+        <output> owner .. jink .. snufj .. tehmaze .. dunker
+8) *user-allstatus*
+
+    :description: user-allstatus <status> ..get users with <status> status
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-allstatus #dunkbots
-        <output> no users with #DUNKBOTS status found
-
-3) user-check (check)
-
-    user-check <nick>
+        <output> owner .. bruutipv6 .. lotjuh .. koor .. laagje .. bsod`
+        <output>  .. aim_ .. michiel` .. antarez .. finalx .. markdark
+        <output>  .. jejfafke .. cmdr_sm .. snore .. kgb_ .. madeddie
+        <output>  .. shortguy .. speeksel .. rexodus .. borretje ..
+        <output>  qqa .. habbie .. ircmanz .. jink .. snufj .. grootmoeder
+        <output>  .. vortexbot .. dulla .. nomadz .. dromertje .. liev
+        <output>  .. jonas .. timp .. li-la .. _orange .. tehmaze ..
+        <output>  ]v[ .. djmuggs .. arcangel .. berend .. hztux .. sendog
+        <output>  .. derx .. vieke .. trbs .. ddb .. useloss .. rad1x
+        <output>  .. noa .. barbaar .. wouzer .. gozertje .. langhaar
+         - output trunked -
+9) *user-check (check)*
+
+    :description: user-check <nick>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-check dunker
-        <output> userrecord = name: dunker userhosts: ['bart@gozerbot.org',
-        <output>  'bart?@*.a2000.nl'] perms: ['USER', 'RSS', 'USER']
-        <output>  email: bart@gozerbot.org status: ['#BARTBOT'] allowed:
-        <output>  [] notallowed: [] tempusershosts: [] permit: []
-
-6) user-delemail (delemail)
-
-    reset email
+        <output> can't find user for bart@gozerbot.org
+10) *user-delemail (delemail)*
+
+    :description: reset email
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -124 +161 @@
         <user> !user-delemail
         <output> email removed
-
-3) user-delperm
-
-    user-delperm <name> <perm> .. delete from user <name> permission <perm>
+11) *user-delperm*
+
+    :description: user-delperm <name> <perm> .. delete from user <name> permission <perm>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -133 +173 @@
         <user> !user-delperm dunker rss
         <output> RSS perm removed
-
-3) user-delpermall
-
-    user-delpermall <perm> .. delete <permission> from all users
+12) *user-delpermall*
+
+    :description: user-delpermall <perm> .. delete <permission> from all users
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -142 +185 @@
         <user> !user-delpersall BLA
         <output> none
-
-4) user-delpermit
-
-    user-delpermit <name> <permit>
+13) *user-delpermit*
+
+    :description: user-delpermit <name> <permit>
+
+    :permissions: USER
+
+    :examples:
 
     ::
@@ -151 +197 @@
         <user> !user-delpermit dunker todo
         <output> todo denied
-
-3) user-delstatus (delstatus)
-
-    user-delstatus <name> <status>
+14) *user-delstatus (delstatus)*
+
+    :description: user-delstatus <name> <status>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -160 +209 @@
         <user> !user-delstatus dunker #dunkbots
         <output> dunker has no #DUNKBOTS status
-
-3) user-deluserhost (deluserhosts)
-
-    user-deluserhost <name> <userhost> .. delete from usershosts of <name> userhost <userhost>
+15) *user-deluserhost (deluserhosts)*
+
+    :description: user-deluserhost <name> <userhost> .. delete from usershosts of <name> userhost <userhost>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -169 +221 @@
         <user> !user-deluserhost dunker bart1@bla.a2000.nl
         <output> dunker has no bart1@bla.a2000.nl in userhost list
-
-3) user-email (email)
-
-    get email
+16) *user-email (email)*
+
+    :description: get email
+
+    :permissions: USER
+
+    :examples:
 
     ::
@@ -178 +233 @@
         <user> !user-email
         <output> no email set
-
-3) user-getemail (getemail)
-
-    user-getemail <name> .. get email from user <name>
+17) *user-getemail (getemail)*
+
+    :description: user-getemail <name> .. get email from user <name>
+
+    :permissions: USER
+
+    :examples:
 
     ::
 
         <user> !user-getemail dunker
-        <output> dunker has email bart@gozerbot.org
-
-3) user-getname (gn)
-
-    user-getname <nick> .. get the name of <nick>
+        <output> dunker has no email set
+18) *user-getname (gn)*
+
+    :description: user-getname <nick> .. get the name of <nick>
+
+    :permissions: USER
+
+    :examples:
 
     ::
 
         <user> !user-getname dunker
-        <output> dunker
-
-3) user-getperms (getperms)
-
-    user-getperms <name> .. get permissions of <name>
+        <output> can't find user for bart@gozerbot.org
+19) *user-getperms (getperms)*
+
+    :description: user-getperms <name> .. get permissions of <name>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -205 +269 @@
         <user> !user-getperms dunker
         <output> USER .. USER
-
-3) user-getstatus (getstatus)
-
-    user-getstatus <name> .. get status of <name>
+20) *user-getstatus (getstatus)*
+
+    :description: user-getstatus <name> .. get status of <name>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -214 +281 @@
         <user> !user-getstatus dunker
         <output> #BARTBOT
-
-3) user-getuserhosts (getuserhosts)
-
-    user-getuserhosts <name> .. get userhosts of <name>
+21) *user-getuserhosts (getuserhosts)*
+
+    :description: user-getuserhosts <name> .. get userhosts of <name>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-getuserhosts dunker
-        <output> bart@gozerbot.org .. bart?@*.a2000.nl
-
-3) user-match (match)
-
-    user-match <userhost>
+        <output> gozerbot@conference.jabber.xs4all.nl/dunker .. bart?@*.a2000.nl
+22) *user-match (match)*
+
+    :description: user-match <userhost>
+
+    :permissions: USER .. OPER
+
+    :examples:
 
     ::
 
         <user> !user-match test@test
-        <output> userrecord = name: test userhosts: ['test@test', 'bla@bla']
-        <output>  perms: ['OPER', 'USER', 'QUOTE', 'USER', 'USER', 'USER']
-        <output>  email:  status: [] allowed: [] notallowed: [] tempusershosts:
+        <output> userrecord = name: test userhosts: ['test@test'] perms:
+        <output>  ['OPER', 'USER', 'QUOTE', 'MAIL', 'USER'] email: 
+        <output>  status: [] allowed: [] notallowed: [] tempusershosts:
         <output>  [] permit: []
-
-6) user-meet (meet)
-
-    meet <nick> .. introduce <nick> to the bot
+23) *user-meet (meet)*
+
+    :description: meet <nick> .. introduce <nick> to the bot
+
+    :permissions: OPER .. MEET
+
+    :examples:
 
     ::
@@ -244 +320 @@
         <user> !user-meet dunker
         <output> there is already a user with username dunker
-
-3) user-merge (merge)
-
-    user-merge <name> <nick> .. merge record with <name> with userhost from <nick>
+24) *user-merge (merge)*
+
+    :description: user-merge <name> <nick> .. merge record with <name> with userhost from <nick>
+
+    :permissions: OPER .. MEET
+
+    :examples:
 
     ::
@@ -253 +332 @@
         <user> !merge bart dunker
         <output> we have no user bart
-
-3) user-name (name)
-
-    show name of user giving the command
+25) *user-name (name)*
+
+    :description: show name of user giving the command
+
+    :permissions: USER
+
+    :examples:
 
     ::
@@ -262 +344 @@
         <user> !user-name
         <output> your name is test
-
-3) user-names (names)
-
-    show names of registered users
+26) *user-names (names)*
+
+    :description: show names of registered users
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-names
-        <output> owner .. test .. web .. dunker
-
-3) user-permit (permit)
-
-    show permit of user giving the command
+        <output> owner .. bruutipv6 .. lotjuh .. koor .. laagje .. mr-trev
+        <output>  .. bsod` .. aim_ .. michiel` .. freakie .. iceman_x
+        <output>  .. rainman .. antarez .. cybercobra .. finalx .. stonex
+        <output>  .. rmeist .. markdark .. jejfafke .. giagio .. maky``
+        <output>  .. sphynx .. cmdr_sm .. snore .. kgb_ .. synto ..
+        <output>  madeddie .. dunkert .. shortguy .. speeksel .. a-v-s
+        <output>  .. rexodus .. borretje .. bart__ .. qqa .. gozerbot
+        <output>  .. timmer .. jan__ .. habbie .. burp2001 .. jelleh
+        <output>  .. murf .. ircmanz .. andabata .. |mdf| .. jink ..
+        <output>  web .. zomo .. snufj .. xenobyte .. pro__ .. grootmoeder
+         - output trunked -
+27) *user-permit (permit)*
+
+    :description: show permit of user giving the command
+
+    :permissions: USER
+
+    :examples:
 
     ::
@@ -280 +378 @@
         <user> !user-permit
         <output> you don't have any permits set
-
-3) user-perms (perms)
-
-    get permissions
+28) *user-perms (perms)*
+
+    :description: get permissions
+
+    :permissions: USER
+
+    :examples:
 
     ::
 
         <user> !user-perms
-        <output> OPER .. USER .. QUOTE .. USER .. USER .. USER
-
-3) user-scan (us)
-
-    user-scan <txt> .. search database for matching usernames
+        <output> OPER .. USER .. QUOTE .. MAIL .. USER
+29) *user-scan (us)*
+
+    :description: user-scan <txt> .. search database for matching usernames
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-scan dunk
-        <output> dunker
-
-3) user-search
-
-    search for matching userhosts
+        <output> dunkert .. dunkk .. dunker-done .. dunker
+30) *user-search*
+
+    :description: search for matching userhosts
+
+    :permissions: OPER
+
+    :examples:
 
     ::
 
         <user> !user-search gozerbot
-        <output> (dunker) bart@gozerbot.org
-
-3) user-setemail (setemail)
-
-    user-setemail <name> <email>.. set email of user <name>
+        <output> (None) ~dunker@gozerbot.org .. (None) n=dunker@gozerbot.org
+        <output>  .. (None) ~dunker@irc.gozerbot.org .. (None) ~dunker@bla.gozerbot.org
+        <output>  .. (None) n=dunker@bla.gozerbot.org .. (gozerbot)
+        <output>  gozerbot@r8.cg.nu .. (None) n=gozerbot@gozerbot.org
+        <output>  .. (None) ~gozerbot@vortex.superstring.nl .. (None)
+        <output>  ~gozerbot@ip5657f74a.direct-adsl.nl .. (None) ~gozerbot@249-164-ftth.onsnetnuenen.nl
+        <output>  .. (dunker) gozerbot@conference.jabber.xs4all.nl/dunker
+        <output>  .. (blablabla2) gozerbot@conference.jabber.xs4all.nl/blablabla2
+        <output>  .. (grue) gozerbot@conference.jabber.xs4all.nl/grue
+        <output>  .. (mad@xs4all) gozerbot@conference.jabber.xs4all.nl/mad@xs4all
+         - output trunked -
+31) *user-setemail (setemail)*
+
+    :description: user-setemail <name> <email>.. set email of user <name>
+
+    :permissions: OPER
+
+    :examples:
 
     ::
@@ -316 +436 @@
         <user> !user-setemail dunker bart@gozerbot.org
         <output> email set
-
-3) user-status (status)
-
-    get status
+32) *user-status (status)*
+
+    :description: get status
+
+    :permissions: USER
+
+    :examples:
 
     ::
@@ -325 +448 @@
         <user> !user-status
         <output> you have no status set
-
-3) user-userhosts (userhosts)
-
-    get userhosts
+33) *user-userhosts (userhosts)*
+
+    :description: get userhosts
+
+    :permissions: USER
+
+    :examples:
 
     ::
 
         <user> !user-userhosts
-        <output> test@test .. bla@bla
-
-3) user-whoami (whoami)
-
-    get your username
+        <output> test@test
+34) *user-whoami (whoami)*
+
+    :description: get your username
+
+    :permissions: USER
+
+    :examples:
 
     ::
@@ -343 +472 @@
         <user> !user-whoami
         <output> test
-
-3) user-del (delete)
-
-    user-del <name> .. delete user with <username>
+35) *user-del (delete)*
+
+    :description: user-del <name> .. delete user with <username>
+
+    :permissions: OPER
+
+    :examples:
 
     ::

doc/plugins/USERSTATE

@@ -10 +10 @@
 :author:  Bart Thate <bthate@gmail.com>
 :contact: IRCNET/#dunkbots
-:website: http://plugins.gozerbot.org
+:distribution: core
 :license: Public Domain
  
@@ -31 +31 @@
 | 
 
+1) *userstate*
 
-1) userstate
+    :description: get or set userstate
 
-    get or set userstate
+    :permissions: USER
+
+    :examples:
 
     ::
 
         <user> !userstate
-        <output> no userstate of test known
+        <output> TZ=1
 
     ::
@@ -45 +48 @@
         <user> !userstate TZ -1
         <output> TZ=-1