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