← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gozerbot/utopic

« back to all changes in this revision

Viewing changes to doc/BASIC

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Malcolm
  • Date: 2009-09-14 09:00:29 UTC
  • mfrom: (1.1.4 upstream) (3.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090914090029-uval0ekt72kmklxw
Tags: 0.9.1.3-3
http://bugs.debian.org/546435
Changed dependency on python-setuptools to python-pkg-resources
(Closes: #546435) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/BASIC
1
 
=====
2
 
Basic
3
 
=====
4
 
 
5
 
Basic know your way around.
6
 
 
7
 
1) See what permission you have
8
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9
 
::
10
 
 
11
 
  < dunk> !perms
12
 
  < gozerbot> USER .. ADMIN .. MAIL .. RSS .. EVAL .. VOTE .. FORGET .. ALIAS
13
 
            .. OPER .. QUOTE .. SENDRAW .. SAY
14
 
 
15
 
2) See what plugins are available
16
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17
 
::
18
 
 
19
 
  < dunk> !list
20
 
  < gozerbot> loaded plugins: alarm alias all at autoreply autovoice away 
21
 
              backup birthday botsnack chanperm choice code collective 
22
 
              convert core count country debug dig dns event fleet gcollect 
23
 
              googletalk grab greeting grep hello hg idle ignore infoitem 
24
 
              install irc jabber job karma lag links lists log mail 
25
 
              mailexceptions markov misc nickcapture nickserv not ops pgp 
26
 
              popcon probe quote relay (+1)
27
 
 
28
 
if the response is longer than 375 characters the bot will cache the output
29
 
and only show the first 375 chars. use !more to see the following lines.
30
 
::
31
 
 
32
 
  < dunk> !more
33
 
  < gozerbot> reload remind rest reverse rss search seen shop simplelog 
34
 
              size snarf tail tcp tell timer to todo topic udp umode 
35
 
              underauth update upgrade url user userstate webserver 
36
 
              wikipedia
37
 
 
38
 
3) See what commands a plugin provides
39
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40
 
 
41
 
An alias if it exists for a command is show in ()
42
 
::
43
 
 
44
 
  <@dunk> !commands todo
45
 
  < gozerbot> todo has the following commands: todo .. todo-chan (chantodo) 
46
 
              .. todo-chandone (chandone) .. todo-done (done) .. todo-get 
47
 
              .. todo-getprio (prio) .. todo-set .. todo-setprio (setprio) 
48
 
              .. todo-settime .. todo-time (tt) .. todo-today (today) .. 
49
 
              todo-tomorrow (tomorrow) .. todo-week
50
 
 
51
 
4) Get help on a plugin
52
 
~~~~~~~~~~~~~~~~~~~~~~~
53
 
 
54
 
The help command only shows the commands you can do in a plugin.
55
 
::
56
 
 
57
 
  < dunk> !help collective
58
 
  < gozerbot> plugin description: manage links to other bots .. to be
59
 
              accessible a bot needs to run the webserver
60
 
  < gozerbot> commands: coll .. coll-exec
61
 
 
62
 
5) Get help on a command
63
 
~~~~~~~~~~~~~~~~~~~~~~~~
64
 
::
65
 
 
66
 
  < dunk> !help coll
67
 
  < gozerbot> command description of coll: coll <cmnd> .. execute command in
68
 
              the collective .. alias: None .. examples: coll lq
69
 
 
70
 
6) Use apro to find commands
71
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72
 
::
73
 
 
74
 
  < dunk> !apro shop
75
 
  < gozerbot> 1) shop 2) shop-del 3) shop-get 4) shop-add 5) shop-chan
76
 
 
77
 
7) Use pipelines
78
 
~~~~~~~~~~~~~~~~
79
 
 
80
 
::
81
 
 
82
 
  <@dunk> !apro todo | count
83
 
  < gozerbot> 13