← Back to branch summary

~ubuntu-branches/ubuntu/precise/gozerbot/precise

« back to all changes in this revision

Viewing changes to doc/plugins/USER

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Malcolm
  • Date: 2008-06-02 19:26:39 UTC
  • mfrom: (1.1.3 upstream) (3.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080602192639-3rn65nx4q1sgd6sy
Tags: 0.8.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/plugins/USER
7
7
-----
8
8
| 
9
9
 
10
 
:author:  Bart Thate <bart@gozerbot.org>
 
10
:author:  Bart Thate <bthate@gmail.com>
11
11
:contact: IRCNET/#dunkbots
12
12
:website: http://plugins.gozerbot.org
13
13
:license: Public Domain
22
22
 
23
23
| 
24
24
 
 
25
  user related commands 
 
26
 
 
27
| 
 
28
 
25
29
commands
26
30
--------
27
31
| 
36
40
        <user> !user-add dunker bart@localhost
37
41
        <output> dunker added to user database
38
42
 
39
 
2) user-addperm (setperms)
 
43
3) user-addperm (setperms)
40
44
 
41
45
    add permission to user <name>
42
46
 
51
55
 
52
56
    ::
53
57
 
54
 
        <user> !addpermsall USER
 
58
        <user> !user-addpermall USER
 
59
        <output> USER perm added
55
60
 
56
 
4) user-addpermit
 
61
3) user-addpermit
57
62
 
58
63
    user-addpermit <nick> <what> .. permit nick access to <what> .. use setperms to add permissions
59
64
 
62
67
        <user> !user-addpermit dunker todo
63
68
        <output> dunker is already allowed to do todo
64
69
 
65
 
5) user-addstatus (setstatus)
 
70
3) user-addstatus (setstatus)
66
71
 
67
72
    user-addstatus <name> <status>
68
73
 
71
76
        <user> !user-addstatus dunker #bartbot
72
77
        <output> #BARTBOT status added
73
78
 
74
 
6) user-adduserhost (adduserhost)
 
79
3) user-adduserhost (adduserhost)
75
80
 
76
81
    user-adduserhost <name> <userhost> .. add <userhost> to userhosts of <name>
77
82
 
80
85
        <user> !user-adduserhost dunker bart?@*.a2000.nl
81
86
        <output> userhost added
82
87
 
83
 
7) user-allperm
 
88
3) user-allperm
84
89
 
85
90
    user-allperm <perm> .. get users with <perm> permission
86
91
 
89
94
        <user> !user-allperm rss
90
95
        <output> dunker
91
96
 
92
 
8) user-allstatus
 
97
3) user-allstatus
93
98
 
94
99
    user-allstatus <status> ..get users with <status> status
95
100
 
98
103
        <user> !user-allstatus #dunkbots
99
104
        <output> no users with #DUNKBOTS status found
100
105
 
101
 
9) user-check (check)
 
106
3) user-check (check)
102
107
 
103
108
    user-check <nick>
104
109
 
105
110
    ::
106
111
 
107
112
        <user> !user-check dunker
108
 
        <output> userrecord = name: dunker userhosts: ['bart@gozerbot.org', 'bart?@*.a2000.nl'] perms: ['USER', 'RSS']
109
 
        <output>  email: bart@r8.cg.nu status: ['#BARTBOT'] allowed: [] notallowed: [] tempusershosts: [] permit: []
110
 
 
111
 
10) user-del (delete)
112
 
 
113
 
    user-del <name> .. delete user with <username>
114
 
 
115
 
    ::
116
 
 
117
 
        <user> !user-del dunker
118
 
        <output> dunker deleted
119
 
 
120
 
11) user-delemail (delemail)
 
113
        <output> userrecord = name: dunker userhosts: ['bart@gozerbot.org',
 
114
        <output>  'bart?@*.a2000.nl'] perms: ['USER', 'RSS', 'USER']
 
115
        <output>  email: bart@gozerbot.org status: ['#BARTBOT'] allowed:
 
116
        <output>  [] notallowed: [] tempusershosts: [] permit: []
 
117
 
 
118
6) user-delemail (delemail)
121
119
 
122
120
    reset email
123
121
 
126
124
        <user> !user-delemail
127
125
        <output> email removed
128
126
 
129
 
12) user-delperm
 
127
3) user-delperm
130
128
 
