]> jfr.im git - irc/unrealircd/unrealircd.git/blame - help.conf
Create branch unreal33.
[irc/unrealircd/unrealircd.git] / help.conf
CommitLineData
6c167e35 1/* UnrealIRCd3.2 Help Configuration
2 * Based on the original help text written by hAtbLaDe
3 * Revised by CC (07/2002)
4 *
5 * A worthwhile update for the /HELPOP system.
751e14cb 6 * Included with Unreal3.2 Dist. on 8/24/02 (Beta12)
6c167e35 7 */
8
9help {
10 " Server Commands Help.";
11 " Specify your Question after the /HELPOP command.";
12 " You will find all of the server commands and options";
13 " available for use.";
14 " If you need extra assistance please visit the server's";
15 " help channel or ask an available IRCop.";
16 " -";
17 " /HELPOP USERCMDS - To get the list of User Commands";
18 " /HELPOP OPERCMDS - To get the list of Oper Commands";
19 " /HELPOP SVSCMDS - Commands sent via U:Lined Server (Services)";
20 " /HELPOP UMODES - To get the list of User Modes";
21 " /HELPOP SNOMASKS - To get a list of Snomasks";
22 " /HELPOP CHMODES - To get the list of Channel Modes";
23 " /HELPOP OFLAGS - To see the list of O:line Flags";
24 " -";
25 " ==-------------------------oOo--------------------------==";
26};
27
fd47548f
BM
28/* note: indexes were generated by cat somecmds|sort|column -c 70
29 * along with tab->space conversion (tabwidth 8).
30 * Perhaps we should automate this step :). -- Syzop
31 */
32
6c167e35 33help Usercmds {
34 " Currently the following User commands are available.";
35 " Use /HELPOP <command name> to get more information about";
36 " a specific command.";
37 " -";
ecdb0571
BM
38 " ==-------------------------oOo-------------------------==";
39 " ADMIN LICENSE PART USERHOST";
40 " AWAY LINKS PING USERIP";
41 " CREDITS LIST PONG VERSION";
42 " CYCLE LUSERS PRIVMSG VHOST";
43 " DALINFO MAP QUIT WATCH";
44 " DCCALLOW MODE RULES WHO";
45 " INVITE MODULE SETNAME WHOIS";
46 " ISON MOTD SILENCE WHOWAS";
47 " JOIN NAMES STATS";
48 " KICK NICK TIME";
49 " KNOCK NOTICE TOPIC";
50 " ==-------------------------oOo-------------------------==";
6c167e35 51};
52
53help Opercmds {
54 " This section gives the IRC Operator only commands.";
55 " Use /HELPOP <command name> to get more information about";
56 " a specific command.";
57 " -";
ecdb0571 58 " ==-------------------------oOo-------------------------==";
7bc78fae 59 " ADCHAT DNS NACHAT SETIDENT";
60 " ADDMOTD GLINE OPER SHUN";
61 " ADDOMOTD GLOBOPS OPERMOTD SPAMFILTER";
ecdb0571
BM
62 " CHATOPS GZLINE REHASH SQUIT";
63 " CHGHOST HTM RESTART TEMPSHUN";
64 " CHGIDENT KILL RPING TRACE";
65 " CHGNAME KLINE SAJOIN TSCTL";
66 " CLOSE LAG SAMODE UNDCCDENY";
67 " CONNECT LOCOPS SAPART WALLOPS";
68 " DCCDENY MKPASSWD SDESC ZLINE";
69 " DIE MODULE SETHOST";
ecdb0571 70 " ==-------------------------oOo-------------------------==";
6c167e35 71};
72
73help Svscmds {
74 " This section gives the commands that can be";
75 " sent via a U:Lined Server such as Services.";
76 " The command is typically sent as:";
77 " /MSG OPERSERV RAW :services <command>";
78 " Use /HELPOP <command name> to get more information about";
79 " a specific command.";
80 " -";
ecdb0571 81 " ==-------------------------oOo-------------------------==";
20d84eda 82 " SQLINE SVSKILL SVSNLINE SVSSILENCE";
83 " SVS2MODE SVSLUSERS SVSNOLAG SVSSNO";
84 " SVS2SNO SVSMODE SVSNOOP SVSWATCH";
85 " SVSFLINE SVSMOTD SVSO SWHOIS";
86 " SVSJOIN SVSNICK SVSPART UNSQLINE";
ecdb0571 87 " ==-------------------------oOo-------------------------==";
6c167e35 88};
89
90help Umodes {
91 " Here is a list of all the usermodes which are available for use.";
92 " -";
93 " ==---------------------------oOo---------------------------==";
94 " o = Global IRC Operator";
95 " O = Local IRC Operator";
96 " a = Is a Services Administrator";
97 " A = Is a Server Administrator";
98 " N = Is a Network Administrator";
99 " C = Is a Co Administrator";
100 " -";
37a93b55 101 " d = Makes it so you can not receive channel PRIVMSGs (Deaf)";
6c167e35 102 " g = Can read & send to GlobOps, and LocOps";
103 " h = Available for Help (Help Operator)";
104 " i = Invisible (Not shown in /WHO searches)";
68a589da 105 " p = Hide all channels in /whois and /who";
9f1c8154 106 " q = Only U:lines can kick you (Services Admins/Net Admins only)";
37a93b55 107 " r = Identifies the nick as being Registered (settable by services only)";
6c167e35 108 " s = Can listen to Server notices";
109 " t = Says that you are using a /VHOST";
110 " v = Receive infected DCC send rejection notices";
111 " w = Can listen to Wallop messages";
112 " x = Gives the user Hidden Hostname (security)";
113 " z = Marks the client as being on a Secure Connection (SSL)";
114 " B = Marks you as being a Bot";
115 " G = Filters out all Bad words in your messages with <censored>";
116 " H = Hide IRCop status in /WHO and /WHOIS. (IRC Operators only)";
9df80388 117 " R = Allows you to only receive PRIVMSGs/NOTICEs from registered (+r) users";
6c167e35 118 " S = For Services only. (Protects them)";
a65906bc 119 " T = Prevents you from receiving CTCPs";
6c167e35 120 " V = Marks the client as a WebTV user";
121 " W = Lets you see when people do a /WHOIS on you (IRC Operators only)";
122 " ==---------------------------oOo---------------------------==";
123};
124
125help Snomasks {
d731cf04
BM
126 " Snomask stands for 'Service NOtice MASK', it (mainly) controls which";
127 " server notices you will receive.";
128 " Usage: /MODE nick +s <snomask>";
129 " Ex: /MODE blah +s +cF-j";
2857f3ef 130 " The parameter specifies which snomasks you want (or don't want).";
d731cf04
BM
131 " You can also remove all snomasks by simply doing /MODE nick -s.";
132 "-";
133 " Below is a list of possible snomasks:";
6c167e35 134 " ==-------------------------oOo-----------------------==";
d731cf04
BM
135 " c = View connects/disconnects on local server";
136 " e = View 'Eyes' server messages (OperOverride, /CHG* and /SET* usage, ..)";
137 " f = View flood alerts";
138 " F = View connects/disconnects on remote servers (except U-lines)";
139 " G = View TKL notices (Gline, GZline, Shun, etc)";
140 " j = View Junk notices (not recommended for normal use)";
141 " k = View KILL notices";
142 " n = View nick changes on local server";
143 " N = View nick changes on remote servers";
23ee49f6 144 " o = View oper-up notices";
d731cf04 145 " q = View rejected nick changes due to Q:lines";
23ee49f6 146 " s = View general notices";
d731cf04
BM
147 " S = View spamfilter matches";
148 " v = View usage of /VHOST command";
6c167e35 149 " ==-------------------------oOo------------------------==";
150};
151
152help Chmodes {
153 " This section lists all of the possible channel modes that may be used with /MODE";
154 " -";
155 " ==------------------------------oOo----------------------------==";
156 " v <nickname> = Gives Voice to the user (May talk if chan is +m)";
157 " h <nickname> = Gives HalfOp status to the user (Limited op access)";
158 " o <nickname> = Gives Operator status to the user";
ed7a06f1 159 " a <nickname> = Gives Channel Admin to the user";
6c167e35 160 " q <nickname> = Gives Owner status to the user";
161 " -";
a2137bda 162 " A = Server/Net Admin only channel (settable by Admins)";
a523cec9 163 " b <nick!ident@host> = Bans the nick!ident@host from the channel [h]";
193265ef 164 " c = Block messages containing mIRC color codes [o]";
a2137bda 165 " C = No CTCPs allowed in the channel [o]";
193265ef 166 " e <nick!ident@host> = Overrides a ban for matching users [h]";
839efd90 167 " f <floodparams> = Flood protection (for more info see /HELPOP CHMODEF) [o]";
a2137bda
BM
168 " (For more info on extended bantypes, see /HELPOP EXTBANS)";
169 " G = Filters out all Bad words in messages with <censored> [o]";
193265ef 170 " i = A user must be invited to join the channel [h]";
a2137bda 171 " I <nick!ident@host> = Overrides +i for matching users [h]";
6128e121 172 " j <joins:sec> = Throttle joins per-user to 'joins' per 'sec' seconds [o]";
193265ef 173 " k <key> = Users must specify <key> to join [h]";
a2137bda
BM
174 " K = /KNOCK is not allowed [o]";
175 " L <chan2> = Channel link (If +l is full, the next user will auto-join <chan2>) [q]";
193265ef
BM
176 " l <number of max users> = Channel may hold at most <number> of users [o]";
177 " m = Moderated channel (only +vhoaq users may speak) [h]";
165386a4 178 " M = Must be using a registered nick (+r), or have voice access to talk [o]";
193265ef 179 " N = No Nickname changes are permitted in the channel [o]";
a2137bda 180 " n = Users outside the channel can not send PRIVMSGs to the channel [h]";
37a93b55 181 " O = IRC Operator only channel (settable by IRCops)";
a2137bda 182 " p = Private channel [o]";
193265ef
BM
183 " Q = No kicks allowed [o]";
184 " R = Only registered (+r) users may join the channel [o]";
a2137bda
BM
185 " r = The channel is registered (settable by services only)";
186 " s = Secret channel [o]";
193265ef 187 " S = Strips mIRC color codes [o]";
5a6e957a 188 " T = No NOTICEs allowed in the channel [o]";
a2137bda 189 " t = Only +hoaq may change the topic [h]";
37a93b55 190 " u = Auditorium mode (/names and /who #channel only show channel ops) [q]";
a2137bda
BM
191 " V = /INVITE is not allowed [o]";
192 " z = Only Clients on a Secure Connection (SSL) can join [o]";
193 " Z = All users on the channel are on a Secure connection (SSL) [server]";
194 " (This mode is set/unset by the server. Only if the channel is also +z)";
193265ef
BM
195 " -";
196 " [h] requires at least halfop, [o] requires at least chanop, [q] requires owner";
6c167e35 197 " ==------------------------------oOo----------------------------==";
198};
199
803a67d4 200help ExtBans {
f72ad196 201 " These bans let you ban based on things other than the traditional nick!user@host";
a0b4fe90 202 " mask. They also provide support for things like ``quieting'' users (on other IRCds";
d8b2069b 203 " you might do +q <hostmask>, on UnrealIRCd use +b ~q:<hostmask>).";
803a67d4 204 " -";
d8b2069b 205 " These bantypes specify which actions are affected by a ban:";
803a67d4
BM
206 " ==-Type--------Name---------------------------Explanation-----------------------==";
207 " | | People matching these bans can join but are unable to ";
75d4fecb 208 " ~q | quiet | speak, unless they have +v or higher. ";
803a67d4
BM
209 " | | Example: ";
210 " | | +bb ~q:*!*@blah.blah.com ~q:nick*!*@* ";
211 "-----------------------------------------------------------------------------------";
212 " | | People matching these bans cannot change nicks, unless ";
213 " ~n | nickchange | they have +v or higher. ";
214 " | | Example: ";
215 " | | +bb ~n:*!*@*.aol.com ~n:nick*!*@* ";
216 "-----------------------------------------------------------------------------------";
46668768 217 " | | If a user matches this, he may not join the channel. ";
218 " ~j | join | He may perform all other activities if he is already on ";
219 " | | the channel, such as speaking and changing his nick. ";
220 "-----------------------------------------------------------------------------------";
d8b2069b
BM
221 " -";
222 " These bantypes introduce new criteria which can be used:";
223 " ==-Type--------Name---------------------------Explanation-----------------------==";
803a67d4 224 " | | If the user is in this channel then (s)he is unable to ";
d8b2069b 225 " | | join. A prefix can also be specified (+/%/@/&/~) which ";
2ff21308 226 " ~c | channel | means that it will only match if the user has that ";
803a67d4
BM
227 " | | rights or higher on the specified channel. ";
228 " | | Example: +b ~c:#lamers, +e ~c:@#trusted ";
229 "-----------------------------------------------------------------------------------";
230 " | | If the realname of a user matches this then (s)he is ";
231 " | | unable to join. ";
232 " ~r | realname | Example: +b ~r:*Stupid_bot_script* ";
233 " | | NOTE: an underscore ('_') matches both a space (' ') and";
234 " | | an underscore ('_'), so this ban would ";
235 " | | match 'Stupid bot script v1.4'. ";
d8b2069b
BM
236 "-----------------------------------------------------------------------------------";
237 " | | If a user has identified to services (usually NickServ) ";
238 " | | and matches this nickname, then this ban will match. ";
239 " | | This means this ban is really only useful for ban ";
240 " ~R | registered | exemptions (+e). Example: +e ~R:Nick ";
241 " | | Will allow Nick in the channel, regardless of other ";
242 " | | bans, if he identified to NickServ and is using the ";
243 " | | nickname Nick. ";
803a67d4 244 " ==------------------------------------------------------------------------------==";
d8b2069b
BM
245 " -";
246 "You may stack extended bans from the 1st group with the 2nd.";
247 "Example: +b ~q:~c:#lamers";
248 "The above would quiet all users who have joined #lamers.";
803a67d4
BM
249};
250
839efd90 251help Chmodef {
252 " The +f channel mode provides comprehensive flood protection for a channel.";
253 " This mode allows you to prevent join, nick change, CTCP, text, and knock";
254 " floods. The syntax for this mode's parameter is as follows:";
255 " -";
256 " +f [<amount><type>{#<action>}{,...}]:<seconds>";
257 " -";
258 " The amount specifies the number of times the specified flood must occur";
259 " before action is taken. Below are the available types:";
260 " -";
261 " ==-----Type-----Name--------Default Action---Other Actions-----==";
262 " c CTCP +C m, M";
263 " j Join +i R";
f3d578f2 264 " k Knock +K";
839efd90 265 " m Messages +m M";
266 " n Nickchange +N";
267 " t Text kick b";
268 " -";
269 " The difference between type m and t is that m is tallied for the entire";
270 " channel whereas t is tallied per user.";
271 " -";
272 " If you choose to specify an action for a mode, you may also specify a";
273 " time (in minutes) after which the specific action will be reversed.";
274};
275
276
6c167e35 277help Oflags {
278 " Here you will find the flags that can be placed inside of the O:Lines";
279 " -";
6653e4ef
BM
280 " ==-------------------------------oOo-----------------------------==";
281 " o (locop) Local Operator";
282 " O (globop) Global Operator";
283 " C (coadmin) Gets +C on oper up. Is Co Administrator";
284 " A (admin) Gets +A on oper up. Is Server Administrator";
285 " a (services-admin) Gets +a on oper up. Is Services Administrator";
286 " N (netadmin) Gets +N on oper up. Is Network Administrator";
6c167e35 287 " -";
6653e4ef
BM
288 " r (can_rehash) Access to /REHASH server";
289 " R (can_restart) Access to /RESTART server";
290 " D (can_die) Access to /DIE server";
291 " h (helpop) Oper receives umode +h (helpop)";
292 " g (can_globops) Oper can send /GLOBOPS";
293 " w (can_wallops) Oper can send /WALLOPS";
294 " n (can_localnotice) Oper can send Local Server Notices";
295 " G (can_globalnotice) Oper can send Global Server Notices";
296 " c (can_localroute) Access to do local /SQUITs and /CONNECTs";
297 " L (can_globalroute) Access to do global /SQUITs and /CONNECTs";
298 " k (can_localkill) Access to do local /KILLs";
299 " K (can_globalkill) Access to do global /KILLs";
300 " b (can_kline) Oper can /KLINE users from server";
301 " B (can_unkline) Oper can remove Klines";
302 " z (can_zline) Can add Z:Lines";
303 " Z (can_gzline) Can add global Z:Lines";
304 " t (can_gkline) Can use /GLINE, /SHUN and /SPAMFILTER";
305 " v (can_override) Can use OperOverride";
306 " q (can_setq) Can use +q";
307 " H (get_host) Gets +x on oper up";
308 " W (get_umodew) Gets +W on oper up";
309 " X (can_addline) Can use /ADDLINE";
310 " d (can_dccdeny) Can use /DCCDENY";
311 " ==-------------------------------oOo-----------------------------==";
6c167e35 312};
313
314
315help Nick {
316 " Changes your \"Online Identity\" on a server.";
317 " All those in the channel you are in will be";
318 " alerted of your nickname change.";
319 " -";
320 " Syntax: NICK <new nickname>";
321 " Example: NICK hAtbLaDe";
322};
323
324help Whois {
325 " Shows information about the user in question,";
326 " such as their \"Name\", channels they are";
327 " currently in, their hostmask, etc.";
328 " -";
329 " Syntax: WHOIS <user>";
330 " Example: WHOIS hAtbLaDe";
8f196cd8 331 " -";
332 " Status flags:";
333 " The list of channels shown in the WHOIS reply can include one or more";
334 " status flags to indicate information about the channel. These flags are";
335 " described below:";
336 " ~ - User is a Channel Owner (+q)";
337 " & - User is a Channel Admin (+a)";
338 " @ - User is a Channel Operator (+o)";
339 " % - User is a Halfop (+h)";
340 " + - User is Voiced (+v)";
341 " ! - User has channels hidden in whois (+p) and you are an IRC Operator";
342 " ? - The channel is secret (+s) and you are an IRC Operator";
6c167e35 343};
344
345help Who {
346 " Retrieves information about users";
347 " -";
348 " Syntax:";
8f196cd8 349 " /WHO [+|-][acghimnsuMRI] [args]";
6c167e35 350 " Flags are specified like channel modes, the flags cgmnsu all have arguments";
351 " Flags are set to a positive check by +, a negative check by -";
352 " The flags available:";
353 " Flag a: user is away";
354 " Flag c <channel>: user is on <channel>, no wildcards accepted";
8f196cd8 355 " Flag g <gcos/realname>: user has string <gcos> in his/her GCOS,";
6c167e35 356 " wildcards accepted, oper only";
8f196cd8 357 " Flag h <host>: user has string <host> in his/her hostname, wildcards are accepted";
358 " Flag i <ip>: user has string <ip> in his/her IP address";
359 " Flag m <usermodes>: user has <usermodes> set, only o/C/A/a/N for nonopers";
360 " Flag n <nick>: user has string <nick> in his/her nickname, wildcards accepted";
6c167e35 361 " Flag s <server>: user is on server <server>, wildcards not accepted";
8f196cd8 362 " Flag u <user>: user has string <user> in his/her username, wildcards accepted";
6c167e35 363 " Behavior flags:";
6c167e35 364 " Flag M: check for user in channels I am a member of";
8f196cd8 365 " Flag R: show users' real hostnames";
366 " Flag I: show users' IP addresses";
6c167e35 367 " -";
368 " For backwards compatibility, /who 0 o still shows +o users";
369 " Example: WHO +m o";
8f196cd8 370 " -";
371 " Status flags:";
372 " The who command shows several flags in the returned result to indicate";
373 " different information about the user. These flags are explained below:";
374 " G - User is /away (gone)";
375 " H - User is not /away (here)";
376 " r - User is using a registered nickname";
e9641139 377 " B - User is a bot (+B)";
8f196cd8 378 " * - User is an IRC Operator";
379 " ~ - User is a Channel Owner (+q)";
380 " & - User is a Channel Admin (+a)";
381 " @ - User is a Channel Operator (+o)";
382 " % - User is a Halfop (+h)";
383 " + - User is Voiced (+v)";
384 " ! - User is +H and you are an IRC Operator";
385 " ? - User is only visible because you are an IRC Operator";
6c167e35 386};
387
388help Whowas {
389 " Retrieves previous WHOIS information for users";
390 " no longer connected to the server.";
391 " -";
392 " Syntax: WHOWAS <nickname>";
393 " WHOWAS <nickname> <max number of replies>";
394 " Example: WHOWAS hAtbLaDe";
395};
396
9df80388 397help Cycle {
398 " Cycles the given channel(s). This command is equivilent";
399 " to sending a PART then a JOIN command.";
400 " -";
401 " Syntax: CYCLE <chan1>,<chan2>,<chan3>";
402 " Example: CYCLE #help";
403 " Example: CYCLE #main,#chat";
404};
405
406help Dns {
407 " Returns information about the IRC server's DNS cache.";
408 " Note, since most clients have a builtin DNS command,";
409 " you will most likely need to use /raw DNS to use this.";
37a93b55
BM
410 " There are also 2 other variants:";
411 " 'DNS l' will show you the DNS cache entries";
412 " 'DNS i' will give you details about the nameserver config";
9df80388 413 " -";
37a93b55 414 "Syntax: DNS [option]";
9df80388 415};
416
6c167e35 417help Names {
418 " Provides a list of users on the specified channel.";
419 " -";
420 "Syntax: NAMES <channel>";
421 "Example: NAMES #Support";
422};
423
424help Ison {
425 " Used to determine if certain user(s) are";
426 " currently online based upon their nickname.";
427 " -";
428 " Syntax: ISON <user> <user2> <user3> <user4>";
429 " Example: ISON hAtbLaDe Stskeeps OperServ AOLBot";
430};
431
432help Join {
433 " Used to enter one or more channels on an IRC server.";
434 " All occupants of the channel will be notified of your arrival.";
435 " JOIN with 0 as a parameter makes you Part all channels.";
436 " If you specify one or more keys, they will be used to join a +k channel";
437 " -";
438 " Syntax: JOIN <chan>,<chan2>,<chan3> <key1>,<key2>,<key3>";
439 " JOIN 0 (Parts all channels)";
440 " Example: JOIN #Support";
441 " JOIN #Lobby,#IRCd";
442 " JOIN #IRCd,#Support,#main letmein,somepass,anotherpass";
443};
444
445help Part {
446 " Used to part (or leave) a channel you currently occupy.";
447 " All those in the channel will be notified of your departure.";
448 " If you specify a reason it will be displayed to the users on the channel";
449 " -";
450 " Syntax: PART <chan>,<chan2>,<chan3>,<chan4> <reason>";
451 " Example: PART #Support";
452 " PART #Lobby,#IRCd See ya later!";
453};
454
455help Motd {
456 " Displays the Message Of The Day of the IRC Server you are logged onto.";
457 " -";
458 " Syntax: MOTD";
459 " MOTD <server>";
460};
461
462help Rules {
463 " Shows you the Rules of the Network.";
464 " -";
465 " Syntax: RULES";
466 " RULES <server>";
467};
468
469help Lusers {
470 " Provides Local and Global user information";
471 " (Such as Current and Maximum user count).";
472 " -";
d9446430 473 " Syntax: LUSERS [server]";
6c167e35 474};
475
476help Map {
477 " Provides a graphical \"Network Map\" of the IRC network.";
478 " Mainly used for routing purposes.";
479 " -";
480 " Syntax: MAP";
481};
482
483help Quit {
484 " Disconnects you from the IRC server. Those in the";
485 " channels you occupy will be notified of your departure.";
486 " If you do not specify a reason, your nickname becomes the reason.";
487 " -";
488 " Syntax: QUIT <reason>";
489 " Example: QUIT Leaving!";
490};
491
492help Ping {
493 " The PING command is used to test the presence of an active client or";
494 " server at the other end of the connection. Servers send a PING";
495 " message at regular intervals if no other activity detected coming";
496 " from a connection. If a connection fails to respond to a PING";
497 " message within a set amount of time, that connection is closed. A";
498 " PING message MAY be sent even if the connection is active.";
499 " Note that this is different from a CTCP PING command..";
500 " -";
501 " Syntax: PING <server> <server2>";
502 " Example: PING irc.fyremoon.net";
503 " PING hAtbLaDe";
504 " PING hAtbLaDe irc2.dynam.ac";
505};
506
507help Pong {
508 " PONG message is a reply to PING message. If parameter <server2> is";
509 " given, this message will be forwarded to given target. The <server>";
510 " parameter is the name of the entity who has responded to PING message";
511 " and generated this message.";
512 " -";
513 " Syntax: PONG <server> <server2>";
514 " Example: PONG irc.fyremoon.net irc2.dynam.ac";
515 " (PONG message from irc.fyremoon.net to irc2.dynam.ac)";
516};
517
518help Version {
519 " Provides Version information of the IRCd software in usage.";
520 " -";
521 " Syntax: VERSION";
522 " VERSION <server>";
523};
524
525help Stats {
526 " Provides certain Statistical information about the server";
527 " -";
528 " Syntax: STATS <flags>";
529 " Example: STATS u";
530 " -";
f0a5ab13 531 " Type /stats without parameters to get a list of available flags.";
6c167e35 532};
533
534help Links {
535 " Lists all of the servers currently linked to the network.";
536 " Only IRCops can see linked U:lined servers.";
537 " -";
538 " Syntax: LINKS";
539};
540
541help Admin {
542 " Provides Administrative information regarding the server.";
543 " -";
544 " Syntax: ADMIN";
545 " ADMIN <server>";
546};
547
548help Userhost {
549 " Returns the userhost of the user in question.";
550 " Usually used by scripts or bots.";
551 " -";
552 " Syntax: USERHOST <nickname>";
553 " Example: USERHOST hAtbLaDe";
554};
555
fea3b691 556help Userip {
557 " Returns the userip of the user in question.";
558 " Usually used by scripts or bots.";
559 " -";
560 " Syntax: USERIP <nickname>";
561 " Example: USERIP codemastr";
562};
563
6c167e35 564help Topic {
565 " Sets/Changes the topic of the channel in question,";
566 " or just display the current Topic.";
567 " -";
568 " Syntax: TOPIC <channel> (Displays the current topic)";
569 " TOPIC <channel> <topic> (Changes topic)";
570 " Example: TOPIC #Operhelp";
571 " TOPIC #Lobby Welcome to #Lobby!!";
572};
573
574help Invite {
575 " Sends a user an Invitation to join a particular channel.";
52fc7090 576 " If the channel is +i, you must be an Operator to use this";
577 " command, otherwise any user may use the command.";
578 " Invite without parameters lists the channels you have been";
579 " invited to.";
6c167e35 580 " -";
45cee8f2 581 " Syntax: INVITE [<user> <channel>]";
6c167e35 582 " Example: INVITE hAtbLaDe #Support";
45cee8f2 583 " Example: INVITE";
6c167e35 584};
585
586help Kick {
587 " Removes a user from a channel. Can only be used by Operators";
588 " or Half-Ops. If no reason is specified, your nickname becomes the reason.";
589 " -";
ded7f117
BM
590 " Syntax: KICK <channel> <user> [reason]";
591 " Example: KICK #Lobby foobar Lamer..";
6c167e35 592};
593
594help Away {
595 " Sets your online status to \"Away\".";
596 " -";
597 " Syntax: AWAY <reason> (Sets you Away with the reason given)";
598 " AWAY (Un-Sets you as Away)";
599 " Example: AWAY Lunch time!";
600};
601
602help Watch {
603 " Watch is a notify-type system on the server which is both faster";
604 " and uses less network resources than any old-style notify";
605 " system. The server will send you a message when any nickname";
606 " in your watch list logs on or off.";
607 " The watch list DOES NOT REMAIN BETWEEN SESSIONS - You (or your";
608 " script or client) must add the nicknames to your watch list every";
609 " time you connect to an IRC server.";
610 " -";
611 " Syntax: WATCH +nick1 +nick2 +nick3 (Add nicknames)";
612 " WATCH -nick (Delete nicknames)";
eae23edc 613 " WATCH (View which users are online)";
6c167e35 614};
615
616help List {
617 " Provides a complete listing of all channels on the network.";
618 " If a search string is specified, it will only show those";
619 " matching the search string.";
620 " -";
621 " Syntax: LIST <search string>";
622 " Example: LIST";
623 " LIST *ircd*";
624 " -";
625 " Some additional flags are also supported.";
626 " >number List channels with more than <number> people";
627 " <number List channels with less than <number> people";
628 " !*mask* List channels that do not match *mask*";
629 " -";
630 " Any of those may be used instead of a standard mask.";
631};
632
633help Privmsg {
e53a688c
BM
634 " Send a message to a user, channel or server.";
635 " /PRIVMSG <nick> <text>";
636 " Send a private message.";
637 " Ex: /PRIVMSG Blah hi, how are you?";
638 " /PRIVMSG <#channel> <text>";
639 " Send a message to a channel.";
640 " Ex: /PRIVMSG #room Hi all";
641 " /PRIVMSG <prefix><#channel> <text>";
aab9bffe
BM
642 " Send a message to users with <prefix> and higher in <#channel> only";
643 " Ex: /PRIVMSG @#room This goes to +oaq";
644 " /PRIVMSG +#room This goes to +vhoaq";
645 " NOTE: You need at least voice in order to send to +#chan/%#chan/@#chan";
646 " and at least ops to send to &#chan/~#chan.";
e53a688c
BM
647 " /PRIVMSG $<mask> <text>";
648 " Send a message to all users on servers matching <mask> [Oper only]";
649 " This is shown in the status window by most clients.";
650 " Ex: /PRIVMSG $*.mynet.net We will be upgrading our net in the next hour";
651 " Note that in most cases services (/OS GLOBAL) is a better alternative.";
652 " -";
653 " Multiple targets are also supported, like /PRIVMSG <nick1>,<nick2>,<nick3>.";
654 " -";
655 " NOTE: In case of some old clients (eg: ircII) you cannot use /msg";
656 " or /privmsg to use any of the 'advanced features', you'll then have to use:";
657 " '/QUOTE PRIVMSG @#channel blah' or something similar.";
6c167e35 658};
659
660help Notice {
e53a688c
BM
661 " Send a notice to a user, channel or server.";
662 " /NOTICE <nick> <text>";
663 " Send a notice to a user.";
664 " Ex: /NOTICE Blah hi, how are you?";
665 " /NOTICE <#channel> <text>";
666 " Send a notice to a channel.";
667 " Ex: /NOTICE #room Hi all, this is annoying";
668 " /NOTICE <prefix><#channel> <text>";
aab9bffe
BM
669 " Send a notice to users with <prefix> and higher in <#channel> only";
670 " Ex: /NOTICE @#room This goes to +oaq";
671 " /NOTICE +#room This goes to +vhoaq";
672 " NOTE: You need at least voice in order to send to +#chan/%#chan/@#chan";
673 " and at least ops to send to &#chan/~#chan.";
e53a688c
BM
674 " /NOTICE $<mask> <text>";
675 " Send a notice to all users on servers matching <mask> [Oper only]";
676 " This is shown in the status window by most clients.";
677 " Ex: /NOTICE $*.mynet.net We will be upgrading our net in the next hour";
678 " Note that in most cases services (/OS GLOBAL) is a better alternative.";
679 " -";
680 " Multiple targets are also supported, like /NOTICE <nick1>,<nick2>,<nick3>.";
681 " -";
682 " NOTE: In case of some old clients (eg: ircII) you cannot use /notice";
683 " to use any of the 'advanced features', you'll then have to use:";
684 " '/QUOTE NOTICE @#channel blah' or something similar.";
6c167e35 685};
686
687help Knock {
688 " For channels which are invite only, you can \"Knock\" on the";
689 " channel to request an invite.";
690 " -";
691 " Syntax: KNOCK <channel> <message>";
692 " Example: KNOCK #secret_chan I'm an op, let me in!";
693};
694
695help Setname {
696 " Allows users to change their \"Real name\" (GECOS)";
697 " directly online at IRC without reconnecting";
698 " -";
699 " Syntax: SETNAME <New Real Name>";
700};
701
702help Vhost {
703 " Hides your real hostname with a virtual hostname";
704 " provided by the IRC server , using SETHOST.";
705 " -";
706 " Synatx: VHOST <login> <password>";
707 " Example: VHOST openbsd ilovecypto";
708};
709
710help Mode {
711 " Sets a mode on a Channel or User.";
712 " Use /HELPOP CHMODES or /HELPOP UMODES to see a list of Modes";
713 " -";
714 " Syntax: MODE <channel/user> <mode>";
715 " Example: MODE #Support +tn";
716 " MODE #Support +ootn hAtbLaDe XYZ";
717};
718
719help Credits {
720 " This command will list the Credits to all the people who";
721 " helped create UnrealIRCd.";
722 " -";
723 " Syntax: CREDITS";
724 " CREDITS <server>";
725};
726
37a93b55
BM
727help Dalinfo {
728 " This command will show historical credits (from ircu, etc..)";
729 " -";
730 " Syntax: DALINFO";
731 " Syntax: DALINFO <server>";
732};
733
6c167e35 734help License {
735 " This command displays information about the license UnrealIRCd is released under.";
736 " Syntax: LICENSE";
737 " LICENSE <server>";
738};
739
740help Time {
741 " Displays the current Server Date and Time.";
742 " -";
743 " Syntax : TIME";
744 " TIME <server>";
745};
746
747help Silence {
748 " Ignores messages from a user or list of users at the Server itself.";
749 " -";
750 " Syntax: SILENCE +nickname (Adds a nickname to SILENCE list)";
751 " SILENCE -nickname (Removes a nickname from the SILENCE list)";
752 " SILENCE (Lists the current SILENCE list)";
753};
754
755help Oper {
756 " Attempts to give a user IRC Operator status.";
757 " (Lets the IRCop opper up)";
758 " -";
759 " Syntax: OPER <uid> <password>";
2cc542f4 760 " Note: both uid and password are case sensitive";
6c167e35 761 " Example: OPER hAtbLaDe foobar234";
762};
763
764help Wallops {
765 " Sends a \"Message\" to all those with the umode +w.";
766 " Only IRCops can send Wallops, while anyone with the mode +w";
767 " can view them.";
768 " -";
769 " Syntax: WALLOPS <message>";
770};
771
772help Globops {
773 " Sends a global \"Message\" to all IRCops. Only viewable by IRCops";
774 " (unlike WALLOPS, which can be viewed by normal users).";
775 " -";
776 " Syntax: GLOBOPS <message>";
777 " Example: GLOBOPS Lets get em clones ..";
778};
779
780help Locops {
37a93b55 781 " Sends a message to all IRCops at this server (local).";
6c167e35 782 " -";
783 " Syntax: LOCOPS <message>";
784 " Example: LOCOPS Gonna k:line that user ...";
785};
786
37a93b55
BM
787help Chatops {
788 " Sends a message to all ircops (global).";
789 " -";
790 " Syntax: CHATOPS <message>";
791 " Example: CHATOPS Gonna k:line that user ...";
792};
793
6c167e35 794help Adchat {
795 " Sends a message to all online Admins";
796 " -";
797 " Syntax: ADCHAT <text>";
798 " Example: ADCHAT Hey guys! I'm finally here.";
799};
800
801help Nachat {
802 " Sends a message to all online NetAdmins";
803 " -";
804 " Syntax: NACHAT <text>";
805 " Example: NACHAT Hey guys! How is everything?";
806};
807
808help Kill {
152283b7 809 " Forcefully Disconnects users from an IRC Server.";
6c167e35 810 " IRC Operator only command.";
811 " -";
152283b7 812 " Syntax: KILL <user1>,<user2>,<user3>,... <reason>";
6c167e35 813 " Example: KILL Jack16 Cloning is not allowed";
814};
815
816help Kline {
817 " This command provides timed K:Lines. If you match a K:Line you cannot";
818 " connect to the server";
819 " A time of 0 in the KLINE makes it permanent (Never Expires).";
820 " You may also specify the time in the format 1d10h15m30s.";
821 " IRC Operator only command.";
822 " -";
e53a688c 823 " Syntax: KLINE <hostmask or nick> [time] <reason> (adds a Kline)";
6c167e35 824 " KLINE -<hostmask> (removes a Kline)";
825 " Example: KLINE *@*.aol.com Abuse (Adds a permanent K:line)";
826 " KLINE *@*.someisp.com 2d Abuse (Adds a K:line for 2 days)";
e53a688c 827 " KLINE Idiot 1d Please go away";
6c167e35 828 " KLINE -*@*.aol.com";
829};
830
831help Zline {
832 " This command provides timed Z:Lines. If you match a Z:Line you cannot";
833 " connect to the server";
0bdb6a2e 834 " A time of 0 in the ZLINE makes it permanent (Never Expires).";
6c167e35 835 " You may also specify the time in the format 1d10h15m30s.";
836 " IRC Operator only command.";
837 " -";
e53a688c
BM
838 " Syntax: ZLINE <*@ipmask> [time] <reason> (adds a Zline)";
839 " ZLINE -<*@ipmask> (removes a Zline)";
6c167e35 840 " Example: ZLINE *@127.0.0.1 Abuse (Adds a permanent Z:line)";
841 " ZLINE *@127.0.0.1 2d Abuse (Adds a Z:line for 2 days)";
842 " ZLINE -*@127.0.0.1";
a28a349e 843 " NOTE: requires the can_zline oper flag";
6c167e35 844};
845
846help Gline {
847 " This command provides timed G:Lines. If you match a G:Line you cannot";
848 " connect to ANY server on the IRC network";
849 " A time of 0 in the GLINE makes it permanent (Never Expires).";
850 " You may also specify the time in the format 1d10h15m30s.";
851 " IRC Operator only command.";
852 " -";
e53a688c 853 " Syntax: GLINE <user@host mask or nick> [time] <reason>";
6c167e35 854 " (Adds a G:line for user@host)";
855 " GLINE -<user@host mask> (Removes a G:line for user@host)";
e53a688c
BM
856 " Example: GLINE *@*.idiot.net 900 Spammers (Adds a 15 min G:line)";
857 " GLINE *@*.idiot.net 1d5h Spammers (Adds a 29 hour G:line)";
858 " GLINE Idiot 1d Abuse";
6c167e35 859 " GLINE -*@*.idiot.net";
a28a349e 860 " NOTE: requires the can_gkline oper flag";
6c167e35 861};
862
863help Shun {
864 " Prevents a user from executing ANY command except ADMIN";
5c1225fc 865 " and respond to Server Pings. Shuns are global (like glines).";
6c167e35 866 " A time of 0 in the SHUN makes it permanent (Never Expires).";
867 " You may also specify the time in the format 1d10h15m30s.";
868 " IRC Operator only command.";
869 " -");
870 " Syntax: SHUN <nickname> <time> :<Reason> (Shun the nickname for time in seconds)";
871 " SHUN +<user@host> <time> :<Reason>(Shun the user@host for time in seconds)";
872 " SHUN -<user@host> (Removes the SHUN for user@host)";
873 " SHUN (View the current SHUN list)";
874 " -";
875 " Example: SHUN +foobar@aol.com 600 :Spamming";
876 " (Shuns foobar@aol.com for 10 mins for Spamming)";
877 " SHUN +foobar@aol.com 1d6h :Spamming (Adds a 30 hour SHUN)";
a28a349e 878 " NOTE: requires the can_gkline oper flag";
6c167e35 879};
880
881help Gzline {
882 " This command provides timed global Z:line. If you match a Global Z:Line you cannot";
883 " connect to ANY server on the IRC network";
884 " A time of 0 in the GZLINE makes it permanent (Never Expires).";
885 " You may also specify the time in the format 1d10h15m30s.";
886 " IRC Operator only command.";
887 " -";
e53a688c 888 " Syntax: GZLINE <*@ipmask> <seconds to be banned> :<reason>";
0eb09818 889 " (Adds a Global Z:line for *@ipmask)";
e53a688c
BM
890 " GZLINE -<*@ipmask> (Removes a Global Z:line for *@ipmask)";
891 " Example: GZLINE *@4.16.200.* 900 Spammers (Adds a 15 min Global Z:line)";
892 " GZLINE *@4.16.200.* 1d5h Spammers (Adds a 29 hour Global Z:line)";
a28a349e 893 " NOTE: requires the can_gzline oper flag";
6c167e35 894};
895
6c167e35 896help Akill {
897 " Adds an Autokill for the specific host mask. This prevents";
898 " any user from that hostmask from connecting to the network.";
e53a688c 899 " THIS IS A DEPRICATED COMMAND AND ONLY ACCEPTED FROM SERVERS";
6c167e35 900 " -";
901 " Syntax: AKILL <user@host> :<Reason>";
902 " Example: AKILL foo@aol.com :Spammers!";
903};
904
905help Rakill {
e53a688c
BM
906 " Removes an AKILL that was previously set.";
907 " THIS IS A DEPRICATED COMMAND AND ONLY ACCEPTED FROM SERVERS";
6c167e35 908 " -";
909 " Syntax: RAKILL <user@host>";
910};
911
912help Rehash {
913 " Prompts the server to reread the configuration files.";
914 " IRC Operator only command.";
915 " -";
d107a4a6
BM
916 " Syntax: REHASH <servername> [flag]";
917 " REHASH -global [flag]";
918 " REHASH [flag]";
6c167e35 919 " -";
d107a4a6 920 " If servername and flag are not specified this rehashes the";
d4d58c12
BM
921 " unrealircd.conf, and re-reads all MOTD, BOTMOTD, OPERMOTD and RULES files.";
922 " If servername is specified, this is used to rehash the remote server.";
d107a4a6
BM
923 " If -global is specified, then all servers on the network are rehashed.";
924 " Only NetAdmins may specify a server name and use -global.";
6c167e35 925 " -";
926 " The flags are used to rehash other config files, valid flags are:";
d4d58c12 927 " -dns - Reinitializes and reloads the resolver";
6c167e35 928 " -garbage - Force garbage collection";
d4d58c12
BM
929 " -motd - Only re-read all MOTD, BOTMOTD, OPERMOTD and RULES files";
930 " (including those in tld{} blocks)";
931 " -ssl - Reloads SSL certificates";
6c167e35 932};
933
934help Restart {
935 " Kills and Restarts the IRC daemon, disconnecting all users";
936 " currently on that server.";
937 " IRC Operator only command.";
938 " -";
939 " Syntax: RESTART";
940 " RESTART <password>";
66804a1c 941 " RESTART <password> <reason>";
6c167e35 942};
943
944help Die {
945 " Kills the IRC daemon, disconnecting all users currently on that server.";
946 " IRC Operator only command.";
947 " -";
948 " Syntax: DIE";
949 " DIE <password>";
950};
951
952help Lag {
953 " This command is like a Traceroute for IRC servers";
954 " You type in /LAG irc.fyremoon.net and it will";
955 " reply from every server it passes with time and so on";
956 " Useful for looking where lag is and optional TS future/past travels";
957 " -";
958 " Syntax: LAG <server>";
959};
960
961help Sethost {
962 " This command is so you can change your Virtual host (Vhost)";
963 " to anything you want, except special characters.";
964 " IRC Operator only command.";
965 " -";
966 " Syntax: SETHOST <new hostname>";
967 " Example: SETHOST i.have.hairy.armpits";
968};
969
970help Setident {
971 " With this command you can change your Ident (Username).";
972 " IRC Operator only command.";
973 " -";
974 " Syntax: SETIDENT <new ident>";
975 " Example: SETIDENT l33t";
976};
977
978help Chghost {
979 " Changes the hostname of a user currently on the IRC network.";
980 " IRC Operator only command.";
981 " -";
982 " Syntax: CHGHOST <nick> <host>";
983 " Example: CHGHOST hAtbLaDe root.me.com";
984};
985
986help Chgident {
987 " Changes the Ident of a user currently on the IRC network.";
988 " IRC Operator only command.";
989 " -";
990 " Syntax: CHGIDENT <nick> <ident>";
991 " Example: CHGIDENT hAtbLaDe sheep";
992};
993
994help Chgname {
995 " Changes the \"IRC Name\" (or \"Real Name\") of a user currently on the IRC network.";
996 " IRC Operator only command.";
997 " -";
998 " Syntax: CHGNAME <nick> <name>";
999 " Example: CHGNAME hAtbLaDe Gotta new name :)";
1000};
1001
1002help Squit {
1003 " Disconnects an IRC Server from the network.";
1004 " Usually used in routing of servers.";
1005 " IRC Operator only command.";
1006 " -";
1007 " Syntax: SQUIT <server>";
1008 " Example: SQUIT leaf.*";
1009};
1010
1011help Connect {
1012 " Links another IRC server to the one you are currently on.";
1013 " Remote connections are also possible.";
1014 " IRC Operator only command.";
1015 " -";
12b538a6
BM
1016 " Syntax: CONNECT <server> [port]";
1017 " CONNECT <leaf> <port> <hub>";
6c167e35 1018 " Example: CONNECT leaf.*";
12b538a6 1019 " CONNECT leaf.* 6667 hub.*";
6c167e35 1020};
1021
1022help Dccdeny {
1023 " Adds a DCC Deny for that Filename mask. This means that any";
1024 " DCC sends of Files matching that Filename mask will be rejected.";
1025 " IRC Operator only command.";
1026 " -";
1027 " Syntax: DCCDENY <filename mask> <reason>";
1028};
1029
1030help Undccdeny {
1031 " If the EXACT file you type is found it is removed, else it uses wildcards to search";
1032 " IRC Operator only command.";
1033 " -";
1034 " Syntax: UNDCCDENY <filename mask>";
1035};
1036
1037help Sajoin {
1038 " Forces a user to join a channel.";
1039 " Services Admin Command";
1040 " -";
1041 " Syntax: SAJOIN <nick> <channel>,[<channel2>..]";
1042 " Example: SAJOIN hAtbLaDe #OperHelp";
1043 " SAJOIN hAtbLaDe #Support,#IRCHelp";
1044};
1045
1046help Sapart {
37a93b55 1047 " Forces a user to part a channel.";
6c167e35 1048 " Services Admin Command";
1049 " -";
70b32d01 1050 " Syntax: SAPART <nick> <channel>,[<channel2>..] [<comment>]";
37a93b55
BM
1051 " Example: SAPART hAtbLaDe #OperHelp";
1052 " SAPART hAtbLaDe #Support,#IRCHelp";
70b32d01 1053 " SAPART hAtbLaDe #Support,#IRCHelp Go away";
6c167e35 1054};
1055
1056help Samode {
1057 " Allows a Services Administrator to change the mode on a channel,";
1058 " without having Operator status.";
1059 " Services Admin Command";
1060 " -";
1061 " Syntax: SAMODE <channel> <mode>";
1062 " Example: SAMODE #Support +m";
1063};
1064
1065help Rping {
1066 " This will calculate the Lag (In milliseconds) between servers";
1067 " -";
1068 " Syntax: RPING <servermask>";
1069};
1070
1071help Trace {
a28a349e
BM
1072 " You can use TRACE on servers or users.";
1073 " When used on a user it will give you class and lag info.";
1074 " If you use it on a server it gives you class/version/link info.";
6c167e35 1075 " Sometimes TRACE can be confusing, especially if you are using";
1076 " it for the first time.";
1077 " -";
a28a349e 1078 " Syntax: TRACE <servername|nickname>";
6c167e35 1079 " Example: TRACE irc.fyremoon.net";
1080};
1081
1082help Opermotd {
1083 " Shows the IRCd Operator MOTD";
1084 " IRC Operator only command.";
1085 " -";
1086 " Syntax: OPERMOTD";
1087};
1088
1089help Sdesc {
1090 " With this command you can change your Server Info Line";
1091 " Without having to squit and reconnect.";
1092 " This is a Server Admin/Co Admin only command";
1093 " -";
1094 " Syntax: SDESC <New description>";
1095 " Example: SDESC Fly High, Fly Free";
1096};
1097
1098help Mkpasswd {
2857f3ef 1099 " This command will return a 'hash' of the string that has been specified,";
5018dec0
BM
1100 " you can use this hash for any encrypted passwords in your configuration file:";
1101 " eg: for oper::password, vhost::password, etc.";
1102 " Available types (in order of 'secureness'):";
1103 " *NIX: crypt, md5, sha1 [*], ripemd160 [*]";
1104 " Windows: crypt [*], md5, sha1, ripemd160 [*]";
1105 " [*: only available if compiled with SSL support]";
6c167e35 1106 " -";
1107 " Syntax: MKPASSWD <method> <password>";
5018dec0 1108 " Example: MKPASSWD md5 IamTeh1337";
6c167e35 1109};
1110
41a0896d 1111help Module {
d6fd665e
BM
1112 " This will give you a list of all modules loaded.";
1113 " Depending on whether you are a normal user or an oper";
1114 " it will give different output.";
1115 " -- normal user: --";
1116 " Syntax of command: MODULE";
1117 " Output of command: *** name - (description) [3RD]";
1118 " the [3RD] flag is present if it's an 3rd party module.";
1119 " -- ircop: -- ";
1120 " Syntax of command: MODULE [server]";
1121 " Output of command: *** name - version (description) [optional flags]";
41a0896d
BM
1122 " flags can be:";
1123 " [PERM]: permanent module (not possible to unload/reload)";
1124 " [Unloading]: module is in the process of unloading";
d6fd665e 1125 " [3RD] 3rd party module";
01c5b99f 1126 " [OLD?] Lacking Mod_Version, forgot to recompile an old beta* module?";
d6fd665e
BM
1127 " Additionally you'll see a list of which hooks and command";
1128 " overrides are present (the hook number can be looked up in";
1129 " include/modules.h).";
41a0896d
BM
1130};
1131
9df80388 1132help Close {
1133 " This command will disconnect all unknown connections from the";
1134 " IRC server.";
1135 " -";
1136 " Syntax: CLOSE";
1137};
1138
6c167e35 1139help Tsctl {
1140 " This is a highly advanced command used to Adjust the";
1141 " Internal IRC clock.";
1142 " IRC Operator only command.";
1143 " -";
1144 " Syntax: TSCTL OFFSET +|- <time> (Adjust internal IRC clock)";
1145 " TSCTL TIME (Will give TS report)";
1146 " TSCTL ALLTIME (Shows the TS report of all server)";
1147 " TSCTL SVSTIME <timestamp> (Sets the Time on all Servers)";
1148};
1149
1150help Htm {
1151 " Switches the server In & Out of High Traffic Mode";
1152 " HTM is activated when the server is receiving extremely high amounts of information.";
1153 " IRC Operator only command.";
1154 " -";
1155 " Syntax: HTM [option]";
1156 " -";
1157 " If no option is specified it just displays the current HTM state";
1158 " If an option is specified it does a more specific task, valid options are:";
1159 " -";
1160 " ON - Force HTM to activate";
1161 " OFF - Force HTM to deactivate";
1162 " NOISY - Make HTM announce when it is entering/leaving HTM";
1163 " QUIET - Stop HTM from announcing when it is entering/leaving HTM";
1164 " TO <value> - Tell HTM at what incoming rate to activate HTM";
1165};
1166
1167help Svsnick {
1168 " Changes the nickname of the user in question.";
1169 " Must be sent through an U:Lined server.";
1170 " -";
1171 " Syntax: SVSNICK <nickname> <new nickname> <timestamp>";
1172 " Example: SVSNICK hAtbLaDe Foobar 963086432";
1173};
1174
1175help Svsmode {
1176 " Changes the mode of the User in question.";
1177 " Must be sent through an U:Lined server.";
1178 " -";
1179 " Syntax: SVSMODE <nickname> <usermode>";
1180 " Example: SVSMODE hAtbLaDe +i";
1181};
1182
1183help Svskill {
1184 " Forcefully disconnects a user from the network.";
1185 " Must be sent through an U:Lined server.";
1186 " -";
1187 " Syntax: SVSKILL <user> :<reason>";
1188 " Example: SVSKILL Lamer21 :Goodbye";
1189};
1190
1191help Svsnoop {
f3d578f2 1192 " Enables or disables whether IRCop functions";
6c167e35 1193 " exist on the server in question or not.";
1194 " Must be sent through an U:Lined server.";
1195 " -";
1196 " Syntax: SVSNOOP <server> <+/->";
1197 " Example: SVSNOOP leaf.* -";
1198};
1199
1200help Svsjoin {
1201 " Forces a user to join a channel.";
1202 " Must be sent through an U:Lined server.";
1203 " -";
8c20440e 1204 " Syntax: SVSJOIN <nick> <channel>[,<channel2>..] [key1[,key2[..]]]";
6c167e35 1205 " Example: SVSJOIN hAtbLaDe #jail";
1206 " SVSJOIN hAtbLaDe #jail,#zoo";
1207};
1208
1209help Svspart {
1210 " Forces a user to leave a channel.";
1211 " Must be sent through an U:Lined server.";
1212 " -";
70b32d01 1213 " Syntax: SVSPART <nick> <channel>[,<channel2>..] [<comment>]";
6c167e35 1214 " Example: SVSPART hAtbLaDe #Hanson";
1215 " SVSPART hAtbLaDe #Hanson,#AOL";
70b32d01 1216 " SVSPART hAtbLaDe #Hanson,#AOL You must leave";
6c167e35 1217};
1218
1219help Svso {
1220 " Gives nick Operflags like the ones in O:lines.";
1221 " Remember to set SVSMODE +o and alike.";
1222 " Must be sent through an U:Lined server.";
1223 " -";
1224 " Syntax: SVSO <nick> <+operflags> (Adds the Operflags)";
1225 " SVSO <nick> - (Removes all O:Line flags)";
1226 " Example: SVSO SomeNick +bBkK";
1227};
1228
1229help Swhois {
1230 " Changes the WHOIS message of the Nickname.";
1231 " Must be sent through an U:Lined server.";
1232 " -";
1233 " Syntax: SWHOIS <nick> :<message> (Sets the SWHOIS)";
1234 " SWHOIS <nick> : (Resets the SWHOIS)";
1235 " Example: SWHOIS SomeNick :is a lamer";
1236};
1237
1238help Sqline {
1239 " Bans a Nickname or a certain Nickname mask from the Server.";
1240 " Must be sent through an U:Lined server.";
1241 " -";
1242 " Syntax: SQLINE <nickmask> :<Reason>";
1243 " Example: SQLINE *Bot* :No bots";
1244};
1245
1246help Unsqline {
1247 " Un-Bans a Nickname or Nickname mask";
1248 " Must be sent through an U:Lined server.";
1249 " -";
1250 " Synax: UNSQLINE <nickmask>";
1251 " Example: UNSQLINE *Bot*";
1252};
1253
1254help Svs2mode {
a607cc8b 1255 " Changes the Usermode of a nickname and displays";
1256 " the change to the user.";
6c167e35 1257 " Must be sent through an U:Lined server.";
1258 " -";
a607cc8b 1259 " Syntax: SVS2MODE <nickname> <usermodes>";
1260 " Example: SVS2MODE hAtbLaDe +h";
6c167e35 1261};
1262
1263help Svsfline {
1264 " Adds the given Filename mask to DCCDENY";
1265 " Must be sent through an U:Lined server.";
1266 " -";
1267 " Syntax: :server SVSFLINE + file :reason (Add the filename)";
1268 " :server SVSFLINE - file (Deletes the filename)";
1269 " :server SVSFLINE * (Wipes the DCCDENY list)";
1270};
1271
1272help Svsmotd {
1273 "Changes the Services Message Of The Day";
1274 "Must be sent through an U:Lined server.";
1275 "Syntax: SVSMOTD # :<text> (Adds to Services MOTD)";
1276 " SVSMOTD ! (Deletes the MOTD)";
1277 " SVSMOTD ! :<text> (Deletes and Adds text)";
1278 "Example: SVSMOTD # :Services MOTD";
1279};
1280
1281help Svsnline {
1282 " Adds a global realname ban.";
1283 " Must be sent through an U:Lined server.";
1284 " The reason must be a single parameter therefore";
1285 " spaces are indicated by _, Unreal will internally";
a314130c 1286 " translate these to spaces.";
6c167e35 1287 " -";
a314130c
BM
1288 " Syntax: SVSNLINE + <reason_for_ban> :<realname> (To add a ban)";
1289 " SVSNLINE - :<realname> (To remove a ban)";
1290 " SVSNLINE * (To clear all bans)";
cfa469a9 1291 " Example: SVSNLINE + sub7_drone :*sub7*";
6c167e35 1292};
1293
1294help Svslusers {
1295 " Changes the global and/or local maximum user count";
1296 " for a server. If -1 is specified for either of the";
1297 " values, the current value is kept.";
1298 " Must be sent through an U:Lined server.";
1299 " -";
1300 " Syntax: SVSLUSERS <server> <globalmax|-1> <localmax|-1>";
1301 " Example: SVSLUSERS irc.test.com -1 200";
1302};
1303
def64835
BM
1304help Svswatch {
1305 " Changes the WATCH list of a user.";
f3d578f2 1306 " Must be sent through an U:Lined server.";
def64835
BM
1307 " Syntax: SVSWATCH <nick> :<watch parameters>";
1308 " Example: SVSWATCH Blah :+Blih!*@* +Bluh!*@* +Bleh!*@*.com";
1309};
1310
1311help Svssilence {
1312 " Changes the SILENCE list of a user.";
f3d578f2 1313 " Must be sent through an U:Lined server.";
def64835
BM
1314 " In contrast to the SILENCE command, you can add/remove";
1315 " multiple entries in one line.";
1316 " Syntax: SVSSILENCE <nick> :<silence parameters>";
f3d578f2 1317 " Example: SVSSILENCE Blah :+*!*@*.com +*!*@*.bla.co.uk";
def64835 1318};
d2c6bb5a 1319
a607cc8b 1320help Svssno {
1321 " Changes the snomask of the User in question.";
1322 " Must be sent through an U:Lined server.";
1323 " -";
1324 " Syntax: SVSSNO <nickname> <snomasks>";
1325 " Example: SVSSNO joe +Gc";
1326};
1327
1328help Svs2sno {
f7bc069e 1329 " Changes the snomask of a nickname and displays";
a607cc8b 1330 " the change to the user.";
1331 " Must be sent through an U:Lined server.";
1332 " -";
1333 " Syntax: SVS2SNO <nickname> <snomasks>";
4faaf63e 1334 " Example: SVS2SNO joe +Gc";
a607cc8b 1335};
1336
20d84eda 1337help Svsnolag {
1338 " Enable 'no fake lag' for a user.";
1339 " Must be sent through an U:Lined server.";
1340 " -";
1341 " Syntax: SVSNOLAG [+|-] <nickname>";
1342 " Example: SVSNOLAG + joe";
1343};
1344
1345help Svs2nolag {
1346 " Enable 'no fake lag' for a user.";
1347 " Must be sent through an U:Lined server.";
1348 " -";
1349 " Syntax: SVS2NOLAG [+|-] <nickname>";
1350 " Example: SVS2NOLAG + joe";
1351};
a607cc8b 1352
d2c6bb5a
BM
1353help Spamfilter {
1354 " This command adds/removes global spam filters.";
1355 " Spamfilters can be used to get rid of spam, advertising, bots, etc.";
1356 " -";
648d7355
BM
1357 " Use: /spamfilter [add|del|remove|+|-] [type] [action] [tkltime] [reason] [regex]";
1358 " [type] specifies the target type, you can specify multiple targets:";
1359 " 'c' channel msg, 'p' private msg, 'n' private notice,";
fae77f21 1360 " 'N' channel notice, 'P' part msg, 'q' quit msg, 'd' dcc,";
1a655c11 1361 " 'a' away, 't' topic, 'u' user (nick!user@host:realname ban)";
648d7355
BM
1362 " [action] specifies the action to be taken (only 1 action can be specified):";
1363 " 'kill', 'tempshun' (only shun current session), 'shun',";
8ebf5b9a
BM
1364 " 'kline', 'gline', 'zline', 'gzline', 'block' (blocks the msg),";
1365 " 'dccblock' (unable to send any dccs), 'viruschan' (part all channels";
20d84eda 1366 " and join the virus help chan), 'warn' (warn for IRC Operators).";
648d7355
BM
1367 " [regex] this is the actual regex where we should block on";
1368 " [tkltime] the duration of the *LINEs placed by action (use '-' to use the default";
1369 " set::spamfilter::ban-time, this value is ignored for block/tempshun');";
1370 " [reason] the reason for the *LINE or blockmsg, CANNOT CONTAIN SPACES,";
1371 " '_' will be translated to spaces. Again, if you use '-' for this";
1372 " the default (set::spamfilter::ban-reason) is used.";
d2c6bb5a 1373 " - ";
648d7355
BM
1374 " A few examples (note they will probably linewrap!):";
1375 " /spamfilter add p block - - Come watch me on my webcam";
1376 " /spamfilter add p block - Possible_virus_detected,_join_#help Come watch me on my webcam";
1377 " /spamfilter add p tempshun - - You_are_infected me\.mpg";
1378 " /spamfilter add p gline - - Come watch me on my webcam";
1379 " /spamfilter add p gline 3h Please_go_to_www.viruscan.xx/nicepage/virus=blah Come watch me on my webcam";
1380 " /spamfilter add p kill - Please_go_to_www.viruscan.xx/nicepage/virus=blah Come watch me on my webcam";
1381 " /spamfilter del p block - - Come watch me on my webcam*";
1382 " /spamfilter add cN gzline 1d No_advertising_please come to irc\..+\..+";
d2c6bb5a 1383};
8ebf5b9a
BM
1384
1385help Tempshun {
1386 " Add/remove 'temporary shuns'.";
1387 " Temporary shuns are shuns added on a specified target for ";
1388 " _the current session only_, this means if the user reconnects";
1389 " the shun will be gone.";
1390 " -";
1391 " Syntax: TEMPSHUN [+|-]<nickname> [reason]";
1392 " Example: TEMPSHUN evilguy suspected infection";
1393 " TEMPSHUN -niceguy";
1394};
6ec3822c
BM
1395
1396help DccAllow {
1397 " For help on the DCCALLOW system, type '/DCCALLOW HELP'";
1398 /* It would be useless and bad to include it here since that
1399 * stuff quickly gets out-of-synch.
1400 */
1401};
de1fea75
BM
1402
1403help Addmotd {
1404 " Adds a line to the end of the MOTD ";
1405 " -";
1406 " Syntax: ADDMOTD <text>";
1407 " Example: ADDMOTD Play nice!";
1408};
1409
1410help Addomotd {
1411 " Adds a line to the end of the OPERMOTD ";
1412 " -";
1413 " Syntax: ADDOMOTD <text>";
1414 " Example: ADDOMOTD Abuse it and lose it!";
1415};