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