ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/vendor/ircservices-5.1.24/docs/4.html
Revision: 3389
Committed: Fri Apr 25 14:12:15 2014 UTC (9 years, 10 months ago) by michael
Content type: text/html
File size: 121948 byte(s)
Log Message:
- Imported ircservices-5.1.24

File Contents

# Content
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv=Content-Type content="text/html; charset=iso-8859-1">
5 <title>IRC Services Manual - 4. Services command reference</title>
6 </head>
7
8 <body>
9 <a name=top></a>
10 <h1 align=center>IRC Services Manual</h1>
11
12 <h2 align=center>4. Services command reference</h2>
13 <p>4-1. <a href="#1">NickServ commands</a>
14 <p>4-2. <a href="#2">ChanServ commands</a>
15 <p>4-3. <a href="#3">MemoServ commands</a>
16 <p>4-4. <a href="#4">OperServ commands</a>
17 <p>4-5. <a href="#5">StatServ commands</a>
18 <p>4-6. <a href="#6">Command index</a>
19
20 <p><b>Note:</b> This section is based on the help messages included in IRC
21 Services itself, which can be accessed by typing
22 "<tt>/msg <i>pseudoclient-name</i> HELP</tt>" in IRC.
23
24 <p align=right><font size=-1><a href=3.html>Previous section: Overview of Services features</a> |
25 <a href=index.html>Table of Contents</a> |
26 <a href=5.html>Next section: Importing and exporting databases</a></font>
27
28 <!------------------------------------------------------------------------>
29 <p><hr>
30
31 <a name=1></a>
32 <h3>4-1. NickServ commands</h3>
33
34 <p align=center><hr width="50%">
35
36 <a name="nick.register"></a>
37 <p><b>REGISTER</b>
38
39 <p><dl><dt><b>Syntax:</b>
40 <dd><tt><b>REGISTER <i>password</i> [<i>E-mail</i>]</b></tt>
41 </dl>
42 <p>
43 Registers your nickname in the NickServ database. Once
44 your nickname is registered, you can use the <a href="#nick.set"><tt>SET</tt></a>
45 and <a href="#nick.access"><tt>ACCESS</tt></a>
46 commands to configure your nickname's settings as you like
47 them. Make sure you remember the password you use when
48 registering; you'll need it to make changes to your nickname
49 later. (Note that <b>case matters!</b> <tt>FIDO</tt>, <tt>Fido</tt>, and <tt>fido</tt>
50 are all different passwords!)
51 <p>
52 You may include an E-mail address when registering your
53 nickname; you may also set one later using the
54 <a href="#nick.set_email"><tt>SET EMAIL</tt></a>
55 command. (If the <a href="a.html#nickserv/main.NSRequireEmail"><tt>NSRequireEmail</tt></a>
56 is set, the E-mail address is mandatory.)
57 <p>
58 Guidelines on choosing passwords:
59 <p>
60 Passwords should not be easily guessable. For example,
61 using your real name as a password is a bad idea. Using
62 your nickname as a password is a much worse idea and,
63 in fact, NickServ will not allow it. Also, short
64 passwords are vulnerable to trial-and-error searches, so
65 you should choose a password at least 5 characters long.
66
67 <p>
68 <hr align=center width="50%">
69
70 <a name="nick.identify"></a>
71 <p><b>IDENTIFY</b>
72
73 <p><dl><dt><b>Syntax:</b>
74 <dd><tt><b>IDENTIFY <i>password</i></b></tt>
75 </dl>
76 <p>
77 Tells NickServ that you are really the owner of this
78 nickname. Many commands require you to authenticate yourself
79 with this command before you use them. The password
80 should be the same one you sent with the
81 <a href="#nick.register"><tt>REGISTER</tt></a> command.
82
83 <p>
84 <hr align=center width="50%">
85
86 <a name="nick.drop"></a>
87 <p><b>DROP</b>
88
89 <p><dl><dt><b>Syntax:</b>
90 <dd><tt><b>DROP <i>password</i></b></tt>
91 </dl>
92 <p>
93 De-registers (drops) your nickname from the NickServ
94 database. A nickname that has been dropped is free for anyone
95 to re-register.
96 <p>
97 Note that when you drop a nickname, <b>all nicknames linked to it will
98 be dropped as well</b>. To remove a single linked nickname, use
99 the <a href="#nick.unlink"><tt>UNLINK</tt></a> command.
100 <p>
101 To prevent accidental use of this command, you must enter
102 your password in order to drop your nickname.
103
104 <p>
105 <hr align=center width="50%">
106
107 <a name="nick.dropnick"></a>
108 <p><b>DROPNICK</b>
109
110 <p><dl><dt><b>Syntax:</b>
111 <dd><tt><b>DROPNICK <i>nickname</i></b></tt>
112 </dl>
113 <p>
114 Drops the given nickname from the NickServ database, as well
115 as any linked nicknames.
116 <p>
117 Limited to <b>Services admins</b>.
118
119 <p>
120 <hr align=center width="50%">
121
122 <a name="nick.dropemail"></a>
123 <p><b>DROPEMAIL</b>
124
125 <p><dl><dt><b>Syntax:</b>
126 <dd><tt><b>DROPEMAIL <i>pattern</i></b></tt>
127 <br><tt><b>DROPEMAIL-CONFIRM <i>pattern</i></b></tt>
128 </dl>
129 <p>
130 Drops all nicknames with an E-mail address matching the
131 given <tt><i>pattern</i></tt>. If <tt><i>pattern</i></tt> is the single character
132 "<tt>-</tt>", drops all nicknames without an E-mail address.
133 <p>
134 To prevent accidentally dropping nicknames via this command,
135 it must be given twice: first using the <tt>DROPEMAIL</tt> command
136 name, then using <tt>DROPEMAIL-CONFIRM</tt> with the same pattern.
137 The <tt>DROPEMAIL-CONFIRM</tt> command must be given within 10 minutes of
138 (by default, changeable via the
139 <a href="a.html#nickserv/main.NSDropEmailExpire"><tt>NSDropEmailExpire</tt></a>
140 option in <tt>modules.conf</tt>)
141 and by the same person who gave the <tt>DROPEMAIL</tt> command.
142 If more than 4 <tt>DROPEMAIL</tt> commands are given in a row, the
143 oldest will be discarded and no longer recognized for a
144 <tt>DROPEMAIL-CONFIRM</tt> command.
145 <p>
146 Limited to <b>Services admins.</b>
147
148 <p>
149 <hr align=center width="50%">
150
151 <a name="nick.auth"></a>
152 <p><b>AUTH</b> (requires the <tt>nickserv/mail-auth</tt> module)
153
154 <p><dl><dt><b>Syntax:</b>
155 <dd><tt><b>AUTH <i>code</i></b></tt>
156 </dl>
157 <p>
158 Authenticates registration or change of E-mail for a nickname.
159 To ensure that your E-mail address is correct, NickServ will
160 send an message containing an authentication code to the
161 E-mail address given when you register your nickname or
162 change your E-mail address with the <a href="#nick.set_email"><tt>SET EMAIL</tt></a> command. This
163 command allows you to confirm that you have received the
164 message and continue using your nickname normally. Replace
165 <tt><i>code</i></tt> in the command with the nine-digit authentication code
166 given in the E-mail message.
167
168 <p>
169 <hr align=center width="50%">
170
171 <a name="nick.sendauth"></a>
172 <p><b>SENDAUTH</b> (requires the <tt>nickserv/mail-auth</tt> module)
173
174 <p><dl><dt><b>Syntax:</b>
175 <dd><tt><b>SENDAUTH</b></tt>
176 </dl>
177 <p>
178 Sends you a copy of the authentication code for your nickname
179 after a <a href="#nick.register"><tt>REGISTER</tt></a> or
180 <a href="#nick.set_email"><tt>SET EMAIL</tt></a>. If you accidentally delete
181 or otherwise lose the message with the authentication code,
182 you can use this command to have an extra copy sent to you.
183 <p>
184 To prevent abuse, this command may only be used once every
185 24 hours.
186
187 <p>
188 <hr align=center width="50%">
189
190 <a name="nick.reauth"></a>
191 <p><b>REAUTH</b> (requires the <tt>nickserv/mail-auth</tt> module)
192
193 <p><dl><dt><b>Syntax:</b>
194 <dd><tt><b>REAUTH</b></tt>
195 </dl>
196 <p>
197 Sets an authentication code which you can use to identify
198 for your nickname. If you forget your nickname password,
199 use this command to generate a new authentication code, then
200 give that code (which will be mailed to you) with the <a href="#nick.auth"><tt>AUTH</tt></a>
201 command to identify for your nickname; you can then change
202 your password with the <a href="#nick.set_password"><tt>SET PASSWORD</tt></a>
203 command as usual.
204
205 <p>
206 <hr align=center width="50%">
207
208 <a name="nick.restoremail"></a>
209 <p><b>RESTOREMAIL</b> (requires the <tt>nickserv/mail-auth</tt> module)
210
211 <p><dl><dt><b>Syntax:</b>
212 <dd><tt><b>RESTOREMAIL <i>password</i></b></tt>
213 </dl>
214 <p>
215 Restores the last authenticated E-mail address for your
216 nickname. If you accidentally use the wrong E-mail address
217 in a <a href="#nick.set_email"><tt>SET EMAIL</tt></a> command, you can use this command to restore
218 the previous E-mail address and clear the authentication
219 code for your nickname, allowing you to identify for the
220 nickname again. You must give your nickname's password with
221 this command.
222 <p>
223 <tt>RESTOREMAIL</tt> can only be used after <tt>SET EMAIL</tt> and before
224 entering the new authorization code with the <a href="#nick.auth"><tt>AUTH</tt></a> command.
225
226 <p>
227 <hr align=center width="50%">
228
229 <a name="nick.setauth"></a>
230 <p><b>SETAUTH</b> (requires the <tt>nickserv/mail-auth</tt> module)
231
232 <p><dl><dt><b>Syntax:</b>
233 <dd><tt><b>SETAUTH <i>nickname</i></b></tt>
234 </dl>
235 <p>
236 Sets a new authentication code for the given nickname. The
237 nickname's owner will have to use the <a href="#nick.auth"><tt>AUTH</tt></a>
238 command for the nickname before being allowed to identify again. If the
239 nickname is currently in use, a notice will be sent to the
240 user of the nickname and they will no longer be treated as
241 identified for the nickname.
242
243 <p>
244 <hr align=center width="50%">
245
246 <a name="nick.getauth"></a>
247 <p><b>GETAUTH</b> (requires the <tt>nickserv/mail-auth</tt> module)
248
249 <p><dl><dt><b>Syntax:</b>
250 <dd><tt><b>GETAUTH <i>nickname</i></b></tt>
251 </dl>
252 <p>
253 Retrieves the authentication code associated with <tt><i>nickname</i></tt>,
254 if one exists.
255
256 <p>
257 <hr align=center width="50%">
258
259 <a name="nick.clearauth"></a>
260 <p><b>CLEARAUTH</b> (requires the <tt>nickserv/mail-auth</tt> module)
261
262 <p><dl><dt><b>Syntax:</b>
263 <dd><tt><b>CLEARAUTH <i>nickname</i></b></tt>
264 </dl>
265 <p>
266 Clears any authentication code associated with <tt><i>nickname</i></tt>,
267 allowing the nickname to be used normally.
268
269 <p>
270 <hr align=center width="50%">
271
272 <a name="nick.link"></a>
273 <p><b>LINK</b> (requires the <tt>nickserv/link</tt> module)
274
275 <p><dl><dt><b>Syntax:</b>
276 <dd><tt><b>LINK <i>nickname</i></b></tt>
277 </dl>
278 <p>
279 Links a new nickname to the nickname you are currently using,
280 creating a new "alias" for your nick. The new nick will be
281 equivalent to your current nick in terms of access
282 privileges and memos; for example, you can read memos sent
283 to one of your linked nicks from any other one, and if one
284 of your nicks has auto-op privileges in a channel, you will
285 get auto-opped no matter which linked nick you use.
286 <p>
287 To cancel a link, use the <a href="#nick.unlink"><tt>UNLINK</tt></a> command.
288 <p>
289 In order to use this command, you must identify for your
290 current nickname (using the <a href="#nick.identify"><tt>IDENTIFY</tt></a>
291 command), and the nickname to be linked must not currently be in use.
292
293 <p>
294 <hr align=center width="50%">
295
296 <a name="nick.unlink"></a>
297 <p><b>UNLINK</b> (requires the <tt>nickserv/link</tt> module)
298
299 <p><dl><dt><b>Syntax:</b>
300 <dd><tt><b>UNLINK <i>nickname</i> [FORCE]</b></tt>
301 </dl>
302 <p>
303 Removes a link (alias) to your nickname created with the
304 <a href="#nick.link"><tt>LINK</tt></a> command. You cannot unlink the
305 nickname you are currently using; change to another linked nick first
306 before using this command.
307 <p>
308 If you unlink the "main nickname" you have selected using the
309 <a href="#nick.set_mainnick"><tt>SET MAINNICK</tt></a> command, your
310 current nickname will automatically be selected as the main nickname.
311 <p>
312 Services admins may add the <tt>FORCE</tt> option, which allows
313 removal of a link to a nickname other than their own.
314
315 <p>
316 <hr align=center width="50%">
317
318 <a name="nick.listlinks"></a>
319 <p><b>LISTLINKS</b> (requires the <tt>nickserv/link</tt> module)
320
321 <p><dl><dt><b>Syntax:</b>
322 <dd><tt><b>LISTLINKS</b></tt>
323 </dl>
324 <p>
325 Lists all nicknames which are linked to your nick. The main
326 nickname for the group of linked nicks will be indicated by a
327 "<tt>*</tt>" to the left of the nick.
328 <p>
329 Services operators may list links for any nick by specifying the nick
330 in the command.
331
332 <p>
333 <hr align=center width="50%">
334
335 <a name="nick.access"></a>
336 <p><b>ACCESS</b> (requires the <tt>nickserv/access</tt> module)
337
338 <p><dl><dt><b>Syntax:</b>
339 <dd><tt><b>ACCESS ADD <i>mask</i></b></tt>
340 <br><tt><b>ACCESS DEL <i>mask</i></b></tt>
341 <br><tt><b>ACCESS LIST</b></tt>
342 </dl>
343 <p>
344 Modifies or displays the access list for your nickname. This is
345 the list of <tt><i>user</i>@<i>host</i></tt> addresses which will be
346 automatically recognized by NickServ as allowed to use the nickname.
347 If you connect to IRC with an address on this list, you will not be
348 affected by the nick's <a href="#nick.set_kill"><tt>SET KILL</tt></a>
349 setting, and if the <a href="#nick.set_secure"><tt>SET SECURE</tt></a>
350 option is disabled, you will be able to receive auto-op and other
351 privileges in channels without using the
352 <a href="#nick.identify"><tt>IDENTIFY</tt></a> command.
353 <p>
354 The mask given to the <tt>ADD</tt> and <tt>DEL</tt>commands may contain
355 wildcards (<tt>*</tt> or <tt>?</tt>).
356 <p>
357 Examples:
358 <dl>
359 <dt>
360 <tt> <b>ACCESS ADD achurch@*.dragonfire.net</b></tt>
361 <dd>
362 Allows access to user <tt>achurch</tt> from any machine in
363 the <tt>dragonfire.net</tt> domain.
364 <dt>
365 <tt> <b>ACCESS DEL achurch@*.dragonfire.net</b></tt>
366 <dd>
367 Reverses the previous command.
368 <dt>
369 <tt> <b>ACCESS LIST</b></tt>
370 <dd>
371 Displays the current access list.
372 </dl>
373 <p>
374 Services admins may give a nickname parameter to the LIST
375 command to display the access list for any nickname.
376
377 <p>
378 <hr align=center width="50%">
379
380 <a name="nick.ajoin"></a>
381 <p><b>AJOIN</b> (requires the <tt>nickserv/autojoin</tt> module)
382
383 <p><dl><dt><b>Syntax:</b>
384 <dd><tt><b>AJOIN ADD <i>channel</i></b></tt>
385 <br><tt><b>AJOIN DEL <i>channel</i></b></tt>
386 <br><tt><b>AJOIN LIST</b></tt>
387 </dl>
388 <p>
389 Modifies or displays the autojoin list for your nickname. This
390 is the list of channels that you would like to automatically
391 join, and takes effect whenever you identify to NickServ.
392 You may only put channel names starting with "<tt>#</tt>" in the
393 autojoin list (local channels cannot be added).
394 <p>
395 Note that the IRC server may prohibit you from entering some
396 channels on the autojoin list, such as channels that have a
397 channel key set (mode <tt>+k</tt>) or are invite-only (mode <tt>+i</tt>).
398 However, if you have access to the ChanServ
399 <tt><a href="#chan.invite">INVITE</a></tt> command on a registered channel,
400 NickServ will automatically invite you into the channel.
401 <p>
402 Services admins can list the autojoin list for any nickname
403 with the format <tt>LIST <i>nickname</i></tt>.
404
405 <p>
406 <hr align=center width="50%">
407
408 <a name="nick.set"></a>
409 <p><b>SET</b>
410
411 <p><dl><dt><b>Syntax:</b>
412 <dd><tt><b>SET <i>option</i> <i>parameters</i></b></tt>
413 </dl>
414 <p>
415 Sets various nickname options. <tt><i>option</i></tt> can be one of:
416 <p>
417 <dl>
418 <dt><tt><b><a href="#nick.set_password">PASSWORD</a></b></tt>
419 <dd>Set your nickname password
420 <dt><tt><b><a href="#nick.set_language">LANGUAGE</a></b></tt>
421 <dd>Set the language Services will use when
422 sending messages to you
423 <dt><tt><b><a href="#nick.set_url">URL</a></b></tt>
424 <dd>Associate a URL with your nickname
425 <dt><tt><b><a href="#nick.set_email">EMAIL</a></b></tt>
426 <dd>Associate an E-mail address with your nickname
427 <dt><tt><b><a href="#nick.set_info">INFO</a></b></tt>
428 <dd>Set text to be displayed with the <tt><a href="#nick.info">INFO</a></tt> command
429 <dt><tt><b><a href="#nick.set_kill">KILL</a></b></tt>
430 <dd>Turn kill protection on or off
431 <dt><tt><b><a href="#nick.set_secure">SECURE</a></b></tt>
432 <dd>Turn nickname security on or off
433 <dt><tt><b><a href="#nick.set_private">PRIVATE</a></b></tt>
434 <dd>Prevent your nickname from appearing in a
435 <tt>/msg NickServ LIST</tt>
436 <dt><tt><b><a href="#nick.set_noop">NOOP</a></b></tt>
437 <dd>Prevent your nickname from being added to channel access lists
438 <dt><tt><b><a href="#nick.set_hide">HIDE</a></b></tt>
439 <dd>Hide certain pieces of nickname information
440 <dt><tt><b><a href="#nick.set_timezone">TIMEZONE</a></b></tt>
441 <dd>Set the time zone to use for displaying times
442 <dt><tt><b><a href="#nick.set_mainnick">MAINNICK</a></b></tt>
443 <dd>Set the nickname shown in channel access lists
444 </dl>
445 <p>
446 In order to use this command, you must first identify
447 with your password (<tt><a href="#nick.identify">/msg NickServ HELP IDENTIFY</a></tt> for more
448 information).
449 <p>
450 Services admins can also set the option <a href="#nick.set_noexpire"><tt>NOEXPIRE</tt></a>, with
451 which nicknames can be prevented from expiring.
452 Additionally, Services admins can set options for any
453 nickname without entering a password, using the format
454 <tt>SET !<i>nickname</i> <i>option</i> <i>parameters</i></tt>.
455
456 <p>
457 <hr align=center width="50%">
458
459 <a name="nick.set_password"></a>
460 <p><b>SET PASSWORD</b>
461
462 <p><dl><dt><b>Syntax:</b>
463 <dd><tt><b>SET PASSWORD <i>new-password</i></b></tt>
464 </dl>
465 <p>
466 Changes the password used to identify you as the nickname's
467 owner.
468
469 <p>
470 <hr align=center width="50%">
471
472 <a name="nick.set_language"></a>
473 <p><b>SET LANGUAGE</b>
474
475 <p><dl><dt><b>Syntax:</b>
476 <dd><tt><b>SET LANGUAGE <i>number</i></b></tt>
477 </dl>
478 <p>
479 Changes the language Services uses when sending messages to
480 you (for example, when responding to a command you send).
481 <tt><i>number</i></tt> should be chosen from the list of
482 supported languages displayed with
483 <tt>/msg NickServ HELP SET LANGUAGE</tt>.
484 <p>
485
486 <p>
487 <hr align=center width="50%">
488
489 <a name="nick.set_url"></a>
490 <p><b>SET URL</b>
491
492 <p><dl><dt><b>Syntax:</b>
493 <dd><tt><b>SET URL <i>url</i></b></tt>
494 </dl>
495 <p>
496 Associates the given URL with your nickname. This URL
497 will be displayed whenever someone requests information
498 on your nickname with the <a href="#nick.info"><tt>INFO</tt></a> command.
499
500 <p>
501 <hr align=center width="50%">
502
503 <a name="nick.set_email"></a>
504 <p><b>SET EMAIL</b>
505
506 <p><dl><dt><b>Syntax:</b>
507 <dd><tt><b>SET EMAIL <i>address</i></b></tt>
508 </dl>
509 <p>
510 Associates the given E-mail address with your nickname.
511 This address will be displayed whenever someone requests
512 information on your nickname with the <a href="#nick.info"><tt>INFO</tt></a> command.
513
514 <p>
515 <hr align=center width="50%">
516
517 <a name="nick.set_info"></a>
518 <p><b>SET INFO</b>
519
520 <p><dl><dt><b>Syntax:</b>
521 <dd><tt><b>SET INFO <i>test</i></b></tt>
522 </dl>
523 <p>
524 Associates the given text with your nickname; it will be
525 displayed whenever someone requests information on your nickname
526 with the <a href="#nick.info"><tt>INFO</tt></a> command.
527
528 <p>
529 <hr align=center width="50%">
530
531 <a name="nick.set_kill"></a>
532 <p><b>SET KILL</b>
533
534 <p><dl><dt><b>Syntax:</b>
535 <dd><tt><b>SET KILL {ON | QUICK | IMMED | OFF}</b></tt>
536 </dl>
537 <p>
538 Turns the automatic kill protection option for your nickname
539 on or off. With kill protection on, if another user
540 tries to take your nick, they will be given one minute to
541 change to another nick, after which they will be forcibly
542 removed from IRC by NickServ.
543 <p>
544 If you select <tt>QUICK</tt>, the user will be given only 20 seconds
545 to change their nickname instead of the usual 60. If you select
546 <tt>IMMED</tt>, the user will be killed immediately <b>without</b> being
547 warned first or given a chance to change their nick; please
548 do not use this option unless necessary. (<tt>IMMED</tt> can be disabled;
549 see the <a href="a.html#nickserv/main.NSAllowKillImmed"><tt>NSAllowKillImmed</tt></a>
550 option in <tt>modules.conf</tt>.)
551
552 <p>
553 <hr align=center width="50%">
554
555 <a name="nick.set_secure"></a>
556 <p><b>SET SECURE</b>
557
558 <p><dl><dt><b>Syntax:</b>
559 <dd><tt><b>SET SECURE {ON | OFF}</b></tt>
560 </dl>
561 <p>
562 Turns NickServ's security features on or off for your
563 nickname. With <tt>SECURE</tt> set, you must enter your password
564 before you will be recognized as the owner of the nick,
565 regardless of whether your address is on the access
566 list. However, if you are on the access list, NickServ
567 will not auto-kill you regardless of the setting of the
568 <a href="#nick.set_kill"><tt>KILL</tt></a> option.
569
570 <p>
571 <hr align=center width="50%">
572
573 <a name="nick.set_private"></a>
574 <p><b>SET PRIVATE</b>
575
576 <p><dl><dt><b>Syntax:</b>
577 <dd><tt><b>SET PRIVATE {ON | OFF}</b></tt>
578 </dl>
579 <p>
580 Turns NickServ's privacy option on or off for your nickname.
581 With <tt>PRIVATE</tt> set, your nickname will not appear in
582 nickname lists generated with NickServ's <a href="#nick.list"><tt>LIST</tt></a> command.
583 (However, anyone who knows your nickname can still get
584 information on it using the <a href="#nick.info"><tt>INFO</tt></a> command.)
585
586 <p>
587 <hr align=center width="50%">
588
589 <a name="nick.set_noop"></a>
590 <p><b>SET NOOP</b>
591
592 <p><dl><dt><b>Syntax:</b>
593 <dd><tt><b>SET NOOP {ON | OFF}</b></tt>
594 </dl>
595 <p>
596 Turns NickServ's no-op option on or off for your nickname.
597 Setting the <tt>NOOP</tt> option prevents your nickname from being
598 added to channel access lists. However, if your nickname is
599 already on a channel's access list, it will not be removed
600 even if you turn this option on.
601
602 <p>
603 <hr align=center width="50%">
604
605 <a name="nick.set_hide"></a>
606 <p><b>SET HIDE</b>
607
608 <p><dl><dt><b>Syntax:</b>
609 <dd><tt><b>SET HIDE {EMAIL | USERMASK | QUIT} {ON | OFF}</b></tt>
610 </dl>
611 <p>
612 Allows you to prevent certain pieces of information from
613 being displayed when someone does a NickServ <a href="#nick.info"><tt>INFO</tt></a> on your
614 nickname. You can hide your E-mail address (<tt>EMAIL</tt>), last seen
615 <tt><i>user</i>@<i>host</i></tt> mask (<tt>USERMASK</tt>), and last quit message (<tt>QUIT</tt>).
616 The second parameter specifies whether the information should
617 be displayed (<tt>OFF</tt>) or hidden (<tt>ON</tt>).
618
619 <p>
620 <hr align=center width="50%">
621
622 <a name="nick.set_timezone"></a>
623 <p><b>SET TIMEZONE</b>
624
625 <p><dl><dt><b>Syntax:</b>
626 <dd><tt><b>SET TIMEZONE {<i>UTC-offset</i> | <i>time-zone</i> | DEFAULT}</b></tt>
627 </dl>
628 <p>
629 Sets the time zone to use for displaying times (such as a
630 nickname or channel's last used time), instead of using the
631 time zone Services is operating in; the <tt>DEFAULT</tt> setting can
632 be used to return to Services' time zone. The time zone can
633 be specified in one of two ways:
634 <p>
635 <ul>
636 <li>As a <b>UTC offset</b>, the time difference between your local
637 time and UTC (Universal Coordinated Time, also known as
638 GMT, Greenwich Mean Time). The offset is given as a
639 "+" or "-" to indicate ahead of (east) or behind (west)
640 UTC, followed by either a whole number of hours or a
641 string in the form "<tt><i>hh</i>:<i>mm</i></tt>".
642 </ul>
643 <ul>
644 <li>As a <b>time zone name</b>, such as "GMT" or "EDT". Not all
645 time zone names are supported by Services, and some
646 countries' time zones have the same names, so if you
647 get an error or the time displayed by Services is
648 wrong, use a UTC offset instead.
649 </ul>
650 Note that Services will not automatically adjust for
651 daylight savings time (summer time); you will have to adjust
652 the time zone manually.
653 <p>
654 Examples:
655 <dl>
656 <dt>
657 <tt> <b>SET TIMEZONE -5</b></tt>
658 <dd>
659 Set the time zone to 5 hours behind UTC.
660 <dt>
661 <tt> <b>SET TIMEZONE +3:30</b></tt>
662 <dd>
663 Set the time zone to 3 hours, 30 minutes ahead of UTC.
664 <dt>
665 <tt> <b>SET TIMEZONE JST</b></tt>
666 <dd>
667 Set the time zone to Japan Standard Time (UTC+9:00).
668 </dl>
669
670 <p>
671 <hr align=center width="50%">
672
673 <a name="nick.set_mainnick"></a>
674 <p><b>SET MAINNICK</b> (requires the <tt>nickserv/link</tt> module)
675
676 <p><dl><dt><b>Syntax:</b>
677 <dd><tt><b>SET MAINNICK <i>nickname</i></b></tt>
678 </dl>
679 <p>
680 When you have several nicknames linked together, allows you to
681 select which one is displayed in channel access lists. If
682 you later unlink this nick, then a different one will be
683 selected automatically.
684
685 <p>
686 <hr align=center width="50%">
687
688 <a name="nick.set_noexpire"></a>
689 <p><b>SET NOEXPIRE</b>
690
691 <p><dl><dt><b>Syntax:</b>
692 <dd><tt><b>SET [<i>nickname</i>] NOEXPIRE {ON | OFF}</b></tt>
693 </dl>
694 <p>
695 Sets whether the given nickname will expire. Setting this
696 to <tt>ON</tt> prevents the nickname from expiring. If no
697 nickname is given, sets the no-expire flag for your nick.
698 <p>
699 Limited to <b>Services admins</b>.
700
701 <p>
702 <hr align=center width="50%">
703
704 <a name="nick.unset"></a>
705 <p><b>UNSET</b>
706
707 <p><dl><dt><b>Syntax:</b>
708 <dd><tt><b>UNSET {URL | EMAIL | INFO}</b></tt>
709 </dl>
710 <p>
711 Allows you to clear the URL (<tt>URL</tt>), E-mail address (<tt>EMAIL</tt>),
712 or information text (<tt>INFO</tt>) associated with your nickname.
713 <p>
714 If the <a href="a.html#nickserv/main.NSRequireEmail"><tt>NSRequireEmail</tt></a>
715 option is set in <tt>modules.conf</tt>, then the E-mail address cannot be
716 cleared (<tt>UNSET EMAIL</tt> will generate an error).
717 <p>
718 Services admins may use the <tt>UNSET</tt> command on any nickname by
719 adding "<tt>!<i>nickname</i></tt>" before the option name, as with the
720 <tt>SET</tt> command.
721
722 <p>
723 <hr align=center width="50%">
724
725 <a name="nick.recover"></a>
726 <p><b>RECOVER</b>
727
728 <p><dl><dt><b>Syntax:</b>
729 <dd><tt><b>RECOVER <i>nickname</i> [<i>password</i>]</b></tt>
730 </dl>
731 <p>
732 Allows you to recover your nickname if someone else has
733 taken it; this does the same thing that NickServ does
734 automatically if someone tries to use a kill-protected
735 nickname.
736 <p>
737 When you give this command, NickServ will bring a fake
738 user online with the same nickname as the user you're
739 trying to recover your nick from, causing the IRC servers
740 to disconnect the other user. This fake user will remain
741 online for one minute (by default, changeable with the
742 <a href="a.html#nickserv/main.NSReleaseTimeout"><tt>NSReleaseTimeout</tt></a>
743 option in <tt>modules.conf</tt>) to ensure that the other user does
744 not immediately reconnect; after that time, you can
745 reclaim your nick. Alternatively, use the <a href="#nick.release"><tt>RELEASE</tt></a>
746 command to get the nick back sooner.
747 <p>
748 In order to use the <tt>RECOVER</tt> command for a nickname, you must
749 supply the correct password for the nickname, or you must
750 already have identified to a nick linked to the given nick.
751
752 <p>
753 <hr align=center width="50%">
754
755 <a name="nick.release"></a>
756 <p><b>RELEASE</b>
757
758 <p><dl><dt><b>Syntax:</b>
759 <dd><tt><b>RELEASE <i>nickname</i> [<i>password</i>]</b></tt>
760 </dl>
761 <p>
762 Instructs NickServ to remove any hold on your nickname
763 caused by automatic kill protection or use of the <a href="#nick.recover"><tt>RECOVER</tt></a>
764 command. By default, such holds last for one minute
765 (changeable with the <a href="a.html#nickserv/main.NSReleaseTimeout"><tt>NSReleaseTimeout</tt></a>
766 option in <tt>modules.conf</tt>); this command gets rid of them sooner.
767 <p>
768 In order to use the <tt>RELEASE</tt> command for a nickname, you must
769 supply the correct password for the nickname, or you must
770 already have identified to a nick linked to the given nick.
771
772 <p>
773 <hr align=center width="50%">
774
775 <a name="nick.ghost"></a>
776 <p><b>GHOST</b>
777
778 <p><dl><dt><b>Syntax:</b>
779 <dd><tt><b>GHOST <i>nickname</i> [<i>password</i>]</b></tt>
780 </dl>
781 <p>
782 Terminates a "ghost" IRC session using your nickname. A
783 "ghost" session is one which is not actually connected,
784 but which the IRC server believes is still online for one
785 reason or another. Typically, this happens if your
786 computer crashes or your Internet or modem connection
787 goes down while you're on IRC.
788 <p>
789 In order to use the <tt>GHOST</tt> command for a nickname, you must
790 supply the correct password for the nickname, or you must
791 already have identified to a nick linked to the given nick.
792
793 <p>
794 <hr align=center width="50%">
795
796 <a name="nick.info"></a>
797 <p><b>INFO</b>
798
799 <p><dl><dt><b>Syntax:</b>
800 <dd><tt><b>INFO <i>nickname</i> [ALL]</b></tt>
801 </dl>
802 <p>
803 Displays information about the given nickname, such as
804 the nickname's owner, last seen address and time, and
805 options. If you are identified for the nick you're
806 getting information for and <tt>ALL</tt> is specified, you will
807 be shown all the information, regardless of whether
808 it's hidden or not.
809 <p>
810 When the <tt>nickserv/mail-auth</tt> module is in use, if the
811 nickname's E-mail address has not yet been confirmed with the
812 <tt>AUTH</tt> command, it will not be shown to anyone except the
813 nickname owner and Services administrators, regardless of the
814 nickname's <tt>SET HIDE EMAIL</tt> setting.
815 <p>
816 Services admins may use the <tt>ALL</tt> parameter with any nickname.
817
818 <p>
819 <hr align=center width="50%">
820
821 <a name="nick.listchans"></a>
822 <p><b>LISTCHANS</b>
823
824 <p><dl><dt><b>Syntax:</b>
825 <dd><tt><b>LISTCHANS</b></tt>
826 </dl>
827 <p>
828 Lists the names and the total number of channels you have
829 registered under your nickname.
830 <p>
831 Services admins may list channels for any nickname by
832 giving the nickname with the command (for example,
833 <tt>/msg NickServ LISTCHANS OtherNick</tt>).
834
835 <p>
836 <hr align=center width="50%">
837
838 <a name="nick.list"></a>
839 <p><b>LIST</b>
840
841 <p><dl><dt><b>Syntax:</b>
842 <dd><tt><b>LIST [+<i>start</i>] <i>pattern</i> [FORBIDDEN] [NOEXPIRE] [SUSPENDED] [NOAUTH]</b></tt>
843 </dl>
844 <p>
845 Lists all registered nicknames for which either the nickname
846 itself or the last seen address (in <tt><i>user</i>@<i>host</i></tt> format) match
847 the given pattern. Nicks with the <a href="#nick.set_private"><tt>PRIVATE</tt></a>
848 option set will only be displayed to Services admins. For
849 Services admins, nicks with the <a href="#nick.set_noexpire"><tt>NOEXPIRE</tt></a> option set will
850 have a <tt>!</tt> prepended to the nickname, those that are
851 suspended will be prepended by a <tt>*</tt>, and those that have not
852 yet been authenticated (with the <a href="#nick.auth"><tt>AUTH</tt></a> command)
853 will be prepended by a <tt>?</tt>.
854 <p>
855 If the <tt><i>start</i></tt> parameter is given, it specifies how many
856 matches to skip before displaying results (for example, <tt>+50</tt>
857 would cause the first 50 matches to be skipped).
858 <p>
859 If the <tt>FORBIDDEN</tt>, <tt>SUSPENDED</tt>, <tt>NOEXPIRE</tt>, or <tt>NOAUTH</tt>
860 options are given, only nicks which, respectively, are forbidden, suspended,
861 have the <tt>NOEXPIRE</tt> option set, or have not yet been authenticated will be
862 displayed. The options can be used in any order and in any combination.
863 These options are limited to <b>Services admins</b>. (Note that the <tt>NOAUTH</tt>
864 option is not available unless the <tt>nickserv/mail-auth</tt> module is
865 loaded.)
866 <p>
867 If the <a href="a.html#nickserv/main.NSListOpersOnly"><tt>NSListOpersOnly</tt></a>
868 option is given in <tt>modules.conf</tt>, only IRC operators will be allowed
869 to use this command.
870 <p>
871 Examples:
872 <dl>
873 <dt>
874 <tt> <b>LIST joeuser@foo.com</b></tt>
875 <dd>
876 Lists all registered nicknames last used by <tt>joeuser@foo.com</tt>.
877 <dt>
878 <tt> <b>LIST *Bot*</b></tt>
879 <dd>
880 Lists all registered nicknames with <tt>Bot</tt> in their
881 names (case insensitive).
882 <dt>
883 <tt> <b>LIST * NOEXPIRE</b></tt>
884 <dd>
885 Lists all registered nicknames which have been set to
886 not expire.
887 </dl>
888
889 <p>
890 <hr align=center width="50%">
891
892 <a name="nick.listemail"></a>
893 <p><b>LISTEMAIL</b>
894
895 <p><dl><dt><b>Syntax:</b>
896 <dd><tt><b>LISTEMAIL [+<i>start</i>] <i>pattern</i> [FORBIDDEN] [NOEXPIRE] [SUSPENDED] [NOAUTH]</b></tt>
897 </dl>
898 <p>
899 Lists registered nicknames like the <a href="#nick.list"><tt>LIST</tt></a>
900 command, but matches on E-mail addresses instead of <tt><i>user</i>@<i>host</i></tt> addresses.
901 See the <a href="#nick.list"><tt>LIST</tt></a> command help for more information.
902
903 <p>
904 <hr align=center width="50%">
905
906 <a name="nick.status"></a>
907 <p><b>STATUS</b>
908
909 <p><dl><dt><b>Syntax:</b>
910 <dd><tt><b>STATUS <i>nickname</i>...</b></tt>
911 </dl>
912 <p>
913 Returns whether the user using the given nickname is
914 recognized as the owner of the nickname. The response has
915 this format:
916 <blockquote>
917 <tt><i>nickname</i> <i>status-code</i></tt>
918 </blockquote>
919 where <tt><i>nickname</i></tt> is the nickname sent with the command, and
920 <tt><i>status-code</i></tt> is one of the following:
921 <p>
922 <dl>
923 <dt><tt><b>0</b></tt>
924 <dd>no such user online <b>or</b> nickname not registered
925 <dt><tt><b>1</b></tt>
926 <dd>user not recognized as nickname's owner
927 <dt><tt><b>2</b></tt>
928 <dd>user recognized as owner via access list only
929 <dt><tt><b>3</b></tt>
930 <dd>user recognized as owner via password identification
931 </dl>
932 Up to sixteen nicknames may be sent with each command; the
933 rest will be ignored. No error message is generated if no
934 nickname is given.
935
936 <p>
937 <hr align=center width="50%">
938
939 <a name="nick.getpass"></a>
940 <p><b>GETPASS</b>
941
942 <p><dl><dt><b>Syntax:</b>
943 <dd><tt><b>GETPASS <i>nickname</i></b></tt>
944 </dl>
945 <p>
946 Returns the password for the given nickname. <b>Note</b> that
947 whenever this command is used, a message including the
948 person who issued the command and the nickname it was used
949 on will be logged.
950 <p>
951 If encryption (see <a href="3.html#7">section 3-7</a>) is in use,
952 this command may not be available depending on the type of encryption used.
953 <p>
954 Limited to <b>Services admins</b>.
955
956 <p>
957 <hr align=center width="50%">
958
959 <a name="nick.forbid"></a>
960 <p><b>FORBID</b>
961
962 <p><dl><dt><b>Syntax:</b>
963 <dd><tt><b>FORBID <i>nickname</i></b></tt>
964 </dl>
965 <p>
966 Disallows a nickname from being registered or used by
967 anyone. May be cancelled by dropping the nickname.
968 <p>
969 Limited to <b>Services admins</b>.
970
971 <p>
972 <hr align=center width="50%">
973
974 <a name="nick.suspend"></a>
975 <p><b>SUSPEND</b>
976
977 <p><dl><dt><b>Syntax:</b>
978 <dd><tt><b>SUSPEND [+<i>expiry</i>] <i>nickname</i> <i>reason</i></b></tt>
979 </dl>
980 <p>
981 Prevents a nickname, and all nicknames linked to it, from
982 being used or identified for by anyone. A nickname can be
983 unsuspended with the <tt>UNSUSPEND</tt> command, which will allow it
984 to be used as before. The <tt><i>expiry</i></tt> parameter is interpreted
985 in the same manner as for the OperServ <a href="#oper.akill"><tt>AKILL</tt></a> command.
986 <p>
987 Limited to <b>Services admins</b>.
988
989 <p>
990 <hr align=center width="50%">
991
992 <a name="nick.unsuspend"></a>
993 <p><b>UNSUSPEND</b>
994
995 <p><dl><dt><b>Syntax:</b>
996 <dd><tt><b>UNSUSPEND <i>nickname</i></b></tt>
997 </dl>
998 <p>
999 Allows people to use and identify for a previously
1000 suspended nickname.
1001 <p>
1002 Limited to <b>Services admins</b>.
1003
1004 <!------------------------------------------------------------------------>
1005 <p><hr>
1006
1007 <a name=2></a>
1008 <h3>4-2. ChanServ commands</h3>
1009
1010 <p>
1011 <hr align=center width="50%">
1012
1013 <a name="chan.register"></a>
1014 <p><b>REGISTER</b>
1015
1016 <p><dl><dt><b>Syntax:</b>
1017 <dd><tt><b>REGISTER <i>channel</i> <i>password</i> <i>description</i></b></tt>
1018 </dl>
1019 <p>
1020 Registers a channel in the ChanServ database. In order
1021 to use this command, you must first be a channel operator
1022 on the channel you're trying to register. The password
1023 is used with the <a href="#chan.identify"><tt>IDENTIFY</tt></a> command to allow you to
1024 make changes to the channel settings at a later time.
1025 The last parameter, which <b>must</b> be included, is a
1026 general description of the channel's purpose.
1027 <p>
1028 When you register a channel, you are recorded as the
1029 "founder" of the channel. The channel founder is allowed
1030 to change all of the channel settings for the channel;
1031 ChanServ will also automatically give the founder
1032 channel-operator privileges when s/he enters the channel.
1033 See the <a href="#chan.access"><tt>ACCESS</tt></a> command (<tt><a href="#chan.access">/msg ChanServ HELP ACCESS</a></tt>) for
1034 information on giving a subset of these privileges to
1035 other channel users.
1036 <p>
1037 NOTICE: In order to register a channel, you must have
1038 first registered and identified for your nickname. If you
1039 haven't, <tt>/msg NickServ HELP</tt> for information on how to do so.
1040 <p>
1041 <p>Non-Services admins may be prevented from registering channels by unsetting the
1042 <a href="a.html#chanserv/main.CSEnableRegister"><tt>CSEnableRegister</tt></a>
1043 option (enabled by default) in <tt>modules.conf</tt>
1044
1045 <p>
1046 <hr align=center width="50%">
1047
1048 <a name="chan.identify"></a>
1049 <p><b>IDENTIFY</b>
1050
1051 <p><dl><dt><b>Syntax:</b>
1052 <dd><tt><b>IDENTIFY <i>channel</i> <i>password</i></b></tt>
1053 </dl>
1054 <p>
1055 Authenticates you to ChanServ as the founder of the given
1056 channel. Many commands require you to use this command
1057 before using them. The password should be the same one
1058 you sent with the <a href="#chan.register"><tt>REGISTER</tt></a> command.
1059
1060 <p>
1061 <hr align=center width="50%">
1062
1063 <a name="chan.drop"></a>
1064 <p><b>DROP</b>
1065
1066 <p><dl><dt><b>Syntax:</b>
1067 <dd><tt><b>DROP <i>channel</i></b></tt>
1068 </dl>
1069 <p>
1070 Unregisters the named channel. Can only be used by
1071 <b>channel founder</b>, who must use the <a href="#chan.identify"><tt>IDENTIFY</tt></a> command first.
1072 (However, Services admins may drop any channel without identifying for the channel.)
1073
1074 <p>
1075 <hr align=center width="50%">
1076
1077 <a name="chan.set"></a>
1078 <p><b>SET</b>
1079
1080 <p><dl><dt><b>Syntax:</b>
1081 <dd><tt><b>SET <i>channel</i> <i>option</i> <i>parameters</i></b></tt>
1082 </dl>
1083 <p>
1084 Allows the channel founder to set various channel options
1085 and other information. The founder must use the <a href="#chan.identify"><tt>IDENTIFY</tt></a>
1086 command before using <tt>SET</tt>.
1087 <p>
1088 Available options:
1089 <p>
1090 <dl>
1091 <dt><tt><b><a href="#chan.set_founder">FOUNDER</a></b></tt>
1092 <dd>Set the founder of a channel
1093 <dt><tt><b><a href="#chan.set_successor">SUCCESSOR</a></b></tt>
1094 <dd>Set the successor for a channel
1095 <dt><tt><b><a href="#chan.set_password">PASSWORD</a></b></tt>
1096 <dd>Set the founder password
1097 <dt><tt><b><a href="#chan.set_desc">DESC</a></b></tt>
1098 <dd>Set the channel description
1099 <dt><tt><b><a href="#chan.set_url">URL</a></b></tt>
1100 <dd>Associate a URL with the channel
1101 <dt><tt><b><a href="#chan.set_email">EMAIL</a></b></tt>
1102 <dd>Associate an E-mail address with the channel
1103 <dt><tt><b><a href="#chan.set_entrymsg">ENTRYMSG</a></b></tt>
1104 <dd>Set a message to be sent to users when they enter the channel
1105 <dt><tt><b><a href="#chan.set_keeptopic">KEEPTOPIC</a></b></tt>
1106 <dd>Retain topic when channel is not in use
1107 <dt><tt><b><a href="#chan.set_topiclock">TOPICLOCK</a></b></tt>
1108 <dd>Topic can only be changed with TOPIC
1109 <dt><tt><b><a href="#chan.set_mlock">MLOCK</a></b></tt>
1110 <dd>Lock channel modes on or off
1111 <dt><tt><b><a href="#chan.set_private">PRIVATE</a></b></tt>
1112 <dd>Hide channel from LIST command
1113 <dt><tt><b><a href="#chan.set_restricted">RESTRICTED</a></b></tt>
1114 <dd>Restrict access to the channel
1115 <dt><tt><b><a href="#chan.set_secure">SECURE</a></b></tt>
1116 <dd>Activate ChanServ security features
1117 <dt><tt><b><a href="#chan.set_secureops">SECUREOPS</a></b></tt>
1118 <dd>Stricter control of chanop status
1119 <dt><tt><b><a href="#chan.set_leaveops">LEAVEOPS</a></b></tt>
1120 <dd>Do not de-op users on channel entry
1121 <dt><tt><b><a href="#chan.set_opnotice">OPNOTICE</a></b></tt>
1122 <dd>Send a notice when OP/VOICE commands are used
1123 <dt><tt><b><a href="#chan.set_enforce">ENFORCE</a></b></tt>
1124 <dd>Enforce auto-op, auto-voice status
1125 <dt><tt><b><a href="#chan.set_memo_restricted">MEMO-RESTRICTED</a></b></tt>
1126 <dd>Limit who can send memos to the channel
1127 </dl>
1128 <p>
1129 Services admins can also set the option <a href="#chan.set_noexpire"><tt>NOEXPIRE</tt></a>, with
1130 which channels can be prevented from expiring.
1131 Additionally, Services admins can set options for any
1132 channel without identifying by password for the channel.
1133
1134 <p>
1135 <hr align=center width="50%">
1136
1137 <a name="chan.set_founder"></a>
1138 <p><b>SET FOUNDER</b>
1139
1140 <p><dl><dt><b>Syntax:</b>
1141 <dd><tt><b>SET <i>channel</i> FOUNDER <i>nickname</i></b></tt>
1142 </dl>
1143 <p>
1144 Changes the founder of a channel. The new nickname must
1145 be a registered one.
1146
1147 <p>
1148 <hr align=center width="50%">
1149
1150 <a name="chan.set_successor"></a>
1151 <p><b>SET SUCCESSOR</b>
1152
1153 <p><dl><dt><b>Syntax:</b>
1154 <dd><tt><b>SET <i>channel</i> SUCCESSOR <i>nickname</i></b></tt>
1155 </dl>
1156 <p>
1157 Changes the successor of a channel. If the founder's
1158 nickname expires or is dropped while the channel is still
1159 registered, the successor will become the new founder of the
1160 channel. However, if the successor already has too many
1161 channels registered (20 by default, changeable with the
1162 <a href="a.html#chanserv/main.CSMaxReg"><tt>CSMaxReg</tt></a> directive
1163 in <tt>modules.conf</tt>), the channel will be dropped
1164 instead, just as if no successor had been set. The
1165 nickname must be a registered one.
1166
1167 <p>
1168 <hr align=center width="50%">
1169
1170 <a name="chan.set_password"></a>
1171 <p><b>SET PASSWORD</b>
1172
1173 <p><dl><dt><b>Syntax:</b>
1174 <dd><tt><b>SET <i>channel</i> PASSWORD <i>password</i></b></tt>
1175 </dl>
1176 <p>
1177 Sets the password used to identify as the founder of the
1178 channel.
1179
1180 <p>
1181 <hr align=center width="50%">
1182
1183 <a name="chan.set_desc"></a>
1184 <p><b>SET DESC</b>
1185
1186 <p><dl><dt><b>Syntax:</b>
1187 <dd><tt><b>SET <i>channel</i> DESC <i>description</i></b></tt>
1188 </dl>
1189 <p>
1190 Sets the description for the channel, which shows up with
1191 the <a href="#chan.list"><tt>LIST</tt></a> and <a href="#chan.info"><tt>INFO</tt></a> commands.
1192
1193 <p>
1194 <hr align=center width="50%">
1195
1196 <a name="chan.set_url"></a>
1197 <p><b>SET URL</b>
1198
1199 <p><dl><dt><b>Syntax:</b>
1200 <dd><tt><b>SET <i>channel</i> URL <i>url</i></b></tt>
1201 </dl>
1202 <p>
1203 Associates the given URL with the channel. This URL will
1204 be displayed whenever someone requests information on the
1205 channel with the <a href="#chan.info"><tt>INFO</tt></a> command.
1206
1207 <p>
1208 <hr align=center width="50%">
1209
1210 <a name="chan.set_email"></a>
1211 <p><b>SET EMAIL</b>
1212
1213 <p><dl><dt><b>Syntax:</b>
1214 <dd><tt><b>SET <i>channel</i> EMAIL <i>address</i></b></tt>
1215 </dl>
1216 <p>
1217 Associates the given E-mail address with the channel.
1218 This address will be displayed whenever someone requests
1219 information on the channel with the <a href="#chan.info"><tt>INFO</tt></a> command.
1220
1221 <p>
1222 <hr align=center width="50%">
1223
1224 <a name="chan.set_entrymsg"></a>
1225 <p><b>SET ENTRYMSG</b>
1226
1227 <p><dl><dt><b>Syntax:</b>
1228 <dd><tt><b>SET <i>channel</i> ENTRYMSG <i>message</i></b></tt>
1229 </dl>
1230 <p>
1231 Sets the message which will be sent via <tt>/NOTICE</tt> to users
1232 when they enter the channel.
1233
1234 <p>
1235 <hr align=center width="50%">
1236
1237 <a name="chan.set_keeptopic"></a>
1238 <p><b>SET KEEPTOPIC</b>
1239
1240 <p><dl><dt><b>Syntax:</b>
1241 <dd><tt><b>SET <i>channel</i> KEEPTOPIC {ON | OFF}</b></tt>
1242 </dl>
1243 <p>
1244 Enables or disables the <b>topic retention</b> option for a
1245 channel. When <b>topic retention</b> is set, the topic for the
1246 channel will be remembered by ChanServ even after the
1247 last user leaves the channel, and will be restored the
1248 next time the channel is created.
1249
1250 <p>
1251 <hr align=center width="50%">
1252
1253 <a name="chan.set_topiclock"></a>
1254 <p><b>SET TOPICLOCK</b>
1255
1256 <p><dl><dt><b>Syntax:</b>
1257 <dd><tt><b>SET <i>channel</i> TOPICLOCK {ON | OFF}</b></tt>
1258 </dl>
1259 <p>
1260 Enables or disables the <b>topic lock</b> option for a channel.
1261 When <b>topic lock</b> is set, ChanServ will not allow the
1262 channel topic to be changed except via the <a href="#chan.topic"><tt>TOPIC</tt></a>
1263 command.
1264
1265 <p>
1266 <hr align=center width="50%">
1267
1268 <a name="chan.set_mlock"></a>
1269 <p><b>SET MLOCK</b>
1270
1271 <p><dl><dt><b>Syntax:</b>
1272 <dd><tt><b>SET <i>channel</i> MLOCK <i>modes</i></b></tt>
1273 </dl>
1274 <p>
1275 Sets the mode-lock parameter for the channel. ChanServ
1276 allows you to define certain channel modes to be always
1277 on (or off). All binary modes (<tt>n</tt>, <tt>s</tt>, <tt>t</tt>, <tt>k</tt>, <tt>l</tt>, and so on)
1278 can be locked; each mode can be locked on, locked off, or
1279 not locked. The <tt><i>modes</i></tt> parameter is constructed exactly
1280 the same way as a <b><tt>/MODE</tt></b> command; that is, modes followed by
1281 a <tt>+</tt> are locked on, and modes followed by a <tt>-</tt> are locked off.
1282 <p>
1283 <b>Warning:</b> If you set a mode-locked key, as in the second
1284 example below, you should also set the <a href="#chan.set_restricted"><tt>RESTRICTED</tt></a>
1285 option for the channel, or anyone entering
1286 the channel when it is empty will be able to see the key!
1287 <tt>MLOCK +i</tt> will likewise not prevent users from entering the
1288 channel when it is empty without being invited.
1289 <p>
1290 <dl><dt>Examples:
1291 <dd><dl>
1292 <dt>
1293 <tt> <b>SET #channel MLOCK +nt-ikl</b></tt>
1294 <dd>
1295 Forces modes <tt>n</tt> and <tt>t</tt> on, and modes <tt>i</tt>, <tt>k</tt>, and <tt>l</tt> off.
1296 All other modes are left free to be either on or off.
1297 <dt>
1298 <tt> <b>SET #channel MLOCK +knst-ilmp my-key</b></tt>
1299 <dd>
1300 Forces modes <tt>k</tt>, <tt>n</tt>, <tt>s</tt>, and <tt>t</tt> on, and modes <tt>i</tt>, <tt>l</tt>, <tt>m</tt>,
1301 and <tt>p</tt> off. Also forces the channel key to be
1302 "<tt>my-key</tt>".
1303 <dt>
1304 <tt> <b>SET #channel MLOCK +</b></tt>
1305 <dd>
1306 Removes the mode lock; all channel modes are free
1307 to be either on or off.
1308 </dl>
1309 </dl>
1310
1311 <p>
1312 <hr align=center width="50%">
1313
1314 <a name="chan.set_hide"></a>
1315 <p><b>SET HIDE</b>
1316
1317 <p><dl><dt><b>Syntax:</b>
1318 <dd><tt><b>SET <i>channel</i> HIDE {EMAIL | TOPIC | MLOCK} {ON | OFF}</b></tt>
1319 </dl>
1320 <p>
1321 Allows you to prevent certain pieces of information from
1322 being displayed when someone does a ChanServ <a href="#chan.info"><tt>INFO</tt></a> on the
1323 given channel. You can hide the channel's E-mail address
1324 (<tt>EMAIL</tt>), last topic (<tt>TOPIC</tt>), and mode lock (<tt>MLOCK</tt>).
1325 The second parameter specifies whether the information should
1326 be displayed (<tt>OFF</tt>) or hidden (<tt>ON</tt>).
1327 <p>
1328 Note that the topic will always be hidden if the channel is
1329 mode-locked <tt>+p</tt> or <tt>+s</tt>.
1330
1331 <p>
1332 <hr align=center width="50%">
1333
1334 <a name="chan.set_private"></a>
1335 <p><b>SET PRIVATE</b>
1336
1337 <p><dl><dt><b>Syntax:</b>
1338 <dd><tt><b>SET <i>channel</i> PRIVATE {ON | OFF}</b></tt>
1339 </dl>
1340 <p>
1341 Enables or disables the <b>private</b> option for a channel.
1342 When <b>private</b> is set, a <tt>/msg ChanServ LIST</tt> will not
1343 include the channel in any lists.
1344
1345 <p>
1346 <hr align=center width="50%">
1347
1348 <a name="chan.set_restricted"></a>
1349 <p><b>SET RESTRICTED</b>
1350
1351 <p><dl><dt><b>Syntax:</b>
1352 <dd><tt><b>SET <i>channel</i> RESTRICTED {ON | OFF}</b></tt>
1353 </dl>
1354 <p>
1355 Enables or disables the <b>restricted access</b> option for a
1356 channel. When <b>restricted access</b> is set, users who are not
1357 on the access list or who would normally be disallowed from
1358 having channel operator privileges will be kicked and banned
1359 from the channel.
1360
1361 <p>
1362 <hr align=center width="50%">
1363
1364 <a name="chan.set_secure"></a>
1365 <p><b>SET SECURE</b>
1366
1367 <p><dl><dt><b>Syntax:</b>
1368 <dd><tt><b>SET <i>channel</i> SECURE {ON | OFF}</b></tt>
1369 </dl>
1370 <p>
1371 Enables or disables ChanServ's security features for a
1372 channel. When <tt>SECURE</tt> is set, only users who have registered
1373 their nicknames with NickServ and <tt>IDENTIFY</tt>'d with their
1374 password will be given privileges on the channel as
1375 controlled by the access list. If the <tt>RESTRICTED</tt> option is
1376 also set, users will not be able to join the channel until
1377 they identify to NickServ.
1378
1379 <p>
1380 <hr align=center width="50%">
1381
1382 <a name="chan.set_secureops"></a>
1383 <p><b>SET SECUREOPS</b>
1384
1385 <p><dl><dt><b>Syntax:</b>
1386 <dd><tt><b>SET <i>channel</i> SECUREOPS {ON | OFF}</b></tt>
1387 </dl>
1388 <p>
1389 Enables or disables the <b>secure ops</b> option for a channel.
1390 When <b>secure ops</b> is set, users who are not on the access list
1391 will not be allowed chanop status.
1392
1393 <p>
1394 <hr align=center width="50%">
1395
1396 <a name="chan.set_leaveops"></a>
1397 <p><b>SET LEAVEOPS</b>
1398
1399 <p><dl><dt><b>Syntax:</b>
1400 <dd><tt><b>SET <i>channel</i> LEAVEOPS {ON | OFF}</b></tt>
1401 </dl>
1402 <p>
1403 Enables or disables the <b>leave ops</b> option for a channel.
1404 When <b>leave ops</b> is set, ChanServ will leave server ops (<tt>+o</tt> for
1405 the first person in the channel) in place even if the user
1406 would not normally get auto-opped. The SECUREOPS option will still
1407 be enforced.
1408 <b>Notice:</b> This can allow users to "steal" ops during a netsplit.
1409
1410 <p>
1411 <hr align=center width="50%">
1412
1413 <a name="chan.set_opnotice"></a>
1414 <p><b>SET OPNOTICE</b>
1415
1416 <p><dl><dt><b>Syntax:</b>
1417 <dd><tt><b>SET <i>channel</i> OPNOTICE {ON | OFF}</b></tt>
1418 </dl>
1419 <p>
1420 Enables or disables the <b>op-notice</b> option for a channel.
1421 When <b>op-notice</b> is set, ChanServ will send a notice to the
1422 channel whenever the <a href="#chan.op"><tt>OP</tt></a>,
1423 <a href="#chan.voice"><tt>VOICE</tt></a>, or related commands are used
1424 for a user in the channel.
1425
1426 <p>
1427 <hr align=center width="50%">
1428
1429 <a name="chan.set_enforce"></a>
1430 <p><b>SET ENFORCE</b>
1431
1432 <p><dl><dt><b>Syntax:</b>
1433 <dd><tt><b>SET <i>channel</i> ENFORCE {ON | OFF}</b></tt>
1434 </dl>
1435 <p>
1436 Enables or disables the <b>enforce</b> option for a channel.
1437 When <b>enforce</b> is set, ChanServ will enforce the auto-op and
1438 auto-voice levels for all users. For example, if a user
1439 with auto-op privileges is deopped, ChanServ will
1440 automatically op the user again, and ChanServ will also
1441 not allow the <a href="#chan.deop"><tt>DEOP</tt></a> command to be used on that user.
1442
1443 <p>
1444 <hr align=center width="50%">
1445
1446 <a name="chan.set_memo_restricted"></a>
1447 <p><b>SET MEMO-RESTRICTED</b>
1448
1449 <p><dl><dt><b>Syntax:</b>
1450 <dd><tt><b>SET <i>channel</i> MEMO-RESTRICTED {ON | OFF}</b></tt>
1451 </dl>
1452 <p>
1453 Enables or disables the <b>memo restriction</b> option for a
1454 channel. When <b>memo restriction</b> is set, only users with
1455 privileges to receive channel memos will be able to send
1456 memos to the channel.
1457
1458 <p>
1459 <hr align=center width="50%">
1460
1461 <a name="chan.set_noexpire"></a>
1462 <p><b>SET NOEXPIRE</b>
1463
1464 <p><dl><dt><b>Syntax:</b>
1465 <dd><tt><b>SET <i>channel</i> NOEXPIRE {ON | OFF}</b></tt>
1466 </dl>
1467 <p>
1468 Sets whether the given channel will expire. Setting this
1469 to <tt>ON</tt> prevents the channel from expiring.
1470 <p>
1471 Limited to <b>Services admins</b>.
1472
1473 <p>
1474 <hr align=center width="50%">
1475
1476 <a name="chan.unset"></a>
1477 <p><b>UNSET</b>
1478
1479 <p><dl><dt><b>Syntax:</b>
1480 <dd><tt><b>UNSET <i>channel</i> {SUCCESSOR | URL | EMAIL | ENTRYMSG}</b></tt>
1481 </dl>
1482 <p>
1483 Clears the given setting for a channel.
1484 <p>
1485 As with the <a href="#chan.set"><tt>SET</tt></a> command, Services admins can clear settings
1486 for any channel without identifying for the channel.
1487
1488 <p>
1489 <hr align=center width="50%">
1490
1491 <a name="chan.sop"></a>
1492 <p><b>SOP</b> (requires the <tt>chanserv/access-xop</tt> module)
1493
1494 <p><dl><dt><b>Syntax:</b>
1495 <dd><tt><b>SOP <i>channel</i> ADD <i>nickname</i></b></tt>
1496 <br><tt><b>SOP <i>channel</i> DEL <i>nickname</i></b></tt>
1497 <br><tt><b>SOP <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1498 <br><tt><b>SOP <i>channel</i> COUNT</b></tt>
1499 </dl>
1500 <p>
1501 Maintains the <b>SuperOp</b> (SOP) list for a channel. Users with
1502 <b>SOP</b> status are automatically opped (set mode <tt>+o</tt>) and
1503 protected (mode <tt>+a</tt>), if supported by the IRC server) when they join
1504 the channel.
1505 <p>
1506 An SOP can modify the AOP, HOP (if the IRC server supports halfops),
1507 VOP, and NOP lists. Only a channel's founder can modify the SOP list.
1508 <p>
1509 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>LIST</tt>, and <tt>COUNT</tt>
1510 subcommands function the same way as for the
1511 <a href="#chan.aop"><tt>AOP</tt></a> command.
1512
1513 <p>
1514 <hr align=center width="50%">
1515
1516 <a name="chan.aop"></a>
1517 <p><b>AOP</b> (requires the <tt>chanserv/access-xop</tt> module)
1518
1519 <p><dl><dt><b>Syntax:</b>
1520 <dd><tt><b>AOP <i>channel</i> ADD <i>nickname</i></b></tt>
1521 <br><tt><b>AOP <i>channel</i> DEL <i>nickname</i></b></tt>
1522 <br><tt><b>AOP <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1523 <br><tt><b>AOP <i>channel</i> COUNT</b></tt>
1524 </dl>
1525 <p>
1526 Maintains the <b>AutoOp</b> (AOP) list for a channel. Users with
1527 <b>AOP</b> status are automatically opped (set mode <tt>+o</tt>) when they
1528 join the channel.
1529 <p>
1530 An AOP can modify the HOP (if the IRC server supports halfops), VOP, and
1531 NOP lists; SOPs can modify the AOP list.
1532 <p>
1533 The <tt>AOP ADD</tt> command adds a user to the AOP list, and the
1534 <tt>AOP DEL</tt> command removes a user from the AOP list. Note that
1535 a user can only be on one channel access list at once; if
1536 the user given in an <tt>AOP ADD</tt> command is already on another
1537 channel access list, such as the VOP list, they will be
1538 removed from that list first. (If you would not be allowed
1539 to modify that list&mdash;for example, if the user is already on
1540 the SOP list and you are not the channel founder&mdash;then the
1541 <tt>AOP ADD</tt> command will fail.)
1542 <p>
1543 The <tt>AOP LIST</tt> command displays the AOP list. If a wildcard
1544 mask is given, only those entries matching the mask are
1545 displayed. If the <tt><i>start</i></tt> parameter is given, it
1546 specifies how many matches to skip before displaying results
1547 (for example, <tt>+50</tt> would cause the first 50 matches to be
1548 skipped).
1549 <p>
1550 The <tt>AOP COUNT</tt> command shows the number of entries there are
1551 are on the AOP list.
1552
1553 <p>
1554 <hr align=center width="50%">
1555
1556 <a name="chan.hop"></a>
1557 <p><b>HOP</b> (requires the <tt>chanserv/access-xop</tt> module)
1558
1559 <p><dl><dt><b>Syntax:</b>
1560 <dd><tt><b>HOP <i>channel</i> ADD <i>nickname</i></b></tt>
1561 <br><tt><b>HOP <i>channel</i> DEL <i>nickname</i></b></tt>
1562 <br><tt><b>HOP <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1563 <br><tt><b>HOP <i>channel</i> COUNT</b></tt>
1564 </dl>
1565 <p>
1566 Maintains the <b>HalfOp</b> (HOP) list for a channel. Users with
1567 <b>HOP</b> status are automatically halfopped (set mode <tt>+h</tt>) when
1568 they join the channel.
1569 <p>
1570 An HOP can modify the VOP and NOP lists; SOPs and AOPs can modify the
1571 HOP list.
1572 <p>
1573 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>LIST</tt>, and <tt>COUNT</tt>
1574 subcommands function the same way as for the
1575 <a href="#chan.aop"><tt>AOP</tt></a> command.
1576 <p>
1577 Note that this command is only available if the IRC server in use
1578 supports halfops.
1579
1580 <p>
1581 <hr align=center width="50%">
1582
1583 <a name="chan.vop"></a>
1584 <p><b>VOP</b> (requires the <tt>chanserv/access-xop</tt> module)
1585
1586 <p><dl><dt><b>Syntax:</b>
1587 <dd><tt><b>VOP <i>channel</i> ADD <i>nickname</i></b></tt>
1588 <br><tt><b>VOP <i>channel</i> DEL <i>nickname</i></b></tt>
1589 <br><tt><b>VOP <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1590 <br><tt><b>VOP <i>channel</i> COUNT</b></tt>
1591 </dl>
1592 <p>
1593 Maintains the <b>VoiceOp</b> (VOP) list for a channel. Users with
1594 <b>VOP</b> status are automatically voiced (set mode <tt>+v</tt>) when they
1595 join the channel.
1596 <p>
1597 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>LIST</tt>, and <tt>COUNT</tt>
1598 subcommands function the same way as for the
1599 <a href="#chan.aop"><tt>AOP</tt></a> command.
1600
1601 <p>
1602 <hr align=center width="50%">
1603
1604 <a name="chan.nop"></a>
1605 <p><b>NOP</b> (requires the <tt>chanserv/access-xop</tt> module)
1606
1607 <p><dl><dt><b>Syntax:</b>
1608 <dd><tt><b>NOP <i>channel</i> ADD <i>nickname</i></b></tt>
1609 <br><tt><b>NOP <i>channel</i> DEL <i>nickname</i></b></tt>
1610 <br><tt><b>NOP <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1611 <br><tt><b>NOP <i>channel</i> COUNT</b></tt>
1612 </dl>
1613 <p>
1614 Maintains the <b>NeverOp</b> (NOP) list for a channel. Users with
1615 <b>NOP</b> status are not permitted to be given channel operator
1616 (mode <tt>+o</tt>) status, and ChanServ will remove mode <tt>+o</tt> from such
1617 users whenever it is given to them.
1618 <p>
1619 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>LIST</tt>, and <tt>COUNT</tt>
1620 subcommands function the same way as for the
1621 <a href="#chan.aop"><tt>AOP</tt></a> command.
1622
1623 <p>
1624 <hr align=center width="50%">
1625
1626 <a name="chan.access"></a>
1627 <p><tt>ACCESS</tt> (requires the <tt>chanserv/access-levels</tt> module)
1628
1629 <p><dl><dt><b>Syntax:</b>
1630 <dd><tt><b>ACCESS <i>channel</i> ADD <i>nickname</i> <i>level</i></b></tt>
1631 <br><tt><b>ACCESS <i>channel</i> DEL <i>nickname</i></b></tt>
1632 <br><tt><b>ACCESS <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1633 <br><tt><b>ACCESS <i>channel</i> LISTLEVEL [+<i>start</i>] <i>level</i></b></tt>
1634 <br><tt><b>ACCESS <i>channel</i> COUNT</b></tt>
1635 </dl>
1636 <p>
1637 Maintains the <b>access list</b> for a channel. The access
1638 list specifies which users are allowed chanop status or
1639 access to ChanServ commands on the channel. Different
1640 user levels allow for access to different subsets of
1641 privileges; <tt>/msg ChanServ HELP ACCESS LEVELS</tt> for more
1642 specific information. Any nickname not on the access list has
1643 a user level of 0.
1644 <p>
1645 The <tt>ACCESS ADD</tt> command adds the given nickname to the
1646 access list with the given user level; if the nick is
1647 already present on the list, its access level is changed to
1648 the level specified in the command. The <tt><i>level</i></tt> specified
1649 must be less than that of the user giving the command, and
1650 if the nick is already on the access list, the current
1651 access level of that nick must be less than the access level
1652 of the user giving the command.
1653 <p>
1654 The <tt>ACCESS DEL</tt> command removes the given nickname from the
1655 access list.
1656 <p>
1657 The <tt>ACCESS LIST</tt> command displays the access list. If
1658 a wildcard mask is given, only those entries matching the
1659 mask are displayed. If the <tt><i>start</i></tt> parameter is given, it
1660 specifies how many matches to skip before displaying results
1661 (for example, <tt>+50</tt> would cause the first 50 matches to be
1662 skipped).
1663 <p>
1664 The <tt>ACCESS LISTLEVEL</tt> command is similar to <tt>ACCESS LIST</tt>, but
1665 displays only entries with the given access level. The
1666 level can be specified as a range: <tt>LISTLEVEL 50-100</tt>, for
1667 example, lists all users with access levels between 50 and 100
1668 inclusive.
1669 <p>
1670 The <tt>ACCESS COUNT</tt> command returns the number of entries
1671 there are on the access list.
1672 <p>
1673 Note that the access list may also be manipulated with the
1674 <a href="#chan.sop"><tt>SOP</tt></a>, <a href="#chan.aop"><tt>AOP</tt></a>,
1675 <a href="#chan.hop"><tt>HOP</tt></a>, <a href="#chan.vop"><tt>VOP</tt></a>,
1676 and <a href="#chan.nop"><tt>NOP</tt></a> commands, which correspond to
1677 levels of 100, 50, 40, 30, and -1 respectively, if the
1678 <tt>chanserv/access-xop</tt> module is also loaded.
1679
1680 <p>
1681 <hr align=center width="50%">
1682
1683 <a name="chan.levels"></a>
1684 <p><b>LEVELS</b> (requires the <tt>chanserv/access-levels</tt> module)
1685
1686 <p><dl><dt><b>Syntax:</b>
1687 <dd><tt><b>LEVELS <i>channel</i> SET <i>type</i> <i>level</i></b></tt>
1688 <br><tt><b>LEVELS <i>channel</i> {DIS | DISABLE} <i>type</i></b></tt>
1689 <br><tt><b>LEVELS <i>channel</i> LIST</b></tt>
1690 <br><tt><b>LEVELS <i>channel</i> RESET</b></tt>
1691 </dl>
1692 <p>
1693 The <tt>LEVELS</tt> command allows fine control over the meaning of
1694 the numeric access levels used by the <a href="#chan.access"><tt>ACCESS</tt></a> command. With
1695 this command, you can define the access level required for
1696 most of ChanServ's functions. (The <a href="#chan.set_founder"><tt>SET FOUNDER</tt></a> and <a href="#chan.set_password"><tt>SET PASSWORD</tt></a>
1697 commands, as well as this command, are always restricted to
1698 the channel founder.)
1699 <p>
1700 <b>Caution:</b> This command is for advanced users only! Changing
1701 level settings with this command may cause the <tt>SOP</tt>, <tt>AOP</tt>,
1702 <tt>HOP</tt>, <tt>VOP</tt>, and <tt>NOP</tt> commands to stop working
1703 correctly.
1704 <p>
1705 <tt>LEVELS SET</tt> allows the access level for a function or group of
1706 functions to be changed. <tt>LEVELS DISABLE</tt> (or <tt>DIS</tt> for short)
1707 disables an automatic feature or disallows access to a
1708 function by anyone other than the channel founder.
1709 <tt>LEVELS LIST</tt> shows the current levels for each function or
1710 group of functions. <tt>LEVELS RESET</tt> resets the levels to the
1711 default levels of a newly-created channel (see <tt>HELP ACCESS LEVELS</tt>).
1712 <p>
1713 For a list of the features and functions whose levels can be
1714 set, see <tt>HELP LEVELS DESC</tt>.
1715
1716 <p>
1717 <hr align=center width="50%">
1718
1719 <a name="chan.akick"></a>
1720 <p><b>AKICK</b>
1721
1722 <p><dl><dt><b>Syntax:</b>
1723 <dd><tt><b>AKICK <i>channel</i> ADD <i>mask</i> [<i>reason</i>]</b></tt>
1724 <br><tt><b>AKICK <i>channel</i> DEL <i>mask</i></b></tt>
1725 <br><tt><b>AKICK <i>channel</i> LIST [+<i>start</i>] [<i>mask</i>]</b></tt>
1726 <br><tt><b>AKICK <i>channel</i> VIEW [+<i>start</i>] [<i>mask</i>]</b></tt>
1727 <br><tt><b>AKICK <i>channel</i> COUNT</b></tt>
1728 <br><tt><b>AKICK <i>channel</i> ENFORCE</b></tt>
1729 </dl>
1730 <p>
1731 Maintains the <b>autokick list</b> for a channel. If a user
1732 on the autokick list attempts to join the channel,
1733 ChanServ will ban that user from the channel, then kick
1734 the user.
1735 <p>
1736 The <tt>AKICK ADD</tt> command adds the given <tt><i>user</i>@<i>host</i></tt> or
1737 <tt><i>nickname</i>!<i>user</i>@<i>host</i></tt> mask to the autokick list.
1738 If a <tt><i>reason</i></tt> is given with the command, that reason will be
1739 used in the kick message when the user is kicked.
1740 <p>
1741 The <tt>AKICK DEL</tt> command removes the given mask
1742 from the autokick list. It does not, however, remove any
1743 bans placed by an autokick; those must be removed
1744 manually.
1745 <p>
1746 The <tt>AKICK LIST</tt> command displays the autokick list, or
1747 optionally only those autokick entries which match the
1748 given mask. <tt>AKICK VIEW</tt> is similar, but shows more details.
1749 If the <tt><i>start</i></tt> parameter is given to either command, it
1750 specifies how many matches to skip before displaying results
1751 (for example, <tt>+50</tt> would cause the first 50 matches to be
1752 skipped).
1753 <p>
1754 The <tt>AKICK COUNT</tt> command shows how many entries there
1755 are on the autokick list.
1756 <p>
1757 The <tt>AKICK ENFORCE</tt> command causes ChanServ to enforce the
1758 current autokick list by removing those users who match an
1759 autokick mask.
1760 <p>
1761 By default, limited to users with level 100 (SOP) access and
1762 above on the channel.
1763
1764 <p>
1765 <hr align=center width="50%">
1766
1767 <a name="chan.info"></a>
1768 <p><b>INFO</b>
1769
1770 <p><dl><dt><b>Syntax:</b>
1771 <dd><tt><b>INFO <i>channel</i> [ALL]</b></tt>
1772 </dl>
1773 <p>
1774 Lists information about the named registered channel,
1775 including its founder, time of registration, last time
1776 used, description, and mode lock, if any. If you are
1777 identified as the founder of the channel you're getting
1778 information for and <tt>ALL</tt> is specified, the entry message
1779 and successor will also be displayed.
1780 <p>
1781 Services admins can use the <tt>ALL</tt> parameter with any channel.
1782
1783 <p>
1784 <hr align=center width="50%">
1785
1786 <a name="chan.list"></a>
1787 <p><b>LIST</b>
1788
1789 <p><dl><dt><b>Syntax:</b>
1790 <dd><tt><b>LIST [+<i>start</i>] <i>pattern</i></b></tt>
1791 </dl>
1792 <p>
1793 Lists all registered channels matching the given pattern.
1794 Channels with the <a href="#chan.set_private"><tt>PRIVATE</tt></a> option set will only be displayed
1795 to Services admins. Channels with the <a href="#chan.set_noexpire"><tt>NOEXPIRE</tt></a> option set
1796 will have a <tt>!</tt> prepended to the channel name for Services
1797 admins.
1798 <p>
1799 If the <tt><i>start</i></tt> parameter is given, it specifies how many
1800 matches to skip before displaying results (for example, <tt>+50</tt>
1801 would cause the first 50 matches to be skipped).
1802 <p>
1803 If the <tt>FORBIDDEN</tt>, <tt>SUSPENDED</tt> or <tt>NOEXPIRE</tt> options are given,
1804 only channels which, respectively, are forbidden, suspended or
1805 have the <tt>NOEXPIRE</tt> flag set will be displayed. The options can
1806 be used in any order and in any combination. These options
1807 are limited to <tt>Services admins</tt>.
1808 <p>
1809 If the <a href="a.html#chanserv/main.CSListOpersOnly"><tt>CSListOpersOnly</tt></a>
1810 option is given in <tt>modules.conf</tt>, only IRC operators will be allowed
1811 to use this command.
1812
1813 <p>
1814 <hr align=center width="50%">
1815
1816 <a name="chan.op"></a>
1817 <p><b>OP</b>
1818
1819 <p><dl><dt><b>Syntax:</b>
1820 <dd><tt><b>OP <i>#channel</i> [<i>nickname</i>]</b></tt>
1821 </dl>
1822 <p>
1823 Ops a selected nickname on a channel. If <tt><i>nickname</i></tt> is not given, ops
1824 you. By default, limited to users with level 50 (AOP) access and
1825 above on the channel.
1826
1827 <p>
1828 <hr align=center width="50%">
1829
1830 <a name="chan.deop"></a>
1831 <p><b>DEOP</b>
1832
1833 <p><dl><dt><b>Syntax:</b>
1834 <dd><tt><b>DEOP <i>#channel</i> [<i>nickname</i>]</b></tt>
1835 </dl>
1836 <p>
1837 Deops a selected nickname on a channel. If <tt><i>nickname</i></tt> is not given,
1838 deops you. By default, limited to users with level 50 (AOP) access
1839 and above on the channel.
1840
1841 <p>
1842 <hr align=center width="50%">
1843
1844 <a name="chan.voice"></a>
1845 <p><b>VOICE</b>
1846
1847 <p><dl><dt><b>Syntax:</b>
1848 <dd><tt><b>VOICE <i>#channel</i> [<i>nickname</i>]</b></tt>
1849 </dl>
1850 <p>
1851 Voices a selected nickname on a channel. If <tt><i>nickname</i></tt> is not given,
1852 voices you. By default, limited to users with level 30 (VOP) access
1853 and above on the channel.
1854
1855 <p>
1856 <hr align=center width="50%">
1857
1858 <a name="chan.devoice"></a>
1859 <p><b>DEVOICE</b>
1860
1861 <p><dl><dt><b>Syntax:</b>
1862 <dd><tt><b>DEVOICE <i>#channel</i> [<i>nickname</i>]</b></tt>
1863 </dl>
1864 <p>
1865 Devoices a selected nickname on a channel. If <tt><i>nickname</i></tt> is not given,
1866 devoices you. By default, limited to users with level 30 (VOP)
1867 access and above on the channel.
1868
1869 <p>
1870 <hr align=center width="50%">
1871
1872 <a name="chan.halfop"></a>
1873 <p><b>HALFOP</b>
1874
1875 <p><dl><dt><b>Syntax:</b>
1876 <dd><tt><b>HALFOP <i>#channel</i> [<i>nickname</i>]</b></tt>
1877 </dl>
1878 <p>
1879 Gives halfop access to a selected nickname on a channel. If
1880 <tt><i>nickname</i></tt> is not given, gives you halfop access. By default,
1881 limited to users with level 40 (HOP) access and above on the
1882 channel. Only available with IRC servers which support halfops.
1883
1884 <p>
1885 <hr align=center width="50%">
1886
1887 <a name="chan.dehalfop"></a>
1888 <p><b>DEHALFOP</b>
1889
1890 <p><dl><dt><b>Syntax:</b>
1891 <dd><tt><b>DEHALFOP <i>#channel</i> [<i>nickname</i>]</b></tt>
1892 </dl>
1893 <p>
1894 Removes halfop access from a selected nickname on a channel. If
1895 <tt><i>nickname</i></tt> is not given, removes halfop access from you. By
1896 default, limited to users with level 40 (HOP) access and above on
1897 the channel. Only available with IRC servers which support halfops.
1898
1899 <p>
1900 <hr align=center width="50%">
1901
1902 <a name="chan.protect"></a>
1903 <p><b>PROTECT</b>
1904
1905 <p><dl><dt><b>Syntax:</b>
1906 <dd><tt><b>PROTECT <i>#channel</i> [<i>nickname</i>]</b></tt>
1907 </dl>
1908 <p>
1909 Gives channel protection (mode <tt>+a</tt>) to a selected nickname on a
1910 channel. If <tt><i>nickname</i></tt> is not given, gives channel protection to
1911 you. By default, limited to users with level 100 (SOP) access and
1912 above on the channel. Only available with IRC servers which
1913 support this mode.
1914
1915 <p>
1916 <hr align=center width="50%">
1917
1918 <a name="chan.deprotect"></a>
1919 <p><b>DEPROTECT</b>
1920
1921 <p><dl><dt><b>Syntax:</b>
1922 <dd><tt><b>DEPROTECT <i>#channel</i> [<i>nickname</i>]</b></tt>
1923 </dl>
1924 <p>
1925 Removes channel protection (mode <tt>+a</tt>) from a selected nickname
1926 on a channel. If <tt><i>nickname</i></tt> is not given, removes channel
1927 protection from you. By default, limited to users with
1928 level 100 (SOP) access and above on the channel. Only available with IRC
1929 servers which support this mode.
1930
1931 <p>
1932 <hr align=center width="50%">
1933
1934 <a name="chan.invite"></a>
1935 <p><b>INVITE</b>
1936
1937 <p><dl><dt><b>Syntax:</b>
1938 <dd><tt><b>INVITE <i>channel</i></b></tt>
1939 </dl>
1940 <p>
1941 Tells ChanServ to invite you into the given channel. By
1942 default, limited to users with level 50 (AOP) access and
1943 above on the channel.
1944 <p>
1945 Note: If you get a message saying that the channel is not in
1946 use, it means that the channel is empty, and you can join it
1947 freely without needing to use this command.
1948
1949 <p>
1950 <hr align=center width="50%">
1951
1952 <a name="chan.unban"></a>
1953 <p><b>UNBAN</b>
1954
1955 <p><dl><dt><b>Syntax:</b>
1956 <dd><tt><b>UNBAN <i>channel</i></b></tt>
1957 </dl>
1958 <p>
1959 Tells ChanServ to remove all bans preventing you from
1960 entering the given channel. By default, limited to users
1961 with level 50 (AOP) access and above on the channel.
1962
1963 <p>
1964 <hr align=center width="50%">
1965
1966 <a name="chan.kick"></a>
1967 <p><b>KICK</b>
1968
1969 <p><dl><dt><b>Syntax:</b>
1970 <dd><tt><b>KICK <i>channel</i> <i>nickname</i> [<i>reason</i>]</b></tt>
1971 </dl>
1972 <p>
1973 Tells ChanServ to kick the given nickname from the given
1974 channel. The message included in the kick will show who
1975 used the <tt>KICK</tt> command, as well as the reason given with the
1976 command, if any. By default, limited to users with level
1977 50 (AOP) access and above on the channel.
1978 <p>
1979 Note that protected (<tt>+a</tt>) users and IRC operators with
1980 Services operator privileges cannot be kicked with this command,
1981 even by the channel founder.
1982
1983 <p>
1984 <hr align=center width="50%">
1985
1986 <a name="chan.topic"></a>
1987 <p><b>TOPIC</b>
1988
1989 <p><dl><dt><b>Syntax:</b>
1990 <dd><tt><b>TOPIC <i>channel</i> <i>topic</i></b></tt>
1991 </dl>
1992 <p>
1993 Causes ChanServ to set the channel topic to the one
1994 specified. This command is most useful in conjunction
1995 with <a href="#chan.set_topiclock"><tt>SET TOPICLOCK</tt></a>.
1996 By default, limited to users with level 50 (AOP) access and
1997 above on the channel.
1998
1999 <p>
2000 <hr align=center width="50%">
2001
2002 <a name="chan.clear"></a>
2003 <p><b>CLEAR</b>
2004
2005 <p><dl><dt><b>Syntax:</b>
2006 <dd><tt><b>CLEAR <i>channel</i> <i>what</i></b></tt>
2007 </dl>
2008 <p>
2009 Tells ChanServ to clear certain settings on a channel. <tt><i>what</i></tt>
2010 can be any of the following:
2011 <p>
2012 <dl>
2013 <dt><tt><b>MODES</b></tt>
2014 <dd>Clears all modes on the channel except those
2015 set in the channel's mode lock.
2016 <dt><tt><b>BANS</b></tt>
2017 <dd>Clears all bans on the channel.
2018 <dt><tt><b>EXCEPTIONS</b></tt>
2019 <dd>Clears all exceptions on the channel (only available if the IRC server supports ban exceptions).
2020 <dt><tt><b>INVITES</b></tt>
2021 <dd>Clears all invite masks on the channel (only available if the IRC server supports invite masks).
2022 <dt><tt><b>OPS</b></tt>
2023 <dd>Removes channel-operator status (mode <tt>+o</tt>) from
2024 all users.
2025 <dt><tt><b>HALFOPS</b></tt>
2026 <dd>Removes halfop status (mode <tt>+h</tt>) from all users (only available if the IRC server supports halfops).
2027 <dt><tt><b>VOICES</b></tt>
2028 <dd>Removes "voice" status (mode <tt>+v</tt>) from all users.
2029 <dt><tt><b>USERS</b></tt>
2030 <dd>Removes (kicks) all users from the channel.
2031 </dl>
2032 <p>
2033 By default, limited to users with level 100 (SOP) access and
2034 above on the channel.
2035
2036 <p>
2037 <hr align=center width="50%">
2038
2039 <a name="chan.status"></a>
2040 <p><b>STATUS</b>
2041
2042 <p><dl><dt><b>Syntax:</b>
2043 <dd><tt><b>STATUS <i>channel</i> <i>nickname</i></b></tt>
2044 </dl>
2045 <p>
2046 Returns the current access level of the given nickname on the
2047 given channel. The reply is of the form:
2048 <p>
2049 <blockquote>
2050 <tt>STATUS <i>channel</i> <i>nickname</i> <i>access-level</i></tt>
2051 </blockquote>
2052 If an error occurs, the reply will be in the form:
2053 <p>
2054 <blockquote>
2055 <tt>STATUS <i>channel</i> <i>nickname</i> ERROR <i>error-message</i></tt>
2056 </blockquote>
2057 By default, limited to users with level 100 (SOP) access and
2058 above on the channel.
2059 <p>
2060 The format of the <tt><i>access-level</i></tt> response parameter depends
2061 on which access-level modules are loaded, as follows:
2062 <div align=center><table border=1>
2063 <tr><th><tt>access-levels</tt><br>module
2064 <th><tt>access-xop</tt><br>module
2065 <th>Format
2066 <tr><td align=center>Loaded
2067 <td align=center>Not loaded
2068 <td><tt><i>numeric-level</i></tt>
2069 <tr><td align=center>Loaded
2070 <td align=center>Loaded
2071 <td><tt><i>numeric-level</i> (<i>XOP-level</i>)</tt>
2072 <tr><td align=center>Not loaded
2073 <td align=center>Loaded
2074 <td><tt><i>XOP-level</i></tt>
2075 </table></div>
2076 <p>In the table, <tt><i>numeric-level</i></tt> is the numeric access level,
2077 while <tt><i>XOP-level</i></tt> is one of "<tt>Founder</tt>",
2078 "<tt>SOP</tt>", "<tt>AOP</tt>", "<tt>HOP</tt>" (if the IRC server supports
2079 halfops), "<tt>VOP</tt>", "<tt>NOP</tt>", or "<tt>---</tt>" (meaning no
2080 privileges). These strings do not change regardless of the user's
2081 NickServ language setting.
2082
2083 <p>
2084 <hr align=center width="50%">
2085
2086 <a name="chan.getpass"></a>
2087 <p><b>GETPASS</b>
2088
2089 <p><dl><dt><b>Syntax:</b>
2090 <dd><tt><b>GETPASS <i>channel</i></b></tt>
2091 </dl>
2092 <p>
2093 Returns the password for the given channel. <b>Note</b> that
2094 whenever this command is used, a message including the
2095 person who issued the command and the channel it was used
2096 on will be logged.
2097 <p>
2098 If encryption (see <a href="3.html#7">section 3-7</a>) is in use,
2099 encryption may not be available depending on the type of encryption used.
2100 <p>
2101 Limited to <b>Services admins</b>.
2102
2103 <p>
2104 <hr align=center width="50%">
2105
2106 <a name="chan.forbid"></a>
2107 <p><b>FORBID</b>
2108
2109 <p><dl><dt><b>Syntax:</b>
2110 <dd><tt><b>FORBID <i>channel</i></b></tt>
2111 </dl>
2112 <p>
2113 Disallows anyone from registering or using the given
2114 channel. May be cancelled by dropping the channel.
2115 <p>
2116 Limited to <b>Services admins</b>.
2117
2118 <p>
2119 <hr align=center width="50%">
2120
2121 <a name="chan.suspend"></a>
2122 <p><b>SUSPEND</b>
2123
2124 <p><dl><dt><b>Syntax:</b>
2125 <dd><tt><b>SUSPEND [+<i>expiry</i>] <i>channel</i> <i>reason</i></b></tt>
2126 </dl>
2127 <p>
2128 Prevents a channel from being used or identified for
2129 by anyone. The channel can be unsuspended with the
2130 <a href="#chan.unsuspend"><tt>UNSUSPEND</tt></a> command,
2131 which will allow it to be used as before.
2132 The <tt><i>expiry</i></tt> parameter is interpreted in the same manner
2133 as for the OperServ <a href="#oper.akill"><tt>AKILL</tt></a> command.
2134 <p>
2135 Limited to <b>Services admins</b>.
2136
2137 <p>
2138 <hr align=center width="50%">
2139
2140 <a name="chan.unsuspend"></a>
2141 <p><b>UNSUSPEND</b>
2142
2143 <p><dl><dt><b>Syntax:</b>
2144 <dd><tt><b>UNSUSPEND <i>channel</i></b></tt>
2145 </dl>
2146 <p>
2147 Allows users to use and identify for a previously suspended channel.
2148 <p>
2149 Limited to <b>Services admins</b>.
2150
2151 <!------------------------------------------------------------------------>
2152 <p><hr>
2153
2154 <a name=3></a>
2155 <h3>4-3. MemoServ commands</h3>
2156
2157 <p>
2158 <hr align=center width="50%">
2159
2160 <a name="memo.send"></a>
2161 <p><b>SEND</b>
2162
2163 <p><dl><dt><b>Syntax:</b>
2164 <dd><tt><b>SEND {<i>nickname</i> | <i>channel</i>} <i>memo-text</i></b></tt>
2165 </dl>
2166 <p>
2167 Sends the named <tt><i>nickname</i></tt> or <tt><i>channel</i></tt> a memo containing
2168 <tt><i>memo-text</i></tt>. When sending to a nickname, the recipient will
2169 receive a notice that he/she has a new memo. The target
2170 nickname/channel must be registered.
2171
2172 <p>
2173 <hr align=center width="50%">
2174
2175 <a name="memo.list"></a>
2176 <p><b>LIST</b>
2177
2178 <p><dl><dt><b>Syntax:</b>
2179 <dd><tt><b>LIST [<i>channel</i>] [<i>num</i> | <i>list</i> | NEW]</b></tt>
2180 </dl>
2181 <p>
2182 Lists any memos you currently have. With <tt>NEW</tt>, lists only
2183 new (unread) memos. Unread memos are marked with a "<tt>*</tt>" to
2184 the left of the memo number; memos that will not expire are
2185 marked with a "<tt>+</tt>". You can also specify a list of
2186 numbers, as in the example below:
2187 <dl>
2188 <dt><tt><b>LIST 2-5,7-9</b></tt>
2189 <dd>Lists memos numbered 2 through 5 and 7 through 9.
2190 </dl>
2191
2192 <p>
2193 <hr align=center width="50%">
2194
2195 <a name="memo.read"></a>
2196 <p><b>READ</b>
2197
2198 <p><dl><dt><b>Syntax:</b>
2199 <dd><tt><b>READ [<i>channel</i>] {<i>num</i> | <i>list</i> | LAST | NEW}</b></tt>
2200 </dl>
2201 <p>
2202 Sends you the text of the memos specified. If LAST is
2203 given, sends you the memo you most recently received. If
2204 NEW is given, sends you all of your new memos. Otherwise,
2205 sends you memo number <tt><i>num</i></tt>. You can also give a list of
2206 numbers, as with the <a href="#memo.list"><tt>LIST</tt></a> command.
2207
2208 <p>
2209 <hr align=center width="50%">
2210
2211 <a name="memo.save"></a>
2212 <p><b>SAVE</b>
2213
2214 <p><dl><dt><b>Syntax:</b>
2215 <dd><tt><b>SAVE [<i>channel</i>] {<i>num</i> | <i>list</i>}</b></tt>
2216 </dl>
2217 <p>
2218 Marks the given memo or memos as non-expiring. You can give
2219 either a single memo number or, as with the <a href="#memo.list"><tt>LIST</tt></a> command, a
2220 list of memos.
2221 <p>
2222 Note that this command will not be available if the
2223 <a href="a.html#memoserv/main.MSExpire"><tt>MSExpire</tt></a> option is
2224 not set (since there would be no point in using it). However, all memos
2225 received while <tt>MSExpire</tt> is unset will be treated as if SAVE had
2226 been used for them, and they will not expire even if <tt>MSExpire</tt> is
2227 later enabled.
2228
2229 <p>
2230 <hr align=center width="50%">
2231
2232 <a name="memo.del"></a>
2233 <p><b>DEL</b>
2234
2235 <p><dl><dt><b>Syntax:</b>
2236 <dd><tt><b>DEL [<i>channel</i>] {<i>num</i> | <i>list</i> | ALL}</b></tt>
2237 </dl>
2238 <p>
2239 Deletes the specified memo or memos. You can supply
2240 multiple memo numbers or ranges of numbers instead of a
2241 single number, as with the <a href="#memo.list"><tt>LIST</tt></a> command; you can also give
2242 the word <tt>ALL</tt>, which causes all of your memos to be
2243 deleted.
2244 <p>
2245 <b>Warning</b>: Once a memo is deleted, it cannot be recovered!
2246
2247 <p>
2248 <hr align=center width="50%">
2249
2250 <a name="memo.renumber"></a>
2251 <p><b>RENUMBER</b>
2252
2253 <p><dl><dt><b>Syntax:</b>
2254 <dd><tt><b>RENUMBER</b></tt>
2255 </dl>
2256 <p>
2257 Renumbers your memo list, removing "holes" in the number
2258 sequence resulting from deleted memos.
2259
2260 <p>
2261 <hr align=center width="50%">
2262
2263 <a name="memo.set"></a>
2264 <p><b>SET</b>
2265
2266 <p><dl><dt><b>Syntax:</b>
2267 <dd><tt><b>SET <i>option</i> <i>parameters</i></b></tt>
2268 </dl>
2269 <p>
2270 Sets various memo options. <tt><i>option</i></tt> can be one of:
2271 <p>
2272 <dl>
2273 <dt><tt><b>NOTIFY</b></tt>
2274 <dd>Changes when you will be notified about
2275 new memos (only for nicknames)
2276 <dt><tt><b>LIMIT</b></tt>
2277 <dd>Sets the maximum number of memos you can
2278 receive
2279 <dt><tt><b>FORWARD</b></tt>
2280 <dd>Sets whether memos are automatically
2281 forwarded to you
2282 </dl>
2283 <p>
2284
2285 <p>
2286 <hr align=center width="50%">
2287
2288 <a name="memo.set_notify"></a>
2289 <p><b>SET NOTIFY</b>
2290
2291 <p><dl><dt><b>Syntax:</b>
2292 <dd><tt><b>SET NOTIFY {ON | LOGON | NEW | OFF}</b></tt>
2293 </dl>
2294 <p>
2295 Changes when you will be notified about new memos:
2296 <p>
2297 <dl>
2298 <dt><tt><b>ON</b></tt>
2299 <dd>You will be notified of memos when you log on,
2300 when you unset <tt>/AWAY</tt>, and when they are sent
2301 to you.
2302 <dt><tt><b>LOGON</b></tt>
2303 <dd>You will only be notified of memos when you log
2304 on or when you unset <tt>/AWAY</tt>.
2305 <dt><tt><b>NEW</b></tt>
2306 <dd>You will only be notified of memos when they
2307 are sent to you.
2308 <dt><tt><b>OFF</b></tt>
2309 <dd>You will not receive any notification of memos.
2310 </dl>
2311 <tt>ON</tt> is equivalent to <tt>LOGON</tt> and <tt>NEW</tt> combined.
2312 <p>
2313 Note that if your nickname has the "secure" setting on, you
2314 will only be notified of new memos (for <tt>LOGON</tt> or <tt>ON</tt>) after
2315 you identify to NickServ.
2316
2317 <p>
2318 <hr align=center width="50%">
2319
2320 <a name="memo.set_limit"></a>
2321 <p><b>SET LIMIT</b>
2322
2323 <p><dl><dt><b>Syntax:</b>
2324 <dd><tt><b>SET LIMIT [<i>nickname</i> | <i>channel</i>] {<i>limit</i> | NONE | DEFAULT} [HARD]</b></tt>
2325 </dl>
2326 <p>
2327 Sets the maximum number of memos a nickname (or channel) is
2328 allowed to have. Setting the limit to 0 prevents the nick
2329 from receiving any memos; setting it to <tt>NONE</tt> allows the nick
2330 to receive and keep as many memos as they want; and setting
2331 it to <tt>DEFAULT</tt> restores the limit to the default value
2332 (<a href="a.html#memoserv/main.MSMaxMemos"><tt>MSMaxMemos</tt></a>
2333 in <tt>modules.conf</tt>, 20 by default).
2334 If you do not give a nickname or channel, your own limit is set.
2335 <p>
2336 Adding <tt>HARD</tt> prevents the user from changing the limit. Not
2337 adding <tt>HARD</tt> has the opposite effect, allowing the user to
2338 change the limit (even if a previous limit was set with
2339 <tt>HARD</tt>).
2340 <p>
2341 This use of the <a href="#memo.set_limit"><b>SET LIMIT</b></a> command is limited to <b>Services
2342 admins</b>. Other users may only enter a limit for themselves
2343 or a channel on which they have such privileges, may not
2344 remove their limit or set their limit to the default, may
2345 not set a limit above the default limit, and may not set a hard limit.
2346
2347 <p>
2348 <hr align=center width="50%">
2349
2350 <a name="memo.info"></a>
2351 <p><b>INFO</b>
2352
2353 <p><dl><dt><b>Syntax:</b>
2354 <dd><tt><b>INFO [<i>nickname</i> | <i>channel</i>]</b></tt>
2355 </dl>
2356 <p>
2357 Without a parameter, displays information on the number of
2358 memos you have, how many of them are unread, how many
2359 total memos you can receive and when you are notified of
2360 new ones.
2361 <p>
2362 With a channel parameter, displays the same information for
2363 the given channel.
2364 <p>
2365 With a nickname parameter, displays the same information
2366 for the given nickname. This use limited to <b>Services
2367 admins</b>.
2368
2369 <p>
2370 <hr align=center width="50%">
2371
2372 <a name="memo.forward"></a>
2373 <p><b>FORWARD</b> (requires the <tt>memoserv/forward</tt> module)
2374
2375 <p><dl><dt><b>Syntax:</b>
2376 <dd><tt><b>FORWARD {<i>num</i> | <i>list</i> | ALL}</b></tt>
2377 </dl>
2378 <p>
2379 Forwards one or more of your memos to your E-mail address.
2380 You must have a valid E-mail address set for your nickname
2381 in order to use this command. Channel memos cannot be
2382 forwarded.
2383
2384 <p>
2385 <hr align=center width="50%">
2386
2387 <a name="memo.set_forward"></a>
2388 <p><b>SET FORWARD</b> (requires the <tt>memoserv/forward</tt> module)
2389
2390 <p><dl><dt><b>Syntax:</b>
2391 <dd><tt><b>SET FORWARD {ON | COPY | OFF}</b></tt>
2392 </dl>
2393 <p>
2394 Sets whether MemoServ automatically forwards to your E-mail
2395 address memos sent to you. When set to <tt>ON</tt>, memos sent to
2396 your nickname will instead be forwarded to the E-mail
2397 address registered with your nickname. <tt>COPY</tt> is similar, but
2398 also causes MemoServ to save a copy of the memo to read
2399 online. When set to <tt>OFF</tt>, your memos will be stored online
2400 as usual. Even if you set this option to <tt>ON</tt>, you may still
2401 receive memos online if Services is unable to forward them
2402 to you.
2403 <p>
2404 Note that when this option is set to <tt>COPY</tt> and you have
2405 received the maximum number of memos you are allowed to, you
2406 will not be able to receive any new memos (including by
2407 E-mail) until you delete some old memos using the <a href="#memo.del"><tt>DEL</tt></a>
2408 command.
2409
2410 <p>
2411 <hr align=center width="50%">
2412
2413 <a name="memo.ignore"></a>
2414 <p><b>IGNORE</b> (requires the <tt>memoserv/ignore</tt> module)
2415
2416 <p><dl><dt><b>Syntax:</b>
2417 <dd><tt><b>IGNORE {ADD | DEL | LIST} [<i>nickname</i> | <i>mask</i>]</b></tt>
2418 </dl>
2419 <p>
2420 Controls the list of "ignored" users; users whose nickname
2421 or user@host mask match an entry on this list are not
2422 allowed to send you memos. <tt>ADD</tt> adds the given nickname or
2423 user@host mask to your ignore list, and <tt>DEL</tt> removes the
2424 given nickname or mask from the list; <tt>LIST</tt> displays your
2425 current ignore list.
2426 <p>
2427 Note that the nickname or mask given to the <tt>ADD</tt> command may
2428 contain "*" or "?" wildcards, and is not case-sensitive; for
2429 example, "*Evil*" matches "EvilNick", "AN_EVIL_USER" and
2430 "devil".
2431
2432 <!------------------------------------------------------------------------>
2433 <p><hr>
2434
2435 <a name=4></a>
2436 <h3>4-4. OperServ commands</h3>
2437
2438 <p>
2439 <hr align=center width="50%">
2440
2441 <a name="oper.global"></a>
2442 <p><b>GLOBAL</b>
2443
2444 <p><dl><dt><b>Syntax:</b>
2445 <dd><tt><b>GLOBAL <i>message</i></b></tt>
2446 </dl>
2447 <p>
2448 Allows IRCops to send messages to all users on the network.
2449 The message will be sent from the nickname "Global" (which
2450 can be changed with the
2451 <a href="a.html#operserv/main.GlobalName"><tt>GlobalName</tt></a>
2452 option in <tt>modules.conf</tt>).
2453
2454 <p>
2455 <hr align=center width="50%">
2456
2457 <a name="oper.stats"></a>
2458 <p><b>STATS</b>
2459
2460 <p><dl><dt><b>Syntax:</b>
2461 <dd><tt><b>STATS [RESET | NETWORK | AKILL | ALL]</b></tt>
2462 </dl>
2463 <p>
2464 Without any option, shows the current number of users and
2465 IRCops online (excluding Services), the highest number of
2466 users online since Services was started, and the length of
2467 time Services has been running.
2468 <p>
2469 With the <tt>RESET</tt> option, resets the maximum user count to
2470 the number of users currently online.
2471 <p>
2472 With the <tt>NETWORK</tt> option, shows the amount of data sent
2473 to and received from the remote server, and the amount of
2474 memory used by network send/receive buffers. The ratio of
2475 the current buffer memory usage to the buffer size limit is
2476 also displayed as a percentage if a limit is configured (via
2477 <a href="a.html#NetBufferSize"><tt>NetBufferSize</tt></a> in
2478 <tt>ircservices.conf</tt>).
2479 <p>
2480 With the <tt>AKILL</tt> option, displays the current size of the
2481 AKILL list and the current default expiry time.
2482 <p>
2483 The <tt>ALL</tt> option is available only to Services admins, and
2484 displays information on Services' memory usage. Using this
2485 option can freeze Services for a short period of time on
2486 large networks, so don't overuse it!
2487 <p>
2488 <tt>UPTIME</tt> may be used as a synonym for <tt>STATS</tt>.
2489
2490 <p>
2491 <hr align=center width="50%">
2492
2493 <a name="oper.servermap"></a>
2494 <p><b>SERVERMAP</b>
2495
2496 <p><dl><dt><b>Syntax:</b>
2497 <dd><tt><b>SERVERMAP</b></tt>
2498 </dl>
2499 <p>
2500 Displays a map of servers connected to the network, from the
2501 viewpoint of Services. "Fake" servers&mdash;Services itself and
2502 any servers jupitered with the <a href="#oper.jupe"><tt>JUPE</tt></a>
2503 command&mdash;have "<tt>(*)</tt>" displayed after the sever name.
2504
2505 <p>
2506 <hr align=center width="50%">
2507
2508 <a name="oper.oper"></a>
2509 <p><b>OPER</b>
2510
2511 <p><dl><dt><b>Syntax:</b>
2512 <dd><tt><b>OPER ADD <i>nickname</i></b></tt>
2513 <br><tt><b>OPER DEL <i>nickname</i></b></tt>
2514 <br><tt><b>OPER LIST</b></tt>
2515 </dl>
2516 <p>
2517 Allows Services admins to add or remove nicknames to or from
2518 the Services operator list. A user whose nickname is on the
2519 Services operator list and who has identified to NickServ
2520 will be able to access Services operator commands.
2521 <p>
2522 Any IRC operator may use the <tt>OPER LIST</tt> form of the command.
2523 All other use limited to <b>Services admins</b>.
2524
2525 <p>
2526 <hr align=center width="50%">
2527
2528 <a name="oper.admin"></a>
2529 <p><b>ADMIN</b>
2530
2531 <p><dl><dt><b>Syntax:</b>
2532 <dd><tt><b>ADMIN ADD <i>nickname</i></b></tt>
2533 <br><tt><b>ADMIN DEL <i>nickname</i></b></tt>
2534 <br><tt><b>ADMIN LIST</b></tt>
2535 </dl>
2536 <p>
2537 Allows the Services super-user to add or remove nicknames
2538 to or from the Services admin list. A user whose nickname
2539 is on the Services admin list and who has identified to
2540 NickServ will be able to access Services admin commands.
2541 <p>
2542 Any IRC operator may use the <tt>ADMIN LIST</tt> form of the command.
2543 All other use limited to <b>Services super-user</b>.
2544
2545 <p>
2546 <hr align=center width="50%">
2547
2548 <a name="oper.getkey"></a>
2549 <p><b>GETKEY</b>
2550
2551 <p><dl><dt><b>Syntax:</b>
2552 <dd><tt><b>GETKEY <i>channel</i></b></tt>
2553 </dl>
2554 <p>
2555 Returns the channel key set on the given channel, if any.
2556 <p>
2557 Limited to <b>Services operators</b>.
2558
2559 <p>
2560 <hr align=center width="50%">
2561
2562 <a name="oper.mode"></a>
2563 <p><b>MODE</b>
2564
2565 <p><dl><dt><b>Syntax:</b>
2566 <dd><tt><b>MODE <i>channel</i> <i>modes</i></b></tt>
2567 </dl>
2568 <p>
2569 Allows Services operators to set channel modes for any
2570 channel. Parameters are the same as for the standard <tt>/MODE</tt>
2571 command.
2572 <p>
2573 Limited to <b>Services operators</b>.
2574
2575 <p>
2576 <hr align=center width="50%">
2577
2578 <a name="oper.clearmodes"></a>
2579 <p><b>CLEARMODES</b>
2580
2581 <p><dl><dt><b>Syntax:</b>
2582 <dd><tt><b>CLEARMODES <i>channel</i> [ALL]</b></tt>
2583 </dl>
2584 <p>
2585 Clears all channel modes (<tt>n</tt>, <tt>s</tt>, <tt>t</tt>, <tt>k</tt>,
2586 <tt>l</tt>, <tt>b</tt>, and so on) from a channel. If <b>ALL</b> is given,
2587 also clears all user modes (like <tt>+o</tt> and <tt>+v</tt>) from the
2588 channel. However, if the channel is registered, its mode lock will still
2589 take effect.
2590 <p>
2591 Limited to <b>Services operators</b>.
2592
2593 <p>
2594 <hr align=center width="50%">
2595
2596 <a name="oper.clearchan"></a>
2597 <p><b>CLEARCHAN</b>
2598
2599 <p><dl><dt><b>Syntax:</b>
2600 <dd><tt><b>CLEARCHAN <i>channel</i></b></tt>
2601 </dl>
2602 <p>
2603 Removes all users from a channel (masskick).
2604 <p>
2605 Limited to <b>Services operators</b>.
2606
2607 <p>
2608 <hr align=center width="50%">
2609
2610 <a name="oper.kick"></a>
2611 <p><b>KICK</b>
2612
2613 <p><dl><dt><b>Syntax:</b>
2614 <dd><tt><b>KICK <i>channel</i> <i>user</i> <i>reason</i></b></tt>
2615 </dl>
2616 <p>
2617 Allows IRCops to kick a user from any channel.
2618 Parameters are the same as for the standard <tt>/KICK</tt>
2619 command. The kick message will have the nickname of the
2620 IRCop sending the <tt>KICK</tt> command prepended; for example:
2621 <p>
2622 <tt>*** SpamMan has been kicked off channel #my_channel by OperServ (Alcan (Flood))</tt>
2623 <p>
2624 Limited to <b>Services operators</b>.
2625
2626 <p>
2627 <hr align=center width="50%">
2628
2629 <a name="oper.akill"></a>
2630 <p><b>AKILL</b> (requires the <tt>operserv/akill</tt> module)
2631
2632 <p><dl><dt><b>Syntax:</b>
2633 <dd><tt><b>AKILL ADD [+<i>expiry</i>] <i>mask</i> <i>reason</i></b></tt>
2634 <br><tt><b>AKILL DEL <i>mask</i></b></tt>
2635 <br><tt><b>AKILL CLEAR ALL</b></tt>
2636 <br><tt><b>AKILL LIST [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2637 <br><tt><b>AKILL VIEW [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2638 <br><tt><b>AKILL CHECK <i>mask</i></b></tt>
2639 <br><tt><b>AKILL COUNT</b></tt>
2640 </dl>
2641 <p>
2642 Allows Services operators to manipulate the autokill (AKILL)
2643 list. If a user matching an autokill mask attempts to
2644 connect, Services will issue a KILL for that user and, on
2645 supported server types, will instruct all servers to add a
2646 ban (K-line) for the mask which the user matched.
2647 <p>
2648 <tt>AKILL ADD</tt> adds the given <tt><i>user</i>@<i>host</i></tt> mask to the autokill
2649 list. The <tt><i>reason</i></tt> should describe why the entry is being
2650 added; depending on how Services is configured, it may also
2651 be displayed to users in KILL messages. An expiry time can
2652 also be specified, as described below.
2653 <p>
2654 <tt>AKILL DEL</tt> removes the given mask from the autokill list if
2655 it is present.
2656 <p>
2657 <tt>AKILL CLEAR</tt> clears (removes) all masks from the autokill
2658 list. The <tt>ALL</tt> parameter is mandatory, to avoid accidental
2659 use of this command.
2660 <p>
2661 <tt>AKILL LIST</tt> shows all current autokills; if the optional pattern
2662 is given, the list is limited to those AKILLs matching the
2663 pattern. If the <tt><i>start</i></tt> parameter is given, it specifies how
2664 many matches to skip before displaying results (for example,
2665 <tt>+50</tt> would cause the first 50 matches to be skipped).
2666 Additionally, <tt>NOEXPIRE</tt> can be used to limit the list to
2667 autokills that do not expire.
2668 <p>
2669 <tt>AKILL VIEW</tt> is a more verbose version of <tt>AKILL LIST</tt>, and will
2670 show who added an autokill, the date it was added, and when
2671 it expires, as well as the <tt><i>user</i>@<i>host</i></tt> mask and reason.
2672 <p>
2673 <tt>AKILL CHECK</tt> will display any entries on the autokill list
2674 which the given <tt><i>user</i>@<i>host</i></tt> mask would match; this can be used
2675 to determine which autokill caused a particular user to be
2676 killed.
2677 <p>
2678 <tt>AKILL COUNT</tt> simply returns the number of autokills in the
2679 autokill list.
2680 <p>
2681 Optionally, an expiry time can be given with the <tt>AKILL ADD</tt>
2682 command. The expiry time precedes the <tt><i>user</i>@<i>host</i></tt> mask, and
2683 is specified as an integer followed by one of "<tt>d</tt>" (days),
2684 "<tt>h</tt>" (hours), or "<tt>m</tt>" (minutes). Combinations (such as <tt>1h30m</tt>)
2685 are also permitted. If a unit specifier is not included,
2686 the default is days (so <tt>+30</tt> by itself means 30 days). To
2687 add an autokill which does not expire, use <tt>+0</tt>. If the
2688 usermask to be added starts with a <tt>+</tt>, an expiry time must
2689 be given, even if it is the same as the default (specified with the
2690 <a href="a.html#operserv/akill.AutokillExpiry"><tt>AutokillExpiry</tt></a>
2691 option in <tt>modules.conf</tt>).
2692 <p>
2693 If the <a href="a.html#operserv/akill.OperMaxExpiry"><tt>OperMaxExpiry</tt></a>
2694 option is set in <tt>modules.conf</tt>, Services operators may only set an
2695 expiry time up to that limit; otherwise, they may set any expiry time.
2696 Services administrators can always set any expiry time.
2697 <p>
2698 Limited to <b>Services operators</b>.
2699
2700 <p>
2701 <hr align=center width="50%">
2702
2703 <a name="oper.exclude"></a>
2704 <p><b>AKILLCHAN</b> (requires the <tt>operserv/akill</tt> module)
2705
2706 <p><dl><dt><b>Syntax:</b>
2707 <dd><tt><b>AKILLCHAN [KILL] [+<i>expiry</i>] <i>channel</i> <i>reason</i></b></tt>
2708 </dl>
2709 <p>
2710 Adds autokills for all users except IRC operators in a given <tt><i>channel</i></tt>, and optionally
2711 (if <tt>KILL</tt> is given) removes them from the network. The <tt><i>reason</i></tt> will be stored with
2712 each autokill, and may be displayed in kill messages
2713 depending on how Services is configured. <tt><i>expiry</i></tt> takes the
2714 same format as in the <a href="#oper.akill"><tt>AKILL ADD</tt></a> command;
2715 if not given, it defaults to the value given in the
2716 <a href="a.html#operserv/akill.AkillChanExpiry"><tt>AkillChanExpiry</tt></a>
2717 directive in <tt>modules.conf</tt>.
2718 <p>
2719 Autokills added by this command will have the form
2720 <tt>*@<i>hostname</i></tt>, for each hostname used by a client in the
2721 channel. If such an autokill already exists for a hostname,
2722 it will not be modified; this may cause the number of
2723 autokills added to be less than the number of users
2724 affected. Also, these autokills will automatically
2725 be sent to the IRC network regardless of the status of the
2726 <a href="a.html#operserv/akill.ImmediatelySendAutokill"><tt>ImmediatelySendAutokill</tt></a> setting.
2727 <p>
2728 Limited to <b>Services operators</b>.
2729
2730 <p>
2731 <hr align=center width="50%">
2732
2733 <a name="oper.exclude"></a>
2734 <p><b>EXCLUDE</b> (requires the <tt>operserv/akill</tt> module)
2735
2736 <p><dl><dt><b>Syntax:</b>
2737 <dd><tt><b>EXCLUDE ADD [+<i>expiry</i>] <i>mask</i> <i>reason</i></b></tt>
2738 <br><tt><b>EXCLUDE DEL <i>mask</i></b></tt>
2739 <br><tt><b>EXCLUDE CLEAR ALL</b></tt>
2740 <br><tt><b>EXCLUDE LIST [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2741 <br><tt><b>EXCLUDE VIEW [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2742 <br><tt><b>EXCLUDE CHECK <i>mask</i></b></tt>
2743 <br><tt><b>EXCLUDE COUNT</b></tt>
2744 </dl>
2745 <p>
2746 Allows Services operators to manipulate the autokill
2747 exclusion list. When a user matching an autokill exclusion
2748 mask connects to the network, Services will not issue a <tt>KILL</tt>
2749 for that user even if the user would otherwise match an
2750 autokill mask. This is useful if you have wide autokill
2751 masks, and still want specific hosts or users that match
2752 those masks to be able to connect.
2753 <p>
2754 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>CLEAR</tt>, <tt>LIST</tt>, <tt>VIEW</tt>,
2755 <tt>CHECK</tt>, and <tt>COUNT</tt> subcommands function the
2756 same way as the subcommands for the <a href="#oper.akill"><tt>AKILL</tt></a> command; see
2757 the <tt>AKILL</tt> help for more information. (Note that autokill
2758 exclusions are not affected by the state of the
2759 <a href="a.html#operserv/akill.ImmediatelySendAutokill"><tt>ImmediatelySendAutokill</tt></a>
2760 setting, and are always immediately sent to the server.)
2761 <p>
2762 Limited to <b>Services operators</b>.
2763
2764 <p>
2765 <hr align=center width="50%">
2766
2767 <a name="oper.sgline"></a>
2768 <p><b>SGLINE</b> (requires the <tt>operserv/sline</tt> module)
2769
2770 <p><dl><dt><b>Syntax:</b>
2771 <dd><tt><b>SGLINE ADD [+<i>expiry</i>] <i>mask</i> <i>reason</i></b></tt>
2772 <br><tt><b>SGLINE DEL <i>mask</i></b></tt>
2773 <br><tt><b>SGLINE CLEAR ALL</b></tt>
2774 <br><tt><b>SGLINE LIST [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2775 <br><tt><b>SGLINE VIEW [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2776 <br><tt><b>SGLINE CHECK <i>mask</i></b></tt>
2777 <br><tt><b>SGLINE COUNT</b></tt>
2778 </dl>
2779 <p>
2780 Allows Services operators to manipulate the SGLINE list. If
2781 a user whose "real name" matches an SGLINE mask attempts to
2782 connect, Services will issue a KILL for that user and, on
2783 supported server types, will instruct all servers to add a
2784 ban (server G-line) for the mask which the user matched.
2785 <p>
2786 <tt>SGLINE ADD</tt> adds the given real name mask to the SGLINE list.
2787 The <tt><i>reason</i></tt> should describe why the entry is being added;
2788 depending on how Services is configured, it may also be
2789 displayed to users in KILL messages.
2790 <p>
2791 <tt>SGLINE DEL</tt> removes the given mask from the SGLINE list if it
2792 is present.
2793 <p>
2794 <tt>SGLINE CLEAR</tt> clears (removes) all masks from the SGLINE
2795 list. The <tt>ALL</tt> parameter is mandatory, to avoid accidental
2796 use of this command.
2797 <p>
2798 <tt>SGLINE LIST</tt> shows all SGLINE entries; if the optional pattern
2799 is given, the list is limited to those entries matching the
2800 pattern. If the <tt><i>start</i></tt> parameter is given, it specifies how
2801 many matches to skip before displaying results (for example,
2802 <tt>+50</tt> would cause the first 50 matches to be skipped).
2803 Additionally, <tt>NOEXPIRE</tt> can be used to limit the list to
2804 entries that do not expire.
2805 <p>
2806 <tt>SGLINE VIEW</tt> is a more verbose version of SGLINE LIST, and
2807 will show who added each SGLINE entry, the date it was
2808 added, when it was last used, and when it expires, as well
2809 as the mask and reason.
2810 <p>
2811 <tt>SGLINE CHECK</tt> will display any entries on the SGLINE list
2812 which the given user@host mask would match; this can be used
2813 to determine which SGLINE caused a particular user to be
2814 killed.
2815 <p>
2816 <tt>SGLINE COUNT</tt> simply returns the number of entries in the
2817 SGLINE list.
2818 <p>
2819 The <tt><i>mask</i></tt> parameter may be enclosed in double quotes, and
2820 must be when the mask contains spaces; for example:
2821 <blockquote>
2822 <tt>/msg OperServ SGLINE ADD +0 "bad name" This is a bad name.</tt>
2823 </blockquote>
2824 <p>
2825 Optionally, an expiry time can be given with the <tt>SGLINE ADD</tt>
2826 command. The expiry time precedes the user@host mask, and
2827 is specified as an integer followed by one of "<tt>d</tt>" (days),
2828 "<tt>h</tt>" (hours), or "<tt>m</tt>" (minutes). Combinations (such as <tt>1h30m</tt>)
2829 are also permitted. If a unit specifier is not included,
2830 the default is days (so <tt>+30</tt> by itself means 30 days). To
2831 add an entry which does not expire, use <tt>+0</tt>. If the
2832 mask to be added starts with a <tt>+</tt> and no expiry time is
2833 given, the mask must be enclosed in double quotes, as
2834 described above.
2835 <p>
2836 Limited to <b>Services operators</b>.
2837
2838 <p>
2839 <hr align=center width="50%">
2840
2841 <a name="oper.sqline"></a>
2842 <p><b>SQLINE</b> (requires the <tt>operserv/sline</tt> module)
2843
2844 <p><dl><dt><b>Syntax:</b>
2845 <dd><tt><b>SQLINE ADD [+<i>expiry</i>] <i>mask</i> <i>reason</i></b></tt>
2846 <br><tt><b>SQLINE DEL <i>mask</i></b></tt>
2847 <br><tt><b>SQLINE CLEAR ALL</b></tt>
2848 <br><tt><b>SQLINE LIST [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2849 <br><tt><b>SQLINE VIEW [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2850 <br><tt><b>SQLINE CHECK <i>mask</i></b></tt>
2851 <br><tt><b>SQLINE COUNT</b></tt>
2852 </dl>
2853 <p>
2854 Allows Services operators to manipulate the SQLINE list. If
2855 a user whose nickname matches an SQLINE mask attempts to
2856 connect, Services will either (1) if the
2857 <a href="a.html#operserv/sline.SQlineKill"><tt>SQlineKill</tt></a> option
2858 is set in <tt>modules.conf</tt> or the IRC server type in use does not
2859 support forced nick changing, issue a KILL for that user; or (2) change
2860 the user's nickname to a "guest" nickname, and send the user a message
2861 that will normally cause the user's IRC client to request a new nickname.
2862 On supported server types, Services will also instruct all servers to add
2863 a ban (server Q-line) for the mask which the user matched.
2864 <p>
2865 If the <a href="a.html#operserv/sline.SQlineIgnoreOpers"><tt>SQlineIgnoreOpers</tt></a>
2866 option is set in <tt>modules.conf</tt>, then IRC operators will not be
2867 affected by SQlines.
2868 <p>
2869 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>CLEAR</tt>, <tt>LIST</tt>, <tt>VIEW</tt>, <tt>CHECK</tt>, and <tt>COUNT</tt> subcommands
2870 function the same way as the subcommands for the <a href="#oper.sgline"><tt>SGLINE</tt></a>
2871 command; see the <tt>SGLINE</tt> help for more information.
2872 <p>
2873 Limited to <b>Services operators</b>.
2874
2875 <p>
2876 <hr align=center width="50%">
2877
2878 <a name="oper.szline"></a>
2879 <p><b>SZLINE</b> (requires the <tt>operserv/sline</tt> module)
2880
2881 <p><dl><dt><b>Syntax:</b>
2882 <dd><tt><b>SZLINE ADD [+<i>expiry</i>] <i>mask</i> <i>reason</i></b></tt>
2883 <br><tt><b>SZLINE DEL <i>mask</i></b></tt>
2884 <br><tt><b>SZLINE CLEAR ALL</b></tt>
2885 <br><tt><b>SZLINE LIST [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2886 <br><tt><b>SZLINE VIEW [+<i>start</i>] [<i>pattern</i>] [NOEXPIRE]</b></tt>
2887 <br><tt><b>SZLINE CHECK <i>mask</i></b></tt>
2888 <br><tt><b>SZLINE COUNT</b></tt>
2889 </dl>
2890 <p>
2891 Allows Services operators to manipulate the SZLINE list. If
2892 a user whose IP address matches an SZLINE mask attempts to
2893 connect, Services will issue a <tt>KILL</tt> for that user and, on
2894 supported server types, will instruct all servers to add a
2895 ban (server Z-line) for the mask which the user matched.
2896 <p>
2897 The <tt>ADD</tt>, <tt>DEL</tt>, <tt>CLEAR</tt>, <tt>LIST</tt>, <tt>VIEW</tt>, <tt>CHECK</tt>, and <tt>COUNT</tt> subcommands
2898 function the same way as the subcommands for the <a href="#oper.sgline"><tt>SGLINE</tt></a>
2899 command; see the <tt>SGLINE</tt> help for more information.
2900 <p>
2901 Note that SZLINEs are not supported by all IRC servers, and
2902 this command will not be available when using a server
2903 without SZLINE support. Some servers may require the
2904 <tt>ImmediatelySendSline</tt> option in <tt>modules.conf</tt>
2905 to be set in order to use SZLINEs.
2906 <p>
2907 Limited to <b>Services operators</b>.
2908
2909 <p>
2910 <hr align=center width="50%">
2911
2912 <a name="oper.exception"></a>
2913 <p><b>EXCEPTION</b> (requires the <tt>operserv/sessions</tt> module)
2914
2915 <p><dl><dt><b>Syntax:</b>
2916 <dd><tt><b>EXCEPTION ADD [<i>+expiry</i>] <i>mask</i> <i>limit</i> <i>reason</i></b></tt>
2917 <br><tt><b>EXCEPTION DEL {<i>mask</i> | <i>list</i>}</b></tt>
2918 <br><tt><b>EXCEPTION CLEAR ALL</b></tt>
2919 <br><tt><b>EXCEPTION MOVE <i>num</i> <i>newnum</i></b></tt>
2920 <br><tt><b>EXCEPTION LIST [[+<i>start</i>] <i>pattern</i> | <i>list</i>]</b></tt>
2921 <br><tt><b>EXCEPTION VIEW [[+<i>start</i>] <i>pattern</i> | <i>list</i>]</b></tt>
2922 <br><tt><b>EXCEPTION CHECK <i>hostname</i></b></tt>
2923 <br><tt><b>EXCEPTION COUNT</b></tt>
2924 </dl>
2925 <p>
2926 Allows Services operators to manipulate the list of hosts that
2927 have specific session limits, allowing certain machines,
2928 such as shell servers, to carry more than the default number
2929 of clients at a time. Once a host reaches its session limit,
2930 all clients attempting to connect from that host will be
2931 killed. Before the user is killed, they are notified, via a
2932 <tt>/NOTICE</tt> from OperServ, of a source of help regarding session
2933 limiting. The content of this notice is a configuration setting
2934 (<a href="a.html#operserv/sessions.SessionLimitExceeded"><tt>SessionLimitExceeded</tt></a> and
2935 <a href="a.html#operserv/sessions.SessionLimitDetailsLoc"><tt>SessionLimitDetailsLoc</tt></a>
2936 in <tt>modules.conf</tt>).
2937 <p>
2938 <tt>EXCEPTION ADD</tt> adds the given host mask to the exception list.
2939 Note that <tt><i>nick</i>!<i>user</i>@<i>host</i></tt> and <tt><i>user</i>@<i>host</i></tt> masks are invalid!
2940 Only real host masks, such as <tt>box.host.dom</tt> and <tt>*.host.dom</tt>,
2941 are allowed because sessions limiting does not take nick or
2942 user names into account. <tt><i>limit</i></tt> must be a number greater than
2943 or equal to zero; this determines how many sessions this host
2944 may carry at a time (a value of zero means the host has an
2945 unlimited session limit).
2946 <p>
2947 Optionally, an expiry time can be given with the <tt>EXCEPTION
2948 ADD</tt> command. The expiry time precedes the host mask, and
2949 is specified as an integer followed by one of "<tt>d</tt>" (days),
2950 "<tt>h</tt>" (hours), or "<tt>m</tt>" (minutes). Combinations (such as <tt>1h30m</tt>)
2951 are also permitted. If a unit specifier is not included,
2952 the default is days (so <tt>+30</tt> by itself means 30 days). To
2953 add an entry which does not expire, use <tt>+0</tt>. If the
2954 mask to be added starts with a <tt>+</tt>, an expiry time must
2955 be given, even if it is the same as the default.
2956 <p>
2957 <tt>EXCEPTION DEL</tt> removes the given mask or numbered entry or
2958 entries from the exception list (entry numbers can be found
2959 with <tt>VIEW</tt> or <tt>LIST</tt>).
2960 <p>
2961 <tt>EXCEPTION CLEAR</tt> clears (removes) all masks from the autokill exclusion
2962 list. The <tt>ALL</tt> parameter is mandatory, to avoid accidental
2963 use of this command.
2964 <p>
2965 <tt>EXCEPTION MOVE</tt> moves exception <tt><i>num</i></tt> to <tt><i>newnum</i></tt>. If <tt><i>newnum</i></tt>
2966 is already used by another exception, its number will be
2967 increased to make room.
2968 <p>
2969 <tt>EXCEPTION LIST</tt> and <tt>EXCEPTION VIEW</tt> show all current
2970 exceptions. If a pattern is given, the display is limited to
2971 entries matching the pattern (with the optional <tt><i>start</i></tt> parameter
2972 giving the number of entries to skip before displaying
2973 results); if a number list is given, only entries in the
2974 list will be displayed. The difference between the two
2975 commands is that <tt>EXCEPTION VIEW</tt>
2976 is more verbose, displaying the name of the person who added
2977 the exception, its session limit, reason, host mask and the
2978 expiry date and time, as well as the last time the exception
2979 was "used", <i>i.e.</i> the last time a user connected who matched
2980 the exception's mask.
2981 <p>
2982 <tt>EXCEPTION CHECK</tt> will display any entries on the exception
2983 list which the given hostname would match; this can be used to
2984 determine which exception, if any, is applied to a particular
2985 user.
2986 <p>
2987 <tt>EXCEPTION COUNT</tt> displays the number of entries on the
2988 exception list.
2989 <p>
2990 Note that when a client connects, the first matching
2991 exception found will be applied to that client. Large
2992 exception lists and widely matching exception masks are
2993 likely to degrade Services' performance.
2994 <p>
2995 Limited to <b>Services operators</b>.
2996
2997 <p>
2998 <hr align=center width="50%">
2999
3000 <a name="oper.session"></a>
3001 <p><b>SESSION</b> (requires the <tt>operserv/sessions</tt> module)
3002
3003 <p><dl><dt><b>Syntax:</b>
3004 <dd><tt><b>SESSION LIST <i>threshold</i></b></tt>
3005 <br><tt><b>SESSION VIEW <i>host</i></b></tt>
3006 </dl>
3007 <p>
3008 Allows Services operators to view the session list.
3009 <p>
3010 <tt>SESSION LIST</tt> lists hosts with at least <tt><i>threshold</i></tt> sessions.
3011 The threshold must be a number greater than 1, to prevent
3012 accidental listing of the large number of single session
3013 hosts.
3014 <p>
3015 <tt>SESSION VIEW</tt> displays detailed information about a specific
3016 host, including the current session count and session limit.
3017 The <tt><i>host</i></tt> value may not include wildcards.
3018 <p>
3019 See the <a href="#oper.exception"><tt>EXCEPTION</tt></a> help for more information about session
3020 limiting and how to set session limits specific to certain
3021 hosts and groups thereof.
3022 <p>
3023 Limited to <b>Services operators</b>.
3024
3025 <p>
3026 <hr align=center width="50%">
3027
3028 <a name="oper.su"></a>
3029 <p><b>SU</b>
3030
3031 <p><dl><dt><b>Syntax:</b>
3032 <dd><tt><b>SU <i>password</i></b></tt>
3033 </dl>
3034 <p>
3035 Allows access to functions which require Services super-user
3036 privileges. The password is the same as that set with the
3037 <a href="#oper.set_supass"><tt>SET SUPASS</tt></a> command; note that the password must be set once
3038 before using this command. Super-user privileges last until
3039 you quit IRC.
3040 <p>
3041 <b>WARNING:</b> If you enter an incorrect password, Services will
3042 broadcast a warning message to all IRC operators.
3043 <p>
3044 Limited to <b>Services admins</b>.
3045
3046 <p>
3047 <hr align=center width="50%">
3048
3049 <a name="oper.set"></a>
3050 <p><b>SET</b>
3051
3052 <p><dl><dt><b>Syntax:</b>
3053 <dd><tt><b>SET <i>option</i> <i>setting</i></b></tt>
3054 </dl>
3055 <p>
3056 Sets various global Services options. Option names
3057 currently defined are:
3058 <dl>
3059 <dt><tt><b>READONLY</b></tt>
3060 <dd>Set read-only or read-write mode
3061 <dt><tt><b>DEBUG</b></tt>
3062 <dd>Activate or deactivate debug mode
3063 <dt><tt><b>SUPASS</b></tt>
3064 <dd>Set password for <a href="#oper.su"><tt>SU</tt></a> command (super-user)
3065 </dl>
3066 <p>
3067 Limited to <b>Services admins</b>; the <tt>SUPASS</tt> option may only be
3068 set by the <b>Services super-user</b>.
3069
3070 <p>
3071 <hr align=center width="50%">
3072
3073 <a name="oper.set_readonly"></a>
3074 <p><b>SET READONLY</b>
3075
3076 <p><dl><dt><b>Syntax:</b>
3077 <dd><tt><b>SET READONLY {ON | OFF}</b></tt>
3078 </dl>
3079 <p>
3080 Sets read-only mode on or off. In read-only mode, normal
3081 users will not be allowed to modify any Services data,
3082 including channel and nickname access lists, etc. IRCops
3083 with sufficient Services privileges will be able to modify
3084 Services' AKILL list and drop or forbid nicknames and
3085 channels, but any such changes will not be saved unless
3086 read-only mode is deactivated before Services is terminated
3087 or restarted.
3088 <p>
3089 This option is equivalent to the command-line option
3090 <tt>-readonly</tt>.
3091
3092 <p>
3093 <hr align=center width="50%">
3094
3095 <a name="oper.set_debug"></a>
3096 <p><b>SET DEBUG</b>
3097
3098 <p><dl><dt><b>Syntax:</b>
3099 <dd><tt><b>SET DEBUG {ON | OFF | <i>num</i>}</b></tt>
3100 </dl>
3101 <p>
3102 Sets debug mode on or off. In debug mode, all data sent to
3103 and from Services as well as a number of other debugging
3104 messages are written to the log file. If <tt><i>num</i></tt> is
3105 given, debug mode is activated, with the debugging level set
3106 to <tt><i>num</i></tt>.
3107 <p>
3108 This option is equivalent to the command-line option
3109 <tt>-debug</tt>.
3110
3111 <p>
3112 <hr align=center width="50%">
3113
3114 <a name="oper.set_supass"></a>
3115 <p><b>SET SUPASS</b>
3116
3117 <p><dl><dt><b>Syntax:</b>
3118 <dd><tt><b>SET SUPASS [<i>password</i>]</b></tt>
3119 </dl>
3120 <p>
3121 Sets the password to be used for the <a href="#oper.su"><tt>SU</tt></a> command. The
3122 password must be set once before using the SU command for
3123 the first time. If no password is given, the SU command
3124 will be unavailable.
3125 <p>
3126 This option may only be set by the <b>Services super-user</b>.
3127
3128 <p>
3129 <hr align=center width="50%">
3130
3131 <a name="oper.jupe"></a>
3132 <p><b>JUPE</b>
3133
3134 <p><dl><dt><b>Syntax:</b>
3135 <dd><tt><b>JUPE <i>server</i> [<i>reason</i>]</b></tt>
3136 </dl>
3137 <p>
3138 Tells Services to jupiter a server&mdash;that is, to create
3139 a fake "server" connected to Services which prevents
3140 the real server of that name from connecting. The jupe
3141 may be removed using a standard <tt>/SQUIT</tt>. If a reason is
3142 given, it is placed in the server information field;
3143 otherwise, the server information field will contain the
3144 text "<tt>Jupitered by <i>nickname</i></tt>", showing the nickname of the
3145 person who jupitered the server.
3146 <p>
3147 Limited to <b>Services admins</b>.
3148
3149 <p>
3150 <hr align=center width="50%">
3151
3152 <a name="oper.raw"></a>
3153 <p><b>RAW</b>
3154
3155 <p><dl><dt><b>Syntax:</b>
3156 <dd><tt><b>RAW <i>text</i></b></tt>
3157 </dl>
3158 <p>
3159 Sends a string of text directly to the server to which
3160 Services is connected, without performing any processing on
3161 it. This command is intended primarily for testing of
3162 Services and IRC servers; it has a very limited range of
3163 uses on a live network, and can wreak havoc on a network or
3164 cause Services to crash if used improperly. <b>DO NOT USE THIS
3165 COMMAND</b> unless you are absolutely certain you know what you
3166 are doing!
3167 <p>
3168 Limited to the <b>Services super-user</b>.
3169
3170 <p>
3171 <hr align=center width="50%">
3172
3173 <a name="oper.update"></a>
3174 <p><b>UPDATE</b>
3175
3176 <p><dl><dt><b>Syntax:</b>
3177 <dd><tt><b>UPDATE [FORCE]</b></tt>
3178 </dl>
3179 <p>
3180 Causes Services to update all database files as soon as you
3181 send the command. If the <tt>FORCE</tt> option is given, Services
3182 will attempt to unlock the databases before performing the
3183 update; this can be used to fix "databases are locked"
3184 errors when updating the databases.
3185 <p>
3186 Limited to <b>Services admins</b>.
3187
3188 <p>
3189 <hr align=center width="50%">
3190
3191 <a name="oper.quit"></a>
3192 <p><b>QUIT</b>
3193
3194 <p><dl><dt><b>Syntax:</b>
3195 <dd><tt><b>QUIT</b></tt>
3196 </dl>
3197 <p>
3198 Causes Services to do an immediate shutdown; databases are
3199 <b>not</b> saved. This command should not be used unless
3200 damage to the in-memory copies of the databases is feared
3201 and they should not be saved. For normal shutdowns, use the
3202 <a href="#oper.shutdown"><tt>SHUTDOWN</tt></a> command.
3203 <p>
3204 Limited to <b>Services admins</b>.
3205
3206 <p>
3207 <hr align=center width="50%">
3208
3209 <a name="oper.shutdown"></a>
3210 <p><b>SHUTDOWN</b>
3211
3212 <p><dl><dt><b>Syntax:</b>
3213 <dd><tt><b>SHUTDOWN</b></tt>
3214 </dl>
3215 <p>
3216 Causes Services to save all databases and then shut down.
3217 <p>
3218 Limited to <b>Services admins</b>.
3219
3220 <p>
3221 <hr align=center width="50%">
3222
3223 <a name="oper.restart"></a>
3224 <p><b>RESTART</b>
3225
3226 <p><dl><dt><b>Syntax:</b>
3227 <dd><tt><b>RESTART</b></tt>
3228 </dl>
3229 <p>
3230 Causes Services to save all databases and then restart
3231 (<i>i.e.</i> exit and immediately re-run the executable).
3232 <p>
3233 Limited to <b>Services admins</b>.
3234
3235 <p>
3236 <hr align=center width="50%">
3237
3238 <a name="oper.rehash"></a>
3239 <p><b>REHASH</b>
3240
3241 <p><dl><dt><b>Syntax:</b>
3242 <dd><tt><b>REHASH</b></tt>
3243 </dl>
3244 <p>
3245 Causes Services to re-read its configuration files and
3246 update active settings. Some settings, such as
3247 <a href="a.html#RemoteServer"><tt>RemoteServer</tt></a>
3248 (which sets the hostname of the IRC server to connect to),
3249 cannot be changed with REHASH, and will only take effect
3250 when Services is restarted; in these cases, a message will
3251 be written to the Services log file, and a notice will be
3252 sent notifying you of this.
3253 <p>
3254 If <a href="a.html#LoadModule"><tt>LoadModule</tt></a>
3255 lines have been added to or removed from the
3256 main Services configuration file (<tt>ircservices.conf</tt>), modules
3257 will be loaded or unloaded as needed. Modules which no
3258 longer have a <tt>LoadModule</tt> line will be unloaded in reverse
3259 order of loading; then, after the remaining modules have
3260 been rehashed, new modules will be loaded in the order
3261 listed in the configuration file. If an error occurs at any
3262 step, rehashing will be aborted.
3263 <p>
3264 Note that due to module dependencies, some modules cannot be
3265 removed or changed via REHASH; in such cases, you will need
3266 to restart Services for the changes to take effect.
3267 <p>
3268 Limited to <b>Services admins</b>.
3269
3270 <p>
3271 <hr align=center width="50%">
3272
3273 <a name="oper.killclones"></a>
3274 <p><b>KILLCLONES</b>
3275
3276 <p><dl><dt><b>Syntax:</b>
3277 <dd><tt><b>KILLCLONES <i>nickname</i></b></tt>
3278 </dl>
3279 <p>
3280 Kills all users who have the same hostname as <tt><i>nickname</i></tt>. A
3281 temporary AKILL, in the form <tt>*@<i>host</i></tt>, is added to prevent the
3282 offending clients from immediately reconnecting. A <tt>WALLOPS</tt>
3283 is also sent indicating who used the command, which host was
3284 affected, and how many users were killed. It's useful for
3285 removing numerous clones from the network.
3286 <p>
3287 Limited to <b>Services operators</b>.
3288
3289 <p>
3290 <hr align=center width="50%">
3291
3292 <a name="oper.logonnews"></a>
3293 <p><b>LOGONNEWS</b>
3294
3295 <p><dl><dt><b>Syntax:</b>
3296 <dd><tt><b>LOGONNEWS ADD <i>text</i></b></tt>
3297 <tt> <b>LOGONNEWS DEL {<i>num</i> | ALL}</b></tt>
3298 <tt> <b>LOGONNEWS LIST</b></tt>
3299 </dl>
3300 <p>
3301 Edits or displays the list of logon news messages. When a
3302 user connects to the network, these messages will be sent
3303 to them. (However, no more than three messages will be
3304 sent in order to avoid flooding the user. If there are
3305 more than three news messages, only the three most recent
3306 will be sent.)
3307 <p>
3308 <tt>LOGONNEWS LIST</tt> may be used by any IRC operator to list the
3309 current news messages. <tt>ADD</tt> and <tt>DEL</tt> may only be used by
3310 Services administrators.
3311
3312 <p>
3313 <hr align=center width="50%">
3314
3315 <a name="oper.opernews"></a>
3316 <p><b>OPERNEWS</b>
3317
3318 <p><dl><dt><b>Syntax:</b>
3319 <dd><tt><b>OPERNEWS ADD <i>text</i></b></tt>
3320 <tt> <b>OPERNEWS DEL {<i>num</i> | ALL}</b></tt>
3321 <tt> <b>OPERNEWS LIST</b></tt>
3322 </dl>
3323 <p>
3324 Edits or displays the list of logon news messages. When a
3325 user opers up (with the <tt>/OPER</tt> command), these messages will
3326 be sent to them. (However, no more than three messages will
3327 be sent in order to avoid flooding the user. If there are
3328 more than three news messages, only the three most recent
3329 will be sent.)
3330 <p>
3331 <tt>OPERNEWS LIST</tt> may be used by any IRC operator to list the
3332 current news messages. <tt>ADD</tt> and <tt>DEL</tt> may only be used by
3333 Services administrators.
3334
3335
3336 <p align=right><font size="-1"><a href="#top">Back to top</a></font>
3337
3338 <!------------------------------------------------------------------------>
3339 <p><hr>
3340
3341 <a name=5></a>
3342 <h3>4-5. StatServ commands</h3>
3343
3344 <p>
3345 <hr align=center width="50%">
3346
3347 <a name="stat.servers"></a>
3348 <p><b>SERVERS</b>
3349
3350 <p><dl><dt><b>Syntax:</b>
3351 <dd><tt><b>SERVERS STATS</b></tt>
3352 <br><tt><b>SERVERS LIST [<i>mask</i>]</b></tt>
3353 <br><tt><b>SERVERS VIEW [<i>mask</i>] [ONLINE | OFFLINE]</b></tt>
3354 <br><tt><b>SERVERS DELETE <i>server</i></b></tt>
3355 <br><tt><b>SERVERS COPY <i>server</i> <i>newname</i></b></tt>
3356 <br><tt><b>SERVERS RENAME <i>server</i> <i>newname</i></b></tt>
3357 </dl>
3358 <p>
3359 Displays statistics relating to the network's servers.
3360 <p>
3361 <tt>SERVERS STATS</tt> displays a brief summary of the servers
3362 currently visible (online) and invisible (offline) to
3363 Services.
3364 <tt>SERVERS LIST</tt> displays a list of online servers and
3365 current statistics about each.
3366 <tt>SERVERS VIEW</tt> displays a list of online and offline
3367 servers with detailed statistics about each. The
3368 <tt>ONLINE</tt> and <tt>OFFLINE</tt> options cause, respectively,
3369 only online or offline servers to be shown.
3370 <p>
3371 Use the <tt><i>mask</i></tt> option to limit which servers'
3372 statistics are shown.
3373 <p>
3374 <tt>DELETE</tt> deletes the specified server's statistics.
3375 <br> <tt>COPY</tt> duplicates a set of server statistics.
3376 <br> <tt>RENAME</tt> rename's a set of server statistics.
3377 <br> These three commands are limited to <b>Services administrators</b>.
3378
3379 <p>
3380 <hr align=center width="50%">
3381
3382 <a name="stat.users"></a>
3383 <p><b>USERS</b>
3384
3385 <p><dl><dt><b>Syntax:</b>
3386 <dd><tt><b>USERS STATS</b></tt>
3387 </dl>
3388 <p>
3389 Displays statistics relating to the network's users.
3390
3391
3392 <p align=right><font size="-1"><a href="#top">Back to top</a></font>
3393
3394 <!------------------------------------------------------------------------>
3395 <p><hr>
3396
3397 <a name=6></a>
3398 <h3>4-6. Command index</h3>
3399
3400 <p>
3401 <a href="#6.A">A</a>
3402 <a href="#6.B">B</a>
3403 <a href="#6.C">C</a>
3404 <a href="#6.D">D</a>
3405 <a href="#6.E">E</a>
3406 <a href="#6.F">F</a>
3407 <a href="#6.G">G</a>
3408 <a href="#6.H">H</a>
3409 <a href="#6.I">I</a>
3410 <a href="#6.J">J</a>
3411 <a href="#6.K">K</a>
3412 <a href="#6.L">L</a>
3413 <a href="#6.M">M</a>
3414 <a href="#6.N">N</a>
3415 <a href="#6.O">O</a>
3416 <a href="#6.P">P</a>
3417 <a href="#6.Q">Q</a>
3418 <a href="#6.R">R</a>
3419 <a href="#6.S">S</a>
3420 <a href="#6.T">T</a>
3421 <a href="#6.U">U</a>
3422 <a href="#6.V">V</a>
3423 <a href="#6.W">W</a>
3424 <a href="#6.X">X</a>
3425 <a href="#6.Y">Y</a>
3426 <a href="#6.Z">Z</a>
3427
3428 <a name=6.A></a><h4>A</h4>
3429 <br><a href="#chan.access"><tt>ACCESS</tt></a> (ChanServ)
3430 <br><a href="#nick.access"><tt>ACCESS</tt></a> (NickServ)
3431 <br><a href="#oper.admin"><tt>ADMIN</tt></a>
3432 <br><a href="#nick.ajoin"><tt>AJOIN</tt></a>
3433 <br><a href="#chan.akick"><tt>AKICK</tt></a>
3434 <br><a href="#oper.akill"><tt>AKILL</tt></a>
3435 <br><a href="#chan.aop"><tt>AOP</tt></a>
3436 <br><a href="#nick.auth"><tt>AUTH</tt></a>
3437
3438 <a name=6.B></a><h4>B</h4>
3439
3440 <a name=6.C></a><h4>C</h4>
3441 <br><a href="#chan.clear"><tt>CLEAR</tt></a>
3442 <br><a href="#nick.clearauth"><tt>CLEARAUTH</tt></a>
3443 <br><a href="#oper.clearchan"><tt>CLEARCHAN</tt></a>
3444 <br><a href="#oper.clearmodes"><tt>CLEARMODES</tt></a>
3445
3446 <a name=6.D></a><h4>D</h4>
3447 <br><a href="#chan.dehalfop"><tt>DEHALFOP</tt></a>
3448 <br><a href="#memo.del"><tt>DEL</tt></a>
3449 <br><a href="#chan.deop"><tt>DEOP</tt></a>
3450 <br><a href="#chan.deprotect"><tt>DEPROTECT</tt></a>
3451 <br><a href="#chan.devoice"><tt>DEVOICE</tt></a>
3452 <br><a href="#chan.drop"><tt>DROP</tt></a> (ChanServ)
3453 <br><a href="#nick.drop"><tt>DROP</tt></a> (NickServ)
3454 <br><a href="#nick.dropemail"><tt>DROPEMAIL</tt></a>
3455 <br><a href="#nick.dropnick"><tt>DROPNICK</tt></a>
3456
3457 <a name=6.E></a><h4>E</h4>
3458 <br><a href="#oper.exception"><tt>EXCEPTION</tt></a>
3459
3460 <a name=6.F></a><h4>F</h4>
3461 <br><a href="#chan.forbid"><tt>FORBID</tt></a> (ChanServ)
3462 <br><a href="#nick.forbid"><tt>FORBID</tt></a> (NickServ)
3463 <br><a href="#memo.forward"><tt>FORWARD</tt></a>
3464
3465 <a name=6.G></a><h4>G</h4>
3466 <br><a href="#nick.getauth"><tt>GETAUTH</tt></a>
3467 <br><a href="#oper.getkey"><tt>GETKEY</tt></a>
3468 <br><a href="#chan.getpass"><tt>GETPASS</tt></a> (ChanServ)
3469 <br><a href="#nick.getpass"><tt>GETPASS</tt></a> (NickServ)
3470 <br><a href="#nick.ghost"><tt>GHOST</tt></a>
3471 <br><a href="#oper.global"><tt>GLOBAL</tt></a>
3472
3473 <a name=6.H></a><h4>H</h4>
3474 <br><a href="#chan.halfop"><tt>HALFOP</tt></a>
3475 <br><a href="#chan.hop"><tt>HOP</tt></a>
3476
3477 <a name=6.I></a><h4>I</h4>
3478 <br><a href="#chan.identify"><tt>IDENTIFY</tt></a> (ChanServ)
3479 <br><a href="#nick.identify"><tt>IDENTIFY</tt></a> (NickServ)
3480 <br><a href="#memo.ignore"><tt>IGNORE</tt></a>
3481 <br><a href="#chan.info"><tt>INFO</tt></a> (ChanServ)
3482 <br><a href="#memo.info"><tt>INFO</tt></a> (MemoServ)
3483 <br><a href="#nick.info"><tt>INFO</tt></a> (NickServ)
3484 <br><a href="#chan.invite"><tt>INVITE</tt></a>
3485
3486 <a name=6.J></a><h4>J</h4>
3487 <br><a href="#oper.jupe"><tt>JUPE</tt></a>
3488
3489 <a name=6.K></a><h4>K</h4>
3490 <br><a href="#chan.kick"><tt>KICK</tt></a> (ChanServ)
3491 <br><a href="#oper.kick"><tt>KICK</tt></a> (OperServ)
3492 <br><a href="#oper.killclones"><tt>KILLCLONES</tt></a>
3493
3494 <a name=6.L></a><h4>L</h4>
3495 <br><a href="#chan.levels"><tt>LEVELS</tt></a>
3496 <br><a href="#nick.link"><tt>LINK</tt></a>
3497 <br><a href="#chan.list"><tt>LIST</tt></a> (ChanServ)
3498 <br><a href="#memo.list"><tt>LIST</tt></a> (MemoServ)
3499 <br><a href="#nick.list"><tt>LIST</tt></a> (NickServ)
3500 <br><a href="#nick.listchans"><tt>LISTCHANS</tt></a>
3501 <br><a href="#nick.listemail"><tt>LISTEMAIL</tt></a>
3502 <br><a href="#nick.listlinks"><tt>LISTLINKS</tt></a>
3503 <br><a href="#oper.logonnews"><tt>LOGONNEWS</tt></a>
3504
3505 <a name=6.M></a><h4>M</h4>
3506 <br><a href="#oper.mode"><tt>MODE</tt></a>
3507
3508 <a name=6.N></a><h4>N</h4>
3509 <br><a href="#chan.nop"><tt>NOP</tt></a>
3510
3511 <a name=6.O></a><h4>O</h4>
3512 <br><a href="#chan.op"><tt>OP</tt></a>
3513 <br><a href="#oper.oper"><tt>OPER</tt></a>
3514 <br><a href="#oper.opernews"><tt>OPERNEWS</tt></a>
3515
3516 <a name=6.P></a><h4>P</h4>
3517 <br><a href="#chan.protect"><tt>PROTECT</tt></a>
3518
3519 <a name=6.Q></a><h4>Q</h4>
3520 <br><a href="#oper.quit"><tt>QUIT</tt></a>
3521
3522 <a name=6.R></a><h4>R</h4>
3523 <br><a href="#oper.raw"><tt>RAW</tt></a>
3524 <br><a href="#memo.read"><tt>READ</tt></a>
3525 <br><a href="#nick.reauth"><tt>REAUTH</tt></a>
3526 <br><a href="#nick.recover"><tt>RECOVER</tt></a>
3527 <br><a href="#chan.register"><tt>REGISTER</tt></a> (ChanServ)
3528 <br><a href="#nick.register"><tt>REGISTER</tt></a> (NickServ)
3529 <br><a href="#oper.rehash"><tt>REHASH</tt></a>
3530 <br><a href="#nick.release"><tt>RELEASE</tt></a>
3531 <br><a href="#memo.renumber"><tt>RENUMBER</tt></a>
3532 <br><a href="#oper.restart"><tt>RESTART</tt></a>
3533
3534 <a name=6.S></a><h4>S</h4>
3535 <br><a href="#memo.save"><tt>SAVE</tt></a>
3536 <br><a href="#memo.send"><tt>SEND</tt></a>
3537 <br><a href="#nick.sendauth"><tt>SENDAUTH</tt></a>
3538 <br><a href="#oper.servermap"><tt>SERVERMAP</tt></a>
3539 <br><a href="#stat.servers"><tt>SERVERS</tt></a>
3540 <br><a href="#oper.session"><tt>SESSION</tt></a>
3541 <br><a href="#chan.set"><tt>SET</tt></a> (ChanServ)
3542 <br><a href="#memo.set"><tt>SET</tt></a> (MemoServ)
3543 <br><a href="#nick.set"><tt>SET</tt></a> (NickServ)
3544 <br><a href="#oper.set"><tt>SET</tt></a> (OperServ)
3545 <br><a href="#oper.set_debug"><tt>SET DEBUG</tt></a>
3546 <br><a href="#chan.set_desc"><tt>SET DESC</tt></a>
3547 <br><a href="#chan.set_email"><tt>SET EMAIL</tt></a> (ChanServ)
3548 <br><a href="#nick.set_email"><tt>SET EMAIL</tt></a> (NickServ)
3549 <br><a href="#chan.set_enforce"><tt>SET ENFORCE</tt></a>
3550 <br><a href="#chan.set_entrymsg"><tt>SET ENTRYMSG</tt></a>
3551 <br><a href="#memo.set_forward"><tt>SET FORWARD</tt></a>
3552 <br><a href="#chan.set_founder"><tt>SET FOUNDER</tt></a>
3553 <br><a href="#chan.set_hide"><tt>SET HIDE</tt></a> (ChanServ)
3554 <br><a href="#nick.set_hide"><tt>SET HIDE</tt></a> (NickServ)
3555 <br><a href="#chan.set_keeptopic"><tt>SET KEEPTOPIC</tt></a>
3556 <br><a href="#nick.set_kill"><tt>SET KILL</tt></a>
3557 <br><a href="#nick.set_language"><tt>SET LANGUAGE</tt></a>
3558 <br><a href="#chan.set_leaveops"><tt>SET LEAVEOPS</tt></a>
3559 <br><a href="#memo.set_limit"><tt>SET LIMIT</tt></a>
3560 <br><a href="#nick.set_mainnick"><tt>SET MAINNICK</tt></a>
3561 <br><a href="#chan.set_mlock"><tt>SET MLOCK</tt></a>
3562 <br><a href="#chan.set_noexpire"><tt>SET NOEXPIRE</tt></a> (ChanServ)
3563 <br><a href="#nick.set_noexpire"><tt>SET NOEXPIRE</tt></a> (NickServ)
3564 <br><a href="#memo.set_notify"><tt>SET NOTIFY</tt></a>
3565 <br><a href="#chan.set_opnotice"><tt>SET OPNOTICE</tt></a>
3566 <br><a href="#chan.set_password"><tt>SET PASSWORD</tt></a> (ChanServ)
3567 <br><a href="#nick.set_password"><tt>SET PASSWORD</tt></a> (NickServ)
3568 <br><a href="#chan.set_private"><tt>SET PRIVATE</tt></a> (ChanServ)
3569 <br><a href="#nick.set_private"><tt>SET PRIVATE</tt></a> (NickServ)
3570 <br><a href="#oper.set_readonly"><tt>SET READONLY</tt></a>
3571 <br><a href="#chan.set_restricted"><tt>SET RESTRICTED</tt></a>
3572 <br><a href="#chan.set_secure"><tt>SET SECURE</tt></a> (ChanServ)
3573 <br><a href="#nick.set_secure"><tt>SET SECURE</tt></a> (NickServ)
3574 <br><a href="#chan.set_secureops"><tt>SET SECUREOPS</tt></a>
3575 <br><a href="#chan.set_successor"><tt>SET SUCCESSOR</tt></a>
3576 <br><a href="#oper.set_supass"><tt>SET SUPASS</tt></a>
3577 <br><a href="#nick.set_timezone"><tt>SET TIMEZONE</tt></a>
3578 <br><a href="#chan.set_topiclock"><tt>SET TOPICLOCK</tt></a>
3579 <br><a href="#chan.set_url"><tt>SET URL</tt></a> (ChanServ)
3580 <br><a href="#nick.set_url"><tt>SET URL</tt></a> (NickServ)
3581 <br><a href="#nick.setauth"><tt>SETAUTH</tt></a>
3582 <br><a href="#oper.sgline"><tt>SGLINE</tt></a>
3583 <br><a href="#oper.shutdown"><tt>SHUTDOWN</tt></a>
3584 <br><a href="#chan.sop"><tt>SOP</tt></a>
3585 <br><a href="#oper.sqline"><tt>SQLINE</tt></a>
3586 <br><a href="#oper.stats"><tt>STATS</tt></a>
3587 <br><a href="#chan.status"><tt>STATUS</tt></a> (ChanServ)
3588 <br><a href="#nick.status"><tt>STATUS</tt></a> (NickServ)
3589 <br><a href="#oper.su"><tt>SU</tt></a>
3590 <br><a href="#chan.suspend"><tt>SUSPEND</tt></a> (ChanServ)
3591 <br><a href="#nick.suspend"><tt>SUSPEND</tt></a> (NickServ)
3592 <br><a href="#oper.szline"><tt>SZLINE</tt></a>
3593
3594 <a name=6.T></a><h4>T</h4>
3595 <br><a href="#chan.topic"><tt>TOPIC</tt></a>
3596
3597 <a name=6.U></a><h4>U</h4>
3598 <br><a href="#chan.unban"><tt>UNBAN</tt></a>
3599 <br><a href="#nick.unlink"><tt>UNLINK</tt></a>
3600 <br><a href="#chan.unset"><tt>UNSET</tt></a> (ChanServ)
3601 <br><a href="#nick.unset"><tt>UNSET</tt></a> (NickServ)
3602 <br><a href="#chan.unsuspend"><tt>UNSUSPEND</tt></a> (ChanServ)
3603 <br><a href="#nick.unsuspend"><tt>UNSUSPEND</tt></a> (NickServ)
3604 <br><a href="#oper.update"><tt>UPDATE</tt></a>
3605 <br><a href="#stat.users"><tt>USERS</tt></a>
3606
3607 <a name=6.V></a><h4>V</h4>
3608 <br><a href="#chan.voice"><tt>VOICE</tt></a>
3609 <br><a href="#chan.vop"><tt>VOP</tt></a>
3610
3611 <a name=6.W></a><h4>W</h4>
3612
3613 <a name=6.X></a><h4>X</h4>
3614
3615 <a name=6.Y></a><h4>Y</h4>
3616
3617 <a name=6.Z></a><h4>Z</h4>
3618
3619 <p align=right><font size="-1"><a href="#top">Back to top</a></font>
3620
3621 <!------------------------------------------------------------------------>
3622 <p><hr>
3623
3624 <p align=right><font size=-1><a href=3.html>Previous section: Overview of Services features</a> |
3625 <a href=index.html>Table of Contents</a> |
3626 <a href=5.html>Next section: Importing and exporting databases</a></font>
3627
3628 </body>
3629 </html>