]> jfr.im git - irc/evilnet/x3.git/blame - src/opserv.help
oops, broke unsetting the title. fix here
[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. ",
ec311f39 12 " $bTRACKING$b Tracking commands. (if enabled)",
d2dce5ac
AS
13 " $bCHANNEL$b Channel commands. ",
14 " $bCLONES$b Manage trusts and limits. ",
47956fc5 15 " $bROUTING$b Manage the Auto Routing System.",
d2dce5ac
AS
16 " $bSETTINGS$b View and temporarily change ",
17 " config file settings. ",
18 " $bADMIN$b Misc Administrator Commands. ",
b1bf690d 19 " $bOWNERONLY$b $O operator only commands. "
d2dce5ac 20);
a8370a20
AS
21"COMMANDS" ("The following commands are available in $O:",
22 "${index}",
23 "$uSee Also$u: modcmd, access, command");
24"INDEX" ("The following commands are available in $O:",
25 "${index}",
26 "$uSee Also$u: modcmd, access, command");
d76ed9a9 27
b1bf690d 28"PUNISH" (
d2dce5ac
AS
29 " $bGLINE$b Global Ban a host.",
30 " $bUNGLINE$b Remove a GLINE.",
31 " $bBLOCK$b Gline by nickname.",
32 " $bTRACE GLINE$b Gline all hosts matching a search.",
33 " $bGTRACE$b Search the gline list.",
34 " $b$b",
d914d1cb 35 " $bSHUN$b Global Shun a host.",
36 " $bUNSHUN$b Remove a SHUN.",
37 " $bSBLOCK$b Shun by nickname.",
38 " $bTRACE SHUN$b Shun all hosts matching a search.",
39 " $bSTRACE$b Search the shun list.",
40 " $b$b",
d2dce5ac 41 " $bGAG$b Cause the services to ignore... ",
b1bf690d 42 " $bUNGAG$b ...or unignore by mask."
d2dce5ac
AS
43 );
44
b1bf690d 45"INFORMATION" (
d2dce5ac
AS
46 " $bACCESS$b Shows a users $O access level.",
47 " $bSTATS$b Show various lists and runtime info.",
48 " $bWHOIS$b Show details about a user by nick.",
49 " $bVERSION$b Show the $O version information.",
50 " $bLOG$b View $O logs.",
b1bf690d 51 " $bTRACES$b Powerfull commands for viewing or acting on lists of IRC objects."
d2dce5ac
AS
52 );
53
b1bf690d 54"TRACES" (
d2dce5ac
AS
55 " $bTRACE$b Search current users and optionally apply an action.",
56 " $bGTRACE$b Search current GLINEs and optionally remove them.",
d914d1cb 57 " $bSTRACE$b Search current SHUNs and optionally remove them.",
b1bf690d 58 " $bCSEARCH$b Search current channels."
d2dce5ac
AS
59 );
60
b1bf690d 61"ALERTS" (
d2dce5ac
AS
62 " $bADDALERT$b Make $O automatically do something",
63 " when users match a criteria.",
64 " $bDELALERT$b Remove an alert.",
b1bf690d 65 " $bSTATS ALERT$b See a listing of alerts. "
d2dce5ac
AS
66 );
67
ec311f39 68"TRACKING" (
69 " These commands only work if the tracking module has been compiled in",
70 " $b$b",
71 " $bTRACK$b Display and set tracking options.",
72 " $bADDTRACK$b Adds a nick to the tracking list.",
73 " $bDELTRACK$b Deletes an active track.",
74 " $bLISTTRACK$b Lists all active tracks.",
75 );
47956fc5
AS
76"ROUTING" (
77 " The Auto Routing System: ",
78 " $b$b",
79 " $bSTATS ROUTING$b Shows everything about the auto routing configuration.",
80 " $bROUTING ADDPLAN$b Creates a new routing plan. Routing plans are a collection of server linking information that $O uses to decide how to route.",
81 " $bROUTING DELPLAN$b Deletes a routing plan (and all its servers).",
82 " $bROUTING ADDSERVER$b Adds server linking information to a plan.",
83 " $bROUTING DELSERVER$b Deletes a server from a routing plan.",
84 " $bROUTING SET$b Show and change routing settings. ",
85 " $bROUTING MAP$b Show what the active routing plan says the network should look like.",
86 " $bREROUTE$b Connect servers to the network, optionally squiting them first to change the routing.",
87 " $b$b ",
88 " Start by creating a routing plan, and then adding servers to it, with their listning port, uplink, and a backup uplink. You can view it in $bSTATS ROUTING$b. Take care not to create loops, and that you make everything connected. Then set your new plan ACTIVE using $bROUTING SET$b. $O does the rest! See help topic $bROUTING EXAMPLE$b for a working example."
89 );
ec311f39 90
b1bf690d 91"CHANNEL" (
d2dce5ac
AS
92 " $bOP$b Op someone.",
93 " $bDEOP$b Deop someone.",
82794e1b 94 " $bHOP$b Half Op someone.",
95 " $bDEHOP$b DeHalfop someone.",
d2dce5ac
AS
96 " $bVOICE$b Voice someone.",
97 " $bDEVOICE$b Devoice someone.",
98 " $bKICK$b Kick someone.",
99 " $bBAN$b Ban someone.",
100 " $bKICKBAN$b Kickban someone.",
101 " $b$b",
102 " $bOPALL$b Op everyone in a channel.",
103 " $bDEOPALL$b Deop everyone in a channel.",
82794e1b 104 " $bHOPALL$b Half Op everyone in a channel.",
105 " $bDEHOPALL$b Dehalfop everyone in a channel.",
d2dce5ac
AS
106 " $bVOICEALL$b Voice everyone in a channel.",
107 " $bDEVOICEALL$b Devoice everyone in a channel.",
108 " $bKICKALL$b Kick everyone from a channel.",
109 " $bKICKBANALL$b Kickban everyone from a channel.",
110 " $b$b",
111 " $bINVITE$b Invite someone to a channel.",
112 " $bINVITEME$b Invite yourself to a channel.",
113 " $bCLEARBANS$b Cear all bans from a channel.",
b1bf690d 114 " $bCLEARMODES$b Clear all modes from a channel."
d2dce5ac
AS
115 );
116
b1bf690d 117"CLONES" (
d2dce5ac
AS
118 " $bADDTRUST$b Add a clone limit exemption for a host.",
119 " $bDELTRUST$b Remove a clone exemption.",
120 " $bEDITTRUST$b Modify a clone exemption.",
121 " $bquery services/opserv/untrusted_max$b",
b1bf690d 122 " View the clone kill limit"
d2dce5ac
AS
123 );
124
b1bf690d 125"SETTINGS" (
d2dce5ac 126 " $bQUERY$b Show a runtime config setting.",
b1bf690d 127 " $bSET$b $uTemporarily$u change a runtime config setting."
d2dce5ac
AS
128 );
129
b1bf690d 130"ADMIN" (
d2dce5ac
AS
131 " $bACCESS$b Modify someone's $O access level.",
132 " $bCOMMAND$b Show details of a command.",
133 " $bSHOWCOMMANDS$b List all commands and required access levels.",
134 " $b$b",
135 " $bBANEMAIL$b Ban an email address from being used by the email system.",
136 " $bUNBANEMAIL$b Remove an email ban.",
137 " $b$b",
138 " $bJOIN$b Make $O join a channel.",
139 " $bPART$b Make $O leave a channel.",
140 " $b$b",
141 " $bCLONE$b Create and manipulate a fake user.",
142 " $bCOLLIDE$b Create a clone, colliding an existing user.",
143 " $bRESERVE$b Permanently reserve a nick with a clone.",
144 " $bUNRESERVE$b Remove a perminant reserved clone.",
145 " $bJUPE$b Create dummy server.",
146 " $bUNJUPE$b Remove a dummy server.",
147 " $b$b",
148 " $bREFRESHG$b Refresh the Glines.",
d914d1cb 149 " $bREFRESHS$b Refresh the Shuns.",
d2dce5ac 150 " $bSETTIME$b Synchronize time across the network.",
b1bf690d 151 " $bTIMECMD$b Time how long a command runs."
d2dce5ac
AS
152 );
153
b1bf690d 154"OWNERONLY" (
d2dce5ac
AS
155 " $bWRITE$b Write out a database.",
156 " $bWRITEALL$b Write out ALL databases.",
157 " $bREOPEN$b Close and Re-Open the logs.",
158 " $bREADHELP$b Re-read a help file.",
159 " $bDUMPMESSAGES$b Writes messages to a .db file (for translators).",
160 " $b$b",
161 " $bREHASH$b Re-read the config files.",
ceafd592 162 " $bRESTART$b Quit and re-run X3.",
d2dce5ac
AS
163 " $bDIE$b Make the bot quit.",
164 " $bJUMP$b Change uplink servers.",
165 " $bRECONNECT$b Reconnect to this uplink server.",
d914d1cb 166 " $bGSYNC$b Pull glines from the given server into memory.",
167 " $bSSYNC$b Pull shuns from the given server into memory.",
d2dce5ac
AS
168 " $b$b",
169 " $bMODCMD$b Change details of a command.",
170 " $bBIND$b Make a command alias.",
171 " $bUNBIND$b Remove a command alias.",
c8273589 172 " $bREBINDALL$b Re-create all missing commands on all services",
d2dce5ac
AS
173 " $bHELPFILES$b Change the helpfile priority order.",
174 " $b$b",
175 " $bSERVICE ADD$b Create a new service bot.",
176 " $bSERVICE REMOVE$b Remove a service bot.",
177 " $bSERVICE RENAME$b Rename a service bot.",
178 " $bSERVICE PRIVILEGED$b Sets if only opers can use the service.",
182dd032 179 " $bSERVICE TRIGGER$b Change the command character of a service.",
d2dce5ac
AS
180 " $b$b",
181 " $bADDBAD$b Add a word to the illegal channel word list.",
182 " $bDELBAD$b Remove a word from the illegal channel word list.",
183 " $bADDEXEMPT$b Make an exception to the illegal word list for a channel.",
184 " $bDELEXEMPT$b Remove an exception of the illegal word list.",
185 " $b$b",
186 " $bDUMP$b Drop safetychecked server protocol to the server. ",
7637f48f 187 " $bRAW$b Drop raw server protocol to the server. (DANGEROUS!)",
188 " $b$b",
189 " $bRESETMAX$b Reset the maximum recorded users. (used in the event of a clone flood)"
d2dce5ac
AS
190 );
191
192
d76ed9a9 193"ACCESS" ("/msg $O ACCESS [nick|*account] [new-level]",
d2dce5ac 194 "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).",
4ec29502 195 "\"ACCESS *\" will show the access levels of everyone.",
d2dce5ac 196 "Access level: $b${level/access}$b",
182dd032
AS
197 "$uSee Also:$u commands, modcmd"
198 );
d2dce5ac 199
d76ed9a9
AS
200"ADDALERT" ("/msg $O ADDALERT <name> <reaction> <criteria>",
201 "Adds the specified alert to the $b$O$b alert list.",
182dd032
AS
202 "Alerts watch for users matching a givin criteria and perform an action on them.",
203 " <name> - An alphanumeric word to identify this alert in the list",
204 " <reaction> - What to do if a user matches the criteria. See $bALERT REACTION$b.",
205 " <criteria> - What to look for. See $bTRACE CRITERIA$b.",
d2dce5ac
AS
206 "Access level: $b${level/addalert}$b",
207 "$uSee Also:$u delalert, alert reaction, trace criteria"
208 );
209
b1bf690d 210"TIME NOTATION" (
182dd032
AS
211 " Many commands require a duration perameter ",
212 " which all use the same syntax: ",
213 " 1s - 1 second ",
214 " 2m - 2 minutes ",
215 " 3h - 3 hours ",
216 " 4d - 4 days ",
217 " 5w - 5 weeks ",
218 " 6M - 6 months",
219 " 1y - 1 year",
220 " Times can be compounded such as: ",
221 " 1m40s - 1 minute and 40 seconds ",
b1bf690d 222 " 5h20m30s - 5 hours 20 minutes and 30 seconds "
182dd032
AS
223 );
224
d76ed9a9 225"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
182dd032
AS
226 "Extends the clone kill limit for the specified <ip> to <count> for <duration>.",
227 "<duration> uses $btime notation$b",
d76ed9a9 228 "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 229 "Access level: $b${level/addtrust}$b",
182dd032 230 "$uSee Also:$u deltrust, stats trusted, time notation"
d2dce5ac
AS
231 );
232
d76ed9a9
AS
233"ALERT REACTION" ("$bALERT REACTION$b",
234 "Valid alert actions (to be taken when an alert is hit) are:",
235 "$bNOTICE$b: Send a notice to the $b$O$b alert channel",
236 "$bKILL$b: Disconnect the user",
237 "$bGLINE$b: Gline the user that tripped the alert",
ec311f39 238 "$bTRACK$b: Send a notice to the $b$O$b alert channel and track the user (if the tracking module is loaded)",
d914d1cb 239 "$bSHUN$b : Shun the user that tripped the alert",
182dd032
AS
240 "$uSee Also:$u addalert, delalert"
241 );
d2dce5ac 242
d76ed9a9
AS
243"DELALERT" ("/msg $O DELALERT <alert> [alert]...",
244 "Remove the specified alerts from the $b$O$b alert list.",
182dd032
AS
245 "Access level: $b${level/delalert}$b",
246 "$uSee Also:$u addalert, stats"
247 );
d2dce5ac 248
d76ed9a9
AS
249"DELTRUST" ("/msg $O DELTRUST <ip>",
250 "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
251 "Access level: $b${level/deltrust}$b",
252 "$uSee Also:$u addtrust, stats"
253 );
d2dce5ac 254
d76ed9a9
AS
255"INVITEME" ("/msg $O INVITEME [nick]",
256 "Invites the specified user (if omitted, you) to $O's debug channel.",
182dd032
AS
257 "This is currently pointless, since no output is sent to the debug channel.",
258 "Access level: $b${level/inviteme}$b",
259 "$uSee Also:$u invite, clearmodes, clearbans"
260 );
d2dce5ac 261
d76ed9a9 262"TRACE" ("/msg $O TRACE <action> <criteria> <value> [<criteria> <value>]...",
d2dce5ac 263 "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.",
d914d1cb 264 "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, SHUN, GAG, DOMAINS",
27eaa617 265 "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, REGEX",
182dd032
AS
266 "Access level: $b${level/trace}$b",
267 "$uSee Also:$u trace action, trace criteria"
268 );
d2dce5ac 269
d76ed9a9
AS
270"TRACE ACTION" ("$bTRACE ACTION$b",
271 "Options for action in $btrace$b are:",
272 "$bPRINT$b: Display the hostmask to you.",
273 "$bCOUNT$b: Count all matching users.",
274 "$bKILL$b: Kill matching clients.",
275 "$bGLINE$b: Issue a gline for the client's host (by default, 1 hour long).",
d914d1cb 276 "$bSHUN$b: Issue a shun for the client's host (by default, 1 hour long).",
d76ed9a9
AS
277 "$bGAG$b: Gag all matching users (by default, does not expire).",
278 "$bDOMAINS$b: Display counts of users in each domain (length specified by DEPTH criteria.",
d914d1cb 279 "Note: By default, IRC operators are not affected by the KILL, GLINE, SHUN 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.",
182dd032
AS
280 "$uSee Also:$u trace criteria, trace"
281 );
d2dce5ac 282
d76ed9a9
AS
283"TRACE CRITERIA" ("$bTRACE CRITERIA$b",
284 "Criteria and values for $btrace$b (a search with $btrace$b must match all specified items):",
285 "$bMASK$b nick!user@host Specifies a full hostmask to search for.",
286 "$bNICK$b nick Specifies a nick to search for.",
287 "$bIDENT$b ident Specifies an ident to search for.",
288 "$bHOST$b host Specifies a hostname to search for.",
289 "$bINFO$b infoline Specifies a user's info to search for.",
290 "$bSERVER$b server Specifies a server to search for.",
291 "$bIP$b 127.0.0.1 Specifies an IP to search for (independent of hostname).",
292 "$bACCOUNT$b account Specifies an account to search for.",
293 "$bAUTHED$b yes/no Specifies if matching users must be authenticated with $N or not",
294 "$bCHANNEL$b #target Specifies a channel the client must be in.",
295 "$bNUMCHANNELS$b 5 Specifies a number of channels the client must be in.",
296 "$bLIMIT$b 50 Limits the number of responses to a certain number.",
297 "$bNICKAGE$b cmp Client has had nick this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
6762ab9f 298 "$bLINKED$b cmp Connected to the network this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
d76ed9a9 299 "$bACCESS$b cmp Access constraints (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
d914d1cb 300 "$bREASON$b reason Reason for kill, gline or shun (must be listed last).",
d76ed9a9 301 "$bDEPTH$b depth How many domain-name parts to use for $bDOMAINS$b action.",
6762ab9f 302 "$bDURATION$b duration How long to apply a G-line or gag (see $C help topic $bdurations$b).",
d76ed9a9
AS
303 "$bCLONES$b min Ignore clients from hosts with fewer than this many connections.",
304 "$bINFO_SPACE$b yes/no Clients match only if their info starts with a space (' ') character.",
305 "$bABUSE OPERS$b Force adverse actions to affect opers as well.",
306 "$bLOG$b Record matching users in $O's log file (in addition to acting).",
27eaa617 307 "$bREGEX$b yes/no Specifies if NICK/IDENT/HOST/INFO should be treated as a regular expression.",
a8370a20 308 "$bSILENT$b yes/no If yes, AUTO is prepended to the gline message, making the gline silent in nefarious ircd.",
182dd032 309 "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.",
63665495 310 "When searching on the criteria of nick, ident, or info, the search string can be another of the three, prefixed with a & character, to indicate that the match should compare each user's individual data. For example, $binfo &nick$b would search for all users whose info matches their nick. To search for that phrase explicitly, prefix the & with a backslash; e.g.: $binfo \&ident$b.",
182dd032
AS
311 "$uSee Also:$u trace action, trace"
312 );
d2dce5ac 313
d76ed9a9 314"WHOIS" ("/msg $O WHOIS <nick>",
182dd032
AS
315 "Displays detailed information for the named user.",
316 "Access level: $b${level/whois}$b",
317 );
d2dce5ac 318
d76ed9a9
AS
319"CHANINFO" ("/msg $O CHANINFO <#channel> [users]",
320 "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
321 "Access level: $b${level/chaninfo}$b",
322 "$uSee Also:$u whois"
323 );
d2dce5ac 324
d76ed9a9
AS
325"CSEARCH" ("/msg $O CSEARCH <action> <criteria> <value> [<criteria> <value>]...",
326 "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
327 "Access level: $b${level/csearch}$b",
328 "$uSee Also:$u csearch action, csearch criteria"
329 );
d2dce5ac 330
d76ed9a9
AS
331"CSEARCH ACTION" ("$bCSEARCH ACTION$b",
332 "Options for action in $bcsearch$b are:",
333 "$bPRINT$b: Display the channel and user count.",
182dd032
AS
334 "$bCOUNT$b: Count all matching channels."
335 );
d2dce5ac 336
d76ed9a9
AS
337"CSEARCH CRITERIA" ("$bCSEARCH CRITERIA$b",
338 "Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
339 "$bNAME$b name Specifies a name to search for.",
340 "$bTOPIC$b topic Specifies a topic to search for.",
341 "$bUSERS$b cmp User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
342 "$bTIMESTAMP$b cmp Timestamp constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu; supports interval notation)",
182dd032
AS
343 "$bLIMIT$b 50 Limits the number of responses to a certain number."
344 );
d2dce5ac 345
d76ed9a9
AS
346"JOIN" ("/msg $O JOIN <#channel> ",
347 "Makes $b$O$b join the specified channel.",
182dd032
AS
348 "Access level: $b${level/join}$b",
349 "$uSee Also:$u part"
350 );
d2dce5ac 351
d76ed9a9
AS
352"PART" ("/msg $O PART <#channel> ",
353 "Makes $b$O$b leave the specified channel.",
182dd032
AS
354 "Access level: $b${level/part}$b",
355 "$uSee Also:$u join"
356 );
d2dce5ac 357
d76ed9a9
AS
358"ADDBAD" ("/msg $O ADDBAD <word>",
359 "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 360 "Access level: $b${level/addbad}$b",
de9510bc 361 "$uSee Also:$u addexempt, delbad, stats bad, $C:noregister"
182dd032 362 );
d2dce5ac 363
d76ed9a9
AS
364"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
365 "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.",
366 "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.",
367 "The current exempt list is displayed with the current bad-words in $bstats bad$b.",
182dd032
AS
368 "Access level: $b${level/addexempt}$b",
369 "$uSee Also:$u addbad, delexempt, stats"
370 );
d2dce5ac 371
d76ed9a9
AS
372"DELBAD" ("/msg $O DELBAD <keyword>",
373 "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 374 "Access level: $b${level/delbad}$b",
de9510bc 375 "$uSee Also:$u addbad, delexempt, stats bad, $C:allowregister"
182dd032 376 );
d2dce5ac 377
d76ed9a9
AS
378"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
379 "Removes a channel from $O's bad-word-exempt channel list.",
182dd032
AS
380 "Access level: $b${level/delexempt}$b",
381 "$uSee Also:$u addexempt, delbad, stats"
382 );
d2dce5ac 383
d76ed9a9
AS
384"BAN" ("/msg $O BAN <#channel> <nick|hostmask>",
385 "Bans the specified hostmask from the specified channel.",
386 "If a nick is used instead of hostmask, the hostmask is generated based on the nickname.",
387 "If the channel is omitted, the $bban$b will be done in the channel where the command was given.",
182dd032
AS
388 "Access level: $b${level/ban}$b",
389 "$uSee Also:$u kickban, kickbanall, unban"
390 );
d2dce5ac 391
d76ed9a9
AS
392"UNBAN" ("/msg $O UNBAN <#channel> <hostmask>",
393 "Unbans the specified hostmask from the specified channel.",
394 "If the channel is omitted, the $bunban$b will be done in the channel where the command was given.",
182dd032
AS
395 "Access level: $b${level/unban}$b",
396 "$uSee Also:$u kickban, kickbanall, ban"
397 );
d2dce5ac 398
d76ed9a9
AS
399"CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
400 "Clears all bans in the specified channel.",
401 "If the channel is omitted, then $bclearbans$b will be done in the channel where the command was given.",
182dd032
AS
402 "Access level: $b${level/clearbans}$b",
403 "$uSee Also:$u ban, unban"
404 );
d2dce5ac 405
d76ed9a9
AS
406"CLEARMODES" ("/msg $O CLEARMODES <#channel> ",
407 "Clears the specified channel of all modes.",
408 "If the channel is omitted, then $bclearmodes$b will be done in the channel where the command was given.",
182dd032
AS
409 "Access level: $b${level/clearmodes}$b",
410 "$uSee Also:$u mode"
411 );
d2dce5ac 412
d76ed9a9
AS
413"DEOP" ("/msg $O DEOP <#channel> <nick> [nick]...",
414 "Deops the specified user from the specified channel.",
415 "If the channel is omitted, then $bdeop$b will be done in the channel where the command was given.",
182dd032
AS
416 "Access level: $b${level/deop}$b",
417 "$uSee Also:$u deopall, devoiceall, op, opall"
418 );
d2dce5ac 419
d76ed9a9
AS
420"DEOPALL" ("/msg $O DEOPALL <#channel>",
421 "Deops all members of the specified channel.",
422 "If the channel is omitted, then $bdeopall$b will be done in the channel where the command was given.",
182dd032
AS
423 "Access level: $b${level/deopall}$b",
424 "$uSee Also:$u deop, devoiceall, op, opall"
425 );
d2dce5ac 426
82794e1b 427"DEHOP" ("/msg $O DEHOP <#channel> <nick> [nick]...",
428 "Dehalfops the specified user from the specified channel.",
429 "If the channel is omitted, then $bdehop$b will be done in the channel where the command was given.",
430 "Access level: $b${level/dehalfop}$b",
431 "$uSee Also:$u dehalfopall, hop, hopall"
432 );
433
434"DEHOPALL" ("/msg $O DEHOPALL <#channel>",
435 "Dehalfops all members of the specified channel.",
436 "If the channel is omitted, then $bdehopall$b will be done in the channel where the command was given.",
437 "Access level: $b${level/dehopall}$b",
438 "$uSee Also:$u dehop, hop, hopall"
439 );
440
d76ed9a9
AS
441"DEVOICEALL" ("/msg $O DEVOICEALL <#channel>",
442 "Devoice all members of the specified channel who do not have channel ops.",
443 "If the channel is omitted, then $bdevoiceall$b will be done in the channel where the command was given.",
182dd032
AS
444 "Access level: $b${level/devoiceall}$b",
445 "$uSee Also:$u deop, deopall, op, opall"
446 );
d2dce5ac 447
d76ed9a9
AS
448"KICK" ("/msg $O KICK <#channel> <nick> [reason]",
449 "Kicks the specified user from the specified channel.",
450 "If the channel is omitted, then $bkick$b will be done in the channel where the command was given.",
182dd032
AS
451 "Access level: $b${level/kick}$b",
452 "$uSee Also:$u ban, kickall, kickban, kickbanall"
453 );
d2dce5ac 454
d76ed9a9
AS
455"KICKALL" ("/msg $O KICKALL <#channel> [reason]",
456 "Kicks all users in the specified channel except for the user issuing the command.",
457 "If the channel is omitted, then $bkickall$b will be done in the channel where the command was given.",
182dd032
AS
458 "Access level: $b${level/kickall}$b",
459 "$uSee Also:$u ban, kick, kickbanall"
460 );
d2dce5ac 461
d76ed9a9
AS
462"KICKBAN" ("/msg $O KICKBAN <#channel> <nick> [reason]",
463 "Kicks and bans the specified user. $b$O$b determines the hostmask to ban from the nick specified.",
464 "If the channel is omitted, then $bkickban$b will be done in the channel where the command was given.",
182dd032
AS
465 "Access level: $b${level/kickban}$b",
466 "$uSee Also:$u ban, kickall, kickbanall"
467 );
d2dce5ac 468
d76ed9a9
AS
469"KICKBANALL" ("/msg $O KICKBANALL <#channel> [reason]",
470 "Kick and bans all members of the specified channel except for the user issuing the command.",
471 "If the channel is omitted, then $bkickbanall$b will be done in the channel where the command was given.",
182dd032
AS
472 "Access level: $b${level/kickbanall}$b",
473 "$uSee Also:$u ban, kick, kickban"
474 );
d2dce5ac 475
d76ed9a9
AS
476"MODE" ("/msg $O MODE <#channel> <+/- mode>",
477 "Sets the specified modes (but cannot include voice, ban or op changes) on a channel.",
478 "If the channel is omitted, then $bmode$b will be done in the channel where the command was given.",
182dd032
AS
479 "Access level: $b${level/mode}$b",
480 "$uSee Also:$u ban, deop, kickban, op"
481 );
d2dce5ac 482
d76ed9a9
AS
483"OP" ("/msg $O OP <#channel> <nick> [nick]...",
484 "Ops specified nicknames the specified channel.",
485 "If the channel is omitted, then $bop$b will be done in the channel where the command was given.",
182dd032
AS
486 "Access level: $b${level/op}$b",
487 "$uSee Also:$u deop, deopall, opall"
488 );
d2dce5ac 489
d76ed9a9
AS
490"OPALL" ("/msg $O OPALL <#channel>",
491 "Ops all members of the specified channel.",
492 "If the channel is omitted, then $bopall$b will be done in the channel where the command was given.",
182dd032
AS
493 "Access level: $b${level/opall}$b",
494 "$uSee Also:$u deopall"
495 );
d2dce5ac 496
82794e1b 497"HOP" ("/msg $O HOP <#channel> <nick> [nick]...",
498 "Half ops specified nicknames the specified channel.",
499 "If the channel is omitted, then $bhop$b will be done in the channel where the command was given.",
500 "Access level: $b${level/hop}$b",
501 "$uSee Also:$u dehop, dehopall, hopall"
502 );
503
504"HOPALL" ("/msg $O HOPALL <#channel>",
505 "Half ops all members of the specified channel.",
506 "If the channel is omitted, then $bhopall$b will be done in the channel where the command was given.",
507 "Access level: $b${level/hopall}$b",
508 "$uSee Also:$u dehopall"
509 );
510
d76ed9a9
AS
511"VOICEALL" ("/msg $O VOICEALL <#channel>",
512 "Voices all members of the specified channel who do not have channel ops.",
513 "If the channel is omitted, then $bvoiceall$b will be done in the channel where the command was given.",
182dd032
AS
514 "Access level: $b${level/voiceall}$b",
515 "$uSee Also:$u opall, deopall, devoiceall"
516 );
d76ed9a9
AS
517
518"GLINES" ("$bGLINE COMMANDS$b",
519 "Searches for, issues, and removes G-lines (network-global K-lines).",
520 " BLOCK [${level/block}]",
521 " GLINE [${level/gline}]",
522 " GTRACE [${level/gtrace}]",
523 " GSYNC [${level/gsync}]",
524 " REFRESHG [${level/refreshg}]",
182dd032
AS
525 " UNGLINE [${level/ungline}]"
526 );
d2dce5ac 527
d76ed9a9
AS
528"BLOCK" ("/msg $O BLOCK <nick> [reason]",
529 "GLINES the host of the specified nick for one hour If no reason is given, use a default reason.",
182dd032
AS
530 "Access level: $b${level/block}$b",
531 "$uSee Also:$u gline, ungline"
532 );
d2dce5ac 533
d76ed9a9
AS
534"GLINE" ("/msg $O GLINE <user@host> <duration> <reason>",
535 "Issues a GLINE (network ban) on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
6762ab9f 536 "duration is in the form nnm, where nn is a number, and m is a charactor representing the unit (eg d for days.)",
182dd032 537 "Access level: $b${level/gline}$b",
6762ab9f 538 "$uSee Also:$u trace, ungline, ($C) durations"
182dd032 539 );
d2dce5ac 540
d76ed9a9
AS
541"GTRACE" ("/msg $O GTRACE <action> <criteria> [<criteria> <value>]...",
542 "Searches through the glines, much like $bTRACE$b does for users.",
182dd032
AS
543 "Access level: $b${level/gtrace}$b",
544 "$uSee Also:$u trace, gtrace action, gtrace criteria"
545 );
d2dce5ac 546
d76ed9a9
AS
547"GTRACE ACTION" ("$bGTRACE ACTION$b",
548 "Options for the action in $bgtrace$b are:",
549 "$bPRINT$b: Display the glines (mask, issuer, expiration time, reason)",
550 "$bCOUNT$b: Count the number of matching glines",
182dd032
AS
551 "$bUNGLINE$b: Remove matching glines",
552 "$uSee Also:$u gtrace criteria, gtrace"
553 );
d2dce5ac 554
d76ed9a9
AS
555"GTRACE CRITERIA" ("$bGTRACE CRITERIA$b",
556 "Criteria and values for $bgtrace$b (a search with $bgtrace$b must match all the criteria you give):",
557 "$bMASK SUPERSET$b user@host G-line matches if it applies to someone with this hostmask.",
558 "$bMASK SUBSET$b user@host G-line matches if this hostmask \"covers\" the G-line target.",
559 "$bMASK EXACT$b user@host G-line matches only if the target is exactly this.",
560 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
561 "$bLIMIT$b count Limits the number of matching glines.",
562 "$bREASON$b reason Looks for glines with the given reason.",
563 "$bISSUER$b account Looks for glines issued by the given account.",
182dd032
AS
564 "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.",
565 "$uSee Also:$u gtrace action, gtrace"
566 );
d2dce5ac 567
d76ed9a9 568"GSYNC" ("/msg $O GSYNC [server]",
ceafd592 569 "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
570 "Access level: $b${level/gsync}$b",
571 "$uSee Also:$u refreshg, gline, ungline"
572 );
d2dce5ac 573
d76ed9a9
AS
574"REFRESHG" ("/msg $O REFRESHG [server]",
575 "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
576 "Access level: $b${level/refreshg}$b",
577 "$uSee Also:$u gline, ungline, gsync"
578 );
d2dce5ac 579
d76ed9a9
AS
580"UNGLINE" ("/msg $O UNGLINE <user@host>",
581 "Removes a gline from the network before it expires.",
182dd032
AS
582 "Access level: $b${level/ungline}$b",
583 "$uSee Also:$u gline"
584 );
d2dce5ac 585
d914d1cb 586"SHUN" ("$bSHUN COMMANDS$b",
587 "Searches for, issues, and removes Shuns.",
588 " SBLOCK [${level/sblock}]",
589 " SHUN [${level/shun}]",
590 " STRACE [${level/strace}]",
591 " SSYNC [${level/ssync}]",
592 " REFRESHS [${level/refreshs}]",
593 " UNSHUN [${level/unshun}]"
594 );
595
596"SBLOCK" ("/msg $O SBLOCK <nick> [reason]",
597 "SHUNS the host of the specified nick for one hour If no reason is given, use a default reason.",
598 "Access level: $b${level/sblock}$b",
599 "$uSee Also:$u shun, unshun"
600 );
601
602"SHUN" ("/msg $O SHUN <user@host> <duration> <reason>",
603 "Issues a SHUN on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
604 "Access level: $b${level/shun}$b",
605 "$uSee Also:$u trace, unshun"
606 );
607
608"STRACE" ("/msg $O STRACE <action> <criteria> [<criteria> <value>]...",
609 "Searches through the shuns, much like $bTRACE$b does for users.",
610 "Access level: $b${level/strace}$b",
611 "$uSee Also:$u trace, strace action, strace criteria"
612 );
613
614"STRACE ACTION" ("$bSTRACE ACTION$b",
615 "Options for the action in $bstrace$b are:",
616 "$bPRINT$b: Display the shuns (mask, issuer, expiration time, reason)",
617 "$bCOUNT$b: Count the number of matching shuns",
618 "$bUNSHUN$b: Remove matching shuns",
619 "$uSee Also:$u strace criteria, strace"
620 );
621
622"STRACE CRITERIA" ("$bSTRACE CRITERIA$b",
623 "Criteria and values for $bstrace$b (a search with $bstrace$b must match all the criteria you give):",
624 "$bMASK SUPERSET$b user@host Shun matches if it applies to someone with this hostmask.",
625 "$bMASK SUBSET$b user@host Shun matches if this hostmask \"covers\" the Shun target.",
626 "$bMASK EXACT$b user@host Shun matches only if the target is exactly this.",
627 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
628 "$bLIMIT$b count Limits the number of matching shuns.",
629 "$bREASON$b reason Looks for shuns with the given reason.",
630 "$bISSUER$b account Looks for shuns issued by the given account.",
631 "$bAFTER$b interval Looks for shuns that expire more than $binterval$b in the future.",
632 "$uSee Also:$u strace action, strace"
633 );
634
635"SSYNC" ("/msg $O SSYNC [server]",
636 "Requests a list of SHUNS from its uplink or the specified server. This can be used in the event X3 is down for period and becomes desynced.",
637 "Access level: $b${level/ssync}$b",
638 "$uSee Also:$u refreshs, shun, unshun"
639 );
640
641"REFRESHS" ("/msg $O REFRESHS [server]",
642 "Re-issues all SHUNS in $b$O's$b database. Usually used for newly joining or desynched servers. If a server mask is specified, the SHUNS are only sent to server(s) with matching names.",
643 "Access level: $b${level/refreshs}$b",
644 "$uSee Also:$u shun, unshun, ssync"
645 );
646
647"UNSHUN" ("/msg $O UNSHUN <user@host>",
648 "Removes a shun from the network before it expires.",
649 "Access level: $b${level/unshun}$b",
650 "$uSee Also:$u shun"
651 );
652
d76ed9a9
AS
653"CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
654 "Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
655 "$bADD$b: Adds a new clone. Arguments: <nickname> <user@host> <info>",
656 "$bREMOVE$b: Removes a clone. Arguments: <nickname>",
657 "$bJOIN$b: Joins a clone to a channel. Arguments: <nickname> <channel>",
658 "$bPART$b: Parts a clone from a channel. Arguments: <nickname> <channel>",
659 "$bOP$b: Ops a clone in a channel. Arguments: <nickname> <channel>",
182dd032
AS
660 "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>",
661 "Access level: $b${level/clone}$b",
662 "$uSee Also:$u collide, reserve, jupe"
663 );
d2dce5ac 664
d76ed9a9
AS
665"COLLIDE" ("/msg $O COLLIDE <nick> <ident> <host> <description>",
666 "Creates a clone with the specified properties, colliding any existing user with the same nick.",
182dd032
AS
667 "Access level: $b${level/collide}$b",
668 "$uSee Also:$u clone, reserve, jupe"
669 );
d2dce5ac 670
d76ed9a9 671"JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
ceafd592 672 "Causes X3 to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
182dd032
AS
673 "Access level: $b${level/jupe}$b",
674 "$uSee Also:$u unjupe, clone, reserve"
675 );
d2dce5ac 676
d76ed9a9 677"RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
ceafd592 678 "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
679 "Access level: $b${level/reserve}$b",
680 "$uSee Also:$u unreserve, clone, jupe"
681 );
d2dce5ac 682
d76ed9a9 683"UNJUPE" ("/msg $O UNJUPE <srvname>",
ceafd592 684 "Causes X3 to unjupe a jupe server.",
182dd032
AS
685 "Access level: $b${level/unjupe}$b",
686 "$uSee Also:$u jupe, unreserve, clone"
687 );
d2dce5ac 688
47956fc5
AS
689"ROUTING ADDPLAN" ("/msg $O ROUTING ADDPLAN <name>",
690 "Creates a new blank routing plan named name.",
691 "You can then use $bROUTING ADDSERVER$b to build it.",
692 "Use $bSTATS ROUTING$b to view it, and $bROUTING SET ACTIVE$b to activate it.",
693 "$uSee Also:$u routing, stats routing, routing delplan, routing set, routing addserver"
694 );
695"ROUTING DELPLAN" ("/msg $O ROUTING DELPLAN <name>",
696 "Removes the routing plan name, including all the servers that make it up. Use with caution, there is no undo.",
697 "$uSee Also:$u routing, stats routing, routing addplan"
698 );
699
700"ROUTING ADDSERVER" ("/msg $O ROUTING ADDSERVER <plan> <name>[:port] <uplink> [backup uplink]",
701 "Adds a server to the routing plan 'plan'.",
702 " plan - The name of a routing plan already created.",
703 " server - The name of the server you are adding (full hostname).",
704 " port - The port that the server listens to connectons on. If you leave this out, the default is taken from $bSET ROUTING DEFAULT_PORT$b.",
705 " uplink - This is the server (full hostname) that you want the server to connect to.",
706 " backup uplink - If uplink is offline, this one takes over.",
707 " $b$b ",
708 " It is $uvery$u important that the routing plan be from a consistant perspective, without any loops, or disconnected pieces. It helps to pick a server (usually the one $O is liked to) and consider which server each of the servers links to towards $O. For an example see /msg $O HELP ROUTING EXAMPLE.",
709 " If you add a server whose name already exists, the old one will be replaced.",
710 "$uSee Also:$u routing, stats routing, routing delserver, routing addplan",
711 );
712
713"ROUTING EXAMPLE" ("An Auto Routing System Example:",
714 " Consider the following map: ",
715 " test.net.org - test's uplink is x3",
716 " |-X3.NET.Services - this is me",
717 " |-laptop.net.org - laptop's uplink is test",
718 " | `-foobar.net.org - foobar's uplink is laptop",
719 " `-test2.net.org - test2's uplink is test",
dd1fc2a3 720 " `-test3.net.org - test3's uplink is test2",
47956fc5
AS
721 " $b$b ",
722 " Its important that every entry in your routing plan be specified relitive to the same location. Usually this is the location of X3 itself, but doesn't have to be. In the above example you could do:",
723 " ROUTING ADDSERVER myplan test.net.org:4400 x3.net.services ",
724 " ROUTING ADDSERVER myplan test2.net.org:4400 test.net.org ",
725 " ROUTING ADDSERVER myplan test3.net.org:4400 test2.net.org ",
726 " ROUTING ADDSERVER myplan laptop.net.org:4400 test.net.org ",
727 " ROUTING ADDSERVER myplan foobar.net.org:4400 laptop.net.org ",
728 " $b$b ",
729 " If there are loops, or two servers who point to eachother, $O will not be able to use the plan. If there are sections which do not link back to the rest, they will be lost and the plan will not work properly.",
730 );
731
732"ROUTING DELSERVER" ("/msg $O ROUTING DELSERVER <plan> <server>",
733 "Deletes a server from a routing plan.",
734 "$uSee also:$u routing, stats routing, routing addserver, routing delplan",
735 );
736
737"ROUTING SET" ("/msg $O ROUTING SET [option] [value]",
738 "Changes The Auto Routing System options",
739 " ACTIVE - Sets which routing plan is active. ",
740 " Set to 'none' to disable auto routing.",
741 " RETRY_PERIOD - How often to check for missing servers",
742 " see /msg $C durations for help with units",
743 " CONN_PINGOUT - enable to auto-reconnect servers that ping out",
744 " CONN_READERROR - enable to auto-reconnect servers that squit with a read error",
745 " KARMA - enable to keep track of oft-splitting servers, and try to route around them",
746 " DEFAULT_PORT - If you don't specify a port in $brouting addserver$b, this port is used",
747 " $b$b ",
748 " Issue without any option/value to see the current value(s).",
749 "$uSee also:$u routing, stats routing, routing addserver",
750 );
751
752"ROUTING MAP" ("/msg $O ROUTING MAP",
753 "Shows the currently active routing plan, as parsed and re-centered for use.",
754 "Before $O can take a routing plan as entered by you, and use it, $O must re-orient the map so all the uplinks point toward it. Loops are detected, and missing pieces lost. This command shows you the desired route, as $O has compiled it.",
755 "If KARMA is enabled, or a server is un-connectable, $O may use a backup uplink to build this map to attempt to repair the network.",
756 "The check box [ ] is used to indicate if the current routing of the network conforms to the routing map.",
757 "[X] - Server is linked correctly",
758 "[!] - Server is linked, but not where the plan specifies",
759 "[ ] - Server is not linked to the network at all",
760 " $b$b",
761 "$uSee also:$u routing, stats routing, routing set, routing addserver",
762 );
763
764"REROUTE" ("/msg $O REROUTE <C|N|T>",
765 "Allows $O to make changes to the linkage of the servers on the network. It has 3 modes: Normal, Connect-only, and Test:",
766 " N - Normal mode: Will delink any servers which are not linked to their primary uplink, and try to reconnect them correctly according to the active routing plan. it will also try to connect servers that are completely missing.",
767 " C - Connect-only: Will attempt to connect any missing servers to the network, using the active routing plan.",
768 " T - Test: Will do the same as normal mode, only all actions will be simulated. No actual rerouting will take place, it will only tell you what it WOULD do in normal mode.",
769 " $b$b ",
770 "$uSee also:$u routing, routing map, stats routing",
771 );
772
773"STATS ROUTING" ("/msg $O STATS ROUTING",
774 "Provides information about The Auto Routing System's configuration. You can see the routing plans, and the current routing options.",
775 "$uSee also:$u routing, routing set",
776 );
777
d76ed9a9
AS
778"UNRESERVE" ("/msg $O UNRESERVE <nick>",
779 "Removes a nick from $b$O's$b reserve list.",
182dd032
AS
780 "Access level: $b${level/unreserve}$b",
781 "$uSee Also:$u reserve, clone, unjupe"
782 );
d76ed9a9 783
d76ed9a9
AS
784"LOG" ("/msg $O LOG <criteria> <value> [<criteria> <value>]...",
785 "Searches services logs based on critera specified and displays the results.",
786 "Criteria and associated values (a search match all specified items):",
787 "$bBOT$b - A service bot's name (for example, $O).",
788 "$bCHANNEL$b - The channel where a command was issued (accepts wildcards).",
789 "$bNICK$b - The nickname issuing the command (accepts wildcards).",
790 "$bACCOUNT$b - The account of the user who issued the command (accepts wildcards).",
791 "$bHOSTMASK$b - The ident@host of the user who issued the command (accepts wildcards).",
792 "$bAGE$b - Age of commands to find (for example, 1m or >3m).",
793 "$bLIMIT$b - Maximum number of results to show.",
794 "$bLEVEL$b - Comma-separated list of COMMAND, OVERRIDE, STAFF, to return only those commands.",
795 "$bTYPE$b - Name of module that generated log (see $bSTATS MODULES$b).",
182dd032
AS
796 "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.",
797 "Access level: $b${level/log}$b",
798 "$uSee Also:$u reopen"
799 );
d2dce5ac 800
d76ed9a9
AS
801"REOPEN" ("/msg $O REOPEN",
802 "Close and re-open all the log files.",
182dd032
AS
803 "$uSee Also:$u log, rehash, write, writeall, readhelp"
804 );
d2dce5ac 805
d76ed9a9 806"DIE" ("/msg $O DIE <reason>",
ceafd592 807 "SQUIT X3 with the given reason and shuts it down.",
182dd032
AS
808 "Access level: $b${level/die}$b",
809 "$uSee Also:$u restart, reconnect, jump"
810 );
811
d76ed9a9 812"JUMP" ("/msg $O JUMP <uplink>",
ceafd592 813 "Causes X3 to connect to the specified uplink.",
182dd032
AS
814 "Access level: $b${level/jump}$b",
815 "$uSee Also:$u reconnect, restart, die"
816 );
d2dce5ac 817
d76ed9a9 818"RECONNECT" ("/msg $O RECONNECT ",
ceafd592 819 "Causes X3 to reconnect to its current uplink.",
182dd032
AS
820 "Access level: $b${level/reconnect}$b",
821 "$uSee Also:$u jump, rehash, restart, die"
822 );
d2dce5ac 823
d76ed9a9 824"REHASH" ("/msg $O REHASH",
ceafd592 825 "Causes X3 to re-read its configuration file and update its state as much as possible.",
182dd032
AS
826 "Access level: $b${level/rehash}$b",
827 "$uSee Also:$u die, reconnect, jump, restart"
828 );
d2dce5ac 829
d76ed9a9 830"RESTART" ("/msg $O RESTART <reason>",
ceafd592 831 "Causes X3 to SQUIT with the specified reason and restart.",
182dd032
AS
832 "Access level: $b${level/restart}$b",
833 "$uSee Also:$u reconnect, rehash, die"
834 );
d2dce5ac 835
d76ed9a9 836"GAG" ("/msg $O GAG <mask> <duration> <reason>",
de9510bc
AS
837 "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.",
838 "The gag will automatically expire after $b<duration>$b (or last forever if that is zero).",
182dd032 839 "Access level: $b${level/gag}$b",
de9510bc 840 "$uSee Also:$u ungag, trace, stats gags"
182dd032 841 );
d2dce5ac 842
d76ed9a9
AS
843"HELPSERV" ("/msg $O HELPSERV <command>",
844 "Sends a command to the HelpServ system. It is used for all \"override\" commands, as well as registration and unregistration.",
182dd032
AS
845 "$uSee also:$u /msg $O HELPSERV HELP"
846 );
d2dce5ac 847
258d1427
AS
848"QUERY" ("/msg $O QUERY [key][/<sub-key>[/<sub-sub-key>]...]",
849 "Displays the value of the given configuration key. ",
850 "If the key is a composite entry, show the subkeys inside it.",
851 "Examples:",
852 " QUERY - shows 1st level keys ",
853 " QUERY services/chanserv - shows list of chanserv settings ",
854 " QUERY services/chanserv/chan_expire_delay - shows value ",
182dd032
AS
855 "Access level: $b${level/query}$b",
856 "$uSee Also:$u set, rehash"
857 );
d2dce5ac 858
d76ed9a9
AS
859"SET" ("/msg $O SET <option> <value>",
860 "Modifies the internal configuration database. Currently, only keys that have been previously set may be modified.",
182dd032
AS
861 "Access level: $b${level/set}$b",
862 "$uSee Also:$u query, rehash"
863 );
d2dce5ac 864
d76ed9a9 865"UNGAG" ("/msg $O UNGAG <hostmask>",
de9510bc 866 "Ungags a gaged hostmask.",
182dd032
AS
867 "Access level: $b${level/ungag}$b",
868 "$uSee Also:$u gag, stats gags"
869 );
d2dce5ac 870
d76ed9a9
AS
871"DUMP" ("/msg $O DUMP <raw line>",
872 "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
873 "Access level: $b${level/dump}$b",
874 "$uSee Also:$u raw"
875 );
d2dce5ac 876
d76ed9a9
AS
877"RAW" ("/msg $O RAW <raw line>",
878 "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
879 "Access level: $b${level/raw}$b",
880 "$uSee Also:$u dump"
881 );
d2dce5ac 882
d76ed9a9 883"SETTIME" ("/msg $O SETTIME [servermask] [resync]",
ceafd592 884 "Sets the time on the named server(s) to match the time known to X3.",
d76ed9a9 885 "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 886 "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
887 "Access level: $b${level/settime}$b",
888 "$uSee Also:$u timecmd"
889 );
d2dce5ac 890
d76ed9a9
AS
891"STATS" ("/msg $O STATS <subject>",
892 "Displays statistics about a specified subject. Subjects include:",
893 "$bALERTS$b: The list of current \"alerts\".",
894 "$bBAD$b: Current list of bad words and exempted channels.",
895 "$bGAGS$b: The list of current gags.",
896 "$bGLINES$b: Reports the current number of glines.",
d914d1cb 897 "$bSHUNS$b : Reports the current number of shuns.",
d76ed9a9
AS
898 "$bLINKS$b: Information about the link to the network.",
899 "$bMAX$b: The max clients seen on the network.",
900 "$bNETWORK$b: Displays network information such as total users and how many users are on each server.",
901 "$bNETWORK2$b: Additional information about the network, such as numerics and linked times.",
902 "$bOPERS$b: A list of users that are currently +o.",
ceafd592 903 "$bPROXYCHECK$b: Information about proxy checking in X3.",
d76ed9a9 904 "$bRESERVED$b: The list of currently reserved nicks.",
47956fc5 905 "$bROUTING$b: The routing plans and settings of the Auto Routing System",
d76ed9a9
AS
906 "$bTIMEQ$b: The number of events in the timeq, and how long until the next one.",
907 "$bTRUSTED$b: The list of currently trusted IPs.",
ceafd592 908 "$bUPTIME$b: X3 uptime, lines processed, and CPU time.",
d76ed9a9 909 "$bMODULES$b: Shows loaded modules that implement commands.",
182dd032
AS
910 "$bSERVICES$b: Shows active service bots.",
911 "Access level: $b${level/stats}$b",
912 );
d76ed9a9 913
ec311f39 914"TRACK" ("/msg $O TRACK <+/-type|all|none>",
915 "This specifies what will be tracked in the tracking channel.",
916 "Use + to add flags and - to remove types. Use ALL to enable all",
917 "tracking options available, use NONE to completly disable them.",
918 "Available flags are:",
919 "auth - Auths",
920 "chanmode - Channel Modes",
921 "del - Quits",
922 "join - Joins",
923 "kick - Kicks",
924 "new - New Nicks",
925 "nick - Nick Changes",
926 "part - Parts",
927 "umode - Umodes");
928
929"ADDTRACK" ("/msg $O ADDTRACK <nick>",
930 "Adds the given <nick> to the tracking list.",
931 "$uSee Also:$u deltrack listtrack addalert");
932
933"DELTRACK" ("/msg $O DELTRACK <nick>",
934 "Removes the given <nick> from the tracking list.",
935 "$uSee Also:$u deltrack listtrack");
936
937"LISTTRACK" ("/msg $O LISTTRACK",
938 "Lists all currently active tracks.",
939 "$uSee Also:$u addtrack deltrack");
940
7637f48f 941"RESETMAX" ("/msg $O RESETMAX",
942 "Resets the max clients number to the current ammount of connected clients. Use with caution.",
943 "$uSee Also:$u stats max");
944
d2dce5ac 945