]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.helpop-full.example
Correct the base64 implementations
[user/henk/code/inspircd.git] / docs / inspircd.helpop-full.example
1 #####################
2 #  Helpop Standard  #
3 #####################
4
5 <alias text="HELPOP" replace="HELP $2-">
6
7 <helpop key="start" value="InspIRCd Help System
8
9 This system provides help for commands and modes.
10 Specify your question or a command name as the
11 parameter for this command.
12
13 /HELP CUSER    -      To see a list of user commands
14 /HELP COPER    -      To see a list of oper commands
15 /HELP UMODES   -      To see a list of user modes
16 /HELP CHMODES  -      To see a list of channel modes
17 /HELP SNOMASKS -      To see a list of oper snotice masks
18 /HELP EXTBANS  -      To see a list of extended bans">
19
20 <helpop key="nohelp" value="There is no help for the topic
21 you searched for. Please try again.">
22
23 #####################
24 #   User Commands   #
25 #####################
26
27 <helpop key="cuser" value="User Commands
28 -------------
29
30 PRIVMSG   NOTICE   NICK      JOIN      PART
31 CYCLE     KNOCK    MODE      DEVOICE   TOPIC
32 KICK      FPART    REMOVE    TBAN      INVITE
33 UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
34 MKPASSWD  VHOST    TITLE
35
36 WHOIS     WHOWAS   ISON      USERHOST  WATCH
37 LIST      NAMES    WHO       MOTD      RULES
38 ADMIN     MAP      LINKS     LUSERS    TIME
39 STATS     VERSION  INFO      MODULES   COMMANDS
40 SSLINFO   FINGERPRINT
41
42 USER      PASS     PING     PONG       QUIT
43
44 OPER">
45
46 <helpop key="sslinfo" value="/SSLINFO [nick]
47
48 Displays information on the SSL connection and certificate of the
49 target user.">
50
51 <helpop key="fingerprint" value="/FINGERPRINT [nick]
52
53 Shows the SSL fingerprint of a user. This can be used for
54 authentication by bots and scripts.">
55
56 <helpop key="uninvite" value="/UNINVITE [nick] [channel]
57
58 Uninvite a user from a channel, same syntax as INVITE.">
59
60 <helpop key="tban" value="/TBAN [channel] [duration] [banmask]
61
62 Sets a timed ban. The duration of the ban can be specified in the
63 following format: 1w2d3h4m6s which indicates a ban of one week, two
64 days, three hours, four minutes and six seconds. Alternatively the
65 ban may just be specified as a number of seconds. All timed bans
66 appear in the banlist as normal bans and may be safely removed
67 before their time is up.">
68
69 <helpop key="dccallow" value="/DCCALLOW [+|-] [nick] [duration]
70
71 Adds a nickname to or deletes a nickname from your DCCALLOW list.">
72
73 <helpop key="accept" value="/ACCEPT [+-*] [nick]{ [, [+-]<nick> ] }
74
75 Manages your accept list. This list is used to determine who can
76 private message you when you have usermode +g set. ACCEPT +nick adds
77 a nick to your accept list, ACCEPT -nick removes a nick from your
78 accept list, and ACCEPT * displays your accept list.">
79
80 <helpop key="cycle" value="/CYCLE [channel]
81
82 Cycles a channel (leaving and rejoining), overrides restrictions that
83 would stop a new user joining, such as user limits and channel keys.">
84
85 <helpop key="title" value="/TITLE [name] [password]
86
87 Authenticate for a WHOIS title line and optionally a vhost using the
88 specified username and password.">
89
90 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
91
92 Adds or deletes a user from the watch list. C clears the list
93 and S queries the status.">
94
95 <helpop key="vhost" value="/VHOST [username] [password]
96
97 Authenticate for a vhost using the specified username and password.">
98
99 <helpop key="remove" value="/REMOVE [channel] [nick] {[reason]}
100
101 Removes a user from a channel you specify. You must be at least a
102 channel halfoperator to remove a user. A removed user will part with
103 a message stating they were removed from the channel and by whom.">
104
105 <helpop key="fpart" value="/FPART [nick] [channel] {[reason]}
106
107 This behaves identically to /REMOVE, the only difference is that that
108 [channel] and [nick] parameters are switched around to match /KICK's
109 syntax. Also, /REMOVE is a builtin mIRC command which caused trouble
110 for some users. This feature was added in the 1.1 branch.">
111
112 <helpop key="devoice" value="/DEVOICE [channel]
113
114 Devoices yourself from the specified channel.">
115
116 <helpop key="silence" value="/SILENCE [+/-][hostmask] [p|c|i|n|t|a|x]
117
118 A serverside ignore of the given n!u@h mask. The letter(s) at the end
119 specify what is to be ignored from this hostmask.
120
121 Valid SILENCE Flags
122 -------------------
123
124  p        Block private messages
125  c        Block channel messages
126  i        Block invites
127  n        Block private notices
128  t        Block channel notices
129  a        Block all of the above
130  x        Exception
131
132 Multiple letters may be specified. For an exception, you msut pair x
133 with what you want excepted. For example, if you wanted to except
134 everything from people with a host matching *.foo.net, you would do
135 /SILENCE +xa *!*@*.foo.net
136
137 /SILENCE without a parameter will list the hostmasks that you have silenced.">
138
139 <helpop key="knock" value="/KNOCK [channel]
140
141 Sends a notice to a channel indicating you wish to join.">
142
143 <helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
144
145 This command is used by your client to register your
146 IRC session, providing your ident and GECOS to the
147 server.
148
149 You should not use it during an established connection.">
150
151 <helpop key="nick" value="/NICK [new nick]
152
153 Change your nickname to [new nick].">
154
155 <helpop key="quit" value="/QUIT {[reason]}
156
157 Quit from IRC and end your current session.">
158
159 <helpop key="version" value="/VERSION
160
161 Returns the server's version information.">
162
163 <helpop key="ping" value="/PING [server]
164
165 Ping a server. Target server will answer with a PONG.">
166
167 <helpop key="pong" value="/PONG [server]
168
169 Your client should send this to answer server PINGs. You
170 should not issue this command manually.">
171
172 <helpop key="admin" value="/ADMIN [server]
173
174 Shows the administrative information for the given server.">
175
176 <helpop key="privmsg" value="/PRIVMSG [target] [text]
177
178 Sends a message to a user or channel specified in [target].">
179
180 <helpop key="notice" value="/NOTICE [target] [text]
181
182 Sends a notice to a user or channel specified in [target].">
183
184 <helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
185
186 Joins one or more channels you provide the names for.">
187
188 <helpop key="names" value="/NAMES [channel]{,[channel]}
189
190 Return a list of users on the channels you provide.">
191
192 <helpop key="part" value="/PART [channel]{,[channel] [reason]}
193
194 Leaves one or more channels you specify.">
195
196 <helpop key="kick" value="/KICK [channel] [nick] {[reason]}
197
198 Kicks a user from a channel you specify. You must be
199 At least a channel halfoperator to kick a user.">
200
201 <helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
202
203 Sets the mode for a channel or a nickname specified in [target]
204 A user may only set modes upon themselves, and may not set the
205 +o usermode, and a user may only change channel modes of
206 channels where they are at least a halfoperator.
207
208 For a list of all user and channel modes, enter /HELP UMODES or
209 /HELP CHMODES.">
210
211 <helpop key="topic" value="/TOPIC [channel] {topic}
212
213 Sets or retrieves the channel topic. If a channel topic is
214 given in the command and either the channel is not +t, or
215 you are at least a halfoperator, the channel topic will be
216 changed to the new one you provide.">
217
218 <helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
219
220 Looks up the information of users matching the range you provide.
221 You may only /WHO nicknames in channels or on servers where you
222 share a common channel with them, or ones which are not +i (unless
223 you are an IRC operator). The search-pattern may be a special
224 sequence of characters determined by the flags given below, or
225 it may be one of a nickname, a channel, a hostmask, an ip address
226 mask or a server mask.
227
228 Valid WHO Flags
229 ---------------
230
231 The following flags after the mask have the following effects:
232
233  o      Show online IRC operators matching the mask
234
235  a      Show all users who have an away message matching the given mask
236  i      Show all users who have an ident (username) matching the given mask
237  p      Show all users who are connected on the given port number
238  r      Show all users whose realnames match the mask. When this
239         flag is set it overrides the meaning of the search-pattern,
240         which must contain a glob pattern intended to match GECOS
241         (realname) fields.
242  m      Search for all users with a given set of user modes. When
243         this flag is set it overrides the meaning of the
244         search-pattern, which must contain the mode sequence to
245         search for, for example to find all users with +i and
246         without +s, issue the command WHO +i-s m.
247  t      Show users connected within this number of seconds
248  M      Show all users who have metadata attached to them with
249         the given key name
250
251  f      Show only remote (far) users
252  l      Show only local users
253
254  h      Show real hostnames rather than masked hostnames (IRC
255         operators only)
256  u      Unlimit the results past the maximum /who results value
257         (IRC operators only)
258
259 You may combine multiple flags in one WHO command except where stated in the table above.">
260
261 <helpop key="motd" value="/MOTD [server]
262
263 Show the message of the day for [server]. Messages of the day often
264 contain important server rules and notices and should be read prior
265 to using a server.">
266
267 <helpop key="rules" value="/RULES
268
269 Show the rules file for the local server. This is similar in effect to
270 except that these are not sent automatically on connect.">
271
272 <helpop key="oper" value="/OPER [login] [password]
273
274 Attempts to authenticate a user as an IRC operator.
275
276 Both successful and unsuccessful oper attempts are
277 logged, and sent to online IRC operators.">
278
279 <helpop key="list" value="/LIST [pattern]
280
281 Creates a list of all existing channels matching the glob pattern
282 [pattern], e.g. *chat* or bot*.">
283
284 <helpop key="lusers" value="/LUSERS
285
286 Shows a count of local and remote users, servers and channels.">
287
288 <helpop key="userhost" value="/USERHOST [nickname]
289
290 Returns the hostname and nickname of a user, and some other
291 miscellaneous information.">
292
293 <helpop key="away" value="/AWAY {message}
294
295 If a message is given, marks you as being away, otherwise
296 removes your away status and previous message.">
297
298 <helpop key="ison" value="/ISON [nick] {[nick]...}
299
300 Returns a subset of the nicks you give, showing only those
301 that are currently online.">
302
303 <helpop key="invite" value="/INVITE [nick] [channel]
304
305 Invites a user to a channel. If the channel is NOT +A, only
306 channel halfoperators or above can invite people. If +A is set,
307 anyone can invite people to the channel, as long as the person
308 doing the invite is a member of the channel they wish to invite
309 the user to.
310
311 Invited users may override bans, +k, and similar in addition to
312 +i, depending on configuration.">
313
314 <helpop key="pass" value="/PASS [password]
315
316 This command is used by your client when setting up
317 your IRC session to submit a server password to the
318 server.
319
320 You should not use it during an established connection.">
321
322 <helpop key="whowas" value="/WHOWAS [nick]
323
324 Returns a list of times the user was seen recently on IRC along with
325 the time they were last seen and their server.">
326
327 <helpop key="links" value="/LINKS
328
329 Shows all servers linked to this one.">
330
331 <helpop key="map" value="/MAP
332
333 Shows a graphical representation of all users and servers on the
334 network, and the links between them, as a tree from the perspective
335 of your server.">
336
337 <helpop key="whois" value="/WHOIS [nick] {server}
338
339 Returns the WHOIS information of a user, their channels, hostname,
340 etc. If a second nickname or server is provided, then a whois is
341 performed from the server where the user is actually located rather
342 than locally, showing idle and signon times.">
343
344 <helpop key="time" value="/TIME [servermask]
345
346 Returns the local time of the server, or remote time of another
347 server.">
348
349 <helpop key="info" value="/INFO
350
351 Returns information on the developers and supporters who made this
352 IRC server possible.">
353
354 #####################
355 #   Oper Commands   #
356 #####################
357
358 <helpop key="coper" value="Oper Commands
359 -------------
360
361 OPERMOTD  CHECK     TAXONOMY    CLONES   USERIP
362 TLINE     ALLTIME   MODULES     WALLOPS  GLOBOPS
363
364 SETHOST   SETIDENT  SETNAME     CHGHOST  CHGIDENT
365 CHGNAME   SETIDLE   SWHOIS
366
367 SANICK    NICKLOCK  NICKUNLOCK
368
369 SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
370
371 KILL      SAQUIT    GLINE       ZLINE    QLINE
372 KLINE     RLINE     ELINE       CBAN     SHUN
373 FILTER
374
375 CONNECT   SQUIT     RCONNECT    RSQUIT
376
377 DIE            RESTART      REHASH
378 CLEARCACHE     LOADMODULE   UNLOADMODULE
379 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
380 GRELOADMODULE  RELOAD       CLOSE
381 LOCKSERV       UNLOCKSERV   JUMPSERVER">
382
383 <helpop key="userip" value="/USERIP [nickname]
384
385 Returns the ip and nickname of a user.">
386
387 <helpop key="tline" value="/TLINE [host or ip mask]
388
389 This command returns the number of local and global clients matched,
390 and the percentage of clients matched, plus how they were matched
391 (by IP address or by hostname).">
392
393 <helpop key="taxonomy" value="/TAXONOMY [nick]
394
395 Lists all metadata attached to the user.">
396
397 <helpop key="lockserv" value="/LOCKSERV
398
399 Locks out all new connections notifying connecting users that the
400 service is temporarily closed and to try again later.">
401
402 <helpop key="unlockserv" value="/UNLOCKSERV
403
404 Opens the server up again for new connections.">
405
406 <helpop key="jumpserver" value="/JUMPSERVER {[newserver] [newport] [+/-flags] {:[reason]}}
407
408 Sets or cancels jumpserver mode. If no parameters are given,
409 jumpserver mode is cancelled, if it is currently set. If parameters
410 are given, a server address must be given for [newserver] and a
411 server port must be given for [newport]. Zero or more status flags
412 should be given for 'flags', from the list below (if you do not
413 wish to specify any flags just place a '+' in this field):
414
415 1. +a: Redirect all users immediately (except for opers) and cause
416 them to quit with the given reason
417
418 2. +n: Redirect any new users who connect and cause them to quit
419 during registration
420
421 You may use + and - to set or unset these flags in the command, the
422 default flags are -a+n, which will just redirect new users. The
423 reason parameter is optional, and if not provided defaults to
424 'Please use this server/port instead' (the default given in various
425 numeric lists)">
426
427 <helpop key="filter" value="/FILTER [filter-definition] {[action] [flags] {[gline-duration]} :[reason]}
428
429 This command will add a filter when more than one parameter is given,
430 for messages of the types specified by the flags, with the given
431 filter definition, action, gline duration (when the action is 'gline')
432 and reason.
433
434 The filter will take effect when a message of any type specified by
435 the flags and matching the definition is sent to the server, and
436 perform the specified action.
437
438 Valid FILTER Actions
439 --------------------
440
441 None    Does nothing
442 Block   Blocks message and informs +s IRCops of the blocked message
443         and all relevant info
444 Silent  Blocks message, but does not notify IRCops
445 Kill    Kills the user
446 Gline   Glines the user for the specified duration
447
448 Valid FILTER Flags
449 ------------------
450
451 p    Block private and channel messages
452 n    Block private and channel notices
453 P    Block part messages
454 q    Block quit messages
455 o    Don't match against opers
456 *    Represents all of the above flags
457 -    Does nothing, a non-op for when you do not want to specify any
458      flags
459
460 The reason for the filter will be used as the reason for the action,
461 unless the ation is 'none', and is sent to the user when their text is
462 blocked by 'block' and 'silent' actions.
463
464 A gline duration may be specified in seconds, or in the format
465 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
466 minutes and 6 seconds. All fields in this format are optional.
467
468 When only one parameter is provided (the filter pattern) the provided
469 filter will be removed. Note that if you remove a
470 configuration-defined filter, it will reappear at next rehash unless
471 it is also removed from the config file.">
472
473 <helpop key="clones" value="/CLONES [limit]
474
475 Retrieves a list of users with more clones than the specified
476 limit.">
477
478 <helpop key="check" value="/CHECK [nick|ip|hostmask|channel]
479
480 Allows opers to look up advanced information on channels, hostmasks
481 or IP addresses, in a similar way to WHO but in more detail.">
482
483 <helpop key="alltime" value="/ALLTIME
484
485 Shows the time on all servers on the network.">
486
487 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
488
489 The server matching [source mask] will try to connect to the first
490 server in the config file matching [target mask].">
491
492 <helpop key="rsquit" value="/RSQUIT {[source mask]} [target mask]
493
494 Causes a remote server matching [target mask] to be disconnected from
495 the network, only if connected via a server matching [source mask] if
496 it is specified.">
497
498 <helpop key="globops" value="/GLOBOPS [message]
499
500 Sends a message to all users with the +g snomask.">
501
502 <helpop key="cban" value="/CBAN [channel] {[duration] :[reason]}
503
504 Sets or removes a channel ban. You must specify all three parameters
505 to add a ban, and one parameter to remove a ban (just the channel).
506
507 The duration may be specified in seconds, or in the format
508 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
509 5 minutes and 6 seconds. All fields in this format are optional.">
510
511 <helpop key="sajoin" value="/SAJOIN [nick] [channel]
512
513 Forces the user to join the channel.">
514
515 <helpop key="sapart" value="/SAPART [nick] [channel]
516
517 Forces the user to part the channel.">
518
519 <helpop key="samode" value="/SAMODE [target] +/-[modes] {[parameters for modes]}
520
521 Applies the given mode change to the channel or nick specified.">
522
523 <helpop key="sanick" value="/SANICK [nick] [new nick]
524
525 Changes the user's nick to the new nick.">
526
527 <helpop key="saquit" value="/SAQUIT [nick] [reason]
528
529 Forces user to quit with the specified reason.">
530
531 <helpop key="setidle" value="/SETIDLE [idle time]
532
533 Sets your idle time (in seconds) to the specified value.">
534
535 <helpop key="sethost" value="/SETHOST [host]
536
537 Sets your host to the specified host.">
538
539 <helpop key="setident" value="/SETIDENT [ident]
540
541 Sets your ident to the specified ident.">
542
543 <helpop key="setname" value="/SETNAME [name]
544
545 Sets your name to the specified name.">
546
547 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
548
549 Sets the user's swhois field to the given swhois.">
550
551 <helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
552
553 Encodes the plaintext to a hash of the given type and displays
554 the result.">
555
556 <helpop key="opermotd" value="/OPERMOTD
557
558 Redisplays the Oper MOTD.">
559
560 <helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
561
562 Changes the user's nick to the new nick, and forces
563 it to remain as such for the remainder of the session.">
564
565 <helpop key="nickunlock" value="/NICKUNLOCK [nick]
566
567 Allows a previously locked user to change nicks again.">
568
569 <helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
570
571 Changes the hostname of the user to the new hostname.">
572
573 <helpop key="chgname" value="/CHGNAME [nickname] [new name]
574
575 Changes the name of the user to the new name.">
576
577 <helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
578
579 Changes the ident of the user to the new ident.">
580
581 <helpop key="shun" value="/SHUN [nick!user@host] {[duration] :[reason]}
582
583 Sets or removes a shun (serverside ignore) on a host and ident mask.
584 You must specify all three parameters to add a shun, and one parameter
585 to remove a shun (just the nick!user@host section).
586
587 The duration may be specified in seconds, or in the format
588 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
589 5 minutes and 6 seconds. All fields in this format are optional.">
590
591 <helpop key="die" value="/DIE [password]
592
593 This command shuts down the local server. A single parameter is
594 required, which must match the password in the configuration for the
595 command to function.">
596
597 <helpop key="restart" value="/RESTART [password]
598
599 This command restarts down the local server. A single parameter is
600 required, which must match the password in the configuration for the
601 command to function.">
602
603 <helpop key="commands" value="/COMMANDS
604
605 Shows all currently available commands.">
606
607 <helpop key="kill" value="/KILL [user] [reason]
608
609 This command will disconnect a user from IRC with the given reason.">
610
611 <helpop key="rehash" value="/REHASH
612
613 This command will cause the server configuration file to be reread and
614 values reinitialized for all servers matchin the server mask, or the
615 local server if one is not specified.">
616
617 <helpop key="connect" value="/CONNECT [servermask]
618
619 Add a connection to the server matching the given servermask. You must
620 have configured the server for linking in your configuration file
621 before trying to link them.">
622
623 <helpop key="squit" value="/SQUIT [servermask]
624
625 Disconnects the server matching the given servermask from this server.">
626
627 <helpop key="modules" value="/MODULES
628
629 Lists currently loaded modules, their memory offsets, version numbers,
630 and flags. If you are not an operator, you will see reduced detail.">
631
632 <helpop key="loadmodule" value="/LOADMODULE [filename.so]
633
634 Loads the specified module into the local server.">
635
636 <helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
637
638 Unloads a module from the local server. The module cannot have the
639 static flag set (see the output of /MODULES).">
640
641 <helpop key="reloadmodule" value="/RELOADMODULE [filename.so]
642
643 Unloads and reloads a module on the local server. This module cannot
644 have the static flag set (see the output of /MODULES).">
645
646 <helpop key="loadmodule" value="/GLOADMODULE [filename.so]
647
648 Loads the specified module on all linked servers.">
649
650 <helpop key="unloadmodule" value="/GUNLOADMODULE [filename.so]
651
652 Unloads a module from all linked servers. The module cannot have the
653 static flag set (see the output of /MODULES).">
654
655 <helpop key="reloadmodule" value="/GRELOADMODULE [filename.so]
656
657 Unloads and reloads a module on all linked servers. This module cannot
658 have the static flag set (see the output of /MODULES).">
659
660 <helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
661
662 Sets or removes a k-line (local host based ban) on a host and ident mask.
663 You must specify all three parameters to add a ban, and one parameter
664 to remove a ban (just the user@host section).
665
666 The duration may be specified in seconds, or in the format
667 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
668 5 minutes and 6 seconds. All fields in this format are optional.">
669
670 <helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
671
672 Sets or removes a z-line (ip based ban) on an ip range mask.
673 You must specify all three parameters to add a ban, and one parameter
674 to remove a ban (just the ipmask).
675
676 The duration may be specified in seconds, or in the format
677 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
678 5 minutes and 6 seconds. All fields in this format are optional.">
679
680 <helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
681
682 Sets or removes a q-line (nick based ban) on a nick mask.
683 You must specify all three parameters to add a ban, and one parameter
684 to remove a ban (just the nickmask).
685
686 The duration may be specified in seconds, or in the format
687 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
688 5 minutes and 6 seconds. All fields in this format are optional.">
689
690 <helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
691
692 Sets or removes a g-line (host based ban) on host mask.
693 You must specify all three parameters to add a ban, and one
694 parameter to remove a ban (just the user@host section).
695
696 The duration may be specified in seconds, or in the format
697 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
698 5 minutes and 6 seconds. All fields in this format are optional.">
699
700 <helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
701
702 Sets or removes a e-line (local ban exception) on host mask.
703 You must specify at least 3 parameters to add an exception, and one
704 parameter to remove an exception (just the user@host section).
705
706 The duration may be specified in seconds, or in the format
707 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
708 5 minutes and 6 seconds. All fields in this format are optional.
709
710 This command has a few important limitations. Bans on *@<ip> can only
711 be negated by an eline on *@<ip>, bans on *@<host> can be negated by
712 elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
713 can be negated by any eline that matches.">
714
715 <helpop key="wallops" value="/WALLOPS [message]
716
717 Sends a message to all +w users.">
718
719 <helpop key="sakick" value="/SAKICK [#chan] [nick] [reason]
720
721 Kicks the given user from the specified channel.">
722
723 <helpop key="satopic" value="/SATOPIC [#chan] [new topic]
724
725 Applies the given topic to the specified channel.">
726
727 <helpop key="rline" value="/RLINE [regex] {[duration] :[reason]}
728
729 Sets or removes an r-line (regex line) on a n!u@h\\sgecos mask. You
730 must specify all three parameters to add an rline, and one parameter
731 to remove an rline (just the regex).
732
733 The duration may be specified in seconds, or in the format
734 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
735 5 minutes and 6 seconds. All fields in this format are optional.">
736
737 <helpop key="clearcache" value="/CLEARCACHE {servername}
738
739 This command clears the DNS cache of the specified server. If no
740 server is specified, the local server's DNS cache will be cleared.">
741
742 <helpop key="reload" value="/RELOAD [core command]
743
744 Reloads the specified core command.">
745
746 <helpop key="close" value="/CLOSE
747
748 Closes all unregistered connections to the local server.">
749
750 ######################
751 # User/Channel Modes #
752 ######################
753
754 <helpop key="umodes" value="User Modes
755 ----------
756
757  c            Blocks private messages and notices from users who do
758               not share a common channel with you (requires
759               commonchans module).
760  d            Deaf mode. User will not recieve any messages or notices
761               from channels they are in (requires deaf module).
762  g            In combination with /allow, provides for server side
763               ignore (requires callerid module).
764  h            Marks as 'available for help' in WHOIS (IRCop only,
765               requires helpop module).
766  i            Makes invisible to /WHO if the user using /WHO is not in
767               a common channel.
768  k            Prevents the user from being kicked from channels, or
769               having op modes removed from them (services only,
770               requires servprotect module).
771  o            Marks as a IRC operator.
772  s [mask]     Receives server notices specified by [mask]
773               (IRCop only).
774  r            Marks as a having a registered nickname
775               (requires services account module).
776  w            Receives wallops messages.
777  x            Gives a cloaked hostname (requires cloaking module).
778  B            Marks as a bot (requires botmode module).
779  G            Censors messages sent to the user based on filters
780               configured for the network (requires censor module).
781  H            Hides an oper's oper status from WHOIS (requires
782               hideoper module).
783  I            Hides a user's entire channel list in WHOIS from
784               non-IRCops (requires hidechans module).
785  Q            Makes an operator invisible, preventing users from
786               seeing their presence, including in channel user lists
787               (IRCop only, requires invisible module).
788  R            Blocks private messages from unregistered users
789               (requires services account module).
790  S            Strips mIRC colour/bold/underline codes out of private
791               messages to the user (requires stripcolor module).
792  W            Receives notification when a user uses WHOIS on them
793               (IRCop only, requires showwhois module).">
794
795 <helpop key="chmodes" value="Channel Modes
796 -------------
797
798  v [nickname]       Gives voice to [nickname], allowing them to speak
799                     while the channel is +m.
800  h [nickname]       Gives halfop status to [nickname] (this mode can
801                     be disabled).
802  o [nickname]       Gives op status to [nickname].
803  a [nickname]       Gives protected status to [nickname], preventing
804                     them from them from being kicked (+q only,
805                     requires chanprotect module).
806  q [nickname]       Gives owner status to [nickname], preventing them
807                     from being kicked (Services or only, requires
808                     chanprotect module).
809
810  b [hostmask]       Bans [hostmask] from the channel.
811  e [hostmask]       Excepts [hostmask] from bans (requires
812                     banexception module).
813  I [hostmask]       Excepts [hostmask] from +i, allowing matching
814                     users to join while the channel is invite-only
815                     (requires inviteexception module).
816
817  c                  Blocks messages containing mIRC colour codes
818                     (requires blockcolor module).
819  f [*][lines]:[sec] Kicks on text flood equal to or above the
820                     specified rate. With *, the user is banned
821                     (requires messageflood module).
822  g [mask]           Blocks messages matching the given blob mask
823                     (requires chanfilter module).
824  i                  Makes the channel invite-only.
825                     Users can only join if an operator
826                     uses /INVITE to invite them.
827  j [joins]:[sec]    Limits joins to the specified rate (requires
828                     joinflood module).
829  k [key]            Set the channel key (password) to [key].
830  l [limit]          Set the maximum allowed users to [limit].
831  m                  Enable moderation. Only users with +v, +h, or +o
832                     can speak.
833  n                  Blocks users who are not members of the channel
834                     from messaging it.
835  p                  Make channel private, hiding it in user's whoises
836                     and replacing it with * in /LIST.
837  r                  Marks the channel as registered with Services
838                     (requires services account module).
839  s                  Make channel secret, hiding it in user's whoises
840                     and /LIST.
841  t                  Prevents users without +h or +o from changing the
842                     topic.
843  u                  Makes the channel an auditorium; normal users only
844                     see themselves or themselves and the operators,
845                     while operators see all the users (requires
846                     auditorium module).
847  w [flag]:[banmask] Adds basic channel access controls of [flag] to
848                     [banmask], via the +w listmode.
849                     For example, +w o:R:Brain will op anyone identified
850                     to the account 'Brain' on join.
851                     (requires autoop module)
852  z                  Blocks non-SSL clients from joining the channel.
853
854  A                  Allows anyone to invite users to the channel
855                     (normally only chanops can invite, requires
856                     allowinvite module).
857  B                  Blocks messages with too many capital letters,
858                     as determined by the network configuration
859                     (requires blockcaps module).
860  C                  Blocks any CTCPs to the channel (requires noctcp
861                     module).
862  D                  Delays join messages from users until they
863                     message the channel (requires delayjoin module).
864  F [changes]:[sec]  Blocks nick changes when they equal or exceed the
865                     specified rate (requires nickflood module).
866  G                  Censors messages to the channel based on the
867                     network configuration (requires censor module).
868  J [seconds]        Prevents rejoin after kick for the specified
869                     number of seconds. This prevents auto-rejoin
870                     (requires kicknorejoin module).
871  K                  Blocks /KNOCK on the channel.
872  L [channel]        If the channel reaches its limit set by +l,
873                     redirect users to [channel] (requires redirect
874                     module).
875  M                  Blocks unregistered users from speaking (requires
876                     services account module).
877  N                  Prevents users on the channel from chainging nick
878                     (requires nonicks module).
879  O                  Channel is IRCops only (can only be set by IRCops,
880                     requires operchans module).
881  P                  Makes the channel permanent; Bans, invites, the
882                     topic, modes, and such will not be lost when it
883                     empties (can only be set by IRCops, requires
884                     permchannels module).
885  Q                  Only ulined servers and their users can kick
886                     (requires nokicks module)
887  R                  Blocks unregistered users from joining (requires
888                     services account module).
889  S                  Strips mIRC colour codes from messages to the
890                     channel (requirs stripcolor module).
891  T                  Blocks /NOTICEs to the channel from users who are
892                     not at least halfop (requires nonotice module).
893
894 -------------
895 NOTE: A large number of these modes are dependent upon server-side modules
896 being loaded by a server/network administrator. The actual modes available
897 on your network may be very different to this list. Please consult your
898 help channel if you have any questions.">
899
900 ######################
901 #   Stats Symbols    #
902 ######################
903
904 <helpop key="stats" value="/STATS [symbol]
905
906 Shows various server statistics. Depending on configuration, some
907 symbols may be only available to opers.
908
909 Valid symbols are:
910
911 e  Show e-lines (local ban exemptions)
912 g  Show g-lines (host bans)
913 k  Show k-lines (local host bans)
914 q  Show q-lines (nick mask bans)
915 Z  Show z-lines (ip mask bans)
916
917 s  Show filters
918 C  Show channel bans
919
920 c  Show link blocks
921 l  Show all inbound and outbound server and client connections
922 m  Show command statistics, number of times commands have been used
923 o  Show a list of all valid oper usernames and hostmasks
924 p  Show open client ports, and the port type (ssl, plaintext, etc) plus number of users on each port
925 u  Show server uptime
926 z  Show memory usage statistics
927 I  Show connect class permissions
928 L  Show all client connections with information and IP address
929 P  Show online opers and their idle times
930 T  Show bandwidth/socket statistics
931 U  Show u-lined servers
932 Y  Show connection classes
933
934 Note that all /STATS use is broadcast to online IRC operators.">
935
936 ######################
937 #      SNOMASKS      #
938 ######################
939
940 <helpop key="snomasks" value="Server Notice Masks
941
942  a      Allows receipt of local announcement messages.
943  A      Allows receipt of remote announcement messages.
944  c      Allows receipt of local connect messages.
945  C      Allows receipt of remote connect messages.
946  d      Allows receipt of general (and sometimes random) debug
947         messages.
948  f      Allows receipt of flooding notices.
949  g      Allows receipt of globops (requires globops module).
950  G      Allows receipt of notices of use of oper-override (requires
951         override module)
952  j      Allows receipt of channel creation notices (requires
953         chancreate module).
954  J      Allows receipt of remote channel creation notices (requires
955         chancreate module).
956  k      Allows receipt of local kill messages.
957  K      Allows receipt of remote kill messages.
958  l      Allows receipt of local linking related
959         messages.
960  L      Allows receipt of remote linking related
961         messages.
962  n      See local nickname changes (requires seenicks module).
963  N      See remote nickname changes (requires seenicks modules).
964  o      Allows receipt of oper-up, oper-down, and oper-failure
965         messages.
966  O      Allows receipt of remote oper-up, oper-down, and oper-failure
967         messages.
968  q      Allows receipt of local quit messages.
969  Q      Allows receipt of remote quit messages.
970  t      Allows receipt of attempts to use /STATS (local and remote).
971  x      Allows receipt of Xline notice (g/z/q/k/e).">
972
973 ######################
974 #      EXTBANS       #
975 ######################
976
977 <helpop key="extbans" value="Extended Bans
978 ----------
979
980  c:n!u@h       Blocks any messages that contain colour codes from
981                matching users (requires blockcolor module).
982  j:#channel    Prevents anyone in #channel from joining the channel
983                (requires channelban module).
984  m:n!u@h       Blocks messages from matching users (requires muteban
985                module).
986  p:n!u@h       Blocks part messages from matching users (requires
987                nopartmsg module).
988  r:realname    Prevents users with a matching realname from joining
989                the channel (requires gecosban module).
990  s:server      Prevents users on a matching server from joining the
991                channel (requires services account).
992  z:fingerprint Prevents users with a matching ssl fingerprint from
993                joining the server. (requires sslmodes module)
994  A:n!u@h       Blocks invites by matching users even when +A is set
995                (requires allowinvite module).
996  B:n!u@h       Blocks all capital or nearly all capital messages from
997                matching users (requires blockcaps module).
998  C:n!u@h       Blocks CTCPs from matching users (requires noctcp
999                module).
1000  M:account     Blocks messages from users logged into a matching
1001                account (requires services account module).
1002  N:n!u@h       Blocks nick changes from matching users (requires
1003                nonicks module).
1004  O:opertype    Prevents IRCops of the specified opertype from joining
1005                the channel, mostly useful as an invite exception (IRCop
1006                only, requires operchans module).
1007  Q:n!u@h       Blocks kicks by matching users (requires nokicks
1008                module).
1009  R:account     Prevents users logged into a matching account from
1010                joining the channel (requires services account module).
1011  S:n!u@h       Strips color/bold/underline from messages from matching
1012                users (requires stripcolor module).
1013  T:n!u@h       Blocks notices from matching users (requires nonotice
1014                module).
1015
1016  Redirect      n!u@h#channel will redirect the banned user to #channel
1017                when they try to join (requires banredirect module).
1018
1019 All extbans that prevent users from joining may by used for ban
1020 exceptions and invite exceptions (invex), and extbans blocking
1021 specific actions may be used for ban exceptions to exempt people from
1022 either wider extbans or the restrictive mode matching the extban,
1023 where one exists.">