131
129
    user-delperm <name> <perm> .. delete from user <name> permission <perm>
132
130
 
133
131
    ::
134
132
 
135
 
        <user> !user-delperms dunker rss
 
133
        <user> !user-delperm dunker rss
 
134
        <output> RSS perm removed
136
135
 
137
 
13) user-delpermall
 
136
3) user-delpermall
138
137
 
139
138
    user-delpermall <perm> .. delete <permission> from all users
140
139
 
141
140
    ::
142
141
 
143
 
        <user> !delpermsall BLA
 
142
        <user> !user-delpersall BLA
 
143
        <output> none
144
144
 
145
 
14) user-delpermit
 
145
4) user-delpermit
146
146
 
147
147
    user-delpermit <name> <permit>
148
148
 
149
149
    ::
150
150
 
151
151
        <user> !user-delpermit dunker todo
152
 
        <output> can't find registered name of dunker
 
152
        <output> todo denied
153
153
 
154
 
15) user-delstatus (delstatus)
 
154
3) user-delstatus (delstatus)
155
155
 
156
156
    user-delstatus <name> <status>
157
157
 
158
158
    ::
159
159
 
160
160
        <user> !user-delstatus dunker #dunkbots
161
 
        <output> can't find user dunker
 
161
        <output> dunker has no #DUNKBOTS status
162
162
 
163
 
16) user-deluserhost (deluserhosts)
 
163
3) user-deluserhost (deluserhosts)
164
164
 
165
165
    user-deluserhost <name> <userhost> .. delete from usershosts of <name> userhost <userhost>
166
166
 
167
167
    ::
168
168
 
169
169
        <user> !user-deluserhost dunker bart1@bla.a2000.nl
170
 
        <output> can't find user dunker
 
170
        <output> dunker has no bart1@bla.a2000.nl in userhost list
171
171
 
172
 
17) user-email (email)
 
172
3) user-email (email)
173
173
 
174
174
    get email
175
175
 
178
178
        <user> !user-email
179
179
        <output> no email set
180
180
 
181
 
18) user-getemail (getemail)
 
181
3) user-getemail (getemail)
182
182
 
183
183
    user-getemail <name> .. get email from user <name>
184
184
 
185
185
    ::
186
186
 
187
187
        <user> !user-getemail dunker
188
 
        <output> can't find user dunker
 
188
        <output> dunker has email bart@gozerbot.org
189
189
 
190
 
19) user-getname (gn)
 
190
3) user-getname (gn)
191
191
 
192
192
    user-getname <nick> .. get the name of <nick>
193
193
 
194
194
    ::
195
195
 
196
196
        <user> !user-getname dunker
197
 
        <output> can't find user for bart@gozerbot.org
 
197
        <output> dunker
198
198
 
199
 
20) user-getperms (getperms)
 
199
3) user-getperms (getperms)
200
200
 
201
201
    user-getperms <name> .. get permissions of <name>
202
202
 
203
203
    ::
204
204
 
205
205
        <user> !user-getperms dunker
206
 
        <output> can't find user dunker
 
206
        <output> USER .. USER
207
207
 
208
 
21) user-getstatus (getstatus)
 
208
3) user-getstatus (getstatus)
209
209
 
210
210
    user-getstatus <name> .. get status of <name>
211
211
 
212
212
    ::
213
213
 
214
214
        <user> !user-getstatus dunker
215
 
        <output> can't find user dunker
 
215
        <output> #BARTBOT
216
216
 
217
 
22) user-getuserhosts (getuserhosts)
 
217
3) user-getuserhosts (getuserhosts)
218
218
 
219
219
    user-getuserhosts <name> .. get userhosts of <name>
220
220
 
221
221
    ::
222
222
 
223
223
        <user> !user-getuserhosts dunker
224
 
        <output> can't find user dunker
 
224
        <output> bart@gozerbot.org .. bart?@*.a2000.nl
225
225
 
226
 
23) user-match (match)
 
226
3) user-match (match)
227
227
 
228
228
    user-match <userhost>
229
229
 
230
230
    ::
231
231
 
232
232
        <user> !user-match test@test
233
 
        <output> userrecord = name: test userhosts: ['test@test'] perms: ['OPER', 'USER', 'QUOTE'] email:  status: []
