-"<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.",
+ " $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.",
" $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!)"
);
"$uSee Also:$u delalert, alert reaction, trace criteria"
);
-"TIME NOTATION" ("=---------------- $bTime Notation$b ---------------=",
+"TIME NOTATION" (
" Many commands require a duration perameter ",
" which all use the same syntax: ",
" 1s - 1 second ",
" 1y - 1 year",
" Times can be compounded such as: ",
" 1m40s - 1 minute and 40 seconds ",
- " 5h20m30s - 5 hours 20 minutes and 30 seconds ",
- "=-----------------------------------------------="
+ " 5h20m30s - 5 hours 20 minutes and 30 seconds "
);
"ADDTRUST" ("/msg $O ADDTRUST <ip> <count> <duration> <reason>",
"$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",
+ "$bSHUN$b : Shun the user that tripped the alert",
"$uSee Also:$u addalert, delalert"
);
"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",
+ "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"
);
"$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"
);
"$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).",
+ "$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"
);
"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.",
"Access level: $b${level/addbad}$b",
- "$uSee Also:$u addexempt, delbad, stats"
+ "$uSee Also:$u addexempt, delbad, stats bad, $C:noregister"
);
"ADDEXEMPT" ("/msg $O ADDEXEMPT <#channel>",
"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.",
"Access level: $b${level/delbad}$b",
- "$uSee Also:$u addbad, delexempt, stats"
+ "$uSee Also:$u addbad, delexempt, stats bad, $C:allowregister"
);
"DELEXEMPT" ("/msg $O DELEXEMPT <#channel>",
"$uSee Also:$u addexempt, delbad, stats"
);
-"UNWARN" ("/msg $O UNWARN <#channel>",
- "Deletes the activity warning for a channel.",
- "Access level: $b${level/unwarn}$b",
- "$uSee Also:$u warn, stats warn"
- );
-
-"WARN" ("/msg $O WARN <#channel> [reason]",
- "Adds an activity warning for the channel.",
- "Access level: $b${level/warn}$b",
- "$uSee Also:$u unwarn, stats warn"
- );
-
"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.",
);
"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.",
+ "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"
);
"$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"
+ );
+
+"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:",
"$bADD$b: Adds a new clone. Arguments: <nickname> <user@host> <info>",
);
"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.",
+ "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.",
+ "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.",
+ "Causes X3 to unjupe a jupe server.",
"Access level: $b${level/unjupe}$b",
"$uSee Also:$u jupe, unreserve, clone"
);
);
"DIE" ("/msg $O DIE <reason>",
- "SQUIT srvx with the given reason and shuts it down.",
+ "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.",
+ "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.",
+ "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.",
+ "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.",
+ "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).",
+ "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"
+ "$uSee Also:$u ungag, trace, stats gags"
);
"HELPSERV" ("/msg $O HELPSERV <command>",
"$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.",
+"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"
);
);
"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.",
+ "Ungags a gaged hostmask.",
"Access level: $b${level/ungag}$b",
"$uSee Also:$u gag, stats gags"
);
);
"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"
);
"$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.",
"Access level: $b${level/stats}$b",
projects / irc / evilnet / x3.git / blobdiff