]> jfr.im git - irc/evilnet/x3.git/blobdiff - src/opserv.help
Fix typos and copy errors in opserv help
[irc/evilnet/x3.git] / src / opserv.help
index 45ca3b8a528e2f825e28696203d7cb488f45a1fb..f9c040131d8174452722fa5a6e27dee475f86881 100644 (file)
@@ -56,7 +56,7 @@
                 "  $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."
+                "  $bTRACES$b  Powerful commands for viewing or acting on lists of IRC objects."
                );
 
 "TRACES"   (
             " $bROUTING MAP$b       Show what the active routing plan says the network should look like.",
             " $bREROUTE$b           Connect servers to the network, optionally squiting them first to change the routing.",
             " $b$b ",
-            " Start by creating a routing plan, and then adding servers to it, with their listning port, uplink, and a backup uplink. You can view it in $bSTATS ROUTING planname$b. Take care not to create loops, and that you make everything connected. Then set your new plan ACTIVE using $bROUTING SET$b. $O does the rest! See help topic $bROUTING EXAMPLE$b for a working example."
+            " Start by creating a routing plan, and then adding servers to it, with their listening port, uplink, and a backup uplink. You can view it in $bSTATS ROUTING planname$b. Take care not to create loops, and that you make everything connected. Then set your new plan ACTIVE using $bROUTING SET$b. $O does the rest! See help topic $bROUTING EXAMPLE$b for a working example."
             );
 
 "CHANNEL"  (
             "  $b$b",
             "  $bINVITE$b     Invite someone to a channel.",
             "  $bINVITEME$b   Invite yourself to a channel.",
-            "  $bCLEARBANS$b  Cear all bans from a channel.",
+            "  $bCLEARBANS$b  Clear all bans from a channel.",
             "  $bCLEARMODES$b Clear all modes from a channel."
            );
 
             "  $bCLONE$b        Create and manipulate a fake user.",
             "  $bCOLLIDE$b      Create a clone, colliding an existing user.",
             "  $bRESERVE$b      Permanently reserve a nick with a clone.",
-            "  $bUNRESERVE$b    Remove a perminant reserved clone.",
+            "  $bUNRESERVE$b    Remove a permanent reserved clone.",
             "  $bJUPE$b         Create dummy server.",
             "  $bUNJUPE$b       Remove a dummy server.",
             "  $b$b",
              "  $bADDEXEMPT$b     Make an exception to the illegal word list for a channel.",
              "  $bDELEXEMPT$b     Remove an exception of the illegal word list.",
              "  $b$b",
-             "  $bDUMP$b          Drop safetychecked server protocol to the server. ",
+             "  $bDUMP$b          Drop safety-checked server protocol to the server. ",
              "  $bRAW$b           Drop raw server protocol to the server. (DANGEROUS!)",
              "  $b$b",
              "  $bRESETMAX$b      Reset the maximum recorded users. (used in the event of a clone flood)"
 
 "ADDALERT" ("/msg $O ADDALERT <name> <reaction> [expire <duration>] <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.",
+        "Alerts watch for users matching a given 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.",
         "   <duration> - Duration after which the alert should be deleted. See $bdurations$b.",
         );
 
 "TIME NOTATION" (
-                 " Many commands require a duration perameter ",
+                 " Many commands require a duration parameter ",
                  " which all use the same syntax: ",
                  "      1s  - 1 second ",
                  "      2m  - 2 minutes ",
         "$bGLINE$b:        Gline the user that tripped the alert",
         "$bTRACK$b:        Send a notice to the $b$O$b alert channel and track the user (if the tracking module is loaded)",
         "$bSHUN$b :        Shun the user that tripped the alert",
+        "$bTEMPSHUN$b :    Temporarily shun the user that tripped the alert",
         "$bVERSION$b :     Check the version on the user that tripped the alert",
         "$bSVSJOIN$b :     Force the user that tripped the alert to join the target channel",
         "$bSVSPART$b :     Force the user that tripped the alert to part the target channel",
+        "$bMARK$b :        Mark the user that tripped the alert (must be used in combination with the mark trace criteria)",
         "$uSee Also:$u addalert, delalert"
         );
 
         "Edits the 'trust' for the specified IP, changing the count, duration and/or reason.",
         "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.",
         "$uSee Also:$u addtrust, deltrust, stats trusted");
