]> jfr.im git - irc/evilnet/x3.git/blame - src/opserv.help
Cleaning up a bit of a mess
[irc/evilnet/x3.git] / src / opserv.help
CommitLineData
d2dce5ac
AS
1"<INDEX>" ("=------------------ $b$O Help$b ------------------=",
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. ",
8 " $bTRACES$b Powerfull commands for ",
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. ",
17 " $bOWNERONLY$b $O operator only commands. ",
18 "=---------------- End of Help ----------------="
19);
d76ed9a9
AS
20"COMMANDS" "${index}";
21
d2dce5ac
AS
22"PUNISH" ("=------------- $bUser Punishments$b --------------=",
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",
29 " $bGAG$b Cause the services to ignore... ",
30 " $bUNGAG$b ...or unignore by mask.",
31 "=---------------- End of Help ----------------="
32 );
33
34"INFORMATION" ("=----------- $bInformation Gathering$b -----------=",
35 " $bACCESS$b Shows a users $O access level.",
36 " $bSTATS$b Show various lists and runtime info.",
37 " $bWHOIS$b Show details about a user by nick.",
38 " $bVERSION$b Show the $O version information.",
39 " $bLOG$b View $O logs.",
40 " $bTRACES$b Powerfull commands for viewing or acting on lists of IRC objects.",
41 "=--------------- End of Help ----------------="
42 );
43
44"TRACES" ("=------------------ $bTraces$b ------------------=",
45 " $bTRACE$b Search current users and optionally apply an action.",
46 " $bGTRACE$b Search current GLINEs and optionally remove them.",
47 " $bCSEARCH$b Search current channels.",
48 "=--------------- End of Help ----------------="
49 );
50
51"ALERTS" ("=------------------ $bAlerts$b ------------------=",
52 " $bADDALERT$b Make $O automatically do something",
53 " when users match a criteria.",
54 " $bDELALERT$b Remove an alert.",
55 " $bWARN$b Cause activity on a channel to warn",
56 " $b$b ircops.",
57 " $bUNWARN$b Remove a channel activity warning.",
58 "=--------------- End of Help ----------------="
59 );
60
61"CHANNEL" ("=------------- $bChannel Commands$b -------------=",
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.",
80 " $bCLEARMODES$b Clear all modes from a channel.",
81 "=--------------- End of Help ----------------="
82 );
83
84"CLONES" ("=-------------- $bClone handling$b --------------=",
85 " $bADDTRUST$b Add a clone limit exemption for a host.",
86 " $bDELTRUST$b Remove a clone exemption.",
87 " $bEDITTRUST$b Modify a clone exemption.",
88 " $bquery services/opserv/untrusted_max$b",
89 " View the clone kill limit",
90 "=--------------- End of Help ----------------="
91 );
92
93"SETTINGS" ("=----------------- $bSettings$b -----------------=",
94 " $bQUERY$b Show a runtime config setting.",
95 " $bSET$b $uTemporarily$u change a runtime config setting.",
96 "=--------------- End of Help ----------------="
97 );
98
99"ADMIN" ("=---------- $bAdministrative Commands$b ---------=",
100 " $bACCESS$b Modify someone's $O access level.",
101 " $bCOMMAND$b Show details of a command.",
102 " $bSHOWCOMMANDS$b List all commands and required access levels.",
103 " $b$b",
104 " $bBANEMAIL$b Ban an email address from being used by the email system.",
105 " $bUNBANEMAIL$b Remove an email ban.",
106 " $b$b",
107 " $bJOIN$b Make $O join a channel.",
108 " $bPART$b Make $O leave a channel.",
109 " $b$b",
110 " $bCLONE$b Create and manipulate a fake user.",
111 " $bCOLLIDE$b Create a clone, colliding an existing user.",
112 " $bRESERVE$b Permanently reserve a nick with a clone.",
113 " $bUNRESERVE$b Remove a perminant reserved clone.",
114 " $bJUPE$b Create dummy server.",
115 " $bUNJUPE$b Remove a dummy server.",
116 " $b$b",
117 " $bREFRESHG$b Refresh the Glines.",
118 " $bSETTIME$b Synchronize time across the network.",
119 " $bTIMECMD$b Time how long a command runs.",
120 "=--------------- End of Help ----------------="
121 );
122
123"OWNERONLY" ("=------------- $bOwner Only Stuff$b -------------=",
124 " $bWRITE$b Write out a database.",
125 " $bWRITEALL$b Write out ALL databases.",
126 " $bREOPEN$b Close and Re-Open the logs.",
127 " $bREADHELP$b Re-read a help file.",
128 " $bDUMPMESSAGES$b Writes messages to a .db file (for translators).",
129 " $b$b",
130 " $bREHASH$b Re-read the config files.",
131 " $bRESTART$b Quit and re-run srvx.",
132 " $bDIE$b Make the bot quit.",
133 " $bJUMP$b Change uplink servers.",
134 " $bRECONNECT$b Reconnect to this uplink server.",
135 " $bGSYNC$b Pull glines from the givin server into memory.",
136 " $b$b",
137 " $bMODCMD$b Change details of a command.",
138 " $bBIND$b Make a command alias.",
139 " $bUNBIND$b Remove a command alias.",
d2dce5ac
AS
140 " $bHELPFILES$b Change the helpfile priority order.",
141 " $b$b",
142 " $bSERVICE ADD$b Create a new service bot.",
143 " $bSERVICE REMOVE$b Remove a service bot.",
144 " $bSERVICE RENAME$b Rename a service bot.",
145 " $bSERVICE PRIVILEGED$b Sets if only opers can use the service.",
182dd032 146 " $bSERVICE TRIGGER$b Change the command character of a service.",
d2dce5ac
AS
147 " $b$b",
148 " $bADDBAD$b Add a word to the illegal channel word list.",
149 " $bDELBAD$b Remove a word from the illegal channel word list.",
150 " $bADDEXEMPT$b Make an exception to the illegal word list for a channel.",
151 " $bDELEXEMPT$b Remove an exception of the illegal word list.",
152 " $b$b",
153 " $bDUMP$b Drop safetychecked server protocol to the server. ",
154 " $bRAW$b Draw raw server protocol to the server. (DANGEROUS!)",
155 "=--------------- End of Help ----------------="
156 );
157
158
d76ed9a9 159"ACCESS" ("/msg $O ACCESS [nick|*account] [new-level]",
d2dce5ac
AS
160 "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).",
161 "Access level: $b${level/access}$b",
182dd032
AS
162 "$uSee Also:$u commands, modcmd"
163 );
d2dce5ac 164
d76ed9a9
AS
165"ADDALERT" ("/msg $O ADDALERT <name> <reaction> <criteria>",
166 "Adds the specified alert to the $b$O$b alert list.",
182dd032
AS
167 "Alerts watch for users matching a givin criteria and perform an action on them.",
168 " <name> - An alphanumeric word to identify this alert in the list",
169 " <reaction> - What to do if a user matches the criteria. See $bALERT REACTION$b.",
170 " <criteria> - What to look for. See $bTRACE CRITERIA$b.",
d2dce5ac
AS
171 "Access level: $b${level/addalert}$b",
172 "$uSee Also:$u delalert, alert reaction, trace criteria"
173 );
174
182dd032
AS
175"TIME NOTATION" ("=---------------- $bTime Notation$b ---------------=",
176 " Many commands require a duration perameter ",
177 " which all use the same syntax: ",
178 " 1s - 1 second ",
179 " 2m - 2 minutes ",
180 " 3h - 3 hours ",
181 " 4d - 4 days ",
182 " 5w - 5 weeks ",
183 " 6M - 6 months",
184 " 1y - 1 year",
185 " Times can be compounded such as: ",
186 " 1m40s - 1 minute and 40 seconds ",
187 " 5h20m30s - 5 hours 20 minutes and 30 seconds ",
188 "=-----------------------------------------------="
189 );
190
d76ed9a9 191"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
182dd032
AS
192 "Extends the clone kill limit for the specified <ip> to <count> for <duration>.",
193 "<duration> uses $btime notation$b",
d76ed9a9 194 "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 195 "Access level: $b${level/addtrust}$b",
182dd032 196 "$uSee Also:$u deltrust, stats trusted, time notation"
d2dce5ac
AS
197 );
198
d76ed9a9
AS
199"ALERT REACTION" ("$bALERT REACTION$b",
200 "Valid alert actions (to be taken when an alert is hit) are:",
201 "$bNOTICE$b: Send a notice to the $b$O$b alert channel",
202 "$bKILL$b: Disconnect the user",
203 "$bGLINE$b: Gline the user that tripped the alert",
182dd032
AS
204 "$uSee Also:$u addalert, delalert"
205 );
d2dce5ac 206
d76ed9a9
AS
207"DELALERT" ("/msg $O DELALERT <alert> [alert]...",
208 "Remove the specified alerts from the $b$O$b alert list.",
182dd032
AS
209 "Access level: $b${level/delalert}$b",
210 "$uSee Also:$u addalert, stats"
211 );
d2dce5ac 212
d76ed9a9
AS
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
AS
215 "Access level: $b${level/deltrust}$b",
216 "$uSee Also:$u addtrust, stats"
217 );
d2dce5ac 218
d76ed9a9
AS
219"INVITEME" ("/msg $O INVITEME [nick]",
220 "Invites the specified user (if omitted, you) to $O's debug channel.",
182dd032
AS
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
AS
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.",
228 "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, GAG, DOMAINS",
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",
182dd032
AS
230 "Access level: $b${level/trace}$b",
231 "$uSee Also:$u trace action, trace criteria"
232 );
d2dce5ac 233
d76ed9a9
AS
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).",
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.",
182dd032
AS
242 "Note: By default, IRC operators are not affected by the KILL, GLINE 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.",
243 "$uSee Also:$u trace criteria, trace"
244 );
d2dce5ac 245
d76ed9a9
AS
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)",
262 "$bREASON$b reason Reason for kill or gline (must be listed last).",
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).",
182dd032
AS
269 "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.",
270 "$uSee Also:$u trace action, trace"
271 );
d2dce5ac 272
d76ed9a9 273"WHOIS" ("/msg $O WHOIS <nick>",
182dd032
AS
274 "Displays detailed information for the named user.",
275 "Access level: $b${level/whois}$b",
276 );
d2dce5ac 277
d76ed9a9
AS
278"CHANINFO" ("/msg $O CHANINFO <#channel> [users]",
279 "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
280 "Access level: $b${level/chaninfo}$b",
281 "$uSee Also:$u whois"
282 );
d2dce5ac 283
d76ed9a9
AS
284"CSEARCH" ("/msg $O CSEARCH <action> <criteria> <value> [<criteria> <value>]...",
285 "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
286 "Access level: $b${level/csearch}$b",
287 "$uSee Also:$u csearch action, csearch criteria"
288 );
d2dce5ac 289
d76ed9a9
AS
290"CSEARCH ACTION" ("$bCSEARCH ACTION$b",
291 "Options for action in $bcsearch$b are:",
292 "$bPRINT$b: Display the channel and user count.",
182dd032
AS
293 "$bCOUNT$b: Count all matching channels."
294 );
d2dce5ac 295
d76ed9a9
AS
296"CSEARCH CRITERIA" ("$bCSEARCH CRITERIA$b",
297 "Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
298 "$bNAME$b name Specifies a name to search for.",
299 "$bTOPIC$b topic Specifies a topic to search for.",
300 "$bUSERS$b cmp User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
301 "$bTIMESTAMP$b cmp Timestamp constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu; supports interval notation)",
182dd032
AS
302 "$bLIMIT$b 50 Limits the number of responses to a certain number."
303 );
d2dce5ac 304
d76ed9a9
AS
305"JOIN" ("/msg $O JOIN <#channel> ",
306 "Makes $b$O$b join the specified channel.",
182dd032
AS
307 "Access level: $b${level/join}$b",
308 "$uSee Also:$u part"
309 );
d2dce5ac 310
d76ed9a9
AS
311"PART" ("/msg $O PART <#channel> ",
312 "Makes $b$O$b leave the specified channel.",
182dd032
AS
313 "Access level: $b${level/part}$b",
314 "$uSee Also:$u join"
315 );
d2dce5ac 316
d76ed9a9
AS
317"ADDBAD" ("/msg $O ADDBAD <word>",
318 "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
AS
319 "Access level: $b${level/addbad}$b",
320 "$uSee Also:$u addexempt, delbad, stats"
321 );
d2dce5ac 322
d76ed9a9
AS
323"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
324 "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.",
325 "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.",
326 "The current exempt list is displayed with the current bad-words in $bstats bad$b.",
182dd032
AS
327 "Access level: $b${level/addexempt}$b",
328 "$uSee Also:$u addbad, delexempt, stats"
329 );
d2dce5ac 330
d76ed9a9
AS
331"DELBAD" ("/msg $O DELBAD <keyword>",
332 "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
AS
333 "Access level: $b${level/delbad}$b",
334 "$uSee Also:$u addbad, delexempt, stats"
335 );
d2dce5ac 336
d76ed9a9
AS
337"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
338 "Removes a channel from $O's bad-word-exempt channel list.",
182dd032
AS
339 "Access level: $b${level/delexempt}$b",
340 "$uSee Also:$u addexempt, delbad, stats"
341 );
d2dce5ac 342
d76ed9a9
AS
343"UNWARN" ("/msg $O UNWARN <#channel>",
344 "Deletes the activity warning for a channel.",
182dd032
AS
345 "Access level: $b${level/unwarn}$b",
346 "$uSee Also:$u warn, stats warn"
347 );
d2dce5ac 348
d76ed9a9
AS
349"WARN" ("/msg $O WARN <#channel> [reason]",
350 "Adds an activity warning for the channel.",
182dd032
AS
351 "Access level: $b${level/warn}$b",
352 "$uSee Also:$u unwarn, stats warn"
353 );
d2dce5ac 354
d76ed9a9
AS
355"BAN" ("/msg $O BAN <#channel> <nick|hostmask>",
356 "Bans the specified hostmask from the specified channel.",
357 "If a nick is used instead of hostmask, the hostmask is generated based on the nickname.",
358 "If the channel is omitted, the $bban$b will be done in the channel where the command was given.",
182dd032
AS
359 "Access level: $b${level/ban}$b",
360 "$uSee Also:$u kickban, kickbanall, unban"
361 );
d2dce5ac 362
d76ed9a9
AS
363"UNBAN" ("/msg $O UNBAN <#channel> <hostmask>",
364 "Unbans the specified hostmask from the specified channel.",
365 "If the channel is omitted, the $bunban$b will be done in the channel where the command was given.",
182dd032
AS
366 "Access level: $b${level/unban}$b",
367 "$uSee Also:$u kickban, kickbanall, ban"
368 );
d2dce5ac 369
d76ed9a9
AS
370"CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
371 "Clears all bans in the specified channel.",
372 "If the channel is omitted, then $bclearbans$b will be done in the channel where the command was given.",
182dd032
AS
373 "Access level: $b${level/clearbans}$b",
374 "$uSee Also:$u ban, unban"
375 );
d2dce5ac 376
d76ed9a9
AS
377"CLEARMODES" ("/msg $O CLEARMODES <#channel> ",
378 "Clears the specified channel of all modes.",
379 "If the channel is omitted, then $bclearmodes$b will be done in the channel where the command was given.",
182dd032
AS
380 "Access level: $b${level/clearmodes}$b",
381 "$uSee Also:$u mode"
382 );
d2dce5ac 383
d76ed9a9
AS
384"DEOP" ("/msg $O DEOP <#channel> <nick> [nick]...",
385 "Deops the specified user from the specified channel.",
386 "If the channel is omitted, then $bdeop$b will be done in the channel where the command was given.",
182dd032
AS
387 "Access level: $b${level/deop}$b",
388 "$uSee Also:$u deopall, devoiceall, op, opall"
389 );
d2dce5ac 390
d76ed9a9
AS
391"DEOPALL" ("/msg $O DEOPALL <#channel>",
392 "Deops all members of the specified channel.",
393 "If the channel is omitted, then $bdeopall$b will be done in the channel where the command was given.",
182dd032
AS
394 "Access level: $b${level/deopall}$b",
395 "$uSee Also:$u deop, devoiceall, op, opall"
396 );
d2dce5ac 397
d76ed9a9
AS
398"DEVOICEALL" ("/msg $O DEVOICEALL <#channel>",
399 "Devoice all members of the specified channel who do not have channel ops.",
400 "If the channel is omitted, then $bdevoiceall$b will be done in the channel where the command was given.",
182dd032
AS
401 "Access level: $b${level/devoiceall}$b",
402 "$uSee Also:$u deop, deopall, op, opall"
403 );
d2dce5ac 404
d76ed9a9
AS
405"KICK" ("/msg $O KICK <#channel> <nick> [reason]",
406 "Kicks the specified user from the specified channel.",
407 "If the channel is omitted, then $bkick$b will be done in the channel where the command was given.",
182dd032
AS
408 "Access level: $b${level/kick}$b",
409 "$uSee Also:$u ban, kickall, kickban, kickbanall"
410 );
d2dce5ac 411
d76ed9a9
AS
412"KICKALL" ("/msg $O KICKALL <#channel> [reason]",
413 "Kicks all users in the specified channel except for the user issuing the command.",
414 "If the channel is omitted, then $bkickall$b will be done in the channel where the command was given.",
182dd032
AS
415 "Access level: $b${level/kickall}$b",
416 "$uSee Also:$u ban, kick, kickbanall"
417 );
d2dce5ac 418
d76ed9a9
AS
419"KICKBAN" ("/msg $O KICKBAN <#channel> <nick> [reason]",
420 "Kicks and bans the specified user. $b$O$b determines the hostmask to ban from the nick specified.",
421 "If the channel is omitted, then $bkickban$b will be done in the channel where the command was given.",
182dd032
AS
422 "Access level: $b${level/kickban}$b",
423 "$uSee Also:$u ban, kickall, kickbanall"
424 );
d2dce5ac 425
d76ed9a9
AS
426"KICKBANALL" ("/msg $O KICKBANALL <#channel> [reason]",
427 "Kick and bans all members of the specified channel except for the user issuing the command.",
428 "If the channel is omitted, then $bkickbanall$b will be done in the channel where the command was given.",
182dd032
AS
429 "Access level: $b${level/kickbanall}$b",
430 "$uSee Also:$u ban, kick, kickban"
431 );
d2dce5ac 432
d76ed9a9
AS
433"MODE" ("/msg $O MODE <#channel> <+/- mode>",
434 "Sets the specified modes (but cannot include voice, ban or op changes) on a channel.",
435 "If the channel is omitted, then $bmode$b will be done in the channel where the command was given.",
182dd032
AS
436 "Access level: $b${level/mode}$b",
437 "$uSee Also:$u ban, deop, kickban, op"
438 );
d2dce5ac 439
d76ed9a9
AS
440"OP" ("/msg $O OP <#channel> <nick> [nick]...",
441 "Ops specified nicknames the specified channel.",
442 "If the channel is omitted, then $bop$b will be done in the channel where the command was given.",
182dd032
AS
443 "Access level: $b${level/op}$b",
444 "$uSee Also:$u deop, deopall, opall"
445 );
d2dce5ac 446
d76ed9a9
AS
447"OPALL" ("/msg $O OPALL <#channel>",
448 "Ops all members of the specified channel.",
449 "If the channel is omitted, then $bopall$b will be done in the channel where the command was given.",
182dd032
AS
450 "Access level: $b${level/opall}$b",
451 "$uSee Also:$u deopall"
452 );
d2dce5ac 453
d76ed9a9
AS
454"VOICEALL" ("/msg $O VOICEALL <#channel>",
455 "Voices all members of the specified channel who do not have channel ops.",
456 "If the channel is omitted, then $bvoiceall$b will be done in the channel where the command was given.",
182dd032
AS
457 "Access level: $b${level/voiceall}$b",
458 "$uSee Also:$u opall, deopall, devoiceall"
459 );
d76ed9a9
AS
460
461"GLINES" ("$bGLINE COMMANDS$b",
462 "Searches for, issues, and removes G-lines (network-global K-lines).",
463 " BLOCK [${level/block}]",
464 " GLINE [${level/gline}]",
465 " GTRACE [${level/gtrace}]",
466 " GSYNC [${level/gsync}]",
467 " REFRESHG [${level/refreshg}]",
182dd032
AS
468 " UNGLINE [${level/ungline}]"
469 );
d2dce5ac 470
d76ed9a9
AS
471"BLOCK" ("/msg $O BLOCK <nick> [reason]",
472 "GLINES the host of the specified nick for one hour If no reason is given, use a default reason.",
182dd032
AS
473 "Access level: $b${level/block}$b",
474 "$uSee Also:$u gline, ungline"
475 );
d2dce5ac 476
d76ed9a9
AS
477"GLINE" ("/msg $O GLINE <user@host> <duration> <reason>",
478 "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
AS
479 "Access level: $b${level/gline}$b",
480 "$uSee Also:$u trace, ungline"
481 );
d2dce5ac 482
d76ed9a9
AS
483"GTRACE" ("/msg $O GTRACE <action> <criteria> [<criteria> <value>]...",
484 "Searches through the glines, much like $bTRACE$b does for users.",
182dd032
AS
485 "Access level: $b${level/gtrace}$b",
486 "$uSee Also:$u trace, gtrace action, gtrace criteria"
487 );
d2dce5ac 488
d76ed9a9
AS
489"GTRACE ACTION" ("$bGTRACE ACTION$b",
490 "Options for the action in $bgtrace$b are:",
491 "$bPRINT$b: Display the glines (mask, issuer, expiration time, reason)",
492 "$bCOUNT$b: Count the number of matching glines",
182dd032
AS
493 "$bUNGLINE$b: Remove matching glines",
494 "$uSee Also:$u gtrace criteria, gtrace"
495 );
d2dce5ac 496
d76ed9a9
AS
497"GTRACE CRITERIA" ("$bGTRACE CRITERIA$b",
498 "Criteria and values for $bgtrace$b (a search with $bgtrace$b must match all the criteria you give):",
499 "$bMASK SUPERSET$b user@host G-line matches if it applies to someone with this hostmask.",
500 "$bMASK SUBSET$b user@host G-line matches if this hostmask \"covers\" the G-line target.",
501 "$bMASK EXACT$b user@host G-line matches only if the target is exactly this.",
502 "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
503 "$bLIMIT$b count Limits the number of matching glines.",
504 "$bREASON$b reason Looks for glines with the given reason.",
505 "$bISSUER$b account Looks for glines issued by the given account.",
182dd032
AS
506 "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.",
507 "$uSee Also:$u gtrace action, gtrace"
508 );
d2dce5ac 509
d76ed9a9
AS
510"GSYNC" ("/msg $O GSYNC [server]",
511 "Requests a list of GLINES from its uplink or the specified server. This can be used in the event srvx is down for period and becomes desynced.",
182dd032
AS
512 "Access level: $b${level/gsync}$b",
513 "$uSee Also:$u refreshg, gline, ungline"
514 );
d2dce5ac 515
d76ed9a9
AS
516"REFRESHG" ("/msg $O REFRESHG [server]",
517 "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
518 "Access level: $b${level/refreshg}$b",
519 "$uSee Also:$u gline, ungline, gsync"
520 );
d2dce5ac 521
d76ed9a9
AS
522"UNGLINE" ("/msg $O UNGLINE <user@host>",
523 "Removes a gline from the network before it expires.",
182dd032
AS
524 "Access level: $b${level/ungline}$b",
525 "$uSee Also:$u gline"
526 );
d2dce5ac 527
d76ed9a9
AS
528"CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
529 "Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
530 "$bADD$b: Adds a new clone. Arguments: <nickname> <user@host> <info>",
531 "$bREMOVE$b: Removes a clone. Arguments: <nickname>",
532 "$bJOIN$b: Joins a clone to a channel. Arguments: <nickname> <channel>",
533 "$bPART$b: Parts a clone from a channel. Arguments: <nickname> <channel>",
534 "$bOP$b: Ops a clone in a channel. Arguments: <nickname> <channel>",
182dd032
AS
535 "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>",
536 "Access level: $b${level/clone}$b",
537 "$uSee Also:$u collide, reserve, jupe"
538 );
d2dce5ac 539
d76ed9a9
AS
540"COLLIDE" ("/msg $O COLLIDE <nick> <ident> <host> <description>",
541 "Creates a clone with the specified properties, colliding any existing user with the same nick.",
182dd032
AS
542 "Access level: $b${level/collide}$b",
543 "$uSee Also:$u clone, reserve, jupe"
544 );
d2dce5ac 545
d76ed9a9
AS
546"JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
547 "Causes srvx to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
182dd032
AS
548 "Access level: $b${level/jupe}$b",
549 "$uSee Also:$u unjupe, clone, reserve"
550 );
d2dce5ac 551
d76ed9a9
AS
552"RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
553 "Used to ban, protect, or jupe a given nick. Unlike $bclone$b and $bcollide$b, reserved nicks are saved across restarts of srvx.",
182dd032
AS
554 "Access level: $b${level/reserve}$b",
555 "$uSee Also:$u unreserve, clone, jupe"
556 );
d2dce5ac 557
d76ed9a9
AS
558"UNJUPE" ("/msg $O UNJUPE <srvname>",
559 "Causes srvx to unjupe a jupe server.",
182dd032
AS
560 "Access level: $b${level/unjupe}$b",
561 "$uSee Also:$u jupe, unreserve, clone"
562 );
d2dce5ac 563
d76ed9a9
AS
564"UNRESERVE" ("/msg $O UNRESERVE <nick>",
565 "Removes a nick from $b$O's$b reserve list.",
182dd032
AS
566 "Access level: $b${level/unreserve}$b",
567 "$uSee Also:$u reserve, clone, unjupe"
568 );
d76ed9a9 569
d76ed9a9
AS
570"LOG" ("/msg $O LOG <criteria> <value> [<criteria> <value>]...",
571 "Searches services logs based on critera specified and displays the results.",
572 "Criteria and associated values (a search match all specified items):",
573 "$bBOT$b - A service bot's name (for example, $O).",
574 "$bCHANNEL$b - The channel where a command was issued (accepts wildcards).",
575 "$bNICK$b - The nickname issuing the command (accepts wildcards).",
576 "$bACCOUNT$b - The account of the user who issued the command (accepts wildcards).",
577 "$bHOSTMASK$b - The ident@host of the user who issued the command (accepts wildcards).",
578 "$bAGE$b - Age of commands to find (for example, 1m or >3m).",
579 "$bLIMIT$b - Maximum number of results to show.",
580 "$bLEVEL$b - Comma-separated list of COMMAND, OVERRIDE, STAFF, to return only those commands.",
581 "$bTYPE$b - Name of module that generated log (see $bSTATS MODULES$b).",
182dd032
AS
582 "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.",
583 "Access level: $b${level/log}$b",
584 "$uSee Also:$u reopen"
585 );
d2dce5ac 586
d76ed9a9
AS
587"REOPEN" ("/msg $O REOPEN",
588 "Close and re-open all the log files.",
182dd032
AS
589 "$uSee Also:$u log, rehash, write, writeall, readhelp"
590 );
d2dce5ac 591
d76ed9a9
AS
592"DIE" ("/msg $O DIE <reason>",
593 "SQUIT srvx with the given reason and shuts it down.",
182dd032
AS
594 "Access level: $b${level/die}$b",
595 "$uSee Also:$u restart, reconnect, jump"
596 );
597
d76ed9a9
AS
598"JUMP" ("/msg $O JUMP <uplink>",
599 "Causes srvx to connect to the specified uplink.",
182dd032
AS
600 "Access level: $b${level/jump}$b",
601 "$uSee Also:$u reconnect, restart, die"
602 );
d2dce5ac 603
d76ed9a9
AS
604"RECONNECT" ("/msg $O RECONNECT ",
605 "Causes srvx to reconnect to its current uplink.",
182dd032
AS
606 "Access level: $b${level/reconnect}$b",
607 "$uSee Also:$u jump, rehash, restart, die"
608 );
d2dce5ac 609
d76ed9a9
AS
610"REHASH" ("/msg $O REHASH",
611 "Causes srvx to re-read its configuration file and update its state as much as possible.",
182dd032
AS
612 "Access level: $b${level/rehash}$b",
613 "$uSee Also:$u die, reconnect, jump, restart"
614 );
d2dce5ac 615
d76ed9a9
AS
616"RESTART" ("/msg $O RESTART <reason>",
617 "Causes srvx to SQUIT with the specified reason and restart.",
182dd032
AS
618 "Access level: $b${level/restart}$b",
619 "$uSee Also:$u reconnect, rehash, die"
620 );
d2dce5ac 621
d76ed9a9
AS
622"GAG" ("/msg $O GAG <mask> <duration> <reason>",
623 "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, who are only notified when a gag goes into effect, or they sign onto the network. Gags have no effect on opers, and as a safety feature, only affect the first 250 matching users. The gag will automatically expire after $b<duration>$b (or last forever if that is zero).",
182dd032
AS
624 "Access level: $b${level/gag}$b",
625 "$uSee Also:$u ungag, trace"
626 );
d2dce5ac 627
d76ed9a9
AS
628"HELPSERV" ("/msg $O HELPSERV <command>",
629 "Sends a command to the HelpServ system. It is used for all \"override\" commands, as well as registration and unregistration.",
182dd032
AS
630 "$uSee also:$u /msg $O HELPSERV HELP"
631 );
d2dce5ac 632
d76ed9a9
AS
633"QUERY" ("/msg $O QUERY <option>",
634 "Displays the value of the given configuration key. If the key is a composite entry, show the subkeys inside it.",
182dd032
AS
635 "Access level: $b${level/query}$b",
636 "$uSee Also:$u set, rehash"
637 );
d2dce5ac 638
d76ed9a9
AS
639"SET" ("/msg $O SET <option> <value>",
640 "Modifies the internal configuration database. Currently, only keys that have been previously set may be modified.",
182dd032
AS
641 "Access level: $b${level/set}$b",
642 "$uSee Also:$u query, rehash"
643 );
d2dce5ac 644
d76ed9a9
AS
645"UNGAG" ("/msg $O UNGAG <hostmask>",
646 "Ungags a gaged hostmask and displays how many users were affected by $bungag$b. You can get a list of gaged hostmasks from $bgags$b.",
182dd032
AS
647 "Access level: $b${level/ungag}$b",
648 "$uSee Also:$u gag, stats gags"
649 );
d2dce5ac 650
d76ed9a9
AS
651"DUMP" ("/msg $O DUMP <raw line>",
652 "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
653 "Access level: $b${level/dump}$b",
654 "$uSee Also:$u raw"
655 );
d2dce5ac 656
d76ed9a9
AS
657"RAW" ("/msg $O RAW <raw line>",
658 "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
659 "Access level: $b${level/raw}$b",
660 "$uSee Also:$u dump"
661 );
d2dce5ac 662
d76ed9a9
AS
663"SETTIME" ("/msg $O SETTIME [servermask] [resync]",
664 "Sets the time on the named server(s) to match the time known to srvx.",
665 "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.",
182dd032
AS
666 "If the RESYNC argument is provided, sets the time to what srvx believes the local time is, rather than what it believes the network time is.",
667 "Access level: $b${level/settime}$b",
668 "$uSee Also:$u timecmd"
669 );
d2dce5ac 670
d76ed9a9
AS
671"STATS" ("/msg $O STATS <subject>",
672 "Displays statistics about a specified subject. Subjects include:",
673 "$bALERTS$b: The list of current \"alerts\".",
674 "$bBAD$b: Current list of bad words and exempted channels.",
675 "$bGAGS$b: The list of current gags.",
676 "$bGLINES$b: Reports the current number of glines.",
677 "$bLINKS$b: Information about the link to the network.",
678 "$bMAX$b: The max clients seen on the network.",
679 "$bNETWORK$b: Displays network information such as total users and how many users are on each server.",
680 "$bNETWORK2$b: Additional information about the network, such as numerics and linked times.",
681 "$bOPERS$b: A list of users that are currently +o.",
682 "$bPROXYCHECK$b: Information about proxy checking in srvx.",
683 "$bRESERVED$b: The list of currently reserved nicks.",
684 "$bTIMEQ$b: The number of events in the timeq, and how long until the next one.",
685 "$bTRUSTED$b: The list of currently trusted IPs.",
686 "$bUPTIME$b: Srvx uptime, lines processed, and CPU time.",
687 "$bWARN$b: The list of channels with activity warnings.",
688 "$bMODULES$b: Shows loaded modules that implement commands.",
182dd032
AS
689 "$bSERVICES$b: Shows active service bots.",
690 "Access level: $b${level/stats}$b",
691 );
d76ed9a9
AS
692
693"INDEX" "${index}";
d2dce5ac 694