]> jfr.im git - irc/evilnet/x3.git/blame - src/opserv.help
this never ends...
[irc/evilnet/x3.git] / src / opserv.help
CommitLineData
d2dce5ac
AS
1"<INDEX>" ("=------------------ $b$O Help$b ------------------=",
2 " $O provides Oper Services for the Network. ",
3 " Please choose from the following categories: ",
4 " $bGOD$b Enabling channel override. ",
5 " $bPUNISH$b Commands to discipline users.",
6 " $bINFORMATION$b Get information about users. ",
7 " or $O, $C, and $N. ",
8 " $bTRACES$b Powerfull commands for ",
9 " viewing or acting on lists of",
10 " IRC objects. ",
11 " $bALERTS$b Automated responses. ",
12 " $bCHANNEL$b Channel commands. ",
13 " $bCLONES$b Manage trusts and limits. ",
14 " $bSETTINGS$b View and temporarily change ",
15 " config file settings. ",
16 " $bADMIN$b Misc Administrator Commands. ",
17 " $bOWNERONLY$b $O operator only commands. ",
18 "=---------------- End of Help ----------------="
19);
d76ed9a9
AS
20"COMMANDS" "${index}";
21
d2dce5ac
AS
22"PUNISH" ("=------------- $bUser Punishments$b --------------=",
23 " $bGLINE$b Global Ban a host.",
24 " $bUNGLINE$b Remove a GLINE.",
25 " $bBLOCK$b Gline by nickname.",
26 " $bTRACE GLINE$b Gline all hosts matching a search.",
27 " $bGTRACE$b Search the gline list.",
28 " $b$b",
29 " $bGAG$b Cause the services to ignore... ",
30 " $bUNGAG$b ...or unignore by mask.",
31 "=---------------- End of Help ----------------="
32 );
33
34"INFORMATION" ("=----------- $bInformation Gathering$b -----------=",
35 " $bACCESS$b Shows a users $O access level.",
36 " $bSTATS$b Show various lists and runtime info.",
37 " $bWHOIS$b Show details about a user by nick.",
38 " $bVERSION$b Show the $O version information.",
39 " $bLOG$b View $O logs.",
40 " $bTRACES$b Powerfull commands for viewing or acting on lists of IRC objects.",
41 "=--------------- End of Help ----------------="
42 );
43
44"TRACES" ("=------------------ $bTraces$b ------------------=",
45 " $bTRACE$b Search current users and optionally apply an action.",
46 " $bGTRACE$b Search current GLINEs and optionally remove them.",
47 " $bCSEARCH$b Search current channels.",
48 "=--------------- End of Help ----------------="
49 );
50
51"ALERTS" ("=------------------ $bAlerts$b ------------------=",
52 " $bADDALERT$b Make $O automatically do something",
53 " when users match a criteria.",
54 " $bDELALERT$b Remove an alert.",
55 " $bWARN$b Cause activity on a channel to warn",
56 " $b$b ircops.",
57 " $bUNWARN$b Remove a channel activity warning.",
b3076f16 58 " $bSTATS ALERT$b See a listing of alerts. ",
d2dce5ac
AS
59 "=--------------- End of Help ----------------="
60 );
61
62"CHANNEL" ("=------------- $bChannel Commands$b -------------=",
63 " $bOP$b Op someone.",
64 " $bDEOP$b Deop someone.",
65 " $bVOICE$b Voice someone.",
66 " $bDEVOICE$b Devoice someone.",
67 " $bKICK$b Kick someone.",
68 " $bBAN$b Ban someone.",
69 " $bKICKBAN$b Kickban someone.",
70 " $b$b",
71 " $bOPALL$b Op everyone in a channel.",
72 " $bDEOPALL$b Deop everyone in a channel.",
73 " $bVOICEALL$b Voice everyone in a channel.",
74 " $bDEVOICEALL$b Devoice everyone in a channel.",
75 " $bKICKALL$b Kick everyone from a channel.",
76 " $bKICKBANALL$b Kickban everyone from a channel.",
77 " $b$b",
78 " $bINVITE$b Invite someone to a channel.",
79 " $bINVITEME$b Invite yourself to a channel.",
80 " $bCLEARBANS$b Cear all bans from a channel.",
81 " $bCLEARMODES$b Clear all modes from a channel.",
82 "=--------------- End of Help ----------------="
83 );
84
85"CLONES" ("=-------------- $bClone handling$b --------------=",
86 " $bADDTRUST$b Add a clone limit exemption for a host.",
87 " $bDELTRUST$b Remove a clone exemption.",
88 " $bEDITTRUST$b Modify a clone exemption.",
89 " $bquery services/opserv/untrusted_max$b",
90 " View the clone kill limit",
91 "=--------------- End of Help ----------------="
92 );
93
94"SETTINGS" ("=----------------- $bSettings$b -----------------=",
95 " $bQUERY$b Show a runtime config setting.",
96 " $bSET$b $uTemporarily$u change a runtime config setting.",
97 "=--------------- End of Help ----------------="
98 );
99
100"ADMIN" ("=---------- $bAdministrative Commands$b ---------=",
101 " $bACCESS$b Modify someone's $O access level.",
102 " $bCOMMAND$b Show details of a command.",
103 " $bSHOWCOMMANDS$b List all commands and required access levels.",
104 " $b$b",
105 " $bBANEMAIL$b Ban an email address from being used by the email system.",
106 " $bUNBANEMAIL$b Remove an email ban.",
107 " $b$b",
108 " $bJOIN$b Make $O join a channel.",
109 " $bPART$b Make $O leave a channel.",
110 " $b$b",
111 " $bCLONE$b Create and manipulate a fake user.",
112 " $bCOLLIDE$b Create a clone, colliding an existing user.",
113 " $bRESERVE$b Permanently reserve a nick with a clone.",
114 " $bUNRESERVE$b Remove a perminant reserved clone.",
115 " $bJUPE$b Create dummy server.",
116 " $bUNJUPE$b Remove a dummy server.",
117 " $b$b",
118 " $bREFRESHG$b Refresh the Glines.",
119 " $bSETTIME$b Synchronize time across the network.",
120 " $bTIMECMD$b Time how long a command runs.",
121 "=--------------- End of Help ----------------="
122 );
123
124"OWNERONLY" ("=------------- $bOwner Only Stuff$b -------------=",
125 " $bWRITE$b Write out a database.",
126 " $bWRITEALL$b Write out ALL databases.",
127 " $bREOPEN$b Close and Re-Open the logs.",
128 " $bREADHELP$b Re-read a help file.",
129 " $bDUMPMESSAGES$b Writes messages to a .db file (for translators).",
130 " $b$b",
131 " $bREHASH$b Re-read the config files.",
ceafd592 132 " $bRESTART$b Quit and re-run X3.",
d2dce5ac
AS
133 " $bDIE$b Make the bot quit.",
134 " $bJUMP$b Change uplink servers.",
135 " $bRECONNECT$b Reconnect to this uplink server.",
136 " $bGSYNC$b Pull glines from the givin server into memory.",
137 " $b$b",
138 " $bMODCMD$b Change details of a command.",
139 " $bBIND$b Make a command alias.",
140 " $bUNBIND$b Remove a command alias.",
d2dce5ac
AS
141 " $bHELPFILES$b Change the helpfile priority order.",
142 " $b$b",
143 " $bSERVICE ADD$b Create a new service bot.",
144 " $bSERVICE REMOVE$b Remove a service bot.",
145 " $bSERVICE RENAME$b Rename a service bot.",
146 " $bSERVICE PRIVILEGED$b Sets if only opers can use the service.",
182dd032 147 " $bSERVICE TRIGGER$b Change the command character of a service.",
d2dce5ac
AS
148 " $b$b",
149 " $bADDBAD$b Add a word to the illegal channel word list.",
150 " $bDELBAD$b Remove a word from the illegal channel word list.",
151 " $bADDEXEMPT$b Make an exception to the illegal word list for a channel.",
152 " $bDELEXEMPT$b Remove an exception of the illegal word list.",
153 " $b$b",
154 " $bDUMP$b Drop safetychecked server protocol to the server. ",
155 " $bRAW$b Draw raw server protocol to the server. (DANGEROUS!)",
156 "=--------------- End of Help ----------------="
157 );
158
159
d76ed9a9 160"ACCESS" ("/msg $O ACCESS [nick|*account] [new-level]",
d2dce5ac
AS
161 "Displays the $O access level for the specified user or account. With no arguments, displays your own access level. With two arguments, sets the target's $O access level to the second argument (assuming you have sufficient access to do so).",
162 "Access level: $b${level/access}$b",
182dd032
AS
163 "$uSee Also:$u commands, modcmd"
164 );
d2dce5ac 165
d76ed9a9
AS
166"ADDALERT" ("/msg $O ADDALERT <name> <reaction> <criteria>",
167 "Adds the specified alert to the $b$O$b alert list.",
182dd032
AS
168 "Alerts watch for users matching a givin criteria and perform an action on them.",
169 " <name> - An alphanumeric word to identify this alert in the list",
170 " <reaction> - What to do if a user matches the criteria. See $bALERT REACTION$b.",
171 " <criteria> - What to look for. See $bTRACE CRITERIA$b.",
d2dce5ac
AS
172 "Access level: $b${level/addalert}$b",
173 "$uSee Also:$u delalert, alert reaction, trace criteria"
174 );
175
182dd032
AS
176"TIME NOTATION" ("=---------------- $bTime Notation$b ---------------=",
177 " Many commands require a duration perameter ",
178 " which all use the same syntax: ",
179 " 1s - 1 second ",
180 " 2m - 2 minutes ",
181 " 3h - 3 hours ",
182 " 4d - 4 days ",
183 " 5w - 5 weeks ",
184 " 6M - 6 months",
185 " 1y - 1 year",
186 " Times can be compounded such as: ",
187 " 1m40s - 1 minute and 40 seconds ",
188 " 5h20m30s - 5 hours 20 minutes and 30 seconds ",
189 "=-----------------------------------------------="
190 );
191
d76ed9a9 192"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
182dd032
AS
193 "Extends the clone kill limit for the specified <ip> to <count> for <duration>.",
194 "<duration> uses $btime notation$b",
d76ed9a9 195 "You may use 0 as the duration if you do not wish the trust to ever expire, and 0 as the count for unlimited connections.",
d2dce5ac 196 "Access level: $b${level/addtrust}$b",
182dd032 197 "$uSee Also:$u deltrust, stats trusted, time notation"
d2dce5ac
AS
198 );
199
d76ed9a9
AS
200"ALERT REACTION" ("$bALERT REACTION$b",
201 "Valid alert actions (to be taken when an alert is hit) are:",
202 "$bNOTICE$b: Send a notice to the $b$O$b alert channel",
203 "$bKILL$b: Disconnect the user",
204 "$bGLINE$b: Gline the user that tripped the alert",
182dd032
AS
205 "$uSee Also:$u addalert, delalert"
206 );
d2dce5ac 207
d76ed9a9
AS
208"DELALERT" ("/msg $O DELALERT <alert> [alert]...",
209 "Remove the specified alerts from the $b$O$b alert list.",
182dd032
AS
210 "Access level: $b${level/delalert}$b",
211 "$uSee Also:$u addalert, stats"
212 );
d2dce5ac 213
d76ed9a9
AS
214"DELTRUST" ("/msg $O DELTRUST <ip>",
215 "Deletes a trusted IP from $b$O's$b trusted hosts list. A trusted IP address is exempted from normal client limits. A list of currently trusted IPs is displayed by $bstats trusted$b.",
182dd032
AS
216 "Access level: $b${level/deltrust}$b",
217 "$uSee Also:$u addtrust, stats"
218 );
d2dce5ac 219
d76ed9a9
AS
220"INVITEME" ("/msg $O INVITEME [nick]",
221 "Invites the specified user (if omitted, you) to $O's debug channel.",
182dd032
AS
222 "This is currently pointless, since no output is sent to the debug channel.",
223 "Access level: $b${level/inviteme}$b",
224 "$uSee Also:$u invite, clearmodes, clearbans"
225 );
d2dce5ac 226
d76ed9a9 227"TRACE" ("/msg $O TRACE <action> <criteria> <value> [<criteria> <value>]...",
d2dce5ac
AS
228 "Searches through the current users for those matching the specified criteria, and applies the specified action to them. A detailed list of actions can be found in $bhelp trace action$b and a list of criteria in $bhelp trace criteria$b.",
229 "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, GAG, DOMAINS",
230 "Quick Ref CRITERIA: MASK, NICK, IDENT, HOST, INFO, SERVER, IP, ACCOUNT, AUTHED, CHANNEL, NUMCHANNELS, LIMIT, NICKAGE, ACCESS, REASON, DEPTH, DURATION, CLONES, INFO_SPACE, ABUSE OPERS, LOG",
182dd032
AS
231 "Access level: $b${level/trace}$b",
232 "$uSee Also:$u trace action, trace criteria"
233 );
d2dce5ac 234
d76ed9a9
AS
235"TRACE ACTION" ("$bTRACE ACTION$b",
236 "Options for action in $btrace$b are:",
237 "$bPRINT$b: Display the hostmask to you.",
238 "$bCOUNT$b: Count all matching users.",
239 "$bKILL$b: Kill matching clients.",
240 "$bGLINE$b: Issue a gline for the client's host (by default, 1 hour long).",
241 "$bGAG$b: Gag all matching users (by default, does not expire).",
242 "$bDOMAINS$b: Display counts of users in each domain (length specified by DEPTH criteria.",
182dd032
AS
243 "Note: By default, IRC operators are not affected by the KILL, GLINE or GAG actions. You can override this by specifying the $bABUSE OPERS$b criteria for a trace. Even if you do specify $bABUSE OPERS$b, it will not affect opers at your access level or above.",
244 "$uSee Also:$u trace criteria, trace"
245 );
d2dce5ac 246
d76ed9a9
AS
247"TRACE CRITERIA" ("$bTRACE CRITERIA$b",
248 "Criteria and values for $btrace$b (a search with $btrace$b must match all specified items):",
249 "$bMASK$b nick!user@host Specifies a full hostmask to search for.",
250 "$bNICK$b nick Specifies a nick to search for.",
251 "$bIDENT$b ident Specifies an ident to search for.",
252 "$bHOST$b host Specifies a hostname to search for.",
253 "$bINFO$b infoline Specifies a user's info to search for.",
254 "$bSERVER$b server Specifies a server to search for.",
255 "$bIP$b 127.0.0.1 Specifies an IP to search for (independent of hostname).",
256 "$bACCOUNT$b account Specifies an account to search for.",
257 "$bAUTHED$b yes/no Specifies if matching users must be authenticated with $N or not",
258 "$bCHANNEL$b #target Specifies a channel the client must be in.",
259 "$bNUMCHANNELS$b 5 Specifies a number of channels the client must be in.",
260 "$bLIMIT$b 50 Limits the number of responses to a certain number.",
261 "$bNICKAGE$b cmp Client has had nick this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
262 "$bACCESS$b cmp Access constraints (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
263 "$bREASON$b reason Reason for kill or gline (must be listed last).",
264 "$bDEPTH$b depth How many domain-name parts to use for $bDOMAINS$b action.",
265 "$bDURATION$b duration How long to apply a G-line or gag.",
266 "$bCLONES$b min Ignore clients from hosts with fewer than this many connections.",
267 "$bINFO_SPACE$b yes/no Clients match only if their info starts with a space (' ') character.",
268 "$bABUSE OPERS$b Force adverse actions to affect opers as well.",
269 "$bLOG$b Record matching users in $O's log file (in addition to acting).",
182dd032
AS
270 "Additionally, the $bCHANNEL$b target may be prefixed with @ to select channel operators, + to select voiced users (will not select chanops unless @ is also used), or - to select non-voiced non-chanop users. For example, CHANNEL #foo will select all users in #foo; CHANNEL +#foo will select only users voiced in #foo; CHANNEL @+#foo will select ops and voiced users in #foo; etc.",
271 "$uSee Also:$u trace action, trace"
272 );
d2dce5ac 273
d76ed9a9 274"WHOIS" ("/msg $O WHOIS <nick>",
182dd032
AS
275 "Displays detailed information for the named user.",
276 "Access level: $b${level/whois}$b",
277 );
d2dce5ac 278
d76ed9a9
AS
279"CHANINFO" ("/msg $O CHANINFO <#channel> [users]",
280 "Displays very detailed information on the specified channel. If the channel is omitted, then $bchaninfo$b will be done on the channel where the command was given. You must give a second parameter ($busers$b) to list users in the channel.",
182dd032
AS
281 "Access level: $b${level/chaninfo}$b",
282 "$uSee Also:$u whois"
283 );
d2dce5ac 284
d76ed9a9
AS
285"CSEARCH" ("/msg $O CSEARCH <action> <criteria> <value> [<criteria> <value>]...",
286 "Searches through the network's channels for those matching the specified criteria, and applies the specified action to them. A list of actions can be found under $bhelp csearch action$b and a list of criteria in $bhelp csearch criteria$b.",
182dd032
AS
287 "Access level: $b${level/csearch}$b",
288 "$uSee Also:$u csearch action, csearch criteria"
289 );
d2dce5ac 290
d76ed9a9
AS
291"CSEARCH ACTION" ("$bCSEARCH ACTION$b",
292 "Options for action in $bcsearch$b are:",
293 "$bPRINT$b: Display the channel and user count.",
182dd032
AS
294 "$bCOUNT$b: Count all matching channels."
295 );
d2dce5ac 296
d76ed9a9
AS
297"CSEARCH CRITERIA" ("$bCSEARCH CRITERIA$b",
298 "Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
299 "$bNAME$b name Specifies a name to search for.",
300 "$bTOPIC$b topic Specifies a topic to search for.",
301 "$bUSERS$b cmp User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
302 "$bTIMESTAMP$b cmp Timestamp constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu; supports interval notation)",
182dd032
AS
303 "$bLIMIT$b 50 Limits the number of responses to a certain number."
304 );
d2dce5ac 305
d76ed9a9
AS
306"JOIN" ("/msg $O JOIN <#channel> ",
307 "Makes $b$O$b join the specified channel.",
182dd032
AS
308 "Access level: $b${level/join}$b",
309 "$uSee Also:$u part"
310 );
d2dce5ac 311
d76ed9a9
AS
312"PART" ("/msg $O PART <#channel> ",
313 "Makes $b$O$b leave the specified channel.",
182dd032
AS
314 "Access level: $b${level/part}$b",
315 "$uSee Also:$u join"
316 );
d2dce5ac 317
d76ed9a9
AS
318"ADDBAD" ("/msg $O ADDBAD <word>",
319 "Adds a bad word to $b$O's$b bad word list. Bad words make any channel that has a bad word anywhere in a channel's name illegal. A list of current bad words can be displayed by $bstats bad$b.",
182dd032
AS
320 "Access level: $b${level/addbad}$b",
321 "$uSee Also:$u addexempt, delbad, stats"
322 );
d2dce5ac 323
d76ed9a9
AS
324"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
325 "Adds a channel to $O's \"exempt\" list. These channels (and only these channels) are never considered to contain prohibited words. Note that you $bmust$b specify the whole channel name, and may not use wildcards.",
326 "For example, if you have added $ufree$u to the bad-word list, you could add $u#FreeBSD$u to the exempt list, and anyone could join #FreeBSD. Users joining #FreeBSDISOz would be kickbanned by $O.",
327 "The current exempt list is displayed with the current bad-words in $bstats bad$b.",
182dd032
AS
328 "Access level: $b${level/addexempt}$b",
329 "$uSee Also:$u addbad, delexempt, stats"
330 );
d2dce5ac 331
d76ed9a9
AS
332"DELBAD" ("/msg $O DELBAD <keyword>",
333 "Deletes a bad word from $b$O's$b bad word list. Bad words make any channel that has a bad word anywhere in a channel's name illegal. A list of current bad words can be displayed by $bstats bad$b.",
182dd032
AS
334 "Access level: $b${level/delbad}$b",
335 "$uSee Also:$u addbad, delexempt, stats"
336 );
d2dce5ac 337
d76ed9a9
AS
338"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
339 "Removes a channel from $O's bad-word-exempt channel list.",
182dd032
AS
340 "Access level: $b${level/delexempt}$b",
341 "$uSee Also:$u addexempt, delbad, stats"
342 );
d2dce5ac 343
d76ed9a9
AS
344"UNWARN" ("/msg $O UNWARN <#channel>",
345 "Deletes the activity warning for a channel.",
182dd032
AS
346 "Access level: $b${level/unwarn}$b",
347 "$uSee Also:$u warn, stats warn"
348 );
d2dce5ac 349
d76ed9a9
AS
350"WARN" ("/msg $O WARN <#channel> [reason]",
351 "Adds an activity warning for the channel.",
182dd032
AS
352 "Access level: $b${level/warn}$b",
353 "$uSee Also:$u unwarn, stats warn"
354 );
d2dce5ac 355
d76ed9a9
AS
356"BAN" ("/msg $O BAN <#channel> <nick|hostmask>",
357 "Bans the specified hostmask from the specified channel.",
358 "If a nick is used instead of hostmask, the hostmask is generated based on the nickname.",
359 "If the channel is omitted, the $bban$b will be done in the channel where the command was given.",
182dd032
AS
360 "Access level: $b${level/ban}$b",
361 "$uSee Also:$u kickban, kickbanall, unban"
362 );
d2dce5ac 363
d76ed9a9
AS
364"UNBAN" ("/msg $O UNBAN <#channel> <hostmask>",
365 "Unbans the specified hostmask from the specified channel.",
366 "If the channel is omitted, the $bunban$b will be done in the channel where the command was given.",
182dd032
AS
367 "Access level: $b${level/unban}$b",
368 "$uSee Also:$u kickban, kickbanall, ban"
369 );
d2dce5ac 370
d76ed9a9
AS
371"CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
372 "Clears all bans in the specified channel.",
373 "If the channel is omitted, then $bclearbans$b will be done in the channel where the command was given.",
182dd032
AS
374 "Access level: $b${level/clearbans}$b",
375 "$uSee Also:$u ban, unban"
376 );
d2dce5ac 377
d76ed9a9
AS
378"CLEARMODES" ("/msg $O CLEARMODES <#channel> ",
379 "Clears the specified channel of all modes.",
380 "If the channel is omitted, then $bclearmodes$b will be done in the channel where the command was given.",
182dd032
AS
381 "Access level: $b${level/clearmodes}$b",
382 "$uSee Also:$u mode"
383 );
d2dce5ac 384
d76ed9a9
AS
385"DEOP" ("/msg $O DEOP <#channel> <nick> [nick]...",
386 "Deops the specified user from the specified channel.",
387 "If the channel is omitted, then $bdeop$b will be done in the channel where the command was given.",
182dd032
AS
388 "Access level: $b${level/deop}$b",
389 "$uSee Also:$u deopall, devoiceall, op, opall"
390 );
d2dce5ac 391
d76ed9a9
AS
392"DEOPALL" ("/msg $O DEOPALL <#channel>",
393 "Deops all members of the specified channel.",
394 "If the channel is omitted, then $bdeopall$b will be done in the channel where the command was given.",
182dd032
AS
395 "Access level: $b${level/deopall}$b",
396 "$uSee Also:$u deop, devoiceall, op, opall"
397 );
d2dce5ac 398
d76ed9a9
AS
399"DEVOICEALL" ("/msg $O DEVOICEALL <#channel>",
400 "Devoice all members of the specified channel who do not have channel ops.",
401 "If the channel is omitted, then $bdevoiceall$b will be done in the channel where the command was given.",
182dd032
AS
402 "Access level: $b${level/devoiceall}$b",
403 "$uSee Also:$u deop, deopall, op, opall"
404 );
d2dce5ac 405
d76ed9a9
AS
406"KICK" ("/msg $O KICK <#channel> <nick> [reason]",
407 "Kicks the specified user from the specified channel.",
408 "If the channel is omitted, then $bkick$b will be done in the channel where the command was given.",
182dd032
AS
409 "Access level: $b${level/kick}$b",
410 "$uSee Also:$u ban, kickall, kickban, kickbanall"
411 );
d2dce5ac 412
d76ed9a9
AS
413"KICKALL" ("/msg $O KICKALL <#channel> [reason]",
414 "Kicks all users in the specified channel except for the user issuing the command.",
415 "If the channel is omitted, then $bkickall$b will be done in the channel where the command was given.",
182dd032
AS
416 "Access level: $b${level/kickall}$b",
417 "$uSee Also:$u ban, kick, kickbanall"
418 );
d2dce5ac 419
d76ed9a9
AS
420"KICKBAN" ("/msg $O KICKBAN <#channel> <nick> [reason]",
421 "Kicks and bans the specified user. $b$O$b determines the hostmask to ban from the nick specified.",
422 "If the channel is omitted, then $bkickban$b will be done in the channel where the command was given.",
182dd032
AS
423 "Access level: $b${level/kickban}$b",
424 "$uSee Also:$u ban, kickall, kickbanall"
425 );
d2dce5ac 426
d76ed9a9
AS
427"KICKBANALL" ("/msg $O KICKBANALL <#channel> [reason]",
428 "Kick and bans all members of the specified channel except for the user issuing the command.",
429 "If the channel is omitted, then $bkickbanall$b will be done in the channel where the command was given.",
182dd032
AS
430 "Access level: $b${level/kickbanall}$b",
431 "$uSee Also:$u ban, kick, kickban"
432 );
d2dce5ac 433
d76ed9a9
AS
434"MODE" ("/msg $O MODE <#channel> <+/- mode>",
435 "Sets the specified modes (but cannot include voice, ban or op changes) on a channel.",
436 "If the channel is omitted, then $bmode$b will be done in the channel where the command was given.",
182dd032
AS
437 "Access level: $b${level/mode}$b",
438 "$uSee Also:$u ban, deop, kickban, op"
439 );
d2dce5ac 440
d76ed9a9
AS
441"OP" ("/msg $O OP <#channel> <nick> [nick]...",
442 "Ops specified nicknames the specified channel.",
443 "If the channel is omitted, then $bop$b will be done in the channel where the command was given.",
182dd032
AS
444 "Access level: $b${level/op}$b",
445 "$uSee Also:$u deop, deopall, opall"
446 );
d2dce5ac 447
d76ed9a9
AS
448"OPALL" ("/msg $O OPALL <#channel>",
449 "Ops all members of the specified channel.",
450 "If the channel is omitted, then $bopall$b will be done in the channel where the command was given.",
182dd032
AS
451 "Access level: $b${level/opall}$b",
452 "$uSee Also:$u deopall"
453 );
d2dce5ac 454
d76ed9a9
AS
455"VOICEALL" ("/msg $O VOICEALL <#channel>",
456 "Voices all members of the specified channel who do not have channel ops.",
457 "If the channel is omitted, then $bvoiceall$b will be done in the channel where the command was given.",
182dd032
AS
458 "Access level: $b${level/voiceall}$b",
459 "$uSee Also:$u opall, deopall, devoiceall"
460 );
d76ed9a9
AS
461
462"GLINES" ("$bGLINE COMMANDS$b",
463 "Searches for, issues, and removes G-lines (network-global K-lines).",
464 " BLOCK [${level/block}]",
465 " GLINE [${level/gline}]",
466 " GTRACE [${level/gtrace}]",
467 " GSYNC [${level/gsync}]",
468 " REFRESHG [${level/refreshg}]",
182dd032
AS
469 " UNGLINE [${level/ungline}]"
470 );
d2dce5ac 471
d76ed9a9
AS
472"BLOCK" ("/msg $O BLOCK <nick> [reason]",
473 "GLINES the host of the specified nick for one hour If no reason is given, use a default reason.",
182dd032
AS
474 "Access level: $b${level/block}$b",
475 "$uSee Also:$u gline, ungline"
476 );
d2dce5ac 477
d76ed9a9
AS
478"GLINE" ("/msg $O GLINE <user@host> <duration> <reason>",
479 "Issues a GLINE (network ban) on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
182dd032
AS
480 "Access level: $b${level/gline}$b",
481 "$uSee Also:$u trace, ungline"
482 );
d2dce5ac 483
d76ed9a9
AS
484"GTRACE" ("/msg $O GTRACE <action> <criteria> [<criteria> <value>]...",
485 "Searches through the glines, much like $bTRACE$b does for users.",
182dd032
AS
486 "Access level: $b${level/gtrace}$b",
487 "$uSee Also:$u trace, gtrace action, gtrace criteria"
488 );
d2dce5ac 489
d76ed9a9
AS
490"GTRACE ACTION" ("$bGTRACE ACTION$b",
491 "Options for the action in $bgtrace$b are:",
492 "$bPRINT$b: Display the glines (mask, issuer, expiration time, reason)",
493 "$bCOUNT$b: Count the number of matching glines",
182dd032
AS
494 "$bUNGLINE$b: Remove matching glines",
495 "$uSee Also:$u gtrace criteria, gtrace"
496 );
d2dce5ac 497
d76ed9a9
AS
498"GTRACE CRITERIA" ("$bGTRACE CRITERIA$b",
499 "Criteria and values for $bgtrace$b (a search with $bgtrace$b must match all the criteria you give):",
500 "$bMASK SUPERSET$b user@host G-line matches if it applies to someone with this hostmask.",
501 "$bMASK SUBSET$b user@host G-line matches if this hostmask \"covers\" the G-line target.",
502 "$bMASK EXACT$b user@host G-line matches only if the target is exactly this.",
503 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
504 "$bLIMIT$b count Limits the number of matching glines.",
505 "$bREASON$b reason Looks for glines with the given reason.",
506 "$bISSUER$b account Looks for glines issued by the given account.",
182dd032
AS
507 "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.",
508 "$uSee Also:$u gtrace action, gtrace"
509 );
d2dce5ac 510
d76ed9a9 511"GSYNC" ("/msg $O GSYNC [server]",
ceafd592 512 "Requests a list of GLINES from its uplink or the specified server. This can be used in the event X3 is down for period and becomes desynced.",
182dd032
AS
513 "Access level: $b${level/gsync}$b",
514 "$uSee Also:$u refreshg, gline, ungline"
515 );
d2dce5ac 516
d76ed9a9
AS
517"REFRESHG" ("/msg $O REFRESHG [server]",
518 "Re-issues all GLINES in $b$O's$b database. Usually used for newly joining or desynched servers. If a server mask is specified, the GLINES are only sent to server(s) with matching names.",
182dd032
AS
519 "Access level: $b${level/refreshg}$b",
520 "$uSee Also:$u gline, ungline, gsync"
521 );
d2dce5ac 522
d76ed9a9
AS
523"UNGLINE" ("/msg $O UNGLINE <user@host>",
524 "Removes a gline from the network before it expires.",
182dd032
AS
525 "Access level: $b${level/ungline}$b",
526 "$uSee Also:$u gline"
527 );
d2dce5ac 528
d76ed9a9
AS
529"CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
530 "Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
531 "$bADD$b: Adds a new clone. Arguments: <nickname> <user@host> <info>",
532 "$bREMOVE$b: Removes a clone. Arguments: <nickname>",
533 "$bJOIN$b: Joins a clone to a channel. Arguments: <nickname> <channel>",
534 "$bPART$b: Parts a clone from a channel. Arguments: <nickname> <channel>",
535 "$bOP$b: Ops a clone in a channel. Arguments: <nickname> <channel>",
182dd032
AS
536 "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>",
537 "Access level: $b${level/clone}$b",
538 "$uSee Also:$u collide, reserve, jupe"
539 );
d2dce5ac 540
d76ed9a9
AS
541"COLLIDE" ("/msg $O COLLIDE <nick> <ident> <host> <description>",
542 "Creates a clone with the specified properties, colliding any existing user with the same nick.",
182dd032
AS
543 "Access level: $b${level/collide}$b",
544 "$uSee Also:$u clone, reserve, jupe"
545 );
d2dce5ac 546
d76ed9a9 547"JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
ceafd592 548 "Causes X3 to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
182dd032
AS
549 "Access level: $b${level/jupe}$b",
550 "$uSee Also:$u unjupe, clone, reserve"
551 );
d2dce5ac 552
d76ed9a9 553"RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
ceafd592 554 "Used to ban, protect, or jupe a given nick. Unlike $bclone$b and $bcollide$b, reserved nicks are saved across restarts of X3.",
182dd032
AS
555 "Access level: $b${level/reserve}$b",
556 "$uSee Also:$u unreserve, clone, jupe"
557 );
d2dce5ac 558
d76ed9a9 559"UNJUPE" ("/msg $O UNJUPE <srvname>",
ceafd592 560 "Causes X3 to unjupe a jupe server.",
182dd032
AS
561 "Access level: $b${level/unjupe}$b",
562 "$uSee Also:$u jupe, unreserve, clone"
563 );
d2dce5ac 564
d76ed9a9
AS
565"UNRESERVE" ("/msg $O UNRESERVE <nick>",
566 "Removes a nick from $b$O's$b reserve list.",
182dd032
AS
567 "Access level: $b${level/unreserve}$b",
568 "$uSee Also:$u reserve, clone, unjupe"
569 );
d76ed9a9 570
d76ed9a9
AS
571"LOG" ("/msg $O LOG <criteria> <value> [<criteria> <value>]...",
572 "Searches services logs based on critera specified and displays the results.",
573 "Criteria and associated values (a search match all specified items):",
574 "$bBOT$b - A service bot's name (for example, $O).",
575 "$bCHANNEL$b - The channel where a command was issued (accepts wildcards).",
576 "$bNICK$b - The nickname issuing the command (accepts wildcards).",
577 "$bACCOUNT$b - The account of the user who issued the command (accepts wildcards).",
578 "$bHOSTMASK$b - The ident@host of the user who issued the command (accepts wildcards).",
579 "$bAGE$b - Age of commands to find (for example, 1m or >3m).",
580 "$bLIMIT$b - Maximum number of results to show.",
581 "$bLEVEL$b - Comma-separated list of COMMAND, OVERRIDE, STAFF, to return only those commands.",
582 "$bTYPE$b - Name of module that generated log (see $bSTATS MODULES$b).",
182dd032
AS
583 "By default, all levels of audit log entries are returned. You may exclude levels from the results by using the level criteria and the '-' character in front of the level name.",
584 "Access level: $b${level/log}$b",
585 "$uSee Also:$u reopen"
586 );
d2dce5ac 587
d76ed9a9
AS
588"REOPEN" ("/msg $O REOPEN",
589 "Close and re-open all the log files.",
182dd032
AS
590 "$uSee Also:$u log, rehash, write, writeall, readhelp"
591 );
d2dce5ac 592
d76ed9a9 593"DIE" ("/msg $O DIE <reason>",
ceafd592 594 "SQUIT X3 with the given reason and shuts it down.",
182dd032
AS
595 "Access level: $b${level/die}$b",
596 "$uSee Also:$u restart, reconnect, jump"
597 );
598
d76ed9a9 599"JUMP" ("/msg $O JUMP <uplink>",
ceafd592 600 "Causes X3 to connect to the specified uplink.",
182dd032
AS
601 "Access level: $b${level/jump}$b",
602 "$uSee Also:$u reconnect, restart, die"
603 );
d2dce5ac 604
d76ed9a9 605"RECONNECT" ("/msg $O RECONNECT ",
ceafd592 606 "Causes X3 to reconnect to its current uplink.",
182dd032
AS
607 "Access level: $b${level/reconnect}$b",
608 "$uSee Also:$u jump, rehash, restart, die"
609 );
d2dce5ac 610
d76ed9a9 611"REHASH" ("/msg $O REHASH",
ceafd592 612 "Causes X3 to re-read its configuration file and update its state as much as possible.",
182dd032
AS
613 "Access level: $b${level/rehash}$b",
614 "$uSee Also:$u die, reconnect, jump, restart"
615 );
d2dce5ac 616
d76ed9a9 617"RESTART" ("/msg $O RESTART <reason>",
ceafd592 618 "Causes X3 to SQUIT with the specified reason and restart.",
182dd032
AS
619 "Access level: $b${level/restart}$b",
620 "$uSee Also:$u reconnect, rehash, die"
621 );
d2dce5ac 622
d76ed9a9
AS
623"GAG" ("/msg $O GAG <mask> <duration> <reason>",
624 "Sets a complete services-wide ignore on all users matching the provided mask. All services will completely ignore all private messages or notices from gagged users, who are only notified when a gag goes into effect, or they sign onto the network. Gags have no effect on opers, and as a safety feature, only affect the first 250 matching users. The gag will automatically expire after $b<duration>$b (or last forever if that is zero).",
182dd032
AS
625 "Access level: $b${level/gag}$b",
626 "$uSee Also:$u ungag, trace"
627 );
d2dce5ac 628
d76ed9a9
AS
629"HELPSERV" ("/msg $O HELPSERV <command>",
630 "Sends a command to the HelpServ system. It is used for all \"override\" commands, as well as registration and unregistration.",
182dd032
AS
631 "$uSee also:$u /msg $O HELPSERV HELP"
632 );
d2dce5ac 633
d76ed9a9
AS
634"QUERY" ("/msg $O QUERY <option>",
635 "Displays the value of the given configuration key. If the key is a composite entry, show the subkeys inside it.",
182dd032
AS
636 "Access level: $b${level/query}$b",
637 "$uSee Also:$u set, rehash"
638 );
d2dce5ac 639
d76ed9a9
AS
640"SET" ("/msg $O SET <option> <value>",
641 "Modifies the internal configuration database. Currently, only keys that have been previously set may be modified.",
182dd032
AS
642 "Access level: $b${level/set}$b",
643 "$uSee Also:$u query, rehash"
644 );
d2dce5ac 645
d76ed9a9
AS
646"UNGAG" ("/msg $O UNGAG <hostmask>",
647 "Ungags a gaged hostmask and displays how many users were affected by $bungag$b. You can get a list of gaged hostmasks from $bgags$b.",
182dd032
AS
648 "Access level: $b${level/ungag}$b",
649 "$uSee Also:$u gag, stats gags"
650 );
d2dce5ac 651
d76ed9a9
AS
652"DUMP" ("/msg $O DUMP <raw line>",
653 "Dumps a raw server message into the stream. Unlike $braw$b, $bdump$b checks line syntax before sending it, making it much safer to use then $braw$b. If $bdump$b detects a syntax error in the line, it is not sent. It is $bHIGHLY$b recommended that you use $bdump$b instead of $braw$b.",
182dd032
AS
654 "Access level: $b${level/dump}$b",
655 "$uSee Also:$u raw"
656 );
d2dce5ac 657
d76ed9a9
AS
658"RAW" ("/msg $O RAW <raw line>",
659 "Dumps a raw server message into the stream. Unlike $bdump$b, $braw$b does $bNOT$b check line syntax before sending it, making $braw$b dangerous. It will however, after the line is sent, warn of a parse error if there is a problem with the line. It is $bHIGHLY$b recommended that $bdump$b be used instead of $braw$b because it is much safer.",
182dd032
AS
660 "Access level: $b${level/raw}$b",
661 "$uSee Also:$u dump"
662 );
d2dce5ac 663
d76ed9a9 664"SETTIME" ("/msg $O SETTIME [servermask] [resync]",
ceafd592 665 "Sets the time on the named server(s) to match the time known to X3.",
d76ed9a9 666 "For example, using $b*$b as the mask sets the time on all servers; using a server's full name sets the time only on that one.",
ceafd592 667 "If the RESYNC argument is provided, sets the time to what X3 believes the local time is, rather than what it believes the network time is.",
182dd032
AS
668 "Access level: $b${level/settime}$b",
669 "$uSee Also:$u timecmd"
670 );
d2dce5ac 671
d76ed9a9
AS
672"STATS" ("/msg $O STATS <subject>",
673 "Displays statistics about a specified subject. Subjects include:",
674 "$bALERTS$b: The list of current \"alerts\".",
675 "$bBAD$b: Current list of bad words and exempted channels.",
676 "$bGAGS$b: The list of current gags.",
677 "$bGLINES$b: Reports the current number of glines.",
678 "$bLINKS$b: Information about the link to the network.",
679 "$bMAX$b: The max clients seen on the network.",
680 "$bNETWORK$b: Displays network information such as total users and how many users are on each server.",
681 "$bNETWORK2$b: Additional information about the network, such as numerics and linked times.",
682 "$bOPERS$b: A list of users that are currently +o.",
ceafd592 683 "$bPROXYCHECK$b: Information about proxy checking in X3.",
d76ed9a9
AS
684 "$bRESERVED$b: The list of currently reserved nicks.",
685 "$bTIMEQ$b: The number of events in the timeq, and how long until the next one.",
686 "$bTRUSTED$b: The list of currently trusted IPs.",
ceafd592 687 "$bUPTIME$b: X3 uptime, lines processed, and CPU time.",
d76ed9a9
AS
688 "$bWARN$b: The list of channels with activity warnings.",
689 "$bMODULES$b: Shows loaded modules that implement commands.",
182dd032
AS
690 "$bSERVICES$b: Shows active service bots.",
691 "Access level: $b${level/stats}$b",
692 );
d76ed9a9
AS
693
694"INDEX" "${index}";
d2dce5ac 695