234
 
        <output>  allowed: [] notallowed: [] tempusershosts: [] permit: [('dunker', 'todo')]
 
233
        <output> userrecord = name: test userhosts: ['test@test', 'bla@bla']
 
234
        <output>  perms: ['OPER', 'USER', 'QUOTE', 'USER', 'USER', 'USER']
 
235
        <output>  email:  status: [] allowed: [] notallowed: [] tempusershosts:
 
236
        <output>  [] permit: []
235
237
 
236
 
24) user-meet (meet)
 
238
6) user-meet (meet)
237
239
 
238
240
    meet <nick> .. introduce <nick> to the bot
239
241
 
240
242
    ::
241
243
 
242
244
        <user> !user-meet dunker
243
 
        <output> dunker added to user database
 
245
        <output> there is already a user with username dunker
244
246
 
245
 
25) user-merge (merge)
 
247
3) user-merge (merge)
246
248
 
247
249
    user-merge <name> <nick> .. merge record with <name> with userhost from <nick>
248
250
 
251
253
        <user> !merge bart dunker
252
254
        <output> we have no user bart
253
255
 
254
 
26) user-name (name)
 
256
3) user-name (name)
255
257
 
256
258
    show name of user giving the command
257
259
 
260
262
        <user> !user-name
261
263
        <output> your name is test
262
264
 
263
 
27) user-names (names)
 
265
3) user-names (names)
264
266
 
265
267
    show names of registered users
266
268
 
267
269
    ::
268
270
 
269
271
        <user> !user-names
270
 
        <output> owner .. web .. test .. root .. dunker
 
272
        <output> owner .. test .. web .. dunker
271
273
 
272
 
28) user-permit (permit)
 
274
3) user-permit (permit)
273
275
 
274
276
    show permit of user giving the command
275
277
 
276
278
    ::
277
279
 
278
280
        <user> !user-permit
279
 
        <output> ('dunker', 'todo')
 
281
        <output> you don't have any permits set
280
282
 
281
 
29) user-perms (perms)
 
283
3) user-perms (perms)
282
284
 
283
285
    get permissions
284
286
 
285
287
    ::
286
288
 
287
289
        <user> !user-perms
288
 
        <output> OPER .. USER .. QUOTE
 
290
        <output> OPER .. USER .. QUOTE .. USER .. USER .. USER
289
291
 
290
 
30) user-scan (us)
 
292
3) user-scan (us)
291
293
 
292
294
    user-scan <txt> .. search database for matching usernames
293
295
 
296
298
        <user> !user-scan dunk
297
299
        <output> dunker
298
300
 
299
 
31) user-search
 
301
3) user-search
300
302
 
301
303
    search for matching userhosts
302
304
 
303
305
    ::
304
306
 
305
 
        <user> !user-search r8
306
 
        <output> no userhost matching r8 found
 
307
        <user> !user-search gozerbot
 
308
        <output> (dunker) bart@gozerbot.org
307
309
 
308
 
32) user-setemail (setemail)
 
310
3) user-setemail (setemail)
309
311
 
310
312
    user-setemail <name> <email>.. set email of user <name>
311
313
 
312
314
    ::
313
315
 
314
 
        <user> !user-setemail dunker bart@r8.cg.nu
 
316
        <user> !user-setemail dunker bart@gozerbot.org
315
317
        <output> email set
316
318
 
317
 
33) user-showuserhosts
318
 
 
319
 
34) user-status (status)
 
319
3) user-status (status)
320
320
 
321
321
    get status
322
322
 
325
325
        <user> !user-status
326
326
        <output> you have no status set
327
327
 
328
 
35) user-userhosts (userhosts)
 
328
3) user-userhosts (userhosts)
329
329
 
330
330
    get userhosts
331
331
 
332
332
    ::
333
333
 
334
334
        <user> !user-userhosts
335
 
        <output> test@test
 
335
        <output> test@test .. bla@bla
 
336
 
 
337
3) user-whoami (whoami)
 
338
 
 
339
    get your username
 
340
 
 
341
    ::
 
342
 
 
343
        <user> !user-whoami
 
344
        <output> test
 
345
 
 
346
3) user-del (delete)
 
347
 
 
348
    user-del <name> .. delete user with <username>
 
349
 
 
350
    ::
 
351
 
 
352
        <user> !user-del dunker
 
353
        <output> dunker deleted