+"INVITE" ("/msg $O INVITE #channel",
+        "Invites you to the specified channel.");
 "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.",
         
 "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, SHUN, GAG, DOMAINS, SVSJOIN, SVSPART, VERSION",
+        "Quick Ref ACTIONS: PRINT, COUNT, PRIVMSG, NOTICE, KILL, GLINE, SHUN, TEMPSHUN, GAG, DOMAINS, SVSJOIN, SVSPART, VERSION",
         "Quick Ref CRITERIA: MASK, NICK, IDENT, HOST, INFO, SERVER, IP, ACCOUNT, AUTHED, CHANNEL, NUMCHANNELS, LIMIT, NICKAGE, ACCESS, REASON, DEPTH, DURATION, CLONES, INFO_SPACE, CHECKRESTRICTIONS ABUSE OPERS, LOG, REGEX, CHANTARGET, SILENT, VERSION, MARKED",
         "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:",
-        "$bPRINT$b:   Display the hostmask to you.",
-        "$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.", 
-        "$bSVSJOIN$b: Force users to join channel givin in chantarget criteria.",
-        "$bSVSPART$b: Force part the matching clients out of the specified target channel.",
-        "$bVERSION$b: Query for the users CTCP VERSION reply.",
-        "$bMARK$b:    Set a nefarius 'mark' named via the mark criteria as if the user were in that dnsbl.",
+        "$bPRINT$b:    Display the hostmask to you.",
+        "$bCOUNT$b:    Count all matching users.",
+        "$bPRIVMSG$b:  Send a PRIVMSG to all matching users containing REASON.",
+        "$bNOTICE$b:   Send a NOTICE to all matching users containing REASON.",
+        "$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).",
+        "$bTEMPSHUN$b: Issue a temporary shun that affects only the targeted users.",
+        "$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.", 
+        "$bSVSJOIN$b:  Force users to join channel given in chantarget criteria.",
+        "$bSVSPART$b:  Force part the matching clients out of the specified target channel.",
+        "$bVERSION$b:  Query for the users CTCP VERSION reply.",
+        "$bMARK$b:     Set a nefarious 'mark' named via the mark criteria as if the user were in that dnsbl.",
         "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"
         );
         "$bIDENT$b ident              Specifies an ident to search for.",
         "$bHOST$b host                Specifies a hostname to search for.",
         "$bINFO$b infoline            Specifies a user's info to search for.",
+        "$bMODES$b +modes-modes       Specifies modes they have and don't have.",
         "$bSERVER$b server            Specifies a server to search for.",
         "$bIP$b 127.0.0.1             Specifies an IP to search for (independent of hostname).",
         "$bACCOUNT$b account          Specifies an account to search for.",
         "$bMARKED$b mark              If they have a dnsbl mark matching mark. (e.g. from an X line or alert)",
         "$bCHANTARGET$b #channel      For use with SVSJOIN action, this specifies the channel they are svsjoined to.",
         "$bCHECKRESTRICTIONS$b yes/no For use with SVSJOIN action, this specifies to check channel modes like bans, invite, limits, and key before the SVSJOIN is issued.",
-        "$bMARK$b mark                For use with the MARK action, this is what thety are marked with.",
+        "$bMARK$b mark                For use with the MARK action, this is what they are marked with.",
         "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.",
         "When searching on the criteria of nick, ident, or info, the search string can be another of the three, prefixed with a & character, to indicate that the match should compare each user's individual data.  For example, $binfo &nick$b would search for all users whose info matches their nick.  To search for that phrase explicitly, prefix the & with a backslash; e.g.: $binfo \&ident$b.",
         "$uSee Also:$u trace action, trace"
         "Criteria and values for $bcsearch$b (a search with $bcsearch$b must match all specified items):",
         "$bNAME$b name              Specifies a name to search for.",
         "$bTOPIC$b topic            Specifies a topic to search for.",
