Changeset 2384:bfac9d554c4e for doc

Show
Ignore:
Timestamp:
09/14/08 21:53:52 (4 months ago)
Author:
dunker@…
Branch:
default
Message:

more docs .. don't reply if a options is not known

Location:
doc/plugins
Files:
19 modified

Legend:

Unmodified
Added
Removed

  • doc/plugins/CORE

    r2157 r2384  
    1010:author:  Bart Thate <bthate@gmail.com> 
    1111:contact: IRCNET/#dunkbots 
    12 :website: http://plugins.gozerbot.org 
     12:distribution: core 
    1313:license: Public Domain 
    1414  
    … …  
    3030|  
    3131 
    32  
    33 1) apro (apropos) 
    34  
    35     apro <what> .. search for commands that contain <what> 
     321) *apro (apropos)* 
     33 
     34    :description: apro <what> .. search for commands that contain <what> 
     35 
     36    :permissions: USER .. WEB .. ANON 
     37 
     38    :examples: 
    3639 
    3740    :: 
    3841 
    3942        <user> !apro com 
    40         <output> 1) commands .. 2) hg-committers (committers) 
    41  
    42 2) available (plugins) 
    43  
    44     show what plugins are available but not loaded (see the list command for loaded plugins) 
     43        <output> 1) whatcommands .. 2) commands .. 3) hg-committers 
     44        <output>  (committers) 
     452) *available (plugins)* 
     46 
     47    :description: show what plugins are available but not loaded (see the list command for loaded plugins) 
     48 
     49    :permissions: USER .. WEB .. ANON 
     50 
     51    :examples: 
    4552 
    4653    :: 
    4754 
    4855        <user> !available 
    49         <output> megahal .. tinyurl .. webserver 
    50  
    51 3) cc 
    52  
    53     set control char of channel or show control char of channel 
     56        <output> cloud .. collective .. megahal .. powernick 
     573) *cc* 
     58 
     59    :description: set control char of channel or show control char of channel 
     60 
     61    :permissions: USER 
     62 
     63    :examples: 
    5464 
    5565    :: 
    … …  
    6272        <user> !cc 
    6373        <output> control character(s) for channel #test are/is ! 
    64  
    65 4) cc-add 
    66  
    67     cc-add <control char> .. add control character 
     744) *cc-add* 
     75 
     76    :description: cc-add <control char> .. add control character 
     77 
     78    :permissions: OPER 
     79 
     80    :examples: 
    6881 
    6982    :: 
    … …  
    7184        <user> !cc-add # 
    7285        <output> control char # added 
    73  
    74 5) cc-del 
    75  
    76     cc-del <control character> .. remove cc 
     865) *cc-del* 
     87 
     88    :description: cc-del <control character> .. remove cc 
     89 
     90    :permissions: OPER 
     91 
     92    :examples: 
    7793 
    7894    :: 
    … …  
    8096        <user> !cc-del # 
    8197        <output> control char # deleted 
    82  
    83 6) commands 
    84  
    85     show commands of <plugin> 
     986) *cleanpyc* 
     997) *commands* 
     100 
     101    :description: show commands of <plugin> 
     102 
     103    :permissions: USER .. WEB .. ANON 
     104 
     105    :examples: 
    86106 
    87107    :: 
    … …  
    89109        <user> !commands core 
    90110        <output> apro (apropos) .. available (plugins) .. cc .. cc-add 
    91         <output>  .. cc-del .. commands .. encoding .. help .. intro 
    92         <output>  .. less .. less-size .. list (ll) .. loglevel .. more 
    93         <output>  .. party-loud .. party-silent .. partylist .. perm 
    94         <output>  .. quit (halt) .. reboot .. running .. save .. u .. 
    95         <output>  uptime (up) .. userhostcache .. version (mekker) .. 
    96         <output>  whatperms .. whereis 
    97  
    98 7) encoding 
    99  
    100     show default encoding 
     111        <output>  .. cc-del .. cleanpyc .. commands .. encoding .. help 
     112        <output>  .. intro .. less .. less-size .. list (ll) .. loglevel 
     113        <output>  .. more .. party-loud .. party-silent .. partylist 
     114        <output>  .. perm .. quit (halt) .. reboot (stuk) .. running 
     115        <output>  .. save .. threads .. u .. uptime (up) .. userhostcache 
     116        <output>  .. version (v) .. whatcommands .. whatperms .. whereis 
     1178) *encoding* 
     118 
     119    :description: show default encoding 
     120 
     121    :permissions: USER .. OPER .. ANON 
     122 
     123    :examples: 
    101124 
    102125    :: 
    … …  
    104127        <user> !encoding 
    105128        <output> default encoding is utf-8 
    106  
    107 8) help 
    108  
    109     get help on <cmnd> or <plugin> 
     1299) *help* 
     130 
     131    :description: get help on <cmnd> or <plugin> 
     132 
     133    :permissions: USER .. WEB .. ANON 
     134 
     135    :examples: 
    110136 
    111137    :: 
    … …  
    120146        <output>  ps .. response .. source (about) .. test .. time (t) 
    121147        <output>  .. timezone 
    122  
    123 9) intro 
    124  
    125     do a whois of <nick> to sync userhost into the userhost cache 
     14810) *intro* 
     149 
     150    :description: do a whois of <nick> to sync userhost into the userhost cache 
     151 
     152    :permissions: OPER 
     153 
     154    :examples: 
    126155 
    127156    :: 
    … …  
    129158        <user> !intro dunker 
    130159        <output> whois command send 
    131  
    132 10) less 
    133  
    134     less [<who>] [<index1>] <index2> .. get txt from bots output cache 
     16011) *less* 
     161 
     162    :description: less [<who>] [<index1>] <index2> .. get txt from bots output cache 
     163 
     164    :permissions: USER .. ANON 
     165 
     166    :examples: 
    135167 
    136168    :: 
    … …  
    148180        <user> !less bart 1 0 
    149181        <output> no data available for bart 1 0 
    150  
    151 11) less-size 
    152  
    153     show sizes of data in bot's ouput cache 
     18212) *less-size* 
     183 
     184    :description: show sizes of data in bot's ouput cache 
     185 
     186    :permissions: USER .. ANON 
     187 
     188    :examples: 
    154189 
    155190    :: 
    … …  
    157192        <user> !less-size 
    158193        <output> none 
    159  
    160 12) list (ll) 
    161  
    162     list registered plugins or list commands in plugin 
     19413) *list (ll)* 
     195 
     196    :description: list registered plugins or list commands in plugin 
     197 
     198    :permissions: USER .. WEB .. ANON 
     199 
     200    :examples: 
    163201 
    164202    :: 
    165203 
    166204        <user> !list 
    167         <output> alarm .. alias .. all .. at .. autoreply .. backup 
    168         <output>  .. birthday .. botsnack .. chanperm .. choice .. code 
    169         <output>  .. collective .. core .. count .. debug .. dns .. 
    170         <output>  fleet .. gcollect .. googletalk .. grab .. greeting 
    171         <output>  .. grep .. hello .. hg .. idle .. ignore .. infoitem 
    172         <output>  .. install .. irc .. jabber .. job .. karma .. lag 
    173         <output>  .. links .. lists .. log .. mail .. mailexceptions 
    174         <output>  .. markov .. misc .. nickcapture .. nickserv .. not 
    175         <output>  .. ops .. pgp .. popcon .. quote .. relay .. reload 
    176         <output>  .. remind .. rest .. reverse .. rss .. search .. seen 
    177         <output>  .. shop .. simplelog .. size .. snarf .. tail .. tcp 
    178         <output>  .. tell .. timer .. to .. todo .. topic .. udp .. 
    179         <output>  umode .. underauth .. update .. upgrade .. url .. 
    180         <output>  user .. userstate .. wikipedia 
     205        <output> 8b .. alarm .. alias .. all .. anon .. at .. autoreply 
     206        <output>  .. autovoice .. away .. backup .. beats .. bender 
     207        <output>  .. birthday .. botsnack .. buzz .. chanperm .. choice 
     208        <output>  .. code .. core .. count .. country .. dict .. dig 
     209        <output>  .. dns .. event .. facts .. fleet .. gcollect .. googletalk 
     210        <output>  .. grab .. greeting .. grep .. hello .. hex2ip .. 
     211        <output>  hexjoin .. hg .. idle .. ignore .. infoitem .. install 
     212        <output>  .. ipcalc .. irc .. jabber .. job .. jtdict .. karma 
     213        <output>  .. lag .. lart .. links .. lists .. log .. mail .. 
     214        <output>  mailexceptions .. markov .. misc .. nickcapture .. 
    181215 
    182216    :: 
    … …  
    187221        <output>  .. rss-delitem .. rss-delmarkup .. rss-description 
    188222        <output>  .. rss-dump .. rss-feeds .. rss-get .. rss-itemslist 
    189         <output>  .. rss-link .. rss-list .. rss-markup .. rss-running 
    190         <output>  .. rss-scan .. rss-search .. rss-setsleeptime .. rss-sleeptime 
    191         <output>  .. rss-start .. rss-stop .. rss-stopwatch .. rss-sync 
    192         <output>  .. rss-url .. rss-watch 
    193  
    194 13) loglevel 
    195  
    196     get/set current loglevel .. the lower the loglevel the more the bot logs 
     223        <output>  .. rss-link .. rss-list .. rss-markup .. rss-markuplist 
     224        <output>  .. rss-running .. rss-scan .. rss-search .. rss-setsleeptime 
     225        <output>  .. rss-seturl .. rss-sleeptime .. rss-start .. rss-stop 
     226        <output>  .. rss-stopwatch .. rss-sync .. rss-url .. rss-watch 
     22714) *loglevel* 
     228 
     229    :description: get/set current loglevel .. the lower the loglevel the more the bot logs 
     230 
     231    :permissions: OPER 
     232 
     233    :examples: 
    197234 
    198235    :: 
    199236 
    200237        <user> !loglevel 
    201         <output> loglevel is 100 
    202  
    203     :: 
    204  
    205         <user> !loglevel 100 
    206         <output> loglevel is now 100 
    207  
    208 14) more 
    209  
    210     return txt from output cache 
     238        <output> loglevel is 1000 
     239 
     240    :: 
     241 
     242        <user> !loglevel 1000 
     243        <output> loglevel is now 1000 
     24415) *more* 
     245 
     246    :description: return txt from output cache 
     247 
     248    :permissions: USER .. ANON 
     249 
     250    :examples: 
    211251 
    212252    :: 
    … …  
    219259        <user> !more test 
    220260        <output> no more data available for test 
    221  
    222 15) party-loud 
    223  
    224     enable partyline noise 
     26116) *party-loud* 
     262 
     263    :description: enable partyline noise 
     264 
     265    :permissions: USER 
     266 
     267    :examples: 
    225268 
    226269    :: 
    … …  
    228271        <user> !party-loud 
    229272        <output> partyline put to loud mode 
    230  
    231 16) party-silent 
    232  
    233     disable partyline noise 
     27317) *party-silent* 
     274 
     275    :description: disable partyline noise 
     276 
     277    :permissions: USER 
     278 
     279    :examples: 
    234280 
    235281    :: 
    … …  
    237283        <user> !party-silent 
    238284        <output> partyline put to silent mode 
    239  
    240 17) partylist 
    241  
    242     show connected partylist users 
     28518) *partylist* 
     286 
     287    :description: show connected partylist users 
     288 
     289    :permissions: USER .. WEB .. ANON 
     290 
     291    :examples: 
    243292 
    244293    :: 
    … …  
    246295        <user> !partylist 
    247296        <output> no party yet! 
    248  
    249 18) perm 
    250  
    251     show permission of command 
     29719) *perm* 
     298 
     299    :description: show permission of command 
     300 
     301    :permissions: USER .. WEB .. ANON 
     302 
     303    :examples: 
    252304 
    253305    :: 
    … …  
    255307        <user> !perm quit 
    256308        <output> quit command needs ['OPER'] permission 
    257  
    258 19) running 
    259  
    260     show running threads 
     30920) *running* 
     310 
     311    :description: show running jobs 
     312 
     313    :permissions: USER .. OPER .. ANON 
     314 
     315    :examples: 
    261316 
    262317    :: 
    263318 
    264319        <user> !running 
    265         <output> Collective.join = 2 .. Runner._loop = 1 .. Udplistener._handleloop 
    266         <output>  = 1 .. MainThread = 1 .. Outmonitor._loop = 1 .. Plugins.showregistered 
    267         <output>  = 1 .. Tcplistener._listen = 1 .. Commandhandler.handleloop 
    268         <output>  = 1 .. handle_running = 1 .. Tcplistener._handleloop 
    269         <output>  = 1 .. Periodical.checkloop = 1 .. Udplistener._outloop 
    270         <output>  = 1 .. Tcplistener._outloop = 1 
    271  
    272 20) save 
    273  
    274     save bot data 
     320        <output> running.5 = 1 
     32121) *save* 
     322 
     323    :description: save bot data 
     324 
     325    :permissions: OPER 
     326 
     327    :examples: 
    275328 
    276329    :: 
    … …  
    278331        <user> !save 
    279332        <output> saving .. done 
    280  
    281 21) u 
    282  
    283     u <nick> .. get userhost cache entry for <nick> 
     33322) *threads* 
     334 
     335    :description: show running threads 
     336 
     337    :permissions: USER .. OPER .. ANON 
     338 
     339    :examples: 
     340 
     341    :: 
     342 
     343        <user> !thread 
     344        <output> none 
     34523) *u* 
     346 
     347    :description: u <nick> .. get userhost cache entry for <nick> 
     348 
     349    :permissions: USER .. ANON 
     350 
     351    :examples: 
    284352 
    285353    :: 
    … …  
    287355        <user> !u dunker 
    288356        <output> bart@gozerbot.org 
    289  
    290 22) uptime (up) 
    291  
    292     show uptime of the bot 
     35724) *uptime (up)* 
     358 
     359    :description: show uptime of the bot 
     360 
     361    :permissions: USER .. WEB .. JCOLL .. ANON 
     362 
     363    :examples: 
    293364 
    294365    :: 
    295366 
    296367        <user> !uptime 
    297         <output> uptime is 5 seconds 
    298  
    299 23) version (mekker) 
    300  
    301     show version of the bot 
     368        <output> uptime is 52 seconds 
     36925) *version (v)* 
     370 
     371    :description: show version of the bot 
     372 
     373    :permissions: USER .. WEB .. JCOLL .. ANON .. CLOUD 
     374 
     375    :examples: 
    302376 
    303377    :: 
    304378 
    305379        <user> !version 
    306         <output> GOZERBOT 0.8.1 HG revision 2156 
    307  
    308 24) whatperms 
    309  
    310     show what permissions are available 
     380        <output> GOZERBOT 0.8.2-BETA HG revision 2383 
     38126) *whatcommands* 
     382 
     383    :description: show commands with permission <perm> 
     384 
     385    :permissions: USER 
     386 
     387    :examples: 
     388 
     389    :: 
     390 
     391        <user> !whatcommands USER 
     392        <output> 8b .. active .. age .. alarm .. alarm-mylist .. alias-get 
     393        <output>  .. alias-search .. apro .. at .. available .. bd .. 
     394        <output>  bd-del .. bd-set .. beats .. bender .. botsnack .. 
     395        <output>  buzz .. cc .. channels .. chat .. choice .. chuck 
     396        <output>  .. cmnd .. coll .. coll-exec .. commands .. count 
     397        <output>  .. country .. country-rev .. dayline .. dict .. dig 
     398        <output>  .. dns .. encoding .. event-add .. event-join .. event-list 
     399        <output>  .. event-part .. event-who .. excuse .. fleet-list 
     400        <output>  .. got .. got-chan .. greeting-add .. greeting-del 
     401        <output>  .. greeting-list .. grep .. hello .. help .. hex2ip 
     40227) *whatperms* 
     403 
     404    :description: show what permissions are available 
     405 
     406    :permissions: USER .. OPER .. ANON 
     407 
     408    :examples: 
    311409 
    312410    :: 
    313411 
    314412        <user> !whatperms 
    315         <output> ACTION .. ANON .. ANONKARMA .. ANONQUOTE .. FORGET 
    316         <output>  .. IGNORE .. INFOADD .. JCOLL .. JOIN .. KARMA .. 
    317         <output>  LINKS .. MAIL .. MEET .. OPER .. QUOTE .. QUOTEADD 
    318         <output>  .. QUOTEDEL .. RSS .. SAY .. SENDRAW .. UPGRADE .. 
    319         <output>  USER .. WEB 
    320  
    321 25) whereis 
    322  
    323     whereis <cmnd> .. show in which plugins <what> is 
     413        <output> ACTION .. ANON .. ANONKARMA .. ANONQUOTE .. ANY .. 
     414        <output>  CLOUD .. EVENT .. FORGET .. IGNORE .. INFOADD .. JCOLL 
     415        <output>  .. JOIN .. KARMA .. LINKS .. MAIL .. MEET .. OPER 
     416        <output>  .. PROBE .. QUOTE .. QUOTEADD .. QUOTEDEL .. RSS .. 
     417        <output>  SAY .. SENDRAW .. UPGRADE .. USER .. WEB 
     41828) *whereis* 
     419 
     420    :description: whereis <cmnd> .. show in which plugins <what> is 
     421 
     422    :permissions: USER .. WEB .. ANON 
     423 
     424    :examples: 
    324425 
    325426    :: 

  • doc/plugins/COUNT

    r2157 r2384  
    1010:author:  Bart Thate <bthate@gmail.com> 
    1111:contact: IRCNET/#dunkbots 
    12 :website: http://plugins.gozerbot.org 
     12:distribution: core 
    1313:license: Public Domain 
    1414  
    … …  
    3030|  
    3131 
     321) *count* 
    3233 
    33 1) count 
     34    :description: count nr of items 
    3435 
    35     count nr of items 
     36    :permissions: USER .. WEB .. ANON .. CLOUD 
     37 
     38    :examples: 
    3639 
    3740    :: 

  • doc/plugins/FLEET

    r2157 r2384  
    1010:author:  Bart Thate <bthate@gmail.com> 
    1111:contact: IRCNET/#dunkbots 
    12 :website: http://plugins.gozerbot.org 
     12:distribution: core 
    1313:license: Public Domain 
    1414  
    … …  
    3333|  
    3434 
     351) *cmnd* 
    3536 
    36 1) cmnd 
     37    :description: cmnd all|<botname> <cmnd> .. excecute command on bot with <name> or on all fleet bots 
    3738 
    38     cmnd all|<botname> <cmnd> .. excecute command on bot with <name> or on all fleet bots 
     39    :permissions: USER .. WEB 
     40 
     41    :examples: 
    3942 
    4043    :: 
    … …  
    4750        <user> !cmnd all st 
    4851        <output> [test] .. nobody said anything on channel #test yet 
     522) *fleet-addirc (fleet-add)* 
    4953 
    50 2) fleet-addirc (fleet-add) 
     54    :description: fleet-addirc <name> <nick> <server> [ipv6] [port] [passwd] .. add new server to fleet 
    5155 
    52     fleet-addirc <name> <nick> <server> [ipv6] [port] [passwd] .. add new server to fleet 
     56    :permissions: OPER 
     57 
     58    :examples: 
    5359 
    5460    :: 
    5561 
    5662        <user> !fleet-addirc test3 gozertest localhost 
    57         <output> test3 started 
     63        <output> adding bot: name: test3 nick: gozertest server: localhost 
     64        <output>  ipv6: 0 ssl: 0 port:6667 .. test3 started 
     653) *fleet-addjabber* 
    5866 
    59 3) fleet-addjabber 
     67    :description: fleet-addjabber <name> <host> <user> <passwd> [<port>] .. add new jabber server to fleet 
    6068 
    61     fleet-addjabber <name> <host> <user> <passwd> [<port>] .. add new jabber server to fleet 
     69    :permissions: OPER 
     70 
     71    :examples: 
    6272 
    6373    :: 
    … …  
    6676        <output> use this command on a jabber bot (and change password 
    6777        <output>  if you used it) 
     784) *fleet-connect* 
    6879 
    69 4) fleet-connect 
     80    :description: connect bot with <name> to irc server 
    7081 
    71     connect bot with <name> to irc server 
     82    :permissions: OPER 
     83 
     84    :examples: 
    7285 
    7386    :: 
    … …  
    7588        <user> !fleet-connect test 
    7689        <output> test connected 
     905) *fleet-list* 
    7791 
    78 5) fleet-list 
     92    :description: show current fleet list 
    7993 
    80     show current fleet list 
     94    :permissions: USER .. WEB 
     95 
     96    :examples: 
    8197 
    8298    :: 
    … …  
    84100        <user> !fleet-list 
    85101        <output> test .. test3 
     1026) *fleet-del* 
    86103 
    87 6) fleet-del 
     104    :description: fleet-del <botname> .. delete bot from fleet list 
    88105 
    89     fleet-del <botname> .. delete bot from fleet list 
     106    :permissions: OPER 
     107 
     108    :examples: 
    90109 
    91110    :: 
    … …  
    93112        <user> !fleet-del test 
    94113        <output> test deleted 
     1147) *fleet-disconnect* 
    95115 
    96 7) fleet-disconnect 
     116    :description: fleet-disconnect <name> .. disconnect bot with <name> from irc server 
    97117 
    98     fleet-disconnect <name> .. disconnect bot with <name> from irc server 
     118    :permissions: OPER 
     119 
     120    :examples: 
    99121 
    100122    :: 

  • doc/plugins/GOOGLETALK

    r2157 r2384  
    1010:author:  Bart Thate <bthate@gmail.com> 
    1111:contact: IRCNET/#dunkbots 
    12 :website: http://plugins.gozerbot.org 
     12:distribution: core 
    1313:license: Public Domain 
    1414  

  • doc/plugins/GREP

    r2157 r2384  
    1010:author:  Bart Thate <bthate@gmail.com>