changes to !uset autoinvite behavior, introduction of allchanmsg_func hooks
[srvx.git] / src / chanserv.help
index 574f39da408db0316f1510ae5806f51af1fbccb2..df5bc01d465b8a68d5c69e9d9fc10db3fb546e94 100644 (file)
@@ -5,9 +5,9 @@
         "  CHANNEL         Channel management.",
         "  BAN MANAGEMENT  Ban management.",
         "  INFORMATION     Informative commands.",
-        "  OPER            Helper/Operator commands."
+        "  OPER            Helper/IRC Operator commands."
 );
-"USER" ("$bUser commands:$b",
+"USER" ("$bUser Management Commands:$b",
         "  ACCESS      Check someone's access in a channel.",
         "  MYACCESS    Show all channels where you have access.",
         "  ADDCOOWNER  Give another person coowner status in a channel.",
         "  MDELOP             ops with accounts matching a mask.",
         "  MDELPEON           peons with accounts matching a mask.",
        "  TRIM        Remove users inactive for a certain period.",
-        "  UP          Obtain ops in a channel you have access to.",
-        "  DOWN        Remove ops",
-        "  UPALL       Obtain ops in all channels you have access to.",
-        "  DOWNALL     Remove ops in all",
+        "  UP          Give you ops in a channel you have access to.",
+        "  DOWN        Remove your ops in a channel.",
+        "  UPALL       Give you ops in all channels you have access to.",
+        "  DOWNALL     Remove your ops in all channels.",
         "  OP          Give ops to the specified user.",
         "  DEOP        Remove ops from the specified user.",
         "  VOICE       Give voice to the specified user.",
@@ -41,7 +41,7 @@
         "  KICK        Kick a user from a channel.",
         "  BAN         Ban a user from a channel.",
         "  KICKBAN     Kick and ban a user from a channel.",
-        "  BANS        List lasting bans in a channel",
+        "  BANS        List lasting bans in a channel.",
         "  ADDBAN      Add a permanent ban for a user.",
         "  ADDTIMEDBAN Add a ban that expires in the specified time.",
         "  UNBAN       Remove the specified ban from the channel.",
@@ -69,7 +69,7 @@
         "  RESYNC      Synchronize ops and voice with the channel userlist."
 );
 "INFORMATION" ("$bInformative Commands:$b",
-        "  VERSION     Check the current running version of $C",
+        "  VERSION     Check the current running version of $C.",
         "  NETINFO     Check current network-wide information.",
         "  STAFF       Get a list of all the current staff.",
         "  IRCOPS                                    IRC operators.",
 "ADDBAN" ("/msg $C ADDBAN <#channel> <mask|nick> [Reason]",
         "Adds a ban to the channels permanent ban list, remaining in effect until removed with the DELBAN command. If it exactly matches an existing ban already in the list, the reason will be updated. If the existing ban was a timed ban, it will be extended into a permanent ban.",
         "$uSee Also:$u bans, delban, mdelban");
-"ADDUSER" ("/msg $C ADDUSER <#channel><nick|*account> <level>",
+"ADDUSER" ("/msg $C ADDUSER <#channel> <nick|*account> <level>",
         "This command adds someone to the channel user list with the specified access level.  (You may only add users to levels less than your own.)",
         "The level may be one of $bpeon$b, $bop$b, $bmaster$b, $bcoowner$b, $bowner$b, or a number between 1 and 500.  Only network staff may add level 500 users (owners).",
         "$uSee Also:$u deluser, users");
         "If the note type already exists, it is modified with the new values you specify.",
         "$uSee Also:$u removenote");
 "GIVEOWNERSHIP" ("/msg $C GIVEOWNERSHIP <#channel> <nick|*account>",
-        "Transfer ownership of the channel from you to another user on the channel's userlist.  You are demoted to co-owner, and they are promoted to owner.",
+        "Transfer ownership of the channel from you to another user on the channel's userlist.  You are demoted to co-owner, and he or she is promoted to owner.",
        "You may use *Account instead of Nick as the name argument; the * makes $C use the name of a account directly (useful if the user is not online).",
         "$uSee Also:$u clvl, access, users");
 "CSUSPEND" ("/msg $C CSUSPEND <#channel> [!]<duration> <reason>",
         "$uSee Also:$u unregister, cunsuspend, durations");
 "CUNSUSPEND" ("/msg $C CUNSUSPEND <#channel>",
         "Restores a channel's $b$C$b registration.",
-        "$bSee Also:$b csuspend, unregister");
+        "$uSee Also:$u csuspend, unregister");
 "DELBAN" ("/msg $C DELBAN <#channel> <mask|nick>",
         "Deletes a ban from the channel ban list. This command works for both permanent and timed bans alike.",
         "$uSee Also:$u addban, addtimedban, bans");
         "This command responds with various pieces of information about a channel's users, status, and registration.");
 "INVITE" ("/msg $C INVITE <#channel> [nick [reason]]",
         "Invites a user into the channel, sending them a reason if one is provided. However, unless you have at least $bmaster$b access, you can only invite yourself with this command. If no nick is provided, the user issuing the command will be invited.");