-       "$bUSERS$b cmp              User count constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
+        "$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."
         );
         );
 
 "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.",
+        "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.",
         "Access level: $b${level/unban}$b",
-       "$uSee Also:$u kickban, kickbanall, ban"
+        "$uSee Also:$u kickban, kickbanall, ban"
         );
 
 "CLEARBANS" ("/msg $O CLEARBANS <#channel> ",
         );
 
 "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).",
-        "duration is in the form nnm, where nn is a number, and m is a charactor representing the unit (eg d for days.)",
+        "Issues a GLINE (network ban) on the network for the specified user@host for the specified duration (making the expiration time: net time + duration).",
+        "duration is in the form nnm, where nn is a number, and m is a character representing the unit (e.g., d for days.)",
         "Access level: $b${level/gline}$b",
         "$uSee Also:$u trace, ungline, ($C) durations"
         );
         "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"
         );
 
         );
 
 "GSYNC" ("/msg $O GSYNC [server]",
-       "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.",
+        "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 refreshg, gline, ungline"
         );
 
 "DEFCON" ("/msg $O DEFCON [1|2|3|4|5]",
         );
 
 "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).",
+        "Issues a SHUN on the network for the specified user@host for the specified duration (making the expiration time: net time + duration).",
         "Access level: $b${level/shun}$b",
         "$uSee Also:$u trace, unshun"
         );
         "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",
+        "$bUNSHUN$b: Remove matching shuns",
         "$uSee Also:$u strace criteria, 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.",
+        "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"
+        "$uSee Also:$u refreshs, shun, unshun"
         );
 
 "REFRESHS" ("/msg $O REFRESHS [server]",
         );
 
 "CLONE" ("/msg $O CLONE <sub-command> <sub-command arguments>",
-        "Creats and manipulates a fake user. Sub-commands for $bclone$b are:",
+        "Creates and manipulates a fake user. Sub-commands for $bclone$b are:",
         "$bADD$b:    Adds a new clone. Arguments: <nickname> <user@host> <info>",
         "$bREMOVE$b: Removes a clone. Arguments: <nickname>",
         "$bJOIN$b:   Joins a clone to a channel. Arguments: <nickname> <channel>",
         );
 
 "JUPE" ("/msg $O JUPE <srvname> <srvnum> <description>",
-       "Causes X3 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"
+        "$uSee Also:$u unjupe, clone, reserve"
         );
 
 "RESERVE" ("/msg $O RESERVE <nickname> <user> <host> <comment>",
         );
 
 "UNJUPE" ("/msg $O UNJUPE <srvname>",
-       "Causes X3 to unjupe a jupe server.",
+        "Causes X3 to unjupe a jupe server.",
         "Access level: $b${level/unjupe}$b",
-       "$uSee Also:$u jupe, unreserve, clone"
+        "$uSee Also:$u jupe, unreserve, clone"
         );
 
 "ROUTING ADDPLAN" ("/msg $O ROUTING ADDPLAN <name>",
         "Adds a server to the routing plan 'plan'.",
         " plan   - The name of a routing plan already created.",
         " server - The name of the server you are adding (full hostname).",
-        " port   - The port that the server listens to connectons on. If you leave this out, the default is taken from $bSET ROUTING DEFAULT_PORT$b.",
+        " port   - The port that the server listens to connections on. If you leave this out, the default is taken from $bSET ROUTING DEFAULT_PORT$b.",
         " uplink - This is the server (full hostname) that you want the server to connect to.",
         " backup uplink - If uplink is offline, this one takes over.",
         " $b$b ",
-        " It is $uvery$u important that the routing plan be from a consistant perspective, without any loops, or disconnected pieces. It helps to pick a server (usually the one $O is liked to) and consider which server each of the servers links to towards $O. For an example see /msg $O HELP ROUTING EXAMPLE.",
+        " It is $uvery$u important that the routing plan be from a consistent perspective, without any loops, or disconnected pieces. It helps to pick a server (usually the one $O is liked to) and consider which server each of the servers links to towards $O. For an example see /msg $O HELP ROUTING EXAMPLE.",
         " If you add a server whose name already exists, the old one will be replaced.",
         "$uSee Also:$u routing, stats routing, routing delserver, routing addplan",
         );
         "    `-test2.net.org      - test2's uplink is test",
         "      `-test3.net.org    - test3's uplink is test2",
         " $b$b ",
