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