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