+"INVITEME" ("/msg $S INVITEME <#channel>",
+        "Invites you into the channel.");
 "IRCOPS" ("/msg $C IRCOPS",
         "Lists all the IRC operators currently online. Nicknames enclosed in parentheses are away, and likely unavailable.",
         "$uSee Also:$u staff");
 "KICK" ("/msg $C KICK <#channel> <mask|nick> [reason]",
         "Kicks the users matching the given nick or mask with the specified reason. If no reason is provided, a default will be used.",
-        "$bSee Also:$b kickban");
+        "$uSee Also:$u kickban");
 "KICKBAN" ("/msg $C KICKBAN <#channel> <mask|nick> [reason]",
         "Kicks and bans with the specified reason any users with a matching nick or hostmask. If no reason is provided, a default one will be used.",
-        "$bSee Also:$b addban, kick");
+        "$uSee Also:$u addban, kick");
 "MDELCOOWNER" ("/msg $C MDELCOOWNER <#channel> <pattern>",
         "Deletes all coowners with accounts matching the given pattern from the channel user list.",
-        "$bSee Also:$b clist, delcoowner");
+        "$uSee Also:$u clist, delcoowner");
 "MDELMASTER" ("/msg $C MDELMASTER <#channel> <pattern>",
         "Deletes all masters with accounts matching the given pattern from the channel user list.",
-        "$bSee Also:$b mdelban, mdelcoowner, mdelop, mdelowner, mdelpeon");
+        "$uSee Also:$u mdelban, mdelcoowner, mdelop, mdelowner, mdelpeon");
 "MDELOP" ("/msg $C MDELOP <#channel> <pattern>",
         "Deletes all ops with accounts matching the given pattern from the channel user list.");
 "MDELOWNER" ("/msg $C MDELOWNER <#channel> <pattern>",
         "ENFOPS:       Restrictions for opping users.",
         "ENFMODES:     Restrictions to change the default modes.",
         "ENFTOPIC:     Restrictions on changing the topic.",
-        "TOPICSNARF:   Topics set manually (by /TOPIC #channel ...) by users this level and bove change the default $b$C$b topic.",
+        "TOPICSNARF:   Topics set manually (by /TOPIC #channel ...) by users this level and above change the default $b$C$b topic.",
         "SETTERS:      Who may change channel settings (using $bSET$b).",
         "CTCPUSERS:    Who is allowed to send CTCPs to the channel.",
         "CTCPREACTION: What happens when a disallowed CTCP is sent to the channel.",
        "TOYS:         Toggles how $b$C$b will respond to toy commands (!8ball etc).",
         "TOPICREFRESH: Controls if (and how often) $b$C$b will reset the topic.",
         "DYNLIMIT:     Adjusts user limit (+l channel mode) to prevent join floods.",
-        "PEONINVITE:   Indicates whether peons may use the $bINVITEME$b command.",
         "$bIRCOP ONLY$b:",
         "NODELETE:  Prevents channel deletion.",
         "If you wish to reset your channel to the default settings, you can use the $bSET DEFAULTS$b command.",
         "This sets a pattern that $C allows for the topic.  A $b*$b will match any number of characters (including 0); a $b?$b will match any single character -- the same as with IRC hostmasks.  A user may set a topic if either $btopicmask$b or $benftopic$b allow it.",
         "For example, $b!set topicmask Hello *$b allows anyone to set the topic to be $bHello world$b, but they must be able to override the topic (according to the $bEnfTopic$b setting) to set the topic to $bGoodbye world$b.",
         "You may \"escape\" those characters by putting a \\ before them in the topic mask; for example, $b!set topicmask Whassup\\?$b would only allow the topic to be $bWhassup?$b, while leaving out the \\ would allow the topic to be $bWhassup!$b (among other things).",
-        "For ease of use, if the TopicMask has only one * and no ?, then using $b!topic something$b will (if $bsomething$b does not match the TopicMask and you cannot override the topic lock) replace the * with the text $bsomething$b.",
+        "For ease of use, if the TopicMask has only one * and no ?, then using $b!topic something$b will (if $bsomething$b does not match the TopicMask and you cannot override the topic lock) replace the * with the text $bsomething$b.  If there is more than one * or any ? at all, $b!topic something$b will not work like that.",
         "$uSee Also:$u set, set topic, set enftopic");
 "SET TOYS" ("/msg $C SET <#channel> TOYS <value>",
        "This setting changes how $C will respond to commands like !8ball, or whether it responds at all.  Valid settings are:",
         "$b3$b  No users will be protected.",
         "$uSee Also:$u set");
 "SET SETTERS" ("/msg $C SET <#channel> SETTERS <value>",
-        "This setting restricts the protection that $C enforces.  It is a numeric user level.",
+        "Users with at least this user level can use the $bset$b command for $C.",
         "$uSee Also:$u set");
 "SET TOPICREFRESH" ("/msg $C SET <#channel> TOPICREFRESH <value>",
         "This setting controls if (and how often) $C refreshes the topic to the default value.  Valid settings are:",
         "$uSee Also:$u durations");
 "UNBAN" ("/msg $C UNBAN <#channel> <mask|nick>",
         "Unbans the specified nick or hostmask. If a nick is given, $b$C$b determines what hostmask(s) to unban.",
-        "$bSee Also:$b ban, kick, kickban");
+        "$uSee Also:$u ban, kick, kickban");
 "UNBANALL" ("/msg $C UNBANALL <#channel>",
         "Clears the specified channel's banlist. If the channel is omitted, then $bunbanall$b will be done in the channel where the command was given.",
-        "$bSee Also:$b ban, unban, unbanme");
+        "$uSee Also:$u ban, unban, unbanme");
 "UNBANME" ("/msg $C UNBANME <#channel>",
         "Unbans your hostmask from the specified channel.",
-        "$bSee Also:$b ban, unban");
+        "$uSee Also:$u ban, unban");
 "UNREGISTER" ("/msg $C UNREGISTER <#channel> [<confirmation>]",
         "Unregisters a channel that is registered with $b$C$b. $bIMPORTANT$b: Once the channel is unregistered, the userlist $bcannot$b be recovered.",
         "If you are not network staff, you must add a confimation string to the end of your line to confirm the unregistration.  If you leave it out, $C will show the proper confirmation string.",
-        "$bSee Also:$b register");
+        "$uSee Also:$u register");
 "UNSUSPEND" ("/msg $C UNSUSPEND <#channel> <nick|*account>",
         "This restores the target's access to the channel (after it has been suspended).",
         "$uSee Also:$u suspend, deluser");
 "UNVISITED" ("/msg $C UNVISITED [duration] [limit]",
         "Displays up to a certain limit, all channels registered with $b$C$b that have not been visited within a certain duration. If a duration is not provided, a default will be used.",
-        "$bSee Also:$b expire, search, durations");
+        "$uSee Also:$u expire, search, durations");
 "UP" ("/msg $C UP <#channel>",
-        "For a peon, this will cause $b$C$b to voice the user executing the command. For anyone of level op on higher on the userlist, this will cause $b$C$b to op the user executing the command.");
+        "Grants you your normal channel privileges.  If your access in the channel is less than the GiveVoice setting, this does nothing.  Otherwise, if your access is less than the GiveOps setting, $b$C$b will give you voice.  If your access is at least GiveOps, $b$C$b will give you ops.");
 "UPALL" ("/msg $C UPALL",
         "Executes the $bup$b command for each channel you have access in.",
         "$uSee Also:$u up, down, downall");
          "$bOptions:$b",
          "INFO:       Sets the infoline that $C sends when you join the channel.",
          "NOAUTOOP:   Enable or disable $C automatically opping you upon joining or authenticating.",