-        " Its important that every entry in your routing plan be specified relitive to the same location. Usually this is the location of X3 itself, but doesn't have to be. In the above example you could do:",
-        "  ROUTING ADDPLAN mylpan ",
+        " It's important that every entry in your routing plan be specified relative to the same location. Usually this is the location of X3 itself but it does not have to be. In the above example you could do:",
+        "  ROUTING ADDPLAN myplan ",
         "  ROUTING ADDSERVER myplan test.net.org:4400 x3.net.services ",
         "  ROUTING ADDSERVER myplan test2.net.org:4400 test.net.org ",
         "  ROUTING ADDSERVER myplan test3.net.org:4400 test2.net.org ",
         "  ROUTING ADDSERVER myplan foobar.net.org:4400 laptop.net.org ",
         "  ROUTING SET ACTIVE myplan ",
         " $b$b ",
-        " If there are loops, or two servers who point to eachother, $O will not be able to use the plan. If there are sections which do not link back to the rest, they will be lost and the plan will not work properly.",
+        " If there are loops, or two servers who point to each other, $O will not be able to use the plan. If there are sections which do not link back to the rest, they will be lost and the plan will not work properly.",
         );
        
 "ROUTING DELSERVER" ("/msg $O ROUTING DELSERVER <plan> <server>",
 
 "REROUTE" ("/msg $O REROUTE <C|N|T>",
         "Allows $O to make changes to the linkage of the servers on the network. It has 3 modes: Normal, Connect-only, and Test:",
-        " N - Normal mode: Will delink any servers which are not linked to their primary uplink, and try to reconnect them correctly according to the active routing plan. it will also try to connect servers that are completely missing.",
+        " N - Normal mode: Will delink any servers which are not linked to their primary uplink and try to reconnect them correctly according to the active routing plan. it will also try to connect servers that are completely missing.",
         " C - Connect-only:  Will attempt to connect any missing servers to the network, using the active routing plan.",
         " T - Test: Will do the same as normal mode, only all actions will be simulated. No actual rerouting will take place, it will only tell you what it WOULD do in normal mode.",
         " $b$b ",
         );
 
 "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):",
+        "Searches services logs based on criteria specified and displays the results.",
+        "Criteria and associated values (a search matches all specified items):",
         "$bBOT$b -         A service bot's name (for example, $O).",
         "$bCHANNEL$b -     The channel where a command was issued (accepts wildcards).",
         "$bNICK$b -        The nickname issuing the command (accepts wildcards).",
 "TRACK" ("/msg $O TRACK <+/-type|all|none>",
         "This specifies what will be tracked in the tracking channel.",
         "Use + to add flags and - to remove types. Use ALL to enable all",
-        "tracking options available, use NONE to completly disable them.",
+        "tracking options available, use NONE to completely disable them.",
         "Available flags are:",
         "auth  - Auths",
         "chanmode - Channel Modes",
         "$uSee Also:$u addtrack deltrack");
 
 "RESETMAX" ("/msg $O RESETMAX",
-        "Resets the max clients number to the current ammount of connected clients. Use with caution.",
+        "Resets the max clients number to the current amount of connected clients. Use with caution.",
         "$uSee Also:$u stats max");