]> jfr.im git - irc/evilnet/x3.git/blobdiff - chanserv.help
Applied http://contagion.quarantined.net/diffs/sethost.diff
[irc/evilnet/x3.git] / chanserv.help
index 97849d3bbd0702bfd85b8167ecf42481c1a69f7f..0cb28b205341213af216d238cc38cbd3cc20fd6c 100644 (file)
-"<INDEX>" ("$b$C Help$b",
-        "$b$C$b is a channel service bot, intended primarily to prevent and defend against channel takeovers. It also includes convenience features aimed at making it easier to maintain control over all aspects of your channel.",
-        "$b$C$b command categories:",
-        "  USER            User management.",
-        "  CHANNEL         Channel management.",
-        "  BAN MANAGEMENT  Ban management.",
-        "  INFORMATION     Informative commands.",
-        "  OPER            Helper/IRC Operator commands."
+"<INDEX>" ("=--------------- $b$C Help$b --------------=",
+           " Hello there!                           ",
+           " 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       ",
+           " For example: $b/msg $C HELP UBM$b      ",
+           " shows help with the UnBanMe command.   ",
+           "=--------------------------------------=",
+           " GENERAL  - How to use $C  ",
+           " USER     - Commands to add and remove",
+           "            bans, ops and managers from ",
+           "            your channel.",
+           " CHANNEL  - Other channel related info",
+           "            like setting permanent modes",
+           "            and topic.",
+           " INFORMATION - Informative commands.",
+           " OPER     - Commands for IRC Operators.",
+           "=--------------------------------------=",
 );
-"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.",
-        "  ADDMANAGER                       manager status in a channel.",
-        "  ADDOP                           op status in a channel.",
-        "  ADDPEON                         peon status in a channel.",
-        "  GIVEOWNERSHIP    Give ownership to another user in the channel.",
-        "  CLVL        Change a person's access level in a channel.",
-        "  ADDUSER     Give another person access in a channel.",
-        "  DELUSER     Remove a person's access from a channel.",
-        "  DELETEME    Remove your own access from a channel.",
-        "  MDELCOOWNER Remove coowners with accounts matching a mask.",
-        "  MDELMANAGER         managers with accounts matching a mask.",
-        "  MDELOP             ops with accounts matching a mask.",
-        "  MDELPEON           peons with accounts matching a mask.",
-       "  TRIM        Remove users inactive for a certain period.",
-        "  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.",
-        "  DEVOICE     Remove voice from the specified user.",
-        "  USET        Set channel user options.",
-        "  SUSPEND     Suspend a user's access to a channel.",
-        "  UNSUSPEND   Restore a user's access to a channel.",
-        "  WIPEINFO    Remove a lower-ranked user's infoline."
+"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.",
+            " $bPLIST$b       Show all PEONs of a channel.",    
+            " $bBANS$b        Show all  $ulasting$u bans in 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).",
+            " $bSEEN$b        Find out the last time a user was in a channel.",
+            "$b$b",
+            " $bADDPEON$b     Add a user as a PEON in a channel.",
+            " $bADDOP$b       Add a user as an OP in a channel.",
+            " $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.",
+            "$b$b",
+            " $bDELUSER$b     Delete a user from the userlist.",
+            " $bMDELCOOWNER$b Mass-delete coowners with accounts matching a mask.",
+            " $bMDELMANAGER$b Mass-delete managers with accounts matching a mask.",
+            " $bMDELOP$b      Mass-delete ops 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.",
+            " $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.",
+            " $bUNSUSPEND$b   Restore 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 ------------="
 );
-"BAN MANAGEMENT" ("$bBan Management Commands:$b",
-        "  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.",
-        "  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.",
-        "  DELBAN      Remove the specified permanent ban from memory.",
-       "  TRIM        Remove bans inactive for a certain period.",
-        "  UNBANME     Remove a ban matching your hostmask from specified channel.",
-        "  UNBANALL    Remove all bans from a channel."
+
+"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.",
+            " $bOPEN$b        Remove +ilk channel modes and any bans on you from a channel.",
+            "*$bNOTE$b        Set a note on a channel.",
+            "*$bDELNOTE$b     Remove a note from a channel.",
+            "$b$b",
+            " $bUP$b          Give you ops in a channel.",
+            " $bDOWN$b        Remove your ops in a channel.",
+            " $bUPALL$b       Give you ops in all channels you have access to.",
+            " $bDOWNALL$b     Remove your ops in all channels.",
+            " $bOP$b          Give ops to the specified user.",
+            " $bDEOP$b        Remove ops from the specified user.",
+            " $bVOICE$b       Give voice to the specified user.",
+            " $bDEVOICE$b     Remove voice from the specified user.",
+            " $bRESYNC$b      Synchronize ops and voice with the channel userlist.",
+            "$b$b",
+            " $bKICK$b        Kick a user from a channel.",
+            " $bBAN$b         Ban a user from a channel.",
+            " $bUNBAN$b       Remove the specified ban from the channel.",
+            " $bKICKBAN$b     Kick and ban a user from a channel.",
+            " $bUNBANME$b     Remove a ban matching your hostmask from specified channel.",
+            " $bUNBANALL$b    Remove all bans from a channel.",
+            " $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 ------------="
 );
