[project @ 2005-07-04 01:48:38 by unknown_lamer]
[clinton/bobotpp.git] / examples / bot.help
CommitLineData
07686d60 1:ACTION [\ 2<channel>\ 2] \ 2<message>\ 2
2Makes the bot do an action on \ 2<channel>\ 2.
3
4:ADDUSER \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<channelMask>\ 2 \ 2<level>\ 2 \ 2<prot>\ 2 \ 2<autoop>\ 2
5Adds an user to the userlist, for a nick!user@host matching the
6one given, on a channel matching the \ 2<channelMask>\ 2 given.
7The \ 2<level>\ 2 can be: | The \ 2<prot>\ 2 can be: | The \ 2<autoop>\ 2 can be:
8 0 - No level | 0 - No protection | 0 - No auto-op
9 1 - User | 1 - No ban | 1 - Op on join
10 2 - Trusted User | 2 - No kick |
11 3 - Friend | 3 - No deop |
12 4 - Master | |
13
14:ADDSERVER \ 2<host name>\ 2|\ 2<ip address>\ 2 [\ 2<port number>\ 2]
15Adds the server specified by \ 2<host name>\ 2 or \ 2<ip address>\ 2 to
16the server list.
17
18:ADDSHIT \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<channelMask>\ 2 \ 2<level>\ 2 \ 2<time>\ 2 [\ 2<reason>\ 2]
19Adds an user to the shitlist, for a nick!user@host matching the
20one given, on a channel matching the \ 2<channelMask>\ 2 given.
21The \ 2<level>\ 2 can be:
22 0 - No shit
23 1 - No op
24 2 - Kick and Ban on join
25 3 - Kick and Ban on join, no deban
26
27:ALIAS \ 2<new name>\ 2 \ 2<old name>\ 2
28Makes an alias, and adds the function \ 2<new name>\ 2, that will do
29exactly the same command as \ 2<old name>\ 2. Useful for lazy people :-)
30
31:BAN [\ 2<channel>\ 2] \ 2<mask>\ 2|\ 2<nick>\ 2
32Bans \ 2<mask>\ 2 or \ 2<nick>\ 2 from \ 2<channel>\ 2. You need to be a trusted
33user to ban with a \ 2<mask>\ 2.
34
35:CHANGELEVEL \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<channel mask>\ 2 \ 2<new level>\ 2
36Gives \ 2<nick>\ 2 or \ 2<mask>\ 2 level \ 2<new level>\ 2 on channel(s)
37\ 2<channel mask>\ 2. Note that you can not change level for someone
38whose level is greater than yours, and that you can not give a
39level greater than yours.
40
41:CHANNELS
42Prints the channel(s) where the bot is currently.
43
44:CYCLE [\ 2<channel>\ 2]
45Makes the bot leave and join \ 2<channel>\ 2.
46
47:DCCLIST
48Gives the list of all DCC Chat connections.
49
50:DEBAN [\ 2<channel>\ 2] \ 2<mask>\ 2|\ 2<nick>\ 2
51Debans \ 2<mask>\ 2 or \ 2<nick>\ 2 from \ 2<channel>\ 2. You need to be a trusted
52user to deban with a \ 2<mask>\ 2.
53
54:DELSERVER \ 2<server number>\ 2
55Deletes server from server list whose number in the server list
56is \ 2<server number>\ 2
57
58:DELUSER \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<channelMask>\ 2
59Removes \ 2<nick>\ 2 or \ 2<mask>\ 2 from the userlist.
60
61:DELSHIT \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<channelMask>\ 2
62Removes \ 2<nick>\ 2 or \ 2<mask>\ 2 from the shitlist.
63
64:DEOP [\ 2<channel>\ 2] \ 2<mask>\ 2|\ 2<nick>\ 2
65Deops \ 2<mask>\ 2 or \ 2<nick>\ 2 on \ 2<channel>\ 2.
66
67:DIE [\ 2<reason>\ 2]
68Makes the bot stop immediately.
69
70:HELP [\ 2<topic>\ 2]
71Prints this help, or prints help about \ 2<topic>\ 2 if supplied.
72See the topics available for you with "HELP" without arguments.
73
74:IDENT \ 2<channel>\ 2 \ 2<password>\ 2
75Identifies you on the bot. Note that you should not use this
76command in public...
77
78:INVITE [\ 2<channel>\ 2] \ 2<nick>\ 2
79Invites \ 2<nick>\ 2 on \ 2<channel>\ 2.
80
81:JOIN \ 2<channel>\ 2
82Makes the bot join \ 2<channel>\ 2.
83
84:KEEP [\ 2<channel>\ 2] \ 2<modes>\ 2
85Sets the \ 2<modes> \ 2 that the bot will keep for \ 2<channel>\ 2.
86See also STATS.
87
88:KICK [\ 2<channel>\ 2] \ 2<mask>\ 2|\ 2<nick>\ 2 [\ 2<reason>\ 2]
89Kicks \ 2<mask>\ 2 or \ 2<nick>\ 2 out of \ 2<channel>\ 2, because of \ 2<reason>\ 2.
90You need to be a trusted user to use a \ 2<mask>\ 2.
91
92:KICKBAN [\ 2<channel>\ 2] \ 2<mask>\ 2|\ 2<nick>\ 2 [\ 2<reason>\ 2]
93Bans then kicks \ 2<mask>\ 2 or \ 2<nick>\ 2 out of \ 2<channel>\ 2,
94because of \ 2<reason>\ 2.
95You need to be a trusted user to use a \ 2<mask>\ 2.
96
97:LOAD
98Reloads the userlist from disk.
99
100:LOCK [\ 2<channel>\ 2]
101Locks topic on \ 2<channel>\ 2.
102
103:MODE [\ 2<channel>\ 2] \ 2<mode string>\ 2
104Sends \ 2<mode string>\ 2 as mode for \ 2<channel>\ 2.
105
106:NAMES [\ 2<channel>\ 2]
107Shows the nicknames and status of users on \ 2<channel>\ 2.
108
109:NEXTSERVER
110Makes the bot connect to the next server in its server list.
111
112:NICK \ 2<nick>\ 2
113Makes the bot use nickname \ 2<nick>\ 2.
114
115:NSLOOKUP \ 2<nick>\ 2|\ 2<host>\ 2|\ 2<ip address>\ 2
116Does a nameserver query about \ 2<nick>\ 2's host, \ 2<host>\ 2 or
117\ 2<ip address>\ 2.
118
119:OP [\ 2<channel>\ 2] \ 2<nick>\ 2
120Ops \ 2<nick>\ 2 on \ 2<channel>\ 2.
121
122:PART [\ 2<channel>\ 2]
123Makes the bot leave \ 2<channel>\ 2.
124
125:PASSWORD \ 2<password>\ 2
126Changes your password on the bot. Use "NONE" as password
127if you want to clear it.
128Do not use this command in public!
129
130:RECONNECT
131Makes the bot reconnect to its current server.
132
133:RSPYMESSAGE
134Removes you from the spy list.
135
136:SAVE
137Saves the userlist.
138
139:SAY [\ 2<channel>\ 2] \ 2<message>\ 2
140Makes the bot say \ 2<message>\ 2 on \ 2<channel>\ 2.
141
142:SERVER \ 2<server number>\ 2
143Select the server to connect to. \ 2<server number>\ 2 is the number of
144the server in the serverlist.
145
146:SERVERLIST
147Shows the bot's serverlist.
148
149:SHITLIST
150Shows the bot's shitlist.
151
152:SPYLIST
153Shows the bot's spylist.
154
155:SPYMESSAGE
156Adds you to the spylist
157
158:STATS [\ 2<channel>\ 2]
159Gives \ 2<channel>\ 2's statistics.
160
161:TBAN [\ 2<channel>\ 2] \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<time>\ 2
162Bans \ 2<nick>\ 2 or \ 2<mask>\ 2 from \ 2<channel>\ 2 for \ 2<time>\ 2 seconds.
163
164:TKBAN [\ 2<channel>\ 2] \ 2<nick>\ 2|\ 2<mask>\ 2 \ 2<time>\ 2 [\ 2<reason>\ 2]
165Bans \ 2<nick>\ 2 or \ 2<mask>\ 2 from \ 2<channel>\ 2 for \ 2<time>\ 2 seconds,
166then kicks him/them because of \ 2<reason>\ 2.
167
168:TOPIC [\ 2<channel>\ 2] [\ 2<topic>\ 2]
169If no \ 2<topic>\ 2 is given, prints \ 2<channel>\ 2's topic. Otherwise,
170the bot will change \ 2<channel>\ 2's topic to \ 2<topic>\ 2.
171
172:UNLOCK [\ 2<channel>\ 2]
173Makes the bot unlock topic on \ 2<channel>\ 2.
174
175:USERLIST
176Shows the bot's userlist.
177
178:WHO [\ 2<channel>\ 2]
179Show your level on \ 2<channel>\ 2.
180
181:WHOIS [\ 2<channel>\ 2] \ 2<nick>\ 2
182Shows information about \ 2<nick>\ 2 on \ 2<channel>\ 2.