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