]> jfr.im git - irc/evilnet/x3.git/blobdiff - src/chanserv.help
Fixed up the help system some more, and some other small changes.
[irc/evilnet/x3.git] / src / chanserv.help
index baf27398d4192f515652d3e2b73b1fa09331499a..d15c1df49ffb9a83c0fdfe55c674070e039cb142 100644 (file)
@@ -1,12 +1,16 @@
-"<INDEX>" ("=--------------- $b$C Help$b --------------=",
+"<INDEX>" (
            " Hello there!                           ",
+           " I'm $C, your handy channel services bot.",
+           " $b$b",
            " Please select the area you would like  ",
            " help with from the list below. The     ",
            " help system  uses the format:          ",
            "   $b/MSG $C HELP <$bsubject$b>$b       ",
+           " (In help, Words in <> represent required",
+           " paramiters. Words in [] are optional.)",
            " For example: $b/msg $C HELP UBM$b      ",
-           " shows help with the UnBanMe command.   ",
-           "=--------------------------------------=",
+           " shows help with the Un-Ban Me command.   ",
+           "=---------------------------------------=",
            " GENERAL  - How to use $C  ",
            " USER     - Commands to add and remove",
            "            bans, ops and managers from ",
            "            and topic.",
            " INFORMATION - Informative commands.",
            " OPER     - Commands for IRC Operators.",
-           "=--------------------------------------=",
+           "$b$b",
+           "Also see $b/MSG $N HELP$b for getting",
+           "and maintaining your user account."
 );
-"USER"     ("=-- $bUserlist Management Commands:$b ---=",
+"USER"     ("$bUserlist Management Commands:$b",
             " $bUSERS$b       Show the channels userlist.",
             " $bCLIST$b       Show all COOWNERs of a channel.",
             " $bMLIST$b       Show all MANAGERs of a channel.",
             " $bOLIST$b       Show all OPs of a channel.",
             " $bHLIST$b       Show all HALFOPs of a channel.",
             " $bPLIST$b       Show all PEONs of a channel.",    
-            " $bBANS$b        Show all  $ulasting$u bans in a channel.",
+            " $bLAMERS$b      Show all  LAMERs of a channel.",
             " $bACCESS$b      Check someone's access level in a channel.",
             " $bCLVL$b        Change a person's access level in a channel.",
             " $bUSET$b        Set a channel user's options (autos, info).",
@@ -37,8 +43,8 @@
             " $bADDMANAGER$b  Add a user as a MANAGER in a channel.",
             " $bADDCOOWNER$b  Add a user as COOWNER in a channel.",
             " $bADDUSER$b     A more advanced way to add users.",
-            " $bADDBAN$b      Add a $upermanent$u ban for a user.",
-            " $bADDTIMEDBAN$b Add a $ulasting$u ban that expires in the specified time.",
+            " $bADDLAMER$b    Add a lamer to the lamers (keep out) list.",
+            " $bADDTIMEDLAMER$b Add a lamer to the lamers list that expires in the specified time.",
             "$b$b",
             " $bDELUSER$b     Delete a user from the userlist.",
             " $bMDELCOOWNER$b Mass-delete coowners with accounts matching a mask.",
@@ -46,7 +52,7 @@
             " $bMDELOP$b      Mass-delete ops with accounts matching a mask.",
             " $bMDELHOP$b     Mass-delete halfops with accounts matching a mask.",
             " $bMDELPEON$b    Mass-delete peons with accounts matching a mask.",
-            " $bDELBAN$b      Remove the specified $upermanent$u ban from memory.",
+            " $bDELLAMER$b    Remove the specified lamer from the lamer list.",
             " $bWIPEINFO$b    Remove a lower-ranked user's infoline.",
             " $bTRIM$b        Delete users who are inactive.",
             " $bSUSPEND$b     Suspend a user's access to a channel.",
             "$b$b",
             " $bMYACCESS$b    Show all channels where you have access.",
             " $bDELETEME$b    Delete YOURSELF from the userlist.",
-            " $bGIVEOWNERSHIP$b Give away ownership to another user.",
-            "=------------- End of Help ------------="
+            " $bGIVEOWNERSHIP$b Give away ownership to another user."
 );
 
-"CHANNEL"  ("=-------- $bChannel Commands:$b ---------=",
+"CHANNEL"  ("$bChannel Commands:$b",
             " $bSET$b         Change various channel settings.",
             " $bTOPIC$b       Set the current topic, or reset it to the default topic.",
             " $bMODE$b        Change a channel mode.",
             " $bINVITE$b      Admit a user to pass through +ib modes in your channel.",
             "$b$b",
             " $bINFO$b        Show numerical information about the users in a channel.",
-            " $bEVENTS$b      View a list of events relevant to a channel.",
-            "=------------- End of Help ------------="
+            " $bEVENTS$b      View a list of events relevant to a channel."
 );
-"INFORMATION"     ("=------- $bInformative Commands:$b ------=",
+"INFORMATION"     ("$bInformative Commands:$b",
             " $bVERSION$b     Check the current running version of $C.",
             " $bNETINFO$b     Check current network-wide information.",
             " $bSTAFF$b       Get a list of all the current staff.",
             " $bIRCOPS$b      Get a list of all the current IRC operators.",
             " $bHELPERS$b     Get a list of all the current support helpers.",
             " $bPEEK$b        Reveal information on a channel's modes, topic and ops.",
-            " $bCOMMAND$b     Display some information about a command.",
-            "=------------- End of Help ------------="
+            " $bCOMMAND$b     Display some information about a command."
 );
-"OPER"     ("=-- $bHelper/IRC Operator commands:$b ---=",
+"OPER"     ("$bHelper/IRC Operator commands:$b",
             " $bGOD$b         Turn security override on/off.",
             " $bOPCHAN$b      Force $C to op itself in a channel.",
             "$b$b",
             " $bCREATENOTE$b  Create a new note type.",
             " $bREMOVENOTE$b  Remove an existing note type.",
             "*$bSAY$b         Have $C say a message in a channel.",
-            "*$bEMOTE$b       Equivalent to $C doing a /me in a channel.",
-            "=------------- End of Help ------------="
+            "*$bEMOTE$b       Equivalent to $C doing a /me in a channel."
 );
 
-"GENERAL"  ("=----------- General Help -------------=",
+"GENERAL"  (
             " NOTE: Before using $C or being added   ",
             " to channel userlists, users must       ",
             " register  an account with $b$N$b.      ",
             " expected as well.                       ",
             " See $b/msg $C HELP <COMMAND>$b for the  ",
             " exact syntax of each command.           ",
-            "=---------- For more info see ----------=",
-            "     http://www.afternet.org/support     ",
-            "=---------------------------------------="
+            "=---------- For more info see: ---------=",
+            "     http://www.afternet.org/support     "
 );
 
-"LOGIN" ("=-- Logging In --=",
+"LOGIN" (
          " Please login using:",
          "   /MSG $N AUTH <account> <password>",
          " or the shortcut:",
 "ACCESS" ("/msg $S ACCESS <#channel> [<nick|*account>]",
         "Reports various pieces of information about a channel user, including channel and network access level, and the user's info line. If no nick or account is provided, $S returns your own information.",
         "$uSee Also:$u myaccess, users");
-"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");
+"ADDLAMER" ("/msg $C ADDLAMER <#channel> <mask|nick> [Reason]",
+        "Adds a lamer to the channels lamer list, remaining in effect until removed with the DELLAMER command. ",
+        "Lamers are nick!user@host masks which $C watches for, and keeps out of your channel.",
+        "If it exactly matches an existing lamer already in the list, the reason will be updated. If the existing lamer was a timed lamer, it will be extended into a permanent lamer.",
+        "$uSee Also:$u llist, dellamer, mdellamer");
 "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, $bmanager$b, $bcoowner$b, $bowner$b, or a number between 1 and 500.  Only network staff may add level 500 users (owners).",
 "ADDHOP" ("/msg $C ADDHOP <#channel> <nick|*account>",
         "This command adds someone to the channel user list with HALFOP access level. (You may only add users to levels less than your own.)",
         "$uSee Also:$u adduser, deluser, users");
-"ADDTIMEDBAN" ("/msg $C ADDTIMEDBAN <#channel> <mask|nick> <Duration> [Reason]",
-        "Adds an automatically expiring ban to the channel ban list. This command behaves in the exact same fashion as ADDBAN with the exception that the bans are automatically removed after the user-supplied duration. 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. Timed bans can be removed with the DELBAN command, as with permanent bans.",
-        "$uSee Also:$u addban, bans, delban, durations");
+"ADDTIMEDLAMER" ("/msg $C ADDTIMEDLAMER <#channel> <mask|nick> <Duration> [Reason]",
+        "Adds an automatically expiring lamer to the channel lamer list.",
+        "This command behaves in the exact same fashion as $bADDLAMER$b with the exception that the lamers are automatically removed after the user-supplied duration. ",
+        "If it exactly matches an existing lamer already in the list, the reason will be updated. If the existing lamer was a timed lamer, it will be extended. Timed lamers can be removed with the $bDELLAMER$b command, as with permanent lamers.",
+        "$uSee Also:$u addlamer, lamers, dellamer, durations");
 "ALLOWREGISTER" ("/msg $C ALLOWREGISTER <#channel|*Account>",
         "Removes the named channel (or channel mask) from the do-not-register list.",
         "$uSee Also:$u register, noregister, unregister");
         "$uFor assistance, please join #Help$u",
         "Example: *!*serv@*.afternet.org would ban anyone with ident 'serv' and an afternet.org hostname from joining the channel.",
         "$uSee Also:$u unban, unbanall, unbanme");
-"BANS" ("/msg $C BANS <#channel> [mask]",
-        "This command lists all permanent and timed bans in the channel matching mask.",
-        "$uSee Also:$u addban, delban, mdelban");
+"LAMERS" ("/msg $C LAMERS <#channel> [mask]",
+        "This command lists all permanent and timed lamers in the channel matching an optional mask.",
+        "Lamers are nick!user@host masks which $C watches for, and keeps out of your channel.",
+        "$uSee Also:$u addlamer, dellamer, addtimedlamer");
 "CALC" ("/msg $C CALC <expression>",
         "CALC calculates a mathematical expression, and returns the answer.  It",
         "supports +, -, *, /, ^, and () and many other math operations, such as",
 "CUNSUSPEND" ("/msg $C CUNSUSPEND <#channel>",
         "Restores a channel's $b$C$b registration.",
         "$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");
+"DELLAMER" ("/msg $C DELLAMER <#channel> <mask|nick>",
+        "Deletes a lamer from the channel lamer list. This command works for both permanent and timed lamers alike.",
+        "$uSee Also:$u addlamer, addtimedlamer, lamers");
 "DELNOTE" ("/msg $C DELNOTE <#channel> <note-name>",
         "Deletes a note from the channel.  To do this, you must be able to set the note.",
         "$uSee Also:$u note, note types");
         "$uSee Also:$u say");
 "EVENTS" ("/msg $C EVENTS <#channel> [limit [pattern]]",
         "Allows channel coowners to view a list of events related to their channel. If a pattern is provided, only events with a matching description will be displayed.",
-       "$bNote:$b You must specify a limit if you want to use a pattern to match against.",
-        "$uSee Also:$u last");
+       "$bNote:$b You must specify a limit if you want to use a pattern to match against.");
 "EXPIRE" ("/msg $C EXPIRE",
         "Expires any channels that have not been visited within the configured duration. Channel registrations are automatically expired, so you only need to use this command if the duration has been changed.",
         "$uSee Also:$u unvisited");
         "Deletes all peons with accounts matching the given pattern from the channel user list.",
         "$uSee Also:$u addpeon, mdelcoowner, mdelmanager, mdelop");
 "MERGE" ("/msg $C MERGE <#channel> <destination>",
-        "Merges the source channel's registration, users, bans, and other data into the target channel. Users with access to both the source and target channels will retain the higher access level; if the access levels are the same, the more recent seen time is kept. Bans are also merged, with bans expiring later taking precedence.",
+        "Merges the source channel's registration, users, lamers, and other data into the target channel. Users with access to both the source and target channels will retain the higher access level; if the access levels are the same, the more recent seen time is kept. Lamers are also merged, with lamers expiring later taking precedence.",
         "$uSee Also:$u register, move, unregister");
 "MLIST" ("/msg $C MLIST <#channel> [mask]",
         "This command lists all users of level $bManager$b on a channel's userlist. If a mask is supplied, only managers matching the mask will be shown.",
 "TOPIC" ("/msg $C TOPIC <#channel> [topic]",
         "Sets the current topic for the specified channel.  If no topic is specified, then set the current topic to the default topic.");
 "TRIM" ("/msg $C TRIM <#channel> <target> <duration>",
-       "The trim command removes target objects inactive for more than a certain duration from a channel. The target must be a channel access level, a range of access levels (for example, \"300-399\"), \"users\" or \"bans\". The duration argument specifies the amount of time the target has been inactive for to be removed.",
+       "The trim command removes target objects inactive for more than a certain duration from a channel. The target must be a channel access level, a range of access levels (for example, \"300-399\"), \"users\" or \"lamers\". The duration argument specifies the amount of time the target has been inactive for to be removed.",
         "$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.",