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