-"<INDEX>" ("=------------------ $b$O Help$b ------------------=",
+"<INDEX>" (
" $O provides Oper Services for the Network. ",
" Please choose from the following categories: ",
" $bGOD$b Enabling channel override. ",
" $bPUNISH$b Commands to discipline users.",
" $bINFORMATION$b Get information about users. ",
" or $O, $C, and $N. ",
- " $bTRACES$b Powerfull commands for ",
+ " $bTRACES$b Powerful commands for ",
" viewing or acting on lists of",
" IRC objects. ",
" $bALERTS$b Automated responses. ",
" $bSETTINGS$b View and temporarily change ",
" config file settings. ",
" $bADMIN$b Misc Administrator Commands. ",
- " $bOWNERONLY$b $O operator only commands. ",
- "=---------------- End of Help ----------------="
+ " $bOWNERONLY$b $O operator only commands. "
);
"COMMANDS" "${index}";
-"PUNISH" ("=------------- $bUser Punishments$b --------------=",
+"PUNISH" (
" $bGLINE$b Global Ban a host.",
" $bUNGLINE$b Remove a GLINE.",
" $bBLOCK$b Gline by nickname.",
" $bTRACE GLINE$b Gline all hosts matching a search.",
" $bGTRACE$b Search the gline list.",
" $b$b",
+ " $bSHUN$b Global Shun a host.",
+ " $bUNSHUN$b Remove a SHUN.",
+ " $bSBLOCK$b Shun by nickname.",
+ " $bTRACE SHUN$b Shun all hosts matching a search.",
+ " $bSTRACE$b Search the shun list.",
+ " $b$b",
" $bGAG$b Cause the services to ignore... ",
- " $bUNGAG$b ...or unignore by mask.",
- "=---------------- End of Help ----------------="
+ " $bUNGAG$b ...or unignore by mask."
);
-"INFORMATION" ("=----------- $bInformation Gathering$b -----------=",
+"INFORMATION" (
" $bACCESS$b Shows a users $O access level.",
" $bSTATS$b Show various lists and runtime info.",
" $bWHOIS$b Show details about a user by nick.",
" $bVERSION$b Show the $O version information.",
" $bLOG$b View $O logs.",
- " $bTRACES$b Powerfull commands for viewing or acting on lists of IRC objects.",
- "=--------------- End of Help ----------------="
+ " $bTRACES$b Powerfull commands for viewing or acting on lists of IRC objects."
);
-"TRACES" ("=------------------ $bTraces$b ------------------=",
+"TRACES" (
" $bTRACE$b Search current users and optionally apply an action.",
" $bGTRACE$b Search current GLINEs and optionally remove them.",
- " $bCSEARCH$b Search current channels.",
- "=--------------- End of Help ----------------="
+ " $bSTRACE$b Search current SHUNs and optionally remove them.",
+ " $bCSEARCH$b Search current channels."
);
-"ALERTS" ("=------------------ $bAlerts$b ------------------=",
+"ALERTS" (
" $bADDALERT$b Make $O automatically do something",
" when users match a criteria.",
" $bDELALERT$b Remove an alert.",
- " $bWARN$b Cause activity on a channel to warn",
- " $b$b ircops.",
- " $bUNWARN$b Remove a channel activity warning.",
- "=--------------- End of Help ----------------="
+ " $bSTATS ALERT$b See a listing of alerts. "
);
-"CHANNEL" ("=------------- $bChannel Commands$b -------------=",
+"CHANNEL" (
" $bOP$b Op someone.",
" $bDEOP$b Deop someone.",
" $bVOICE$b Voice someone.",
" $bINVITE$b Invite someone to a channel.",
" $bINVITEME$b Invite yourself to a channel.",
" $bCLEARBANS$b Cear all bans from a channel.",
- " $bCLEARMODES$b Clear all modes from a channel.",
- "=--------------- End of Help ----------------="
+ " $bCLEARMODES$b Clear all modes from a channel."
);
-"CLONES" ("=-------------- $bClone handling$b --------------=",
+"CLONES" (
" $bADDTRUST$b Add a clone limit exemption for a host.",
" $bDELTRUST$b Remove a clone exemption.",
" $bEDITTRUST$b Modify a clone exemption.",
" $bquery services/opserv/untrusted_max$b",
- " View the clone kill limit",
- "=--------------- End of Help ----------------="
+ " View the clone kill limit"
);
-"SETTINGS" ("=----------------- $bSettings$b -----------------=",
+"SETTINGS" (
" $bQUERY$b Show a runtime config setting.",
- " $bSET$b $uTemporarily$u change a runtime config setting.",
- "=--------------- End of Help ----------------="
+ " $bSET$b $uTemporarily$u change a runtime config setting."
);
-"ADMIN" ("=---------- $bAdministrative Commands$b ---------=",
+"ADMIN" (
" $bACCESS$b Modify someone's $O access level.",
" $bCOMMAND$b Show details of a command.",
" $bSHOWCOMMANDS$b List all commands and required access levels.",
" $bUNJUPE$b Remove a dummy server.",
" $b$b",
" $bREFRESHG$b Refresh the Glines.",
+ " $bREFRESHS$b Refresh the Shuns.",
" $bSETTIME$b Synchronize time across the network.",
- " $bTIMECMD$b Time how long a command runs.",
- "=--------------- End of Help ----------------="
+ " $bTIMECMD$b Time how long a command runs."
);
-"OWNERONLY" ("=------------- $bOwner Only Stuff$b -------------=",
+"OWNERONLY" (
" $bWRITE$b Write out a database.",
" $bWRITEALL$b Write out ALL databases.",
" $bREOPEN$b Close and Re-Open the logs.",
" $bDUMPMESSAGES$b Writes messages to a .db file (for translators).",
" $b$b",
" $bREHASH$b Re-read the config files.",
- " $bRESTART$b Quit and re-run srvx.",
+ " $bRESTART$b Quit and re-run X3.",
" $bDIE$b Make the bot quit.",
" $bJUMP$b Change uplink servers.",
" $bRECONNECT$b Reconnect to this uplink server.",
- " $bGSYNC$b Pull glines from the givin server into memory.",
+ " $bGSYNC$b Pull glines from the given server into memory.",
+ " $bSSYNC$b Pull shuns from the given server into memory.",
" $b$b",
" $bMODCMD$b Change details of a command.",
" $bBIND$b Make a command alias.",
" $bUNBIND$b Remove a command alias.",
- " $bJOINER$b Make a sub-command (such as stats).",
+ " $bREBINDALL$b Re-create all missing commands on all services",
" $bHELPFILES$b Change the helpfile priority order.",
" $b$b",
" $bSERVICE ADD$b Create a new service bot.",
" $bSERVICE REMOVE$b Remove a service bot.",
" $bSERVICE RENAME$b Rename a service bot.",
" $bSERVICE PRIVILEGED$b Sets if only opers can use the service.",
- " $bSERVICE TRIGGER$b Change the command charactor of a service.",
+ " $bSERVICE TRIGGER$b Change the command character of a service.",
" $b$b",
" $bADDBAD$b Add a word to the illegal channel word list.",
" $bDELBAD$b Remove a word from the illegal channel word list.",
" $bDELEXEMPT$b Remove an exception of the illegal word list.",
" $b$b",
" $bDUMP$b Drop safetychecked server protocol to the server. ",
- " $bRAW$b Draw raw server protocol to the server. (DANGEROUS!)",
- "=--------------- End of Help ----------------="
+ " $bRAW$b Drop raw server protocol to the server. (DANGEROUS!)"
);
"ACCESS" ("/msg $O ACCESS [nick|*account] [new-level]",
"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).",
"Access level: $b${level/access}$b",
- "$uSee Also:$u commands");
+ "$uSee Also:$u commands, modcmd"
+ );
"ADDALERT" ("/msg $O ADDALERT <name> <reaction> <criteria>",
"Adds the specified alert to the $b$O$b alert list.",
+ "Alerts watch for users matching a givin criteria and perform an action on them.",
+ " <name> - An alphanumeric word to identify this alert in the list",
+ " <reaction> - What to do if a user matches the criteria. See $bALERT REACTION$b.",
+ " <criteria> - What to look for. See $bTRACE CRITERIA$b.",
"Access level: $b${level/addalert}$b",
"$uSee Also:$u delalert, alert reaction, trace criteria"
);
+"TIME NOTATION" (
+ " Many commands require a duration perameter ",
+ " which all use the same syntax: ",
+ " 1s - 1 second ",
+ " 2m - 2 minutes ",
+ " 3h - 3 hours ",
+ " 4d - 4 days ",
+ " 5w - 5 weeks ",
+ " 6M - 6 months",
+ " 1y - 1 year",
+ " Times can be compounded such as: ",
+ " 1m40s - 1 minute and 40 seconds ",
+ " 5h20m30s - 5 hours 20 minutes and 30 seconds "
+ );
+
"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
- "Allows the specified IP address to have the specified amount of clones before being removed (rather than the usual limit).",
+ "Extends the clone kill limit for the specified <ip> to <count> for <duration>.",
+ "<duration> uses $btime notation$b",
"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.",
"Access level: $b${level/addtrust}$b",
- "$uSee Also:$u deltrust, stats trusted"
+ "$uSee Also:$u deltrust, stats trusted, time notation"
);
"ALERT REACTION" ("$bALERT REACTION$b",
"$bNOTICE$b: Send a notice to the $b$O$b alert channel",
"$bKILL$b: Disconnect the user",
"$bGLINE$b: Gline the user that tripped the alert",
- "$uSee Also:$u addalert, delalert");
+ "$bSHUN$b : Shun the user that tripped the alert",
+ "$uSee Also:$u addalert, delalert"
+ );
"DELALERT" ("/msg $O DELALERT <alert> [alert]...",
"Remove the specified alerts from the $b$O$b alert list.",
- "$uSee Also:$u addalert, stats");
+ "Access level: $b${level/delalert}$b",
+ "$uSee Also:$u addalert, stats"
+ );
"DELTRUST" ("/msg $O DELTRUST <ip>",
"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.",
- "$uSee Also:$u addtrust, stats");
+ "Access level: $b${level/deltrust}$b",
+ "$uSee Also:$u addtrust, stats"
+ );
"INVITEME" ("/msg $O INVITEME [nick]",
"Invites the specified user (if omitted, you) to $O's debug channel.",
- "This is currently pointless, since no output is sent to the debug channel.");
+ "This is currently pointless, since no output is sent to the debug channel.",
+ "Access level: $b${level/inviteme}$b",
+ "$uSee Also:$u invite, clearmodes, clearbans"
+ );
"TRACE" ("/msg $O TRACE <action> <criteria> <value> [<criteria> <value>]...",
"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.",
- "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, GAG, DOMAINS",
- "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",
- "$uSee Also:$u trace action, trace criteria");
+ "Quick Ref ACTIONS: PRINT, COUNT, KILL, GLINE, SHUN, GAG, DOMAINS",
+ "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",
+ "Access level: $b${level/trace}$b",
+ "$uSee Also:$u trace action, trace criteria"
+ );
"TRACE ACTION" ("$bTRACE ACTION$b",
"Options for action in $btrace$b are:",
"$bCOUNT$b: Count all matching users.",
"$bKILL$b: Kill matching clients.",
"$bGLINE$b: Issue a gline for the client's host (by default, 1 hour long).",
+ "$bSHUN$b: Issue a shun for the client's host (by default, 1 hour long).",
"$bGAG$b: Gag all matching users (by default, does not expire).",
"$bDOMAINS$b: Display counts of users in each domain (length specified by DEPTH criteria.",
- "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.");
+ "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.",
+ "$uSee Also:$u trace criteria, trace"
+ );
"TRACE CRITERIA" ("$bTRACE CRITERIA$b",
"Criteria and values for $btrace$b (a search with $btrace$b must match all specified items):",
"$bLIMIT$b 50 Limits the number of responses to a certain number.",
"$bNICKAGE$b cmp Client has had nick this long (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
"$bACCESS$b cmp Access constraints (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
- "$bREASON$b reason Reason for kill or gline (must be listed last).",
+ "$bREASON$b reason Reason for kill, gline or shun (must be listed last).",
"$bDEPTH$b depth How many domain-name parts to use for $bDOMAINS$b action.",
"$bDURATION$b duration How long to apply a G-line or gag.",
"$bCLONES$b min Ignore clients from hosts with fewer than this many connections.",
"$bINFO_SPACE$b yes/no Clients match only if their info starts with a space (' ') character.",
"$bABUSE OPERS$b Force adverse actions to affect opers as well.",
"$bLOG$b Record matching users in $O's log file (in addition to acting).",
- "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.");
+ "$bREGEX$b yes/no Specifies if NICK/IDENT/HOST/INFO should be treated as a regular expression.",
+ "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.",
+ "$uSee Also:$u trace action, trace"
+ );
"WHOIS" ("/msg $O WHOIS <nick>",
- "Displays detailed information for the named user.");
-
-"CHANNEL" ("$bCHANNEL SUB-CATEGORIES$b",
- "Channel information, control, and searching.",
- " CHANNEL REACTIONS - Automated reactions based on channel names",
- " CHANNEL CONTROL - Channel information and control",
- "There are also some miscellaneous channel-related commands:",
- " CHANINFO [${level/chaninfo}]",
- " CSEARCH [${level/csearch}]",
- " JOIN [${level/join}]",
- " PART [${level/part}]");
+ "Displays detailed information for the named user.",
+ "Access level: $b${level/whois}$b",
+ );
"CHANINFO" ("/msg $O CHANINFO <#channel> [users]",
"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.",
- "$uSee Also:$u whois");
+ "Access level: $b${level/chaninfo}$b",
+ "$uSee Also:$u whois"
+ );
"CSEARCH" ("/msg $O CSEARCH <action> <criteria> <value> [<criteria> <value>]...",
"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.",
- "$uSee Also:$u csearch action, csearch criteria");
+ "Access level: $b${level/csearch}$b",
+ "$uSee Also:$u csearch action, csearch criteria"
+ );
"CSEARCH ACTION" ("$bCSEARCH ACTION$b",
"Options for action in $bcsearch$b are:",
"$bPRINT$b: Display the channel and user count.",
- "$bCOUNT$b: Count all matching channels.");
+ "$bCOUNT$b: Count all matching channels."
+ );
"CSEARCH CRITERIA" ("$bCSEARCH CRITERIA$b",
"Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
"$bTOPIC$b topic Specifies a topic to search for.",
"$bUSERS$b cmp User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
"$bTIMESTAMP$b cmp Timestamp constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu; supports interval notation)",
- "$bLIMIT$b 50 Limits the number of responses to a certain number.");
+ "$bLIMIT$b 50 Limits the number of responses to a certain number."
+ );
"JOIN" ("/msg $O JOIN <#channel> ",
"Makes $b$O$b join the specified channel.",
- "$uSee Also:$u part");
+ "Access level: $b${level/join}$b",
+ "$uSee Also:$u part"
+ );
"PART" ("/msg $O PART <#channel> ",
"Makes $b$O$b leave the specified channel.",
- "$uSee Also:$u join");
-
-"CHANNEL REACTIONS" ("$bCHANNEL REACTION COMMANDS$b",
- "\"Bad-word\" channels are for assisting in enforcement of network policies (such as disallowing \"warez\" channels). \"Warning\" channels are for channels which may be abused when they are present, but should be allowed otherwise.",
- " ADDBAD [${level/addbad}]",
- " ADDEXEMPT [${level/addexempt}]",
- " DELBAD [${level/delbad}]",
- " DELEXEMPT [${level/delexempt}]",
- " UNWARN [${level/unwarn}]",
- " WARN [${level/warn}]");
+ "Access level: $b${level/part}$b",
+ "$uSee Also:$u join"
+ );
"ADDBAD" ("/msg $O ADDBAD <word>",
"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.",
- "$uSee Also:$u addexempt, delbad, stats");
+ "Access level: $b${level/addbad}$b",
+ "$uSee Also:$u addexempt, delbad, stats bad, $C:noregister"
+ );
"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
"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.",
"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.",
"The current exempt list is displayed with the current bad-words in $bstats bad$b.",
- "$uSee Also:$u addbad, delexempt, stats");
+ "Access level: $b${level/addexempt}$b",
+ "$uSee Also:$u addbad, delexempt, stats"
+ );
"DELBAD" ("/msg $O DELBAD <keyword>",
"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.",
- "$uSee Also:$u addbad, delexempt, stats");
+ "Access level: $b${level/delbad}$b",
+ "$uSee Also:$u addbad, delexempt, stats bad, $C:allowregister"
+ );
"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
"Removes a channel from $O's bad-word-exempt channel list.",
- "$uSee Also:$u addexempt, delbad, stats");
-
-"UNWARN" ("/msg $O UNWARN <#channel>",
- "Deletes the activity warning for a channel.",
- "$uSee Also:$u warn, stats warn");
-
-"WARN" ("/msg $O WARN <#channel> [reason]",
- "Adds an activity warning for the channel.",
- "$uSee Also:$u unwarn, stats warn");
-
-"CHANNEL" ("=-- $bCHANNEL CONTROL COMMANDS$b --=",
- "These are analogous to the same (or similar) $C commands, but can be used on any channel.",
- " BAN [${level/ban}]",
- " CLEARBANS [${level/clearbans}]",
- " CLEARMODES [${level/clearmodes}]",
- " DEOP [${level/deop}]",
- " DEOPALL [${level/deopall}]",
- " DEVOICEALL [${level/devoiceall}]",
- " KICK [${level/kick}]",
- " KICKALL [${level/kickall}]",
- " KICKBAN [${level/kickban}]",
- " KICKBANALL [${level/kickbanall}]",
- " MODE [${level/mode}]",
- " OP [${level/op}]",
- " OPALL [${level/opall}]",
- " UNBAN [${level/unban}]",
- " VOICEALL [${level/voiceall}]",
- "=-----------------------------------=");
+ "Access level: $b${level/delexempt}$b",
+ "$uSee Also:$u addexempt, delbad, stats"
+ );
"BAN" ("/msg $O BAN <#channel> <nick|hostmask>",
"Bans the specified hostmask from the specified channel.",
"If a nick is used instead of hostmask, the hostmask is generated based on the nickname.",
"If the channel is omitted, the $bban$b will be done in the channel where the command was given.",
- "$uSee Also:$u kickban, kickbanall, unban");
+ "Access level: $b${level/ban}$b",
+ "$uSee Also:$u kickban, kickbanall, unban"
+ );
"UNBAN" ("/msg $O UNBAN <#channel> <hostmask>",
"Unbans the specified hostmask from the specified channel.",
"If the channel is omitted, the $bunban$b will be done in the channel where the command was given.",
- "$uSee Also:$u kickban, kickbanall, ban");
+ "Access level: $b${level/unban}$b",
+ "$uSee Also:$u kickban, kickbanall, ban"
+ );
"CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
"Clears all bans in the specified channel.",
"If the channel is omitted, then $bclearbans$b will be done in the channel where the command was given.",
- "$uSee Also:$u ban, unban");
+ "Access level: $b${level/clearbans}$b",
+ "$uSee Also:$u ban, unban"
+ );
"CLEARMODES" ("/msg $O CLEARMODES <#channel> ",
"Clears the specified channel of all modes.",
"If the channel is omitted, then $bclearmodes$b will be done in the channel where the command was given.",
- "$uSee Also:$u mode");
+ "Access level: $b${level/clearmodes}$b",
+ "$uSee Also:$u mode"
+ );
"DEOP" ("/msg $O DEOP <#channel> <nick> [nick]...",
"Deops the specified user from the specified channel.",
"If the channel is omitted, then $bdeop$b will be done in the channel where the command was given.",
- "$uSee Also:$u deopall, devoiceall, op, opall");
+ "Access level: $b${level/deop}$b",
+ "$uSee Also:$u deopall, devoiceall, op, opall"
+ );
"DEOPALL" ("/msg $O DEOPALL <#channel>",
"Deops all members of the specified channel.",
"If the channel is omitted, then $bdeopall$b will be done in the channel where the command was given.",
- "$uSee Also:$u deop, devoiceall, op, opall");
+ "Access level: $b${level/deopall}$b",
+ "$uSee Also:$u deop, devoiceall, op, opall"
+ );
"DEVOICEALL" ("/msg $O DEVOICEALL <#channel>",
"Devoice all members of the specified channel who do not have channel ops.",
"If the channel is omitted, then $bdevoiceall$b will be done in the channel where the command was given.",
- "$uSee Also:$u deop, deopall, op, opall");
+ "Access level: $b${level/devoiceall}$b",
+ "$uSee Also:$u deop, deopall, op, opall"
+ );
"KICK" ("/msg $O KICK <#channel> <nick> [reason]",
"Kicks the specified user from the specified channel.",
"If the channel is omitted, then $bkick$b will be done in the channel where the command was given.",
- "$uSee Also:$u ban, kickall, kickban, kickbanall");
+ "Access level: $b${level/kick}$b",
+ "$uSee Also:$u ban, kickall, kickban, kickbanall"
+ );
"KICKALL" ("/msg $O KICKALL <#channel> [reason]",
"Kicks all users in the specified channel except for the user issuing the command.",
"If the channel is omitted, then $bkickall$b will be done in the channel where the command was given.",
- "$uSee Also:$u ban, kick, kickbanall");
+ "Access level: $b${level/kickall}$b",
+ "$uSee Also:$u ban, kick, kickbanall"
+ );
"KICKBAN" ("/msg $O KICKBAN <#channel> <nick> [reason]",
"Kicks and bans the specified user. $b$O$b determines the hostmask to ban from the nick specified.",
"If the channel is omitted, then $bkickban$b will be done in the channel where the command was given.",
- "$uSee Also:$u ban, kickall, kickbanall");
+ "Access level: $b${level/kickban}$b",
+ "$uSee Also:$u ban, kickall, kickbanall"
+ );
"KICKBANALL" ("/msg $O KICKBANALL <#channel> [reason]",
"Kick and bans all members of the specified channel except for the user issuing the command.",
"If the channel is omitted, then $bkickbanall$b will be done in the channel where the command was given.",
- "$uSee Also:$u ban, kick, kickban");
+ "Access level: $b${level/kickbanall}$b",
+ "$uSee Also:$u ban, kick, kickban"
+ );
"MODE" ("/msg $O MODE <#channel> <+/- mode>",
"Sets the specified modes (but cannot include voice, ban or op changes) on a channel.",
"If the channel is omitted, then $bmode$b will be done in the channel where the command was given.",
- "$uSee Also:$u ban, deop, kickban, op");
+ "Access level: $b${level/mode}$b",
+ "$uSee Also:$u ban, deop, kickban, op"
+ );
"OP" ("/msg $O OP <#channel> <nick> [nick]...",
"Ops specified nicknames the specified channel.",
"If the channel is omitted, then $bop$b will be done in the channel where the command was given.",
- "$uSee Also:$u deop, deopall, opall");
+ "Access level: $b${level/op}$b",
+ "$uSee Also:$u deop, deopall, opall"
+ );
"OPALL" ("/msg $O OPALL <#channel>",
"Ops all members of the specified channel.",
"If the channel is omitted, then $bopall$b will be done in the channel where the command was given.",
- "$uSee Also:$u deopall");
+ "Access level: $b${level/opall}$b",
+ "$uSee Also:$u deopall"
+ );
"VOICEALL" ("/msg $O VOICEALL <#channel>",
"Voices all members of the specified channel who do not have channel ops.",
"If the channel is omitted, then $bvoiceall$b will be done in the channel where the command was given.",
- "$uSee Also:$u opall, deopall, devoiceall");
+ "Access level: $b${level/voiceall}$b",
+ "$uSee Also:$u opall, deopall, devoiceall"
+ );
"GLINES" ("$bGLINE COMMANDS$b",
"Searches for, issues, and removes G-lines (network-global K-lines).",
" GTRACE [${level/gtrace}]",
" GSYNC [${level/gsync}]",
" REFRESHG [${level/refreshg}]",
- " UNGLINE [${level/ungline}]");
+ " UNGLINE [${level/ungline}]"
+ );
"BLOCK" ("/msg $O BLOCK <nick> [reason]",
"GLINES the host of the specified nick for one hour If no reason is given, use a default reason.",
- "$uSee Also:$u gline, ungline");
+ "Access level: $b${level/block}$b",
+ "$uSee Also:$u gline, ungline"
+ );
"GLINE" ("/msg $O GLINE <user@host> <duration> <reason>",
"Issues a GLINE (network ban) on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
- "$uSee Also:$u trace, ungline");
+ "Access level: $b${level/gline}$b",
+ "$uSee Also:$u trace, ungline"
+ );
"GTRACE" ("/msg $O GTRACE <action> <criteria> [<criteria> <value>]...",
"Searches through the glines, much like $bTRACE$b does for users.",
- "$uSee Also:$u trace, gtrace action, gtrace criteria");
+ "Access level: $b${level/gtrace}$b",
+ "$uSee Also:$u trace, gtrace action, gtrace criteria"
+ );
"GTRACE ACTION" ("$bGTRACE ACTION$b",
"Options for the action in $bgtrace$b are:",
"$bPRINT$b: Display the glines (mask, issuer, expiration time, reason)",
"$bCOUNT$b: Count the number of matching glines",
- "$bUNGLINE$b: Remove matching glines");
+ "$bUNGLINE$b: Remove matching glines",
+ "$uSee Also:$u gtrace criteria, gtrace"
+ );
"GTRACE CRITERIA" ("$bGTRACE CRITERIA$b",
"Criteria and values for $bgtrace$b (a search with $bgtrace$b must match all the criteria you give):",
"$bLIMIT$b count Limits the number of matching glines.",
"$bREASON$b reason Looks for glines with the given reason.",
"$bISSUER$b account Looks for glines issued by the given account.",
- "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.");
+ "$bAFTER$b interval Looks for glines that expire more than $binterval$b in the future.",
+ "$uSee Also:$u gtrace action, gtrace"
+ );
"GSYNC" ("/msg $O GSYNC [server]",
- "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.",
- "$uSee Also:$u refreshg, gline, ungline");
+ "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.",
+ "Access level: $b${level/gsync}$b",
+ "$uSee Also:$u refreshg, gline, ungline"
+ );
"REFRESHG" ("/msg $O REFRESHG [server]",
"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.",
- "$uSee Also:$u gline, ungline, gsync");
+ "Access level: $b${level/refreshg}$b",
+ "$uSee Also:$u gline, ungline, gsync"
+ );
"UNGLINE" ("/msg $O UNGLINE <user@host>",
"Removes a gline from the network before it expires.",
- "$uSee Also:$u gline");
+ "Access level: $b${level/ungline}$b",
+ "$uSee Also:$u gline"
+ );
+
+"SHUN" ("$bSHUN COMMANDS$b",
+ "Searches for, issues, and removes Shuns.",
+ " SBLOCK [${level/sblock}]",
+ " SHUN [${level/shun}]",
+ " STRACE [${level/strace}]",
+ " SSYNC [${level/ssync}]",
+ " REFRESHS [${level/refreshs}]",
+ " UNSHUN [${level/unshun}]"
+ );
+
+"SBLOCK" ("/msg $O SBLOCK <nick> [reason]",
+ "SHUNS the host of the specified nick for one hour If no reason is given, use a default reason.",
+ "Access level: $b${level/sblock}$b",
+ "$uSee Also:$u shun, unshun"
+ );
+
+"SHUN" ("/msg $O SHUN <user@host> <duration> <reason>",
+ "Issues a SHUN on the network for the speicified user@host for the specified duration (making the expiration time: net time + duration).",
+ "Access level: $b${level/shun}$b",
+ "$uSee Also:$u trace, unshun"
+ );
+
+"STRACE" ("/msg $O STRACE <action> <criteria> [<criteria> <value>]...",
+ "Searches through the shuns, much like $bTRACE$b does for users.",
+ "Access level: $b${level/strace}$b",
+ "$uSee Also:$u trace, strace action, strace criteria"
+ );
+
+"STRACE ACTION" ("$bSTRACE ACTION$b",
+ "Options for the action in $bstrace$b are:",
+ "$bPRINT$b: Display the shuns (mask, issuer, expiration time, reason)",
+ "$bCOUNT$b: Count the number of matching shuns",
+ "$bUNSHUN$b: Remove matching shuns",
+ "$uSee Also:$u strace criteria, strace"
+ );
+
+"STRACE CRITERIA" ("$bSTRACE CRITERIA$b",
+ "Criteria and values for $bstrace$b (a search with $bstrace$b must match all the criteria you give):",
+ "$bMASK SUPERSET$b user@host Shun matches if it applies to someone with this hostmask.",
+ "$bMASK SUBSET$b user@host Shun matches if this hostmask \"covers\" the Shun target.",
+ "$bMASK EXACT$b user@host Shun matches only if the target is exactly this.",
+ "$bMASK$b user@host Specifies a mask to search for (equivalent to MASK SUPERSET).",
+ "$bLIMIT$b count Limits the number of matching shuns.",
+ "$bREASON$b reason Looks for shuns with the given reason.",
+ "$bISSUER$b account Looks for shuns issued by the given account.",
+ "$bAFTER$b interval Looks for shuns that expire more than $binterval$b in the future.",
+ "$uSee Also:$u strace action, strace"
+ );
-"CLONES" ("$bCLONE/JUPE COMMANDS$b",
- "Commands that add, remove or control fake (reserved) users or servers.",
- " CLONE [${level/clone}]",
- " COLLIDE [${level/collide}]",
- " JUPE [${level/jupe}]",
- " RESERVE [${level/reserve}]",
- " UNJUPE [${level/unjupe}]",
- " UNRESERVE [${level/unreserve}]");
+"SSYNC" ("/msg $O SSYNC [server]",
+ "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.",
+ "Access level: $b${level/ssync}$b",
+ "$uSee Also:$u refreshs, shun, unshun"
+ );
+
+"REFRESHS" ("/msg $O REFRESHS [server]",
+ "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.",
+ "Access level: $b${level/refreshs}$b",
+ "$uSee Also:$u shun, unshun, ssync"
+ );
+
+"UNSHUN" ("/msg $O UNSHUN <user@host>",
+ "Removes a shun from the network before it expires.",
+ "Access level: $b${level/unshun}$b",
+ "$uSee Also:$u shun"
+ );
"CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
"Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
"$bJOIN$b: Joins a clone to a channel. Arguments: <nickname> <channel>",
"$bPART$b: Parts a clone from a channel. Arguments: <nickname> <channel>",
"$bOP$b: Ops a clone in a channel. Arguments: <nickname> <channel>",
- "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>");
+ "$bSAY$b: Makes a clone say something to a channel. Arguments: <nickname> <channel> <text>",
+ "Access level: $b${level/clone}$b",
+ "$uSee Also:$u collide, reserve, jupe"
+ );
"COLLIDE" ("/msg $O COLLIDE <nick> <ident> <host> <description>",
"Creates a clone with the specified properties, colliding any existing user with the same nick.",
- "$uSee Also:$u clone");
+ "Access level: $b${level/collide}$b",
+ "$uSee Also:$u clone, reserve, jupe"
+ );
"JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
- "Causes srvx to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
- "$uSee Also:$u unjupe, reserve, unreserve");
+ "Causes X3 to create a \"juped\" (dummy) server. This can be used to prevent a poorly connected server from connecting.",
+ "Access level: $b${level/jupe}$b",
+ "$uSee Also:$u unjupe, clone, reserve"
+ );
"RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
- "Used to ban, protect, or jupe a given nick. Unlike $bclone$b and $bcollide$b, reserved nicks are saved across restarts of srvx.",
- "$uSee Also:$u clone, unreserve, jupe");
+ "Used to ban, protect, or jupe a given nick. Unlike $bclone$b and $bcollide$b, reserved nicks are saved across restarts of X3.",
+ "Access level: $b${level/reserve}$b",
+ "$uSee Also:$u unreserve, clone, jupe"
+ );
"UNJUPE" ("/msg $O UNJUPE <srvname>",
- "Causes srvx to unjupe a jupe server.",
- "$uSee Also:$u jupe, reserve, unreserve");
+ "Causes X3 to unjupe a jupe server.",
+ "Access level: $b${level/unjupe}$b",
+ "$uSee Also:$u jupe, unreserve, clone"
+ );
"UNRESERVE" ("/msg $O UNRESERVE <nick>",
"Removes a nick from $b$O's$b reserve list.",
- "$uSee Also:$u reserve");
+ "Access level: $b${level/unreserve}$b",
+ "$uSee Also:$u reserve, clone, unjupe"
+ );
-"LOGS" ("$bLOGGING COMMANDS$b",
- "Controls what goes into logs and searches them.",
- " LOG [${level/log}]",
- " REOPEN [${level/reopen}]");
"LOG" ("/msg $O LOG <criteria> <value> [<criteria> <value>]...",
"Searches services logs based on critera specified and displays the results.",
"Criteria and associated values (a search match all specified items):",
"$bLIMIT$b - Maximum number of results to show.",
"$bLEVEL$b - Comma-separated list of COMMAND, OVERRIDE, STAFF, to return only those commands.",
"$bTYPE$b - Name of module that generated log (see $bSTATS MODULES$b).",
- "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.");
+ "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.",
+ "Access level: $b${level/log}$b",
+ "$uSee Also:$u reopen"
+ );
"REOPEN" ("/msg $O REOPEN",
"Close and re-open all the log files.",
- "$uSee Also:$u log, loginfo");
-
-"RUNNING" ("$bRUNNING COMMANDS$b",
- "These commands control srvx's runtime state.",
- " DIE [${level/die}]",
- " JUMP [${level/jump}]",
- " RECONNECT [${level/reconnect}]",
- " REHASH [${level/rehash}]",
- " RESTART [${level/restart}]",
- " WRITE [${level/write}]",
- " WRITEALL [${level/writeall}]");
+ "$uSee Also:$u log, rehash, write, writeall, readhelp"
+ );
"DIE" ("/msg $O DIE <reason>",
- "SQUIT srvx with the given reason and shuts it down.",
- "$uSee Also:$u reconnect, restart");
+ "SQUIT X3 with the given reason and shuts it down.",
+ "Access level: $b${level/die}$b",
+ "$uSee Also:$u restart, reconnect, jump"
+ );
+
"JUMP" ("/msg $O JUMP <uplink>",
- "Causes srvx to connect to the specified uplink.",
- "$uSee Also:$u die, reconnect, restart");
+ "Causes X3 to connect to the specified uplink.",
+ "Access level: $b${level/jump}$b",
+ "$uSee Also:$u reconnect, restart, die"
+ );
"RECONNECT" ("/msg $O RECONNECT ",
- "Causes srvx to reconnect to its current uplink.",
- "$uSee Also:$u die, jump, rehash, restart");
+ "Causes X3 to reconnect to its current uplink.",
+ "Access level: $b${level/reconnect}$b",
+ "$uSee Also:$u jump, rehash, restart, die"
+ );
"REHASH" ("/msg $O REHASH",
- "Causes srvx to re-read its configuration file and update its state as much as possible.",
- "$uSee Also:$u die, reconnect, restart");
+ "Causes X3 to re-read its configuration file and update its state as much as possible.",
+ "Access level: $b${level/rehash}$b",
+ "$uSee Also:$u die, reconnect, jump, restart"
+ );
"RESTART" ("/msg $O RESTART <reason>",
- "Causes srvx to SQUIT with the specified reason and restart.",
- "$uSee Also:$u die, reconnect, rehash");
-
-"SERVICES" ("$bSERVICES COMMANDS$b",
- "These commands control how other services behave.",
- " BANEMAIL [${level/banemail}]",
- " BIND [${level/bind}]",
- " GAG [${level/gag}]",
- " HELPSERV [${level/helpserv}]",
- " QUERY [${level/query}]",
- " SET [${level/set}]",
- " UNBANEMAIL [${level/unbanemail}]",
- " UNBIND [${level/unbind}]",
- " UNGAG [${level/ungag}]");
+ "Causes X3 to SQUIT with the specified reason and restart.",
+ "Access level: $b${level/restart}$b",
+ "$uSee Also:$u reconnect, rehash, die"
+ );
"GAG" ("/msg $O GAG <mask> <duration> <reason>",
- "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).",
- "$uSee Also:$u ungag, trace");
+ "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.",
+ "The gag will automatically expire after $b<duration>$b (or last forever if that is zero).",
+ "Access level: $b${level/gag}$b",
+ "$uSee Also:$u ungag, trace, stats gags"
+ );
"HELPSERV" ("/msg $O HELPSERV <command>",
"Sends a command to the HelpServ system. It is used for all \"override\" commands, as well as registration and unregistration.",
- "$uSee also:$u /msg $O HELPSERV HELP");
+ "$uSee also:$u /msg $O HELPSERV HELP"
+ );
-"QUERY" ("/msg $O QUERY <option>",
- "Displays the value of the given configuration key. If the key is a composite entry, show the subkeys inside it.",
- "$uSee Also:$u set");
+"QUERY" ("/msg $O QUERY [key][/<sub-key>[/<sub-sub-key>]...]",
+ "Displays the value of the given configuration key. ",
+ "If the key is a composite entry, show the subkeys inside it.",
+ "Examples:",
+ " QUERY - shows 1st level keys ",
+ " QUERY services/chanserv - shows list of chanserv settings ",
+ " QUERY services/chanserv/chan_expire_delay - shows value ",
+ "Access level: $b${level/query}$b",
+ "$uSee Also:$u set, rehash"
+ );
"SET" ("/msg $O SET <option> <value>",
"Modifies the internal configuration database. Currently, only keys that have been previously set may be modified.",
- "$uSee Also:$u query");
+ "Access level: $b${level/set}$b",
+ "$uSee Also:$u query, rehash"
+ );
"UNGAG" ("/msg $O UNGAG <hostmask>",
- "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.",
- "$uSee Also:$u gag, stats gags");
-
-"OTHER" ("$bOTHER COMMANDS$b",
- "These commands do not easily fall into one of the other categories.",
- " DUMP [${level/dump}]",
- " HELP [${level/help}]",
- " RAW [${level/raw}]",
- " STATS [${level/stats}]",
- " SETTIME [${level/settime}]",
- " VERSION [${level/version}]");
+ "Ungags a gaged hostmask.",
+ "Access level: $b${level/ungag}$b",
+ "$uSee Also:$u gag, stats gags"
+ );
"DUMP" ("/msg $O DUMP <raw line>",
"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.",
- "$uSee Also:$u raw");
+ "Access level: $b${level/dump}$b",
+ "$uSee Also:$u raw"
+ );
"RAW" ("/msg $O RAW <raw line>",
"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.",
- "$uSee Also:$u dump");
+ "Access level: $b${level/raw}$b",
+ "$uSee Also:$u dump"
+ );
"SETTIME" ("/msg $O SETTIME [servermask] [resync]",
- "Sets the time on the named server(s) to match the time known to srvx.",
+ "Sets the time on the named server(s) to match the time known to X3.",
"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.",
- "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.");
+ "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.",
+ "Access level: $b${level/settime}$b",
+ "$uSee Also:$u timecmd"
+ );
"STATS" ("/msg $O STATS <subject>",
"Displays statistics about a specified subject. Subjects include:",
"$bBAD$b: Current list of bad words and exempted channels.",
"$bGAGS$b: The list of current gags.",
"$bGLINES$b: Reports the current number of glines.",
+ "$bSHUNS$b : Reports the current number of shuns.",
"$bLINKS$b: Information about the link to the network.",
"$bMAX$b: The max clients seen on the network.",
"$bNETWORK$b: Displays network information such as total users and how many users are on each server.",
"$bNETWORK2$b: Additional information about the network, such as numerics and linked times.",
"$bOPERS$b: A list of users that are currently +o.",
- "$bPROXYCHECK$b: Information about proxy checking in srvx.",
+ "$bPROXYCHECK$b: Information about proxy checking in X3.",
"$bRESERVED$b: The list of currently reserved nicks.",
"$bTIMEQ$b: The number of events in the timeq, and how long until the next one.",
"$bTRUSTED$b: The list of currently trusted IPs.",
- "$bUPTIME$b: Srvx uptime, lines processed, and CPU time.",
- "$bWARN$b: The list of channels with activity warnings.",
+ "$bUPTIME$b: X3 uptime, lines processed, and CPU time.",
"$bMODULES$b: Shows loaded modules that implement commands.",
- "$bSERVICES$b: Shows active service bots.");
+ "$bSERVICES$b: Shows active service bots.",
+ "Access level: $b${level/stats}$b",
+ );
"INDEX" "${index}";
-"SEX" ("$bSEX$b",
- "I'm sorry, but I can't give you help regarding your sex life.",
- "But if you're so desperate you'll ask an IRC service bot for advice, you need therapy.");
projects / irc / evilnet / x3.git / blobdiff