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