/[cvs]/eggdrop1.8/help/cmds1.help
ViewVC logotype

Contents of /eggdrop1.8/help/cmds1.help

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.4 - (show annotations) (download)
Mon Nov 1 22:38:34 2010 UTC (9 years, 8 months ago) by pseudo
Branch: MAIN
CVS Tags: HEAD
Branch point for: gettext
Changes since 1.3: +2 -4 lines
Made it possible to specify ssl independently for telnet and user ports when modifying bot addresses.
Changed the syntax of .chaddr and .+bot to use space as a port separator instead of ':'.
Changed the syntax of server list entries to enclose literal IPv6 addresses in square brackets, instead of using a comma to separate the port.

1 %{help=+bot}%{+t}
2 ### %b+bot%b <handle> [address [[+]bot port[/[+]user port]]] [host]
3 Creates a user record for a new bot with the handle given. If no hostmask
4 is specified, the bot will try to automatically add a host from the channel.
5 The bot's address will be used in linking. If the bot has a separate port
6 for bots and users they should be separated with a slash (/). Prefixing
7 the port with a plus sign marks the bot for secure (SSL) linking.
8
9 See also: -bot
10 %{help=+host}%{+t|m}
11 ### %b+host%b [handle] <hostmask>
12 Adds a hostmask to a user's user record. Hostmasks are used to identify your
13 handle on IRC. If a handle is not specified, the hostmask will be added to
14 YOUR user record.
15
16 See also: -host
17 %{help=+ignore}%{+m}
18 ### %b+ignore%b <hostmask> [%%<XdXhXm>] [comment]
19 Adds an ignore to the list of ignores stored on the bot, with optional
20 comment and ignore time. This ignore is stored with your handle as the
21 creator. Ignore time has to be expressed in days, hours, and/or minutes.
22
23 See also: -ignore, ignores
24 %{help=+user}%{+m}
25 ### %b+user%b <handle> [hostmask]
26 Creates a new user record for the handle given. The new user record will
27 have no flags, an optional hostmask, and no password.
28
29 See also: -user, +host, -host
30 %{help=-bot}%{+t}
31 ### %b-bot%b <bot>
32 This is exactly the same as %b'.-user'%b (it removes a user record). It is
33 included for convenience.
34
35 See also: +bot, +user, -user
36 %{help=-host}%{-}
37 ### %b-host%b <hostmask>
38 Removes a host from your handle.
39 %{+m|m}
40
41 ### %b-host%b <handle> <hostmask>
42 Removes a hostmask from a user's user record.
43 %{-}
44
45 See also: +host
46 %{help=-ignore}%{+m}
47 ### %b-ignore%b <hostmask/number>
48 Removes the specified ignore from the list of ignores stored on the bot. You
49 may also reference the ignore by the number shown by the 'ignores' command.
50
51 See also: +ignore, ignores
52 %{help=-user}%{+m}
53 ### %b-user%b <handle>
54 Removes the specified handle's user record.
55
56 See also: +user, +bot, -bot
57 %{help=addlog}%{+to|o}
58 ### %baddlog%b <text>
59 Adds your comment to the bot's logfile. Bot masters can go back later and
60 review the log, and will see your comment (with your handle attached). This
61 is useful for explaining confusing activity.
62 %{help=away}%{-}
63 ### %baway%b [away-message]
64 Marks you as "away" on the party line. Your away message will show up in
65 the %b'.who'%b list, and will be displayed to anyone who tries to send you
66 a note. Your notes will be stored, and then displayed to you as soon as you
67 are no longer away. Saying something on the party line will automatically
68 remove your "away" status, or you can type %b'.back'%b or %b'.away'%b by
69 itself.
70
71 See also: back
72 %{help=back}%{-}
73 ### %bback%b
74 This marks you as no longer away on the party line.
75
76 See also: away
77 %{help=backup}%{+m|m}
78 ### %bbackup%b
79 This makes the bot write a backup of its entire user list to the disk. If
80 the channels module is loaded, this will also write a backup of the channels
81 file. This is useful if you feel the need to backup the userfile and channel
82 settings.
83
84 See also: reload, rehash, save
85 %{help=banner}%{+t}
86 ### %bbanner%b <text>
87 Displays a message to everyone currently using the bot's party line or file
88 area. This is useful for announcing that the bot will go down, etc.
89 %{help=binds}%{+m}
90 ### %bbinds%b [type/match] [all]
91 Shows the Tcl bindings in effect, in a list similar to this:
92 Command bindings:
93 TYPE FLAGS COMMAND HITS BINDING (TCL)
94 msg -|- rose 0 msg_rose
95 msg -|- go 0 msg_go
96 dcc m|- bind 0 cmd_bind
97 pub -|- gross 0 pub_gross
98 The fields should be self-explanatory, except for HITS, which records the
99 number of times that binding has been called. If not, go read the file
100 %b'doc/tcl-commands.doc'%b for help on the Tcl bind command. Note that the
101 builtin commands are now shown. You may also specify a type of binding to
102 show (i.e. %b'.binds msg'%b) or you can specify a wild card match (i.e.
103 %b'.binds *seen*'%b) if you want to narrow the field a bit. The wild card
104 matches will match against the TYPE, COMMAND and BINDING fields. You can
105 view more binds by adding 'all' to the end of the command.
106
107 See also: tcl
108 %{help=boot}%{+t}
109 ### %bboot%b <handle[@bot]> [reason]
110 Kicks a user off the party line and displays the reason, if you specify
111 one. You can also specify a bot, and attempt to boot someone from another
112 bot on the botnet, though it may be rejected if that bot does not allow
113 remote boots. You can not boot a bot owner.
114 %{help=botattr}%{+t}
115 ### %bbotattr%b <handle> [flags] [channel]
116 Lets you view and change the bot flags for a bot. For example, to set
117 "Fred1" +share and -hub, you would do '.botattr Fred1 +s-h.'
118
119 Whether or not you change any flags, it will show you the bot's flags
120 afterwards. To get a list of the flags possible, see %b'.help whois'%b.
121
122 %bNOTE:%b This command is NOT used to replace .chattr. It modifies bot flags,
123 such as s, h, a, u, etc.
124 %bNOTE:%b You can't use this command on bots which are directly linked to your
125 bot at the current moment.
126
127 See also: whois, chattr
128 %{help=botinfo}%{-}
129 ### %bbotinfo%b
130 Requests information from every bot currently on the botnet. Each bot should
131 eventually send you one line containing its version, network setting,
132 channels, and uptime.
133
134 See also: bottree, vbottree, bots
135 %{help=bots}%{-}
136 ### %bbots%b
137 Shows the list of bots currently on the botnet.
138
139 Example:
140 Bots: cEvin, ruthie, Killa1
141
142 There is no indication of which bots are directly connected to this current
143 bot. Use %b'.who'%b%{+t} or %b'.bottree'%b%{-} for that information.
144
145 See also: bottree, vbottree, botinfo
146 %{help=bottree}%{-}
147 ### %bbottree%b
148 Shows a tree-format diagram of the bots currently on the botnet. It's just a
149 nice way to get a feel for how the bots are physically connected. If 2 bots
150 are sharing, a + will be indicated, or a ? if nothing is known.
151
152 See also: bots, botinfo, vbottree
153 %{help=chaddr}%{+t}
154 ### %bchaddr%b <bot> <address> [[+]bot port[/[+]user port]]
155 Changes the address for a bot. This is the address your bot will try to
156 connect to when linking. If the bot has a separate port for bots and users,
157 they should be separated by a slash (/). Prefixing the port with a plus
158 sign marks the bot for secure (SSL) linking.
159
160 See also: link, +bot
161 %{help=chat}%{-}
162 ### %bchat%b <on/off>
163 ### %bchat%b <[*]channel number/name>
164 Changes your current channel on the partyline. When you first connect to
165 the partyline, it places you on channel 0 (the main party line).
166
167 Some channels may have assigned names if the assoc module is loaded. For
168 these, you can specify the channel by name instead of channel number if
169 you wish.
170
171 %b'.chat off'%b removes you from all channels, including the main party line.
172 You can still use bot commands and see the console, but you can't talk to
173 anyone except via %b'.note'%b. %b'.chat on'%b returns you to the main party
174 line (channel 0) if you were elsewhere.
175
176 If you prefix the channel with a '*', you will join a local channel.
177
178 See also: console
179 %{help=chattr}%{+m|m}
180 ### %bchattr%b <handle> [flags] [channel]
181 This lets you view and change the flags for a user.
182
183 For example, to give Lamer the p and f flags:
184 .chattr Lamer +pf
185
186 To remove Denali from the global op list:
187 .chattr Denali -o
188
189 You may also do any combination of the above:
190 .chattr Fred1 -m+xj-o
191
192 You can also change the flags for Usagi on a specific channel by supplying
193 the channel after the attributes:
194 .chattr Usagi -m+dk-o #blah
195
196 Changing global and channel specific flags within the same command line is
197 also possible (global +f, +o #lamer):
198 .chattr Bill f|o #lamer
199
200 Whether or not you change any flags, it will show you the user's attributes
201 afterwards. To get a list of all possible flags, see %b'.help whois'%b.
202
203 %bNOTES:%b Only the owner may add or remove the 'n' (owner), 'm' (master) or
204 't' (botnet master) flags. It is pointless to -n a permanent owner.
205 You must remove the permanent owner in the config file.
206
207 See also: whois, botattr
208 %{help=chhandle}%{+t}
209 ### %bchhandle%b <oldhandle> <newhandle>
210 Changes the handle of a user. For example, to change the handle of user
211 'gavroche' to 'jamie', you would use 'chhandle gavroche jamie'.
212
213 See also: chpass
214 %{help=chpass}%{+t}
215 ### %bchpass%b <handle> [newpassword]
216 Changes a user's password. If you do not specify the new password, the user
217 effectively no longer has a password set. A password is needed to get ops,
218 join the party line, etc.
219
220 %bNOTE:%b In previous versions, setting a password to "nopass" would clear
221 a user's password -- with encrypted passwords. This no longer works!
222
223 See also: chhandle
224 %{help=comment}%{+m}
225 ### %bcomment%b <user> <comment>
226 Creates or changes the comment field for a user. The comment field can only
227 be seen via 'whois' or 'match'. Non-masters cannot see the comment field.
228 %{help=console}%{+to|o}
229 ### %bconsole%b [channel] [modes]
230 Changes your console level so that you will see only the types of console
231 messages that you want to. Your current console channel is the channel (that
232 the bot is on) from which you can view from the party line, and which
233 channel-specific commands (like 'say' and 'op') take affect on.
234
235 Valid flags are:
236 %bj%b joins, parts, quits, and netsplits on the channel
237 %bk%b kicks, bans, and mode changes on the channel
238 %bm%b private msgs, notices and ctcps to the bot
239 %bp%b public text on the channel
240 %bs%b server connects, disconnects, and notices
241
242 %{+m}
243 Masters only:
244 %bb%b information about bot linking and userfile sharing
245 %bd%b misc debug information
246 %bc%b commands
247 %bo%b misc info, errors, etc (IMPORTANT STUFF)
248 %bw%b wallops (make sure the bot sets +w in init-server)
249 %bx%b file transfers and file-area commands
250
251 %{+n}
252 Owners only (these have to be enabled in the config file via "set raw-log"):
253 %bh%b raw share traffic
254 %br%b raw incoming server traffic
255 %bt%b raw botnet traffic
256 %bv%b raw outgoing server traffic
257
258 There are also 8 user-defined console modes ('1' through '8').
259
260 %{+o|o}
261 The mode can also be a modifier like '+p' or '-jk' or '+mp-b'. If you omit
262 the channel and modes, your current console channel and flags will be shown.
263
264 %{+m|m}
265 ### %bconsole%b <user> [channel] [modes]
266 This is used to set the console level of another user. This can even be used
267 on users who normally would not be able to set their own console mode.
268 %{help=dccstat}%{+m}
269 ### %bdccstat%b
270 Displays a table-format list of all "dcc" connections in use on the bot.
271 Dcc stands for "Direct Client-to-client Communication", and Eggdrop expands
272 this to cover every open socket. Any type of network connection to the bot
273 is considered a "dcc" connection.
274
275 The headings of the table are:
276 %bIDX%b index; the socket number of this connection (always unique)
277 %bADDR%b the ip address mask of the host the bot is connected to, if
278 applicable
279 %bPORT%b the port number being used for this connection
280 %bNICK%b the handle of the user or bot, if applicable
281 %bTYPE%b the type of dcc connection (see below)
282 %bINFO%b misc information, i.e. flags for certain dcc types
283
284 The types of connections currently possible are as follows (but more are
285 being added all the time):
286 %bCHAT%b dcc-chat partyline user
287 %bPASS%b user entering dcc chat (being asked for password)
288 %bSEND%b user sending a file
289 %bGET%b sending a file to a user
290 %bGETP%b pending get (waiting for the user to acknowledge)
291 %bLSTN%b telnet listening port (in place of a hostname, it will show the
292 callback procedure name, or a mask of acceptable handles)
293 %bT-IN%b incoming telnet user (being asked for handle)
294 %bFILE%b user in dcc-chat file area
295 %bBOT%b connected bot (botnet connection)
296 %bBOT*%b pending bot link (waiting for acknowledgement)
297 %bRELA%b user in relay connection to another bot
298 %b>RLY%b bot being relay'd to (one for each "RELA")
299 %bCONN%b pending telnet connection (chat, relay, bot-link, etc)
300 %bNEW%b new user via telnet (entering a handle)
301 %bNEWP%b new user via telnet (entering a password)
302
303 In addition, 'CHAT' and 'BOT' have flags listed for each connection. Capital
304 letters mean that the flag is on, and lowercase letters mean that the flag
305 is off. The flags for 'CHAT' are:
306 %bC%b in file area, but allowed to return to party line
307 %bP%b party line access only
308 %bT%b telnet connection (instead of dcc chat)
309 %bE%b echo is on
310 %bP%b paging is on
311
312 The flags for 'BOT' are:
313 %bP%b ping sent, waiting for reply
314 %bU%b user-file sharing is active
315 %bC%b local bot initiated the connection
316 %bO%b user-file offered, waiting for reply
317 %bS%b in the process of sending the user-file
318 %bG%b in the process of getting the user-file
319 %bW%b warned this bot to stop hubbing
320 %bL%b leaf-only bot (not allowed to be a hub)
321 %bI%b bot is currently in the 'linking' stage
322 %bA%b bot is being aggressively shared with
323
324 For 'CHAT' users, the party-line channel is also listed.
325 %{help=debug}%{+m}
326 ### %bdebug%b
327 Display a dump of memory allocation information, assuming the bot was
328 compiled with memory debugging. It's useless to anyone but developers
329 trying to find memory leaks.
330 %{help=echo}%{-}
331 ### %becho%b <on/off>
332 Specifies whether you want your messages echoed back to you. If it's on,
333 then when you say something on the party line, it will be displayed to you
334 just like everyone else will see it. If it's off, then it won't happen.
335 %{help=die}%{+n}
336 ### %bdie%b [reason]
337 This kills the bot. The bot goes offline immediately, logging who issued
338 the 'die' command. You shouldn't have to use this too often. If you specify
339 a reason, it is logged, otherwise the reason is "authorized by <handle>".

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23