-         "AUTOINVITE: $C will invite you to +i/+k channels which you have access to and are not in when you authenticate if this setting is on.",
+        "AUTOINVITE: $C will invite you to this channel if you have access to and are not in when you authenticate if this setting is on.",
          "NOTE: The NoAutoOp setting is equivalent to the !togop command in previous versions of srvx.",
          "$uSee Also:$u set");
 "USET INFO" ("/msg $C USET <#channel> INFO <info>",
 "USERS" ("/msg $C USERS <#channel> [mask]",
         "Displays the userlist for the specified channel. If a mask is supplied, only users matching the mask will be shown.",
         "$uSee Also:$u clist, mlist, olist, plist, wlist");
-"VERSION" ("/msg $C VERSION",
-        "Sends you the srvx version and some additional version information that is specific to $b$C$b.");
 "VOICE" ("/msg $C VOICE <#channel> <nick> [nick]...",
         "Voices the specified nick in the specified channel. If the channel is omitted, then $bvoice$b will be done in the channel where the command was given.",
         "$uSee Also:$u devoice");
         "$bGameSurge IRC Network$b - All the users and staff there bear with our shortcomings and bugs and let us know what needs to be fixed.",
         "$bIC5 Networks$b (and JohnM in particular) - Never afraid to critique things, even if we are the 800 pound gorilla.",
         "$bMeeko, eraser, hock(ey), KilledInAction, MadEwokHerd, Milon and Shoat$b - Hardcore beta testing and bug finding on the testnet.",
-        "$bCrips$b - Reading through all the boring messages and finding ways to make them clearer.");
+        "$bCrips and feigling$b - Reading through all the boring messages and finding ways to make them clearer.");