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