-"CHANNEL" ("$bChannel Management Commands:$b",
-        "  OPEN        Remove +ilk channel modes and any bans on you from a channel.",
-        "  USERS       List all users of a channel.",
-        "  CLIST                coowners of a channel.",
-        "  MLIST                managers of a channel.",
-        "  OLIST                ops of a channel.",
-        "  PLIST                peons of a channel.",    
-        "  BANS        List all the bans for a channel.",
-        "  TOPIC       Set the current topic, or reset it to the default topic.",
-        "  MODE        Change a channel mode.",
-        "  INVITE      Invite new users to your channel.",
-        "  INFO        Show numerical information about the users in a channel.",
-        "  SET         Change various channel settings.",
-        "  EVENTS      View a list of events relevant to a channel.",
-        "  NOTE        Set a note on a channel.",
-        "  DELNOTE     Remove a note from a channel.",
-        "  RESYNC      Synchronize ops and voice with the channel userlist."
+"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 ------------="
 );
-"INFORMATION" ("$bInformative Commands:$b",
-        "  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.",
-        "  HELPERS                                   support helpers.",
-        "  PEEK        Reveal information on a channel's modes, topic and ops.",
-        "  SEEN        Find out the last time a user was in a channel.",
-        "  COMMAND     Display some information about a command."
+"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",
+            " $bSEARCH$b      Find registered channel matching criteria.",
+            " $bREGISTER$b    Register a new channel with $C.",
+            " $bNOREGISTER$b  Add a channel to the do-not-register list.",
+            " $bALLOWREGISTER$b Remove a channel from the do-not-register list.",
+            " $bUNREGISTER$b  Remove $C from a registered channel.",
+            " $bMOVE$b        Transition one channel's registration to a new channel name.",
+            " $bMERGE$b       Merges a source and target channels' registration, ",
+            "                 users, bans, and other data into the target channel.",
+            " $bUNVISITED$b   List all channels that have not been visited in specified duration.",
+            " $bEXPIRE$b      Automatically unregister old channels.",
+            "$b$b",
+            " $bADDOWNER$b    Add a new owner to a channel.",
+            " $bDELOWNER$b    Remove a current owner from a channel.",
+            " $bMDELOWNER$b   Remove multiple owners by account mask from a channel.",
+            " $bCSUSPEND$b    Remove $C from a channel (preserving user data).",
+            " $bCUNSUSPEND$b  Restore $C to a channel that was suspended.",
+            "$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 ------------="
 );
-"OPER" ("$bHelper/IRC Operator commands:$b",
-        "  SAY         Have $C say a message in a channel.",
-        "  EMOTE       Equivalent to $C doing a /me in a channel.",
-        "  GOD         Turn security override on/off.",
-        "  EXPIRE      Automatically unregister old channels.",
-        "  CSUSPEND    Remove $C from a channel (preserving user data).",
-        "  CUNSUSPEND  Restore $C to a channel that was suspended.",
-        "  UNVISITED   List all channels that have not been visited in specified duration.",
-       "  MERGE       Merges a source and target channels' registration, users, bans, and other data into the target channel.",
-        "  MOVE        Transition one channel's registration to a new channel name.",
-        "  OPCHAN      Force $C to op itself in a channel.",
-        "  REGISTER    Register a new channel with $C.",
-        "  NOREGISTER  Add a channel to the do-not-register list.",
-        "  ALLOWREGISTER Remove a channel from the do-not-register list.",
-        "  UNREGISTER  Remove $C from a registered channel.",
-        "  SEARCH      Find registered channel matching criteria.",
-        "  ADDOWNER    Add a new owner to a channel.",
-        "  DELOWNER    Remove a current owner from a channel.",
-        "  MDELOWNER   Remove multiple owners by account mask from a channel.",
-        "  CREATENOTE  Create a new note type.",
-        "  REMOVENOTE  Remove an existing note type."
+
+"GENERAL"  ("=----------- General Help -------------=",
+            " NOTE: Before using $C or being added   ",
+            " to channel userlists, users must       ",
+            " register  an account with $b$N$b.      ",
+            "  $b/MSG $N help$b for more information ",
+            "$b$b",
+            " $C uses a standard interface for each  ",
+            " command in its command list. Commands  ",
+            " can be issued either in /MSG format or ",
+            " in a channel which $C is in. These two ",
+            " ways are demonstrated below:",
+            "  $b/MSG $C OP #chatzone Locke$b",
+            "  $b.OP #chatzone locke$b",
+            "$b$b",
+            " If a command is given in a channel, and ",
+            " the channel parameter is not given, the ",
+            " channel that the command was issued in  ",
+            " will be used:",
+            " $b.OP locke$b",
+            "$b$b",
+            " Some commands, such as $bNETSTATS$b     ",
+            " don't require a channel. If one is      ",
+            " supplied it will be ignored.",
+            "$b$b",
+            " If a command takes additional parameters",
+            " asside from channel, they will be       ",
+            " 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     ",
+            "=---------------------------------------="
 );
+
 "MYACCESS" ("/msg $S MYACCESS [<nick|*account>]",
         "Lists channels where you have access and infolines in each.",
         "Network staff may specify a nickname or *account to view the list for another user.",
         "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).",
         "$uSee Also:$u deluser, users");
+"ADDOP" ("/msg $C ADDOP <#channel> <nick|*account>",
+        "This command adds someone to the channel user list with OP 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");