]> jfr.im git - irc/evilnet/x3.git/blame - src/opserv.help
mod-python: generalised the setting of the PYTHONPATH environment variable
[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
a947ef71 216"ADDALERT" ("/msg $O ADDALERT <name> <reaction> [expire <duration>] <criteria>",
d76ed9a9 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.",
a947ef71 221 " <duration> - Duration after which the alert should be deleted. See $bdurations$b.",
182dd032 222 " <criteria> - What to look for. See $bTRACE CRITERIA$b.",
d2dce5ac
AS
223 "Access level: $b${level/addalert}$b",
224 "$uSee Also:$u delalert, alert reaction, trace criteria"
225 );
226
b1bf690d 227"TIME NOTATION" (
182dd032
AS
228 " Many commands require a duration perameter ",
229 " which all use the same syntax: ",
230 " 1s - 1 second ",
231 " 2m - 2 minutes ",
232 " 3h - 3 hours ",
233 " 4d - 4 days ",
234 " 5w - 5 weeks ",
235 " 6M - 6 months",
236 " 1y - 1 year",
237 " Times can be compounded such as: ",
238 " 1m40s - 1 minute and 40 seconds ",
b1bf690d 239 " 5h20m30s - 5 hours 20 minutes and 30 seconds "
182dd032
AS
240 );
241
d76ed9a9 242"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
182dd032
AS
243 "Extends the clone kill limit for the specified <ip> to <count> for <duration>.",
244 "<duration> uses $btime notation$b",
d76ed9a9 245 "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 246 "Access level: $b${level/addtrust}$b",
182dd032 247 "$uSee Also:$u deltrust, stats trusted, time notation"
d2dce5ac
AS
248 );
249
d76ed9a9
AS
250"ALERT REACTION" ("$bALERT REACTION$b",
251 "Valid alert actions (to be taken when an alert is hit) are:",
252 "$bNOTICE$b: Send a notice to the $b$O$b alert channel",
253 "$bKILL$b: Disconnect the user",
254 "$bGLINE$b: Gline the user that tripped the alert",
ec311f39 255 "$bTRACK$b: Send a notice to the $b$O$b alert channel and track the user (if the tracking module is loaded)",
d914d1cb 256 "$bSHUN$b : Shun the user that tripped the alert",
39c1a4ef 257 "$bVERSION$b : Check the version on the user that tripped the alert",
258 "$bSVSJOIN$b : Force the user that tripped the alert to join the target channel",
259 "$bSVSPART$b : Force the user that tripped the alert to part the target channel",
182dd032
AS
260 "$uSee Also:$u addalert, delalert"
261 );
d2dce5ac 262
d76ed9a9
AS
263"DELALERT" ("/msg $O DELALERT <alert> [alert]...",
264 "Remove the specified alerts from the $b$O$b alert list.",
182dd032
AS
265 "Access level: $b${level/delalert}$b",
266 "$uSee Also:$u addalert, stats"
267 );
d2dce5ac 268
d76ed9a9
AS
269"DELTRUST" ("/msg $O DELTRUST <ip>",
270 "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
271 "Access level: $b${level/deltrust}$b",
272 "$uSee Also:$u addtrust, stats"
273 );
d2dce5ac 274
d76ed9a9
AS
275"INVITEME" ("/msg $O INVITEME [nick]",
276 "Invites the specified user (if omitted, you) to $O's debug channel.",
182dd032
AS
277 "This is currently pointless, since no output is sent to the debug channel.",
278 "Access level: $b${level/inviteme}$b",
279 "$uSee Also:$u invite, clearmodes, clearbans"
280 );
d2dce5ac 281
d76ed9a9 282"TRACE" ("/msg $O TRACE <action> <criteria> <value> [<criteria> <value>]...",
d2dce5ac 283 "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 284 "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, SHUN, GAG, DOMAINS, SVSJOIN, SVSPART, VERSION",
2c00fbc2 285 "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
286 "Access level: $b${level/trace}$b",
287 "$uSee Also:$u trace action, trace criteria"
288 );
d2dce5ac 289
d76ed9a9
AS
290"TRACE ACTION" ("$bTRACE ACTION$b",
291 "Options for action in $btrace$b are:",
292 "$bPRINT$b: Display the hostmask to you.",
293 "$bCOUNT$b: Count all matching users.",
294 "$bKILL$b: Kill matching clients.",
295 "$bGLINE$b: Issue a gline for the client's host (by default, 1 hour long).",
d914d1cb 296 "$bSHUN$b: Issue a shun for the client's host (by default, 1 hour long).",
d76ed9a9
AS
297 "$bGAG$b: Gag all matching users (by default, does not expire).",
298 "$bDOMAINS$b: Display counts of users in each domain (length specified by DEPTH criteria.",
a4f0fe36
AS
299 "$bSVSJOIN$b: Force users to join channel givin in chantarget criteria.",
300 "$bSVSPART$b: Force part the matching clients out of the specified target channel.",
301 "$bVERSION$b: Query for the users CTCP VERSION reply.",
d82cf2f0 302 "$bMARK$b: Set a nefarius 'mark' named via the mark criteria as if the user were in that dnsbl.",
a4f0fe36 303 "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
304 "$uSee Also:$u trace criteria, trace"
305 );
d2dce5ac 306
d76ed9a9
AS
307"TRACE CRITERIA" ("$bTRACE CRITERIA$b",
308 "Criteria and values for $btrace$b (a search with $btrace$b must match all specified items):",
5aa400d2 309 "$bMASK$b nick!user@host Specifies a full hostmask to search for.",
310 "$bNICK$b nick Specifies a nick to search for.",
311 "$bIDENT$b ident Specifies an ident to search for.",
312 "$bHOST$b host Specifies a hostname to search for.",
313 "$bINFO$b infoline Specifies a user's info to search for.",
314 "$bSERVER$b server Specifies a server to search for.",
315 "$bIP$b 127.0.0.1 Specifies an IP to search for (independent of hostname).",
316 "$bACCOUNT$b account Specifies an account to search for.",
317 "$bAUTHED$b yes/no Specifies if matching users must be authenticated with $N or not",
318 "$bCHANNEL$b #target Specifies a channel the client must be in.",
319 "$bNUMCHANNELS$b 5 Specifies a number of channels the client must be in.",
320 "$bLIMIT$b 50 Limits the number of responses to a certain number.",
321 "$bNICKAGE$b cmp Client has had nick this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
322 "$bLINKED$b cmp Connected to the network this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
323 "$bACCESS$b cmp Access constraints (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
324 "$bREASON$b reason Reason for kill, gline or shun (must be listed last).",
325 "$bDEPTH$b depth How many domain-name parts to use for $bDOMAINS$b action.",
326 "$bDURATION$b duration How long to apply a G-line or gag (see $C help topic $bdurations$b).",
327 "$bCLONES$b min Ignore clients from hosts with fewer than this many connections.",
328 "$bINFO_SPACE$b yes/no Clients match only if their info starts with a space (' ') character.",
329 "$bABUSE OPERS$b Force adverse actions to affect opers as well.",
330 "$bLOG$b Record matching users in $O's log file (in addition to acting).",
331 "$bREGEX$b yes/no Specifies if NICK/IDENT/HOST/INFO should be treated as a regular expression.",
332 "$bSILENT$b yes/no If yes, AUTO is prepended to the gline message, making the gline silent in nefarious ircd.",
333 "$bVERSION$b version If they have been queried using the VERSION action and responded, they are matched if the reply they give matches.",
2c00fbc2 334 "$bMARKED$b mark If they have a dnsbl mark matching mark. (e.g. from an X line or alert)",
5aa400d2 335 "$bCHANTARGET$b #channel For use with SVSJOIN action, this specifies the channel they are svsjoined to.",
336 "$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.",
337 "$bMARK$b mark For use with the MARK action, this is what thety are marked with.",
182dd032 338 "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 339 "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
340 "$uSee Also:$u trace action, trace"
341 );
d2dce5ac 342
d76ed9a9 343"WHOIS" ("/msg $O WHOIS <nick>",
182dd032
AS
344 "Displays detailed information for the named user.",
345 "Access level: $b${level/whois}$b",
346 );
d2dce5ac 347
d76ed9a9
AS
348"CHANINFO" ("/msg $O CHANINFO <#channel> [users]",
349 "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
350 "Access level: $b${level/chaninfo}$b",
351 "$uSee Also:$u whois"
352 );
d2dce5ac 353
d76ed9a9
AS
354"CSEARCH" ("/msg $O CSEARCH <action> <criteria> <value> [<criteria> <value>]...",
355 "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
356 "Access level: $b${level/csearch}$b",
357 "$uSee Also:$u csearch action, csearch criteria"
358 );
d2dce5ac 359
d76ed9a9
AS
360"CSEARCH ACTION" ("$bCSEARCH ACTION$b",
361 "Options for action in $bcsearch$b are:",
362 "$bPRINT$b: Display the channel and user count.",
182dd032
AS
363 "$bCOUNT$b: Count all matching channels."
364 );
d2dce5ac 365
d76ed9a9
AS
366"CSEARCH CRITERIA" ("$bCSEARCH CRITERIA$b",
367 "Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
368 "$bNAME$b name Specifies a name to search for.",
369 "$bTOPIC$b topic Specifies a topic to search for.",
370 "$bUSERS$b cmp User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
371 "$bTIMESTAMP$b cmp Timestamp constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu; supports interval notation)",
182dd032
AS
372 "$bLIMIT$b 50 Limits the number of responses to a certain number."
373 );
d2dce5ac 374
d76ed9a9
AS
375"JOIN" ("/msg $O JOIN <#channel> ",
376 "Makes $b$O$b join the specified channel.",
182dd032
AS
377 "Access level: $b${level/join}$b",
378 "$uSee Also:$u part"
379 );
d2dce5ac 380
d76ed9a9
AS
381"PART" ("/msg $O PART <#channel> ",
382 "Makes $b$O$b leave the specified channel.",
182dd032
AS
383 "Access level: $b${level/part}$b",
384 "$uSee Also:$u join"
385 );
d2dce5ac 386
d76ed9a9
AS
387"ADDBAD" ("/msg $O ADDBAD <word>",
388 "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 389 "Access level: $b${level/addbad}$b",
de9510bc 390 "$uSee Also:$u addexempt, delbad, stats bad, $C:noregister"
182dd032 391 );
d2dce5ac 392
d76ed9a9
AS
393"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
394 "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.",
395 "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.",
396 "The current exempt list is displayed with the current bad-words in $bstats bad$b.",
182dd032
AS
397 "Access level: $b${level/addexempt}$b",
398 "$uSee Also:$u addbad, delexempt, stats"
399 );
d2dce5ac 400
d76ed9a9
AS
401"DELBAD" ("/msg $O DELBAD <keyword>",
402 "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 403 "Access level: $b${level/delbad}$b",
de9510bc 404 "$uSee Also:$u addbad, delexempt, stats bad, $C:allowregister"
182dd032 405 );
d2dce5ac 406
d76ed9a9
AS
407"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
408 "Removes a channel from $O's bad-word-exempt channel list.",
182dd032
AS
409 "Access level: $b${level/delexempt}$b",
410 "$uSee Also:$u addexempt, delbad, stats"
411 );
d2dce5ac 412
d76ed9a9
AS
413"BAN" ("/msg $O BAN <#channel> <nick|hostmask>",
414 "Bans the specified hostmask from the specified channel.",
415 "If a nick is used instead of hostmask, the hostmask is generated based on the nickname.",
416 "If the channel is omitted, the $bban$b will be done in the channel where the command was given.",
182dd032
AS
417 "Access level: $b${level/ban}$b",
418 "$uSee Also:$u kickban, kickbanall, unban"
419 );
d2dce5ac 420
d76ed9a9
AS
421"UNBAN" ("/msg $O UNBAN <#channel> <hostmask>",
422 "Unbans the specified hostmask from the specified channel.",
423 "If the channel is omitted, the $bunban$b will be done in the channel where the command was given.",
182dd032
AS
424 "Access level: $b${level/unban}$b",
425 "$uSee Also:$u kickban, kickbanall, ban"
426 );
d2dce5ac 427
d76ed9a9
AS
428"CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
429 "Clears all bans in the specified channel.",
430 "If the channel is omitted, then $bclearbans$b will be done in the channel where the command was given.",
182dd032
AS
431 "Access level: $b${level/clearbans}$b",
432 "$uSee Also:$u ban, unban"
433 );
d2dce5ac 434
d76ed9a9
AS
435"CLEARMODES" ("/msg $O CLEARMODES <#channel> ",
436 "Clears the specified channel of all modes.",
437 "If the channel is omitted, then $bclearmodes$b will be done in the channel where the command was given.",
182dd032
AS
438 "Access level: $b${level/clearmodes}$b",
439 "$uSee Also:$u mode"
440 );
d2dce5ac 441
d76ed9a9
AS
442"DEOP" ("/msg $O DEOP <#channel> <nick> [nick]...",
443 "Deops the specified user from the specified channel.",
444 "If the channel is omitted, then $bdeop$b will be done in the channel where the command was given.",
182dd032
AS
445 "Access level: $b${level/deop}$b",
446 "$uSee Also:$u deopall, devoiceall, op, opall"
447 );
d2dce5ac 448
d76ed9a9
AS
449"DEOPALL" ("/msg $O DEOPALL <#channel>",
450 "Deops all members of the specified channel.",
451 "If the channel is omitted, then $bdeopall$b will be done in the channel where the command was given.",
182dd032
AS
452 "Access level: $b${level/deopall}$b",
453 "$uSee Also:$u deop, devoiceall, op, opall"
454 );
d2dce5ac 455
82794e1b 456"DEHOP" ("/msg $O DEHOP <#channel> <nick> [nick]...",
457 "Dehalfops the specified user from the specified channel.",
458 "If the channel is omitted, then $bdehop$b will be done in the channel where the command was given.",
459 "Access level: $b${level/dehalfop}$b",
460 "$uSee Also:$u dehalfopall, hop, hopall"
461 );
462
463"DEHOPALL" ("/msg $O DEHOPALL <#channel>",
464 "Dehalfops all members of the specified channel.",
465 "If the channel is omitted, then $bdehopall$b will be done in the channel where the command was given.",
466 "Access level: $b${level/dehopall}$b",
467 "$uSee Also:$u dehop, hop, hopall"
468 );
469
d76ed9a9
AS
470"DEVOICEALL" ("/msg $O DEVOICEALL <#channel>",
471 "Devoice all members of the specified channel who do not have channel ops.",
472 "If the channel is omitted, then $bdevoiceall$b will be done in the channel where the command was given.",
182dd032
AS
473 "Access level: $b${level/devoiceall}$b",
474 "$uSee Also:$u deop, deopall, op, opall"
475 );
d2dce5ac 476
d76ed9a9
AS
477"KICK" ("/msg $O KICK <#channel> <nick> [reason]",
478 "Kicks the specified user from the specified channel.",
479 "If the channel is omitted, then $bkick$b will be done in the channel where the command was given.",
182dd032 480 "Access level: $b${level/kick}$b",
0f6fe38c 481 "$uSee Also:$u ban, kickall, kickban, kickbanall"
182dd032 482 );
d2dce5ac 483
d76ed9a9
AS
484"KICKALL" ("/msg $O KICKALL <#channel> [reason]",
485 "Kicks all users in the specified channel except for the user issuing the command.",
486 "If the channel is omitted, then $bkickall$b will be done in the channel where the command was given.",
182dd032
AS
487 "Access level: $b${level/kickall}$b",
488 "$uSee Also:$u ban, kick, kickbanall"
489 );
d2dce5ac 490
d76ed9a9
AS
491"KICKBAN" ("/msg $O KICKBAN <#channel> <nick> [reason]",
492 "Kicks and bans the specified user. $b$O$b determines the hostmask to ban from the nick specified.",
493 "If the channel is omitted, then $bkickban$b will be done in the channel where the command was given.",
182dd032
AS
494 "Access level: $b${level/kickban}$b",
495 "$uSee Also:$u ban, kickall, kickbanall"
496 );
d2dce5ac 497
d76ed9a9
AS
498"KICKBANALL" ("/msg $O KICKBANALL <#channel> [reason]",
499 "Kick and bans all members of the specified channel except for the user issuing the command.",
500 "If the channel is omitted, then $bkickbanall$b will be done in the channel where the command was given.",
182dd032
AS
501 "Access level: $b${level/kickbanall}$b",
502 "$uSee Also:$u ban, kick, kickban"
503 );
d2dce5ac 504
d82cf2f0
AS
505"MARK" ("/msg $O MARK <mark>",
506 "Sets a nefarious 'mark' on the user as if they are in <mark> dnsbl. ",
507 "(shows in /whois and prefixes their host, for easy banning)",
508 "Mark must be a-z0-9 or dash (-) 20 chars or less.",
509 "$uSee Also:$u trace action"
510 );
511
512"SVSJOIN" ("/msg $O SVSJOIN <nick> <#channel>",
513 "Forces nick to join #channel",
514 "$uSee Also:$u svspart, join, trace action"
515 );
516
517"SVSPART" ("/msg $O SVSPART <nick> <#channel>",
518 "Forces nick to part #channel",
519 "$uSee Also:$u svsjoin, part, trace action"
520 );
521
964a842d
AS
522"SVSNICK" ("/msg $O SVSNICK <nick> <newnick>",
523 "Forces nick to change nick to newnick",
524 "$uSee Also:$u svspart, svsjoin"
525 );
526
d76ed9a9
AS
527"MODE" ("/msg $O MODE <#channel> <+/- mode>",
528 "Sets the specified modes (but cannot include voice, ban or op changes) on a channel.",
529 "If the channel is omitted, then $bmode$b will be done in the channel where the command was given.",
182dd032
AS
530 "Access level: $b${level/mode}$b",
531 "$uSee Also:$u ban, deop, kickban, op"
532 );
d2dce5ac 533
d76ed9a9
AS
534"OP" ("/msg $O OP <#channel> <nick> [nick]...",
535 "Ops specified nicknames the specified channel.",
536 "If the channel is omitted, then $bop$b will be done in the channel where the command was given.",
182dd032
AS
537 "Access level: $b${level/op}$b",
538 "$uSee Also:$u deop, deopall, opall"
539 );
d2dce5ac 540
d76ed9a9
AS
541"OPALL" ("/msg $O OPALL <#channel>",
542 "Ops all members of the specified channel.",
543 "If the channel is omitted, then $bopall$b will be done in the channel where the command was given.",
182dd032
AS
544 "Access level: $b${level/opall}$b",
545 "$uSee Also:$u deopall"
546 );
d2dce5ac 547
82794e1b 548"HOP" ("/msg $O HOP <#channel> <nick> [nick]...",
549 "Half ops specified nicknames the specified channel.",
550 "If the channel is omitted, then $bhop$b will be done in the channel where the command was given.",
551 "Access level: $b${level/hop}$b",
552 "$uSee Also:$u dehop, dehopall, hopall"
553 );
554
555"HOPALL" ("/msg $O HOPALL <#channel>",
556 "Half ops all members of the specified channel.",
557 "If the channel is omitted, then $bhopall$b will be done in the channel where the command was given.",
558 "Access level: $b${level/hopall}$b",
559 "$uSee Also:$u dehopall"
560 );
561
d76ed9a9
AS
562"VOICEALL" ("/msg $O VOICEALL <#channel>",
563 "Voices all members of the specified channel who do not have channel ops.",
564 "If the channel is omitted, then $bvoiceall$b will be done in the channel where the command was given.",
182dd032
AS
565 "Access level: $b${level/voiceall}$b",
566 "$uSee Also:$u opall, deopall, devoiceall"
567 );
d76ed9a9
AS
568
569"GLINES" ("$bGLINE COMMANDS$b",
570 "Searches for, issues, and removes G-lines (network-global K-lines).",
571 " BLOCK [${level/block}]",
572 " GLINE [${level/gline}]",
573 " GTRACE [${level/gtrace}]",
574 " GSYNC [${level/gsync}]",
575 " REFRESHG [${level/refreshg}]",
182dd032
AS
576 " UNGLINE [${level/ungline}]"
577 );
d2dce5ac 578
d76ed9a9
AS
579"BLOCK" ("/msg $O BLOCK <nick> [reason]",
580 "GLINES the host of the specified nick for one hour If no reason is given, use a default reason.",
182dd032
AS
581 "Access level: $b${level/block}$b",
582 "$uSee Also:$u gline, ungline"
583 );
d2dce5ac 584
d76ed9a9
AS
585"GLINE" ("/msg $O GLINE <user@host> <duration> <reason>",
586 "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 587 "duration is in the form nnm, where nn is a number, and m is a charactor representing the unit (eg d for days.)",
182dd032 588 "Access level: $b${level/gline}$b",
6762ab9f 589 "$uSee Also:$u trace, ungline, ($C) durations"
182dd032 590 );
d2dce5ac 591
d76ed9a9
AS
592"GTRACE" ("/msg $O GTRACE <action> <criteria> [<criteria> <value>]...",
593 "Searches through the glines, much like $bTRACE$b does for users.",
182dd032
AS
594 "Access level: $b${level/gtrace}$b",
595 "$uSee Also:$u trace, gtrace action, gtrace criteria"
596 );
d2dce5ac 597
d76ed9a9
AS
598"GTRACE ACTION" ("$bGTRACE ACTION$b",
599 "Options for the action in $bgtrace$b are:",
600 "$bPRINT$b: Display the glines (mask, issuer, expiration time, reason)",
601 "$bCOUNT$b: Count the number of matching glines",
182dd032
AS
602 "$bUNGLINE$b: Remove matching glines",
603 "$uSee Also:$u gtrace criteria, gtrace"
604 );
d2dce5ac 605
d76ed9a9
AS
606"GTRACE CRITERIA" ("$bGTRACE CRITERIA$b",
607 "Criteria and values for $bgtrace$b (a search with $bgtrace$b must match all the criteria you give):",
608 "$bMASK SUPERSET$b user@host G-line matches if it applies to someone with this hostmask.",
609 "$bMASK SUBSET$b user@host G-line matches if this hostmask \"covers\" the G-line target.",
610 "$bMASK EXACT$b user@host G-line matches only if the target is exactly this.",
611 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
612 "$bLIMIT$b count Limits the number of matching glines.",
613 "$bREASON$b reason Looks for glines with the given reason.",
614 "$bISSUER$b account Looks for glines issued by the given account.",
182dd032
AS
615 "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.",
616 "$uSee Also:$u gtrace action, gtrace"
617 );
d2dce5ac 618
d76ed9a9 619"GSYNC" ("/msg $O GSYNC [server]",
ceafd592 620 "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
621 "Access level: $b${level/gsync}$b",
622 "$uSee Also:$u refreshg, gline, ungline"
623 );
d2dce5ac 624
08895577 625"DEFCON" ("/msg $O DEFCON [1|2|3|4|5]",
626 "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",
627 "Access level: $b${level/defcon}$b",
628 );
629
d76ed9a9
AS
630"REFRESHG" ("/msg $O REFRESHG [server]",
631 "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
632 "Access level: $b${level/refreshg}$b",
633 "$uSee Also:$u gline, ungline, gsync"
634 );
d2dce5ac 635
d76ed9a9
AS
636"UNGLINE" ("/msg $O UNGLINE <user@host>",
637 "Removes a gline from the network before it expires.",
182dd032
AS
638 "Access level: $b${level/ungline}$b",
639 "$uSee Also:$u gline"
640 );
d2dce5ac 641
d914d1cb 642"SHUN" ("$bSHUN COMMANDS$b",
643 "Searches for, issues, and removes Shuns.",
644 " SBLOCK [${level/sblock}]",
645 " SHUN [${level/shun}]",
646 " STRACE [${level/strace}]",
647 " SSYNC [${level/ssync}]",
648 " REFRESHS [${level/refreshs}]",
649 " UNSHUN [${level/unshun}]"
650 );
651
652"SBLOCK" ("/msg $O SBLOCK <nick> [reason]",
653 "SHUNS the host of the specified nick for one hour If no reason is given, use a default reason.",
654 "Access level: $b${level/sblock}$b",
655 "$uSee Also:$u shun, unshun"
656 );
657
658"SHUN" ("/msg $O SHUN <user@host> <duration> <reason>",
659 "Issues a SHUN on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
660 "Access level: $b${level/shun}$b",
661 "$uSee Also:$u trace, unshun"
662 );
663
664"STRACE" ("/msg $O STRACE <action> <criteria> [<criteria> <value>]...",
665 "Searches through the shuns, much like $bTRACE$b does for users.",
666 "Access level: $b${level/strace}$b",
667 "$uSee Also:$u trace, strace action, strace criteria"
668 );
669
670"STRACE ACTION" ("$bSTRACE ACTION$b",
671 "Options for the action in $bstrace$b are:",
672 "$bPRINT$b: Display the shuns (mask, issuer, expiration time, reason)",
673 "$bCOUNT$b: Count the number of matching shuns",
674 "$bUNSHUN$b: Remove matching shuns",
675 "$uSee Also:$u strace criteria, strace"
676 );
677
678"STRACE CRITERIA" ("$bSTRACE CRITERIA$b",
679 "Criteria and values for $bstrace$b (a search with $bstrace$b must match all the criteria you give):",
680 "$bMASK SUPERSET$b user@host Shun matches if it applies to someone with this hostmask.",
681 "$bMASK SUBSET$b user@host Shun matches if this hostmask \"covers\" the Shun target.",
682 "$bMASK EXACT$b user@host Shun matches only if the target is exactly this.",
683 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
684 "$bLIMIT$b count Limits the number of matching shuns.",
685 "$bREASON$b reason Looks for shuns with the given reason.",
686 "$bISSUER$b account Looks for shuns issued by the given account.",
687 "$bAFTER$b interval Looks for shuns that expire more than $binterval$b in the future.",
688 "$uSee Also:$u strace action, strace"
689 );
690
691"SSYNC" ("/msg $O SSYNC [server]",
692 "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.",
693 "Access level: $b${level/ssync}$b",
694 "$uSee Also:$u refreshs, shun, unshun"
695 );
696
697"REFRESHS" ("/msg $O REFRESHS [server]",
698 "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.",
699 "Access level: $b${level/refreshs}$b",
700 "$uSee Also:$u shun, unshun, ssync"
701 );
702
703"UNSHUN" ("/msg $O UNSHUN <user@host>",
704 "Removes a shun from the network before it expires.",
705 "Access level: $b${level/unshun}$b",
706 "$uSee Also:$u shun"
707 );
708
d76ed9a9
AS
709"CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
710 "Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
711 "$bADD$b: Adds a new clone. Arguments: <nickname> <user@host> <info>",
712 "$bREMOVE$b: Removes a clone. Arguments: <nickname>",
713 "$bJOIN$b: Joins a clone to a channel. Arguments: <nickname> <channel>",
714 "$bPART$b: Parts a clone from a channel. Arguments: <nickname> <channel>",
715 "$bOP$b: Ops a clone in a channel. Arguments: <nickname> <channel>",
182dd032
AS
716 "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>",
717 "Access level: $b${level/clone}$b",
718 "$uSee Also:$u collide, reserve, jupe"
719 );
d2dce5ac 720
d76ed9a9
AS
721"COLLIDE" ("/msg $O COLLIDE <nick> <ident> <host> <description>",
722 "Creates a clone with the specified properties, colliding any existing user with the same nick.",
182dd032
AS
723 "Access level: $b${level/collide}$b",
724 "$uSee Also:$u clone, reserve, jupe"
725 );
d2dce5ac 726
d76ed9a9 727"JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
ceafd592 728 "Causes X3 to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
182dd032
AS
729 "Access level: $b${level/jupe}$b",
730 "$uSee Also:$u unjupe, clone, reserve"
731 );
d2dce5ac 732
d76ed9a9 733"RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
ceafd592 734 "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
735 "Access level: $b${level/reserve}$b",
736 "$uSee Also:$u unreserve, clone, jupe"
737 );
d2dce5ac 738
d76ed9a9 739"UNJUPE" ("/msg $O UNJUPE <srvname>",
ceafd592 740 "Causes X3 to unjupe a jupe server.",
182dd032
AS
741 "Access level: $b${level/unjupe}$b",
742 "$uSee Also:$u jupe, unreserve, clone"
743 );
d2dce5ac 744
47956fc5
AS
745"ROUTING ADDPLAN" ("/msg $O ROUTING ADDPLAN <name>",
746 "Creates a new blank routing plan named name.",
747 "You can then use $bROUTING ADDSERVER$b to build it.",
5c6bff84 748 "Use $bSTATS ROUTING [name]$b to view it, and $bROUTING SET ACTIVE$b to activate it.",
47956fc5
AS
749 "$uSee Also:$u routing, stats routing, routing delplan, routing set, routing addserver"
750 );
751"ROUTING DELPLAN" ("/msg $O ROUTING DELPLAN <name>",
752 "Removes the routing plan name, including all the servers that make it up. Use with caution, there is no undo.",
753 "$uSee Also:$u routing, stats routing, routing addplan"
754 );
755
756"ROUTING ADDSERVER" ("/msg $O ROUTING ADDSERVER <plan> <name>[:port] <uplink> [backup uplink]",
757 "Adds a server to the routing plan 'plan'.",
758 " plan - The name of a routing plan already created.",
759 " server - The name of the server you are adding (full hostname).",
760 " 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.",
761 " uplink - This is the server (full hostname) that you want the server to connect to.",
762 " backup uplink - If uplink is offline, this one takes over.",
763 " $b$b ",
764 " 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.",
765 " If you add a server whose name already exists, the old one will be replaced.",
766 "$uSee Also:$u routing, stats routing, routing delserver, routing addplan",
767 );
768
769"ROUTING EXAMPLE" ("An Auto Routing System Example:",
770 " Consider the following map: ",
771 " test.net.org - test's uplink is x3",
772 " |-X3.NET.Services - this is me",
773 " |-laptop.net.org - laptop's uplink is test",
774 " | `-foobar.net.org - foobar's uplink is laptop",
775 " `-test2.net.org - test2's uplink is test",
dd1fc2a3 776 " `-test3.net.org - test3's uplink is test2",
47956fc5
AS
777 " $b$b ",
778 " 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 779 " ROUTING ADDPLAN mylpan ",
47956fc5
AS
780 " ROUTING ADDSERVER myplan test.net.org:4400 x3.net.services ",
781 " ROUTING ADDSERVER myplan test2.net.org:4400 test.net.org ",
782 " ROUTING ADDSERVER myplan test3.net.org:4400 test2.net.org ",
783 " ROUTING ADDSERVER myplan laptop.net.org:4400 test.net.org ",
784 " ROUTING ADDSERVER myplan foobar.net.org:4400 laptop.net.org ",
20517d48 785 " ROUTING SET ACTIVE myplan ",
47956fc5
AS
786 " $b$b ",
787 " 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.",
788 );
789
790"ROUTING DELSERVER" ("/msg $O ROUTING DELSERVER <plan> <server>",
791 "Deletes a server from a routing plan.",
792 "$uSee also:$u routing, stats routing, routing addserver, routing delplan",
793 );
794
795"ROUTING SET" ("/msg $O ROUTING SET [option] [value]",
796 "Changes The Auto Routing System options",
797 " ACTIVE - Sets which routing plan is active. ",
798 " Set to 'none' to disable auto routing.",
799 " RETRY_PERIOD - How often to check for missing servers",
800 " see /msg $C durations for help with units",
801 " CONN_PINGOUT - enable to auto-reconnect servers that ping out",
802 " CONN_READERROR - enable to auto-reconnect servers that squit with a read error",
803 " KARMA - enable to keep track of oft-splitting servers, and try to route around them",
804 " DEFAULT_PORT - If you don't specify a port in $brouting addserver$b, this port is used",
805 " $b$b ",
806 " Issue without any option/value to see the current value(s).",
807 "$uSee also:$u routing, stats routing, routing addserver",
808 );
809
810"ROUTING MAP" ("/msg $O ROUTING MAP",
811 "Shows the currently active routing plan, as parsed and re-centered for use.",
812 "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.",
813 "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.",
814 "The check box [ ] is used to indicate if the current routing of the network conforms to the routing map.",
815 "[X] - Server is linked correctly",
816 "[!] - Server is linked, but not where the plan specifies",
817 "[ ] - Server is not linked to the network at all",
818 " $b$b",
819 "$uSee also:$u routing, stats routing, routing set, routing addserver",
820 );
821
822"REROUTE" ("/msg $O REROUTE <C|N|T>",
823 "Allows $O to make changes to the linkage of the servers on the network. It has 3 modes: Normal, Connect-only, and Test:",
824 " 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.",
825 " C - Connect-only: Will attempt to connect any missing servers to the network, using the active routing plan.",
826 " 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.",
827 " $b$b ",
828 "$uSee also:$u routing, routing map, stats routing",
829 );
830
5c6bff84 831"STATS ROUTING" ("/msg $O STATS ROUTING [planmask]",
47956fc5 832 "Provides information about The Auto Routing System's configuration. You can see the routing plans, and the current routing options.",
5c6bff84 833 " If planmask is provided, you will see the full details for any plans matching the mask (* and ? wildcards)",
47956fc5
AS
834 "$uSee also:$u routing, routing set",
835 );
836
6c34bb5a 837"PRIVSET" ("/msg $O PRIVSET <nick> <+/-flag>",
838 "Allows $O to set flags on users.",
839 "Access level: $b${level/privset}$b",
840 "$uSee also: privflags"
841 );
842
d76ed9a9
AS
843"UNRESERVE" ("/msg $O UNRESERVE <nick>",
844 "Removes a nick from $b$O's$b reserve list.",
182dd032
AS
845 "Access level: $b${level/unreserve}$b",
846 "$uSee Also:$u reserve, clone, unjupe"
847 );
d76ed9a9 848
d76ed9a9
AS
849"LOG" ("/msg $O LOG <criteria> <value> [<criteria> <value>]...",
850 "Searches services logs based on critera specified and displays the results.",
851 "Criteria and associated values (a search match all specified items):",
852 "$bBOT$b - A service bot's name (for example, $O).",
853 "$bCHANNEL$b - The channel where a command was issued (accepts wildcards).",
854 "$bNICK$b - The nickname issuing the command (accepts wildcards).",
855 "$bACCOUNT$b - The account of the user who issued the command (accepts wildcards).",
856 "$bHOSTMASK$b - The ident@host of the user who issued the command (accepts wildcards).",
857 "$bAGE$b - Age of commands to find (for example, 1m or >3m).",
858 "$bLIMIT$b - Maximum number of results to show.",
859 "$bLEVEL$b - Comma-separated list of COMMAND, OVERRIDE, STAFF, to return only those commands.",
860 "$bTYPE$b - Name of module that generated log (see $bSTATS MODULES$b).",
182dd032
AS
861 "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.",
862 "Access level: $b${level/log}$b",
863 "$uSee Also:$u reopen"
864 );
d2dce5ac 865
d76ed9a9
AS
866"REOPEN" ("/msg $O REOPEN",
867 "Close and re-open all the log files.",
182dd032
AS
868 "$uSee Also:$u log, rehash, write, writeall, readhelp"
869 );
d2dce5ac 870
d76ed9a9 871"DIE" ("/msg $O DIE <reason>",
ceafd592 872 "SQUIT X3 with the given reason and shuts it down.",
182dd032
AS
873 "Access level: $b${level/die}$b",
874 "$uSee Also:$u restart, reconnect, jump"
875 );
876
d76ed9a9 877"JUMP" ("/msg $O JUMP <uplink>",
ceafd592 878 "Causes X3 to connect to the specified uplink.",
182dd032
AS
879 "Access level: $b${level/jump}$b",
880 "$uSee Also:$u reconnect, restart, die"
881 );
d2dce5ac 882
d76ed9a9 883"RECONNECT" ("/msg $O RECONNECT ",
ceafd592 884 "Causes X3 to reconnect to its current uplink.",
182dd032
AS
885 "Access level: $b${level/reconnect}$b",
886 "$uSee Also:$u jump, rehash, restart, die"
887 );
d2dce5ac 888
d76ed9a9 889"REHASH" ("/msg $O REHASH",
ceafd592 890 "Causes X3 to re-read its configuration file and update its state as much as possible.",
182dd032
AS
891 "Access level: $b${level/rehash}$b",
892 "$uSee Also:$u die, reconnect, jump, restart"
893 );
d2dce5ac 894
d76ed9a9 895"RESTART" ("/msg $O RESTART <reason>",
ceafd592 896 "Causes X3 to SQUIT with the specified reason and restart.",
182dd032
AS
897 "Access level: $b${level/restart}$b",
898 "$uSee Also:$u reconnect, rehash, die"
899 );
d2dce5ac 900
d76ed9a9 901"GAG" ("/msg $O GAG <mask> <duration> <reason>",
de9510bc
AS
902 "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.",
903 "The gag will automatically expire after $b<duration>$b (or last forever if that is zero).",
182dd032 904 "Access level: $b${level/gag}$b",
de9510bc 905 "$uSee Also:$u ungag, trace, stats gags"
182dd032 906 );
d2dce5ac 907
d76ed9a9
AS
908"HELPSERV" ("/msg $O HELPSERV <command>",
909 "Sends a command to the HelpServ system. It is used for all \"override\" commands, as well as registration and unregistration.",
182dd032
AS
910 "$uSee also:$u /msg $O HELPSERV HELP"
911 );
d2dce5ac 912
258d1427
AS
913"QUERY" ("/msg $O QUERY [key][/<sub-key>[/<sub-sub-key>]...]",
914 "Displays the value of the given configuration key. ",
915 "If the key is a composite entry, show the subkeys inside it.",
916 "Examples:",
917 " QUERY - shows 1st level keys ",
918 " QUERY services/chanserv - shows list of chanserv settings ",
919 " QUERY services/chanserv/chan_expire_delay - shows value ",
182dd032
AS
920 "Access level: $b${level/query}$b",
921 "$uSee Also:$u set, rehash"
922 );
d2dce5ac 923
d76ed9a9
AS
924"SET" ("/msg $O SET <option> <value>",
925 "Modifies the internal configuration database. Currently, only keys that have been previously set may be modified.",
182dd032
AS
926 "Access level: $b${level/set}$b",
927 "$uSee Also:$u query, rehash"
928 );
d2dce5ac 929
d76ed9a9 930"UNGAG" ("/msg $O UNGAG <hostmask>",
de9510bc 931 "Ungags a gaged hostmask.",
182dd032
AS
932 "Access level: $b${level/ungag}$b",
933 "$uSee Also:$u gag, stats gags"
934 );
d2dce5ac 935
d76ed9a9
AS
936"DUMP" ("/msg $O DUMP <raw line>",
937 "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
938 "Access level: $b${level/dump}$b",
939 "$uSee Also:$u raw"
940 );
d2dce5ac 941
d76ed9a9
AS
942"RAW" ("/msg $O RAW <raw line>",
943 "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
944 "Access level: $b${level/raw}$b",
945 "$uSee Also:$u dump"
946 );
d2dce5ac 947
d76ed9a9 948"SETTIME" ("/msg $O SETTIME [servermask] [resync]",
ceafd592 949 "Sets the time on the named server(s) to match the time known to X3.",
d76ed9a9 950 "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 951 "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
952 "Access level: $b${level/settime}$b",
953 "$uSee Also:$u timecmd"
954 );
d2dce5ac 955
d76ed9a9
AS
956"STATS" ("/msg $O STATS <subject>",
957 "Displays statistics about a specified subject. Subjects include:",
958 "$bALERTS$b: The list of current \"alerts\".",
959 "$bBAD$b: Current list of bad words and exempted channels.",
960 "$bGAGS$b: The list of current gags.",
961 "$bGLINES$b: Reports the current number of glines.",
d914d1cb 962 "$bSHUNS$b : Reports the current number of shuns.",
d76ed9a9
AS
963 "$bLINKS$b: Information about the link to the network.",
964 "$bMAX$b: The max clients seen on the network.",
965 "$bNETWORK$b: Displays network information such as total users and how many users are on each server.",
966 "$bNETWORK2$b: Additional information about the network, such as numerics and linked times.",
967 "$bOPERS$b: A list of users that are currently +o.",
ceafd592 968 "$bPROXYCHECK$b: Information about proxy checking in X3.",
d76ed9a9 969 "$bRESERVED$b: The list of currently reserved nicks.",
47956fc5 970 "$bROUTING$b: The routing plans and settings of the Auto Routing System",
d76ed9a9
AS
971 "$bTIMEQ$b: The number of events in the timeq, and how long until the next one.",
972 "$bTRUSTED$b: The list of currently trusted IPs.",
ceafd592 973 "$bUPTIME$b: X3 uptime, lines processed, and CPU time.",
d76ed9a9 974 "$bMODULES$b: Shows loaded modules that implement commands.",
182dd032
AS
975 "$bSERVICES$b: Shows active service bots.",
976 "Access level: $b${level/stats}$b",
eaf715f1
AS
977 "$b$b",
978 "$uSee Also:$u stats alerts"
182dd032 979 );
d76ed9a9 980
eaf715f1
AS
981"STATS ALERTS" ("/msg $O STATS ALERTS [Owner|Filter]",
982 "Show alerts. If a parameter is given, only alerts who match it are shown.",
983 "$b$b",
984 " Owner - the account name of whoever created the alert",
985 " Filter - A wildcard (* and ?) match string compared against the criteria string",
986 "$b$b",
8709474a 987 "Example: STATS ALERTS *nick phil*",
eaf715f1 988 "$uSee Also:$u addalert, delalert, stats"
8709474a 989 );
eaf715f1 990
ec311f39 991"TRACK" ("/msg $O TRACK <+/-type|all|none>",
992 "This specifies what will be tracked in the tracking channel.",
993 "Use + to add flags and - to remove types. Use ALL to enable all",
994 "tracking options available, use NONE to completly disable them.",
995 "Available flags are:",
996 "auth - Auths",
997 "chanmode - Channel Modes",
998 "del - Quits",
999 "join - Joins",
1000 "kick - Kicks",
1001 "new - New Nicks",
1002 "nick - Nick Changes",
1003 "part - Parts",
1004 "umode - Umodes");
1005
1006"ADDTRACK" ("/msg $O ADDTRACK <nick>",
1007 "Adds the given <nick> to the tracking list.",
1008 "$uSee Also:$u deltrack listtrack addalert");
1009
1010"DELTRACK" ("/msg $O DELTRACK <nick>",
1011 "Removes the given <nick> from the tracking list.",
1012 "$uSee Also:$u deltrack listtrack");
1013
1014"LISTTRACK" ("/msg $O LISTTRACK",
1015 "Lists all currently active tracks.",
1016 "$uSee Also:$u addtrack deltrack");
1017
7637f48f 1018"RESETMAX" ("/msg $O RESETMAX",
1019 "Resets the max clients number to the current ammount of connected clients. Use with caution.",
1020 "$uSee Also:$u stats max");
1021
d2dce5ac 1022