]> jfr.im git - irc/evilnet/x3.git/blame - src/opserv.help
This needs more testing *hint hint* rubin :P I diff'ed srvx 1.3.1 to 1.3 then picked...
[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).",
4ec29502 159 "\"ACCESS *\" will show the access levels of everyone.",
d2dce5ac 160 "Access level: $b${level/access}$b",
182dd032 161 "$uSee Also:$u commands, modcmd"
162 );
d2dce5ac 163
d76ed9a9 164"ADDALERT" ("/msg $O ADDALERT <name> <reaction> <criteria>",
165 "Adds the specified alert to the $b$O$b alert list.",
182dd032 166 "Alerts watch for users matching a givin criteria and perform an action on them.",
167 " <name> - An alphanumeric word to identify this alert in the list",
168 " <reaction> - What to do if a user matches the criteria. See $bALERT REACTION$b.",
169 " <criteria> - What to look for. See $bTRACE CRITERIA$b.",
d2dce5ac 170 "Access level: $b${level/addalert}$b",
171 "$uSee Also:$u delalert, alert reaction, trace criteria"
172 );
173
b1bf690d 174"TIME NOTATION" (
182dd032 175 " Many commands require a duration perameter ",
176 " which all use the same syntax: ",
177 " 1s - 1 second ",
178 " 2m - 2 minutes ",
179 " 3h - 3 hours ",
180 " 4d - 4 days ",
181 " 5w - 5 weeks ",
182 " 6M - 6 months",
183 " 1y - 1 year",
184 " Times can be compounded such as: ",
185 " 1m40s - 1 minute and 40 seconds ",
b1bf690d 186 " 5h20m30s - 5 hours 20 minutes and 30 seconds "
182dd032 187 );
188
d76ed9a9 189"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
182dd032 190 "Extends the clone kill limit for the specified <ip> to <count> for <duration>.",
191 "<duration> uses $btime notation$b",
d76ed9a9 192 "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 193 "Access level: $b${level/addtrust}$b",
182dd032 194 "$uSee Also:$u deltrust, stats trusted, time notation"
d2dce5ac 195 );
196
d76ed9a9 197"ALERT REACTION" ("$bALERT REACTION$b",
198 "Valid alert actions (to be taken when an alert is hit) are:",
199 "$bNOTICE$b: Send a notice to the $b$O$b alert channel",
200 "$bKILL$b: Disconnect the user",
9a75756e 201 "$bSILENT$b Same as GLINE, except AUTO: is appended to make the gline silent",
d76ed9a9 202 "$bGLINE$b: Gline the user that tripped the alert",
d914d1cb 203 "$bSHUN$b : Shun the user that tripped the alert",
182dd032 204 "$uSee Also:$u addalert, delalert"
205 );
d2dce5ac 206
d76ed9a9 207"DELALERT" ("/msg $O DELALERT <alert> [alert]...",
208 "Remove the specified alerts from the $b$O$b alert list.",
182dd032 209 "Access level: $b${level/delalert}$b",
210 "$uSee Also:$u addalert, stats"
211 );
d2dce5ac 212
d76ed9a9 213"DELTRUST" ("/msg $O DELTRUST <ip>",
214 "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 215 "Access level: $b${level/deltrust}$b",
216 "$uSee Also:$u addtrust, stats"
217 );
d2dce5ac 218
d76ed9a9 219"INVITEME" ("/msg $O INVITEME [nick]",
220 "Invites the specified user (if omitted, you) to $O's debug channel.",
182dd032 221 "This is currently pointless, since no output is sent to the debug channel.",
222 "Access level: $b${level/inviteme}$b",
223 "$uSee Also:$u invite, clearmodes, clearbans"
224 );
d2dce5ac 225
d76ed9a9 226"TRACE" ("/msg $O TRACE <action> <criteria> <value> [<criteria> <value>]...",
d2dce5ac 227 "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 228 "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, SHUN, GAG, DOMAINS",
27eaa617 229 "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 230 "Access level: $b${level/trace}$b",
231 "$uSee Also:$u trace action, trace criteria"
232 );
d2dce5ac 233
d76ed9a9 234"TRACE ACTION" ("$bTRACE ACTION$b",
235 "Options for action in $btrace$b are:",
236 "$bPRINT$b: Display the hostmask to you.",
237 "$bCOUNT$b: Count all matching users.",
238 "$bKILL$b: Kill matching clients.",
239 "$bGLINE$b: Issue a gline for the client's host (by default, 1 hour long).",
d914d1cb 240 "$bSHUN$b: Issue a shun for the client's host (by default, 1 hour long).",
d76ed9a9 241 "$bGAG$b: Gag all matching users (by default, does not expire).",
242 "$bDOMAINS$b: Display counts of users in each domain (length specified by DEPTH criteria.",
d914d1cb 243 "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 244 "$uSee Also:$u trace criteria, trace"
245 );
d2dce5ac 246
d76ed9a9 247"TRACE CRITERIA" ("$bTRACE CRITERIA$b",
248 "Criteria and values for $btrace$b (a search with $btrace$b must match all specified items):",
249 "$bMASK$b nick!user@host Specifies a full hostmask to search for.",
250 "$bNICK$b nick Specifies a nick to search for.",
251 "$bIDENT$b ident Specifies an ident to search for.",
252 "$bHOST$b host Specifies a hostname to search for.",
253 "$bINFO$b infoline Specifies a user's info to search for.",
254 "$bSERVER$b server Specifies a server to search for.",
255 "$bIP$b 127.0.0.1 Specifies an IP to search for (independent of hostname).",
256 "$bACCOUNT$b account Specifies an account to search for.",
257 "$bAUTHED$b yes/no Specifies if matching users must be authenticated with $N or not",
258 "$bCHANNEL$b #target Specifies a channel the client must be in.",
259 "$bNUMCHANNELS$b 5 Specifies a number of channels the client must be in.",
260 "$bLIMIT$b 50 Limits the number of responses to a certain number.",
261 "$bNICKAGE$b cmp Client has had nick this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
6762ab9f 262 "$bLINKED$b cmp Connected to the network this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
d76ed9a9 263 "$bACCESS$b cmp Access constraints (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
d914d1cb 264 "$bREASON$b reason Reason for kill, gline or shun (must be listed last).",
d76ed9a9 265 "$bDEPTH$b depth How many domain-name parts to use for $bDOMAINS$b action.",
6762ab9f 266 "$bDURATION$b duration How long to apply a G-line or gag (see $C help topic $bdurations$b).",
d76ed9a9 267 "$bCLONES$b min Ignore clients from hosts with fewer than this many connections.",
268 "$bINFO_SPACE$b yes/no Clients match only if their info starts with a space (' ') character.",
269 "$bABUSE OPERS$b Force adverse actions to affect opers as well.",
270 "$bLOG$b Record matching users in $O's log file (in addition to acting).",
27eaa617 271 "$bREGEX$b yes/no Specifies if NICK/IDENT/HOST/INFO should be treated as a regular expression.",
182dd032 272 "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 273 "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 274 "$uSee Also:$u trace action, trace"
275 );
d2dce5ac 276
d76ed9a9 277"WHOIS" ("/msg $O WHOIS <nick>",
182dd032 278 "Displays detailed information for the named user.",
279 "Access level: $b${level/whois}$b",
280 );
d2dce5ac 281
d76ed9a9 282"CHANINFO" ("/msg $O CHANINFO <#channel> [users]",
283 "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 284 "Access level: $b${level/chaninfo}$b",
285 "$uSee Also:$u whois"
286 );
d2dce5ac 287
d76ed9a9 288"CSEARCH" ("/msg $O CSEARCH <action> <criteria> <value> [<criteria> <value>]...",
289 "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 290 "Access level: $b${level/csearch}$b",
291 "$uSee Also:$u csearch action, csearch criteria"
292 );
d2dce5ac 293
d76ed9a9 294"CSEARCH ACTION" ("$bCSEARCH ACTION$b",
295 "Options for action in $bcsearch$b are:",
296 "$bPRINT$b: Display the channel and user count.",
182dd032 297 "$bCOUNT$b: Count all matching channels."
298 );
d2dce5ac 299
d76ed9a9 300"CSEARCH CRITERIA" ("$bCSEARCH CRITERIA$b",
301 "Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
302 "$bNAME$b name Specifies a name to search for.",
303 "$bTOPIC$b topic Specifies a topic to search for.",
304 "$bUSERS$b cmp User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
305 "$bTIMESTAMP$b cmp Timestamp constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu; supports interval notation)",
182dd032 306 "$bLIMIT$b 50 Limits the number of responses to a certain number."
307 );
d2dce5ac 308
d76ed9a9 309"JOIN" ("/msg $O JOIN <#channel> ",
310 "Makes $b$O$b join the specified channel.",
182dd032 311 "Access level: $b${level/join}$b",
312 "$uSee Also:$u part"
313 );
d2dce5ac 314
d76ed9a9 315"PART" ("/msg $O PART <#channel> ",
316 "Makes $b$O$b leave the specified channel.",
182dd032 317 "Access level: $b${level/part}$b",
318 "$uSee Also:$u join"
319 );
d2dce5ac 320
d76ed9a9 321"ADDBAD" ("/msg $O ADDBAD <word>",
322 "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 323 "Access level: $b${level/addbad}$b",
de9510bc 324 "$uSee Also:$u addexempt, delbad, stats bad, $C:noregister"
182dd032 325 );
d2dce5ac 326
d76ed9a9 327"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
328 "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.",
329 "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.",
330 "The current exempt list is displayed with the current bad-words in $bstats bad$b.",
182dd032 331 "Access level: $b${level/addexempt}$b",
332 "$uSee Also:$u addbad, delexempt, stats"
333 );
d2dce5ac 334
d76ed9a9 335"DELBAD" ("/msg $O DELBAD <keyword>",
336 "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 337 "Access level: $b${level/delbad}$b",
de9510bc 338 "$uSee Also:$u addbad, delexempt, stats bad, $C:allowregister"
182dd032 339 );
d2dce5ac 340
d76ed9a9 341"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
342 "Removes a channel from $O's bad-word-exempt channel list.",
182dd032 343 "Access level: $b${level/delexempt}$b",
344 "$uSee Also:$u addexempt, delbad, stats"
345 );
d2dce5ac 346
d76ed9a9 347"BAN" ("/msg $O BAN <#channel> <nick|hostmask>",
348 "Bans the specified hostmask from the specified channel.",
349 "If a nick is used instead of hostmask, the hostmask is generated based on the nickname.",
350 "If the channel is omitted, the $bban$b will be done in the channel where the command was given.",
182dd032 351 "Access level: $b${level/ban}$b",
352 "$uSee Also:$u kickban, kickbanall, unban"
353 );
d2dce5ac 354
d76ed9a9 355"UNBAN" ("/msg $O UNBAN <#channel> <hostmask>",
356 "Unbans the specified hostmask from the specified channel.",
357 "If the channel is omitted, the $bunban$b will be done in the channel where the command was given.",
182dd032 358 "Access level: $b${level/unban}$b",
359 "$uSee Also:$u kickban, kickbanall, ban"
360 );
d2dce5ac 361
d76ed9a9 362"CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
363 "Clears all bans in the specified channel.",
364 "If the channel is omitted, then $bclearbans$b will be done in the channel where the command was given.",
182dd032 365 "Access level: $b${level/clearbans}$b",
366 "$uSee Also:$u ban, unban"
367 );
d2dce5ac 368
d76ed9a9 369"CLEARMODES" ("/msg $O CLEARMODES <#channel> ",
370 "Clears the specified channel of all modes.",
371 "If the channel is omitted, then $bclearmodes$b will be done in the channel where the command was given.",
182dd032 372 "Access level: $b${level/clearmodes}$b",
373 "$uSee Also:$u mode"
374 );
d2dce5ac 375
d76ed9a9 376"DEOP" ("/msg $O DEOP <#channel> <nick> [nick]...",
377 "Deops the specified user from the specified channel.",
378 "If the channel is omitted, then $bdeop$b will be done in the channel where the command was given.",
182dd032 379 "Access level: $b${level/deop}$b",
380 "$uSee Also:$u deopall, devoiceall, op, opall"
381 );
d2dce5ac 382
d76ed9a9 383"DEOPALL" ("/msg $O DEOPALL <#channel>",
384 "Deops all members of the specified channel.",
385 "If the channel is omitted, then $bdeopall$b will be done in the channel where the command was given.",
182dd032 386 "Access level: $b${level/deopall}$b",
387 "$uSee Also:$u deop, devoiceall, op, opall"
388 );
d2dce5ac 389
d76ed9a9 390"DEVOICEALL" ("/msg $O DEVOICEALL <#channel>",
391 "Devoice all members of the specified channel who do not have channel ops.",
392 "If the channel is omitted, then $bdevoiceall$b will be done in the channel where the command was given.",
182dd032 393 "Access level: $b${level/devoiceall}$b",
394 "$uSee Also:$u deop, deopall, op, opall"
395 );
d2dce5ac 396
d76ed9a9 397"KICK" ("/msg $O KICK <#channel> <nick> [reason]",
398 "Kicks the specified user from the specified channel.",
399 "If the channel is omitted, then $bkick$b will be done in the channel where the command was given.",
182dd032 400 "Access level: $b${level/kick}$b",
401 "$uSee Also:$u ban, kickall, kickban, kickbanall"
402 );
d2dce5ac 403
d76ed9a9 404"KICKALL" ("/msg $O KICKALL <#channel> [reason]",
405 "Kicks all users in the specified channel except for the user issuing the command.",
406 "If the channel is omitted, then $bkickall$b will be done in the channel where the command was given.",
182dd032 407 "Access level: $b${level/kickall}$b",
408 "$uSee Also:$u ban, kick, kickbanall"
409 );
d2dce5ac 410
d76ed9a9 411"KICKBAN" ("/msg $O KICKBAN <#channel> <nick> [reason]",
412 "Kicks and bans the specified user. $b$O$b determines the hostmask to ban from the nick specified.",
413 "If the channel is omitted, then $bkickban$b will be done in the channel where the command was given.",
182dd032 414 "Access level: $b${level/kickban}$b",
415 "$uSee Also:$u ban, kickall, kickbanall"
416 );
d2dce5ac 417
d76ed9a9 418"KICKBANALL" ("/msg $O KICKBANALL <#channel> [reason]",
419 "Kick and bans all members of the specified channel except for the user issuing the command.",
420 "If the channel is omitted, then $bkickbanall$b will be done in the channel where the command was given.",
182dd032 421 "Access level: $b${level/kickbanall}$b",
422 "$uSee Also:$u ban, kick, kickban"
423 );
d2dce5ac 424
d76ed9a9 425"MODE" ("/msg $O MODE <#channel> <+/- mode>",
426 "Sets the specified modes (but cannot include voice, ban or op changes) on a channel.",
427 "If the channel is omitted, then $bmode$b will be done in the channel where the command was given.",
182dd032 428 "Access level: $b${level/mode}$b",
429 "$uSee Also:$u ban, deop, kickban, op"
430 );
d2dce5ac 431
d76ed9a9 432"OP" ("/msg $O OP <#channel> <nick> [nick]...",
433 "Ops specified nicknames the specified channel.",
434 "If the channel is omitted, then $bop$b will be done in the channel where the command was given.",
182dd032 435 "Access level: $b${level/op}$b",
436 "$uSee Also:$u deop, deopall, opall"
437 );
d2dce5ac 438
d76ed9a9 439"OPALL" ("/msg $O OPALL <#channel>",
440 "Ops all members of the specified channel.",
441 "If the channel is omitted, then $bopall$b will be done in the channel where the command was given.",
182dd032 442 "Access level: $b${level/opall}$b",
443 "$uSee Also:$u deopall"
444 );
d2dce5ac 445
d76ed9a9 446"VOICEALL" ("/msg $O VOICEALL <#channel>",
447 "Voices all members of the specified channel who do not have channel ops.",
448 "If the channel is omitted, then $bvoiceall$b will be done in the channel where the command was given.",
182dd032 449 "Access level: $b${level/voiceall}$b",
450 "$uSee Also:$u opall, deopall, devoiceall"
451 );
d76ed9a9 452
453"GLINES" ("$bGLINE COMMANDS$b",
454 "Searches for, issues, and removes G-lines (network-global K-lines).",
455 " BLOCK [${level/block}]",
456 " GLINE [${level/gline}]",
457 " GTRACE [${level/gtrace}]",
458 " GSYNC [${level/gsync}]",
459 " REFRESHG [${level/refreshg}]",
182dd032 460 " UNGLINE [${level/ungline}]"
461 );
d2dce5ac 462
d76ed9a9 463"BLOCK" ("/msg $O BLOCK <nick> [reason]",
464 "GLINES the host of the specified nick for one hour If no reason is given, use a default reason.",
182dd032 465 "Access level: $b${level/block}$b",
466 "$uSee Also:$u gline, ungline"
467 );
d2dce5ac 468
d76ed9a9 469"GLINE" ("/msg $O GLINE <user@host> <duration> <reason>",
470 "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 471 "duration is in the form nnm, where nn is a number, and m is a charactor representing the unit (eg d for days.)",
182dd032 472 "Access level: $b${level/gline}$b",
6762ab9f 473 "$uSee Also:$u trace, ungline, ($C) durations"
182dd032 474 );
d2dce5ac 475
d76ed9a9 476"GTRACE" ("/msg $O GTRACE <action> <criteria> [<criteria> <value>]...",
477 "Searches through the glines, much like $bTRACE$b does for users.",
182dd032 478 "Access level: $b${level/gtrace}$b",
479 "$uSee Also:$u trace, gtrace action, gtrace criteria"
480 );
d2dce5ac 481
d76ed9a9 482"GTRACE ACTION" ("$bGTRACE ACTION$b",
483 "Options for the action in $bgtrace$b are:",
484 "$bPRINT$b: Display the glines (mask, issuer, expiration time, reason)",
485 "$bCOUNT$b: Count the number of matching glines",
182dd032 486 "$bUNGLINE$b: Remove matching glines",
487 "$uSee Also:$u gtrace criteria, gtrace"
488 );
d2dce5ac 489
d76ed9a9 490"GTRACE CRITERIA" ("$bGTRACE CRITERIA$b",
491 "Criteria and values for $bgtrace$b (a search with $bgtrace$b must match all the criteria you give):",
492 "$bMASK SUPERSET$b user@host G-line matches if it applies to someone with this hostmask.",
493 "$bMASK SUBSET$b user@host G-line matches if this hostmask \"covers\" the G-line target.",
494 "$bMASK EXACT$b user@host G-line matches only if the target is exactly this.",
495 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
496 "$bLIMIT$b count Limits the number of matching glines.",
497 "$bREASON$b reason Looks for glines with the given reason.",
498 "$bISSUER$b account Looks for glines issued by the given account.",
182dd032 499 "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.",
500 "$uSee Also:$u gtrace action, gtrace"
501 );
d2dce5ac 502
d76ed9a9 503"GSYNC" ("/msg $O GSYNC [server]",
ceafd592 504 "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 505 "Access level: $b${level/gsync}$b",
506 "$uSee Also:$u refreshg, gline, ungline"
507 );
d2dce5ac 508
d76ed9a9 509"REFRESHG" ("/msg $O REFRESHG [server]",
510 "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 511 "Access level: $b${level/refreshg}$b",
512 "$uSee Also:$u gline, ungline, gsync"
513 );
d2dce5ac 514
d76ed9a9 515"UNGLINE" ("/msg $O UNGLINE <user@host>",
516 "Removes a gline from the network before it expires.",
182dd032 517 "Access level: $b${level/ungline}$b",
518 "$uSee Also:$u gline"
519 );
d2dce5ac 520
d914d1cb 521"SHUN" ("$bSHUN COMMANDS$b",
522 "Searches for, issues, and removes Shuns.",
523 " SBLOCK [${level/sblock}]",
524 " SHUN [${level/shun}]",
525 " STRACE [${level/strace}]",
526 " SSYNC [${level/ssync}]",
527 " REFRESHS [${level/refreshs}]",
528 " UNSHUN [${level/unshun}]"
529 );
530
531"SBLOCK" ("/msg $O SBLOCK <nick> [reason]",
532 "SHUNS the host of the specified nick for one hour If no reason is given, use a default reason.",
533 "Access level: $b${level/sblock}$b",
534 "$uSee Also:$u shun, unshun"
535 );
536
537"SHUN" ("/msg $O SHUN <user@host> <duration> <reason>",
538 "Issues a SHUN on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
539 "Access level: $b${level/shun}$b",
540 "$uSee Also:$u trace, unshun"
541 );
542
543"STRACE" ("/msg $O STRACE <action> <criteria> [<criteria> <value>]...",
544 "Searches through the shuns, much like $bTRACE$b does for users.",
545 "Access level: $b${level/strace}$b",
546 "$uSee Also:$u trace, strace action, strace criteria"
547 );
548
549"STRACE ACTION" ("$bSTRACE ACTION$b",
550 "Options for the action in $bstrace$b are:",
551 "$bPRINT$b: Display the shuns (mask, issuer, expiration time, reason)",
552 "$bCOUNT$b: Count the number of matching shuns",
553 "$bUNSHUN$b: Remove matching shuns",
554 "$uSee Also:$u strace criteria, strace"
555 );
556
557"STRACE CRITERIA" ("$bSTRACE CRITERIA$b",
558 "Criteria and values for $bstrace$b (a search with $bstrace$b must match all the criteria you give):",
559 "$bMASK SUPERSET$b user@host Shun matches if it applies to someone with this hostmask.",
560 "$bMASK SUBSET$b user@host Shun matches if this hostmask \"covers\" the Shun target.",
561 "$bMASK EXACT$b user@host Shun matches only if the target is exactly this.",
562 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
563 "$bLIMIT$b count Limits the number of matching shuns.",
564 "$bREASON$b reason Looks for shuns with the given reason.",
565 "$bISSUER$b account Looks for shuns issued by the given account.",
566 "$bAFTER$b interval Looks for shuns that expire more than $binterval$b in the future.",
567 "$uSee Also:$u strace action, strace"
568 );
569
570"SSYNC" ("/msg $O SSYNC [server]",
571 "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.",
572 "Access level: $b${level/ssync}$b",
573 "$uSee Also:$u refreshs, shun, unshun"
574 );
575
576"REFRESHS" ("/msg $O REFRESHS [server]",
577 "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.",
578 "Access level: $b${level/refreshs}$b",
579 "$uSee Also:$u shun, unshun, ssync"
580 );
581
582"UNSHUN" ("/msg $O UNSHUN <user@host>",
583 "Removes a shun from the network before it expires.",
584 "Access level: $b${level/unshun}$b",
585 "$uSee Also:$u shun"
586 );
587
d76ed9a9 588"CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
589 "Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
590 "$bADD$b: Adds a new clone. Arguments: <nickname> <user@host> <info>",
591 "$bREMOVE$b: Removes a clone. Arguments: <nickname>",
592 "$bJOIN$b: Joins a clone to a channel. Arguments: <nickname> <channel>",
593 "$bPART$b: Parts a clone from a channel. Arguments: <nickname> <channel>",
594 "$bOP$b: Ops a clone in a channel. Arguments: <nickname> <channel>",
182dd032 595 "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>",
596 "Access level: $b${level/clone}$b",
597 "$uSee Also:$u collide, reserve, jupe"
598 );
d2dce5ac 599
d76ed9a9 600"COLLIDE" ("/msg $O COLLIDE <nick> <ident> <host> <description>",
601 "Creates a clone with the specified properties, colliding any existing user with the same nick.",
182dd032 602 "Access level: $b${level/collide}$b",
603 "$uSee Also:$u clone, reserve, jupe"
604 );
d2dce5ac 605
d76ed9a9 606"JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
ceafd592 607 "Causes X3 to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
182dd032 608 "Access level: $b${level/jupe}$b",
609 "$uSee Also:$u unjupe, clone, reserve"
610 );
d2dce5ac 611
d76ed9a9 612"RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
ceafd592 613 "Used to ban, protect, or jupe a given nick. Unlike $bclone$b and $bcollide$b, reserved nicks are saved across restarts of X3.",
182dd032 614 "Access level: $b${level/reserve}$b",
615 "$uSee Also:$u unreserve, clone, jupe"
616 );
d2dce5ac 617
d76ed9a9 618"UNJUPE" ("/msg $O UNJUPE <srvname>",
ceafd592 619 "Causes X3 to unjupe a jupe server.",
182dd032 620 "Access level: $b${level/unjupe}$b",
621 "$uSee Also:$u jupe, unreserve, clone"
622 );
d2dce5ac 623
d76ed9a9 624"UNRESERVE" ("/msg $O UNRESERVE <nick>",
625 "Removes a nick from $b$O's$b reserve list.",
182dd032 626 "Access level: $b${level/unreserve}$b",
627 "$uSee Also:$u reserve, clone, unjupe"
628 );
d76ed9a9 629
d76ed9a9 630"LOG" ("/msg $O LOG <criteria> <value> [<criteria> <value>]...",
631 "Searches services logs based on critera specified and displays the results.",
632 "Criteria and associated values (a search match all specified items):",
633 "$bBOT$b - A service bot's name (for example, $O).",
634 "$bCHANNEL$b - The channel where a command was issued (accepts wildcards).",
635 "$bNICK$b - The nickname issuing the command (accepts wildcards).",
636 "$bACCOUNT$b - The account of the user who issued the command (accepts wildcards).",
637 "$bHOSTMASK$b - The ident@host of the user who issued the command (accepts wildcards).",
638 "$bAGE$b - Age of commands to find (for example, 1m or >3m).",
639 "$bLIMIT$b - Maximum number of results to show.",
640 "$bLEVEL$b - Comma-separated list of COMMAND, OVERRIDE, STAFF, to return only those commands.",
641 "$bTYPE$b - Name of module that generated log (see $bSTATS MODULES$b).",
182dd032 642 "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.",
643 "Access level: $b${level/log}$b",
644 "$uSee Also:$u reopen"
645 );
d2dce5ac 646
d76ed9a9 647"REOPEN" ("/msg $O REOPEN",
648 "Close and re-open all the log files.",
182dd032 649 "$uSee Also:$u log, rehash, write, writeall, readhelp"
650 );
d2dce5ac 651
d76ed9a9 652"DIE" ("/msg $O DIE <reason>",
ceafd592 653 "SQUIT X3 with the given reason and shuts it down.",
182dd032 654 "Access level: $b${level/die}$b",
655 "$uSee Also:$u restart, reconnect, jump"
656 );
657
d76ed9a9 658"JUMP" ("/msg $O JUMP <uplink>",
ceafd592 659 "Causes X3 to connect to the specified uplink.",
182dd032 660 "Access level: $b${level/jump}$b",
661 "$uSee Also:$u reconnect, restart, die"
662 );
d2dce5ac 663
d76ed9a9 664"RECONNECT" ("/msg $O RECONNECT ",
ceafd592 665 "Causes X3 to reconnect to its current uplink.",
182dd032 666 "Access level: $b${level/reconnect}$b",
667 "$uSee Also:$u jump, rehash, restart, die"
668 );
d2dce5ac 669
d76ed9a9 670"REHASH" ("/msg $O REHASH",
ceafd592 671 "Causes X3 to re-read its configuration file and update its state as much as possible.",
182dd032 672 "Access level: $b${level/rehash}$b",
673 "$uSee Also:$u die, reconnect, jump, restart"
674 );
d2dce5ac 675
d76ed9a9 676"RESTART" ("/msg $O RESTART <reason>",
ceafd592 677 "Causes X3 to SQUIT with the specified reason and restart.",
182dd032 678 "Access level: $b${level/restart}$b",
679 "$uSee Also:$u reconnect, rehash, die"
680 );
d2dce5ac 681
d76ed9a9 682"GAG" ("/msg $O GAG <mask> <duration> <reason>",
de9510bc 683 "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.",
684 "The gag will automatically expire after $b<duration>$b (or last forever if that is zero).",
182dd032 685 "Access level: $b${level/gag}$b",
de9510bc 686 "$uSee Also:$u ungag, trace, stats gags"
182dd032 687 );
d2dce5ac 688
d76ed9a9 689"HELPSERV" ("/msg $O HELPSERV <command>",
690 "Sends a command to the HelpServ system. It is used for all \"override\" commands, as well as registration and unregistration.",
182dd032 691 "$uSee also:$u /msg $O HELPSERV HELP"
692 );
d2dce5ac 693
258d1427 694"QUERY" ("/msg $O QUERY [key][/<sub-key>[/<sub-sub-key>]...]",
695 "Displays the value of the given configuration key. ",
696 "If the key is a composite entry, show the subkeys inside it.",
697 "Examples:",
698 " QUERY - shows 1st level keys ",
699 " QUERY services/chanserv - shows list of chanserv settings ",
700 " QUERY services/chanserv/chan_expire_delay - shows value ",
182dd032 701 "Access level: $b${level/query}$b",
702 "$uSee Also:$u set, rehash"
703 );
d2dce5ac 704
d76ed9a9 705"SET" ("/msg $O SET <option> <value>",
706 "Modifies the internal configuration database. Currently, only keys that have been previously set may be modified.",
182dd032 707 "Access level: $b${level/set}$b",
708 "$uSee Also:$u query, rehash"
709 );
d2dce5ac 710
d76ed9a9 711"UNGAG" ("/msg $O UNGAG <hostmask>",
de9510bc 712 "Ungags a gaged hostmask.",
182dd032 713 "Access level: $b${level/ungag}$b",
714 "$uSee Also:$u gag, stats gags"
715 );
d2dce5ac 716
d76ed9a9 717"DUMP" ("/msg $O DUMP <raw line>",
718 "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 719 "Access level: $b${level/dump}$b",
720 "$uSee Also:$u raw"
721 );
d2dce5ac 722
d76ed9a9 723"RAW" ("/msg $O RAW <raw line>",
724 "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 725 "Access level: $b${level/raw}$b",
726 "$uSee Also:$u dump"
727 );
d2dce5ac 728
d76ed9a9 729"SETTIME" ("/msg $O SETTIME [servermask] [resync]",
ceafd592 730 "Sets the time on the named server(s) to match the time known to X3.",
d76ed9a9 731 "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 732 "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 733 "Access level: $b${level/settime}$b",
734 "$uSee Also:$u timecmd"
735 );
d2dce5ac 736
d76ed9a9 737"STATS" ("/msg $O STATS <subject>",
738 "Displays statistics about a specified subject. Subjects include:",
739 "$bALERTS$b: The list of current \"alerts\".",
740 "$bBAD$b: Current list of bad words and exempted channels.",
741 "$bGAGS$b: The list of current gags.",
742 "$bGLINES$b: Reports the current number of glines.",
d914d1cb 743 "$bSHUNS$b : Reports the current number of shuns.",
d76ed9a9 744 "$bLINKS$b: Information about the link to the network.",
745 "$bMAX$b: The max clients seen on the network.",
746 "$bNETWORK$b: Displays network information such as total users and how many users are on each server.",
747 "$bNETWORK2$b: Additional information about the network, such as numerics and linked times.",
748 "$bOPERS$b: A list of users that are currently +o.",
ceafd592 749 "$bPROXYCHECK$b: Information about proxy checking in X3.",
d76ed9a9 750 "$bRESERVED$b: The list of currently reserved nicks.",
751 "$bTIMEQ$b: The number of events in the timeq, and how long until the next one.",
752 "$bTRUSTED$b: The list of currently trusted IPs.",
ceafd592 753 "$bUPTIME$b: X3 uptime, lines processed, and CPU time.",
d76ed9a9 754 "$bMODULES$b: Shows loaded modules that implement commands.",
182dd032 755 "$bSERVICES$b: Shows active service bots.",
756 "Access level: $b${level/stats}$b",
757 );
d76ed9a9 758
759"INDEX" "${index}";
d2dce5ac 760