]> jfr.im git - irc/evilnet/x3.git/blobdiff - src/chanserv.help
fixing small memory leak
[irc/evilnet/x3.git] / src / chanserv.help
index a2fa655d1406055685d4c09af14317c27288ec49..2f72a113a841f24ec1a24ab8ec4b49ee0f0401e2 100644 (file)
@@ -11,7 +11,7 @@
            " For example: $b/msg $C HELP UBM$b      ",
            " shows help with the Un-Ban Me command.   ",
            "=---------------------------------------=",
-           " GENERAL  - How to use $C  ",
+           " GENERAL  - How to get and communicate with $C  ",
            " USER     - Commands to add and remove",
            "            bans, ops and managers from ",
            "            your channel.",
@@ -81,7 +81,7 @@
             " $bDEHOP$b       Remove halfops 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.",
+            " $bRESYNC$b      Synchronize (half)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.",
@@ -91,7 +91,7 @@
             " $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.",
+            " $bINFO$b        Show information about a channel.",
             " $bEVENTS$b      View a list of events relevant to a channel."
 );
 "INFORMATION"     ("$bInformative Commands:$b",
             " $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."
+            " $bCOMMAND$b     Display some information about a command.",
+            " $bINFO$b        Gets channel information about a channel.",
+            " $bEVENTS$b      View a list of events relevant to a channel.",
+            " $b$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.",    
+            " $bLAMERS$b      Show all  LAMERs of a channel.",
+            " $bACCESS$b      Check someone's access level in a channel.",
+            " $bMYACCESS$b    Show all channels where you have access.",
 );
 "OPER"     ("$bHelper/IRC Operator commands:$b",
             " $bGOD$b         Turn security override on/off.",
 );
 
 "GENERAL"  (
-            " 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-$N Accounts$b-",
+            " Before using $C or being added to      ",
+            " channel userlists, you and your users  ",
+           " must register an account with $b$N$b.  ",
+            "  $b/MSG $N help$b to learn how. ",
             "$b$b",
+           "$b-Talking to $C-$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$!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$!OP locke$b",
             "$b$b",
-            " Some commands, such as $bNETSTATS$b     ",
+            " Some commands, such as $bNETINFO$b     ",
             " don't require a channel. If one is      ",
             " supplied it will be ignored.",
             "$b$b",
             " See $b/msg $C HELP <COMMAND>$b for the  ",
             " exact syntax of each command.           ",
             "=---------- For more info see: ---------=",
-            "     http://www.afternet.org/support     "
+            "     http://www.afternet.org/support     ",
+            "     http://evilnet.sf.net/x3/x3help.php "
 );
 
 "LOGIN" (
          " or the shortcut:",
          "   /AUTH <account> <password>"
          );
+"LEVELS" ("/msg $S LEVELS",
+        "Lists the numerical level equivelents for channel access levels.",
+        "$b$b",
+        "$S can use either the names (OWNER, COOWNER, MANAGER, OP, HALFOP, and PEON) or numerical values from 1 to 500 to indicate channel access levels. The LEVELS command prints out all the levels and their numerical ranges.",
+        "Advanced users can change their style with $N's set style command to view the numerical version in commands like USERS, and may use numbers instead of names for fine-tuning access.",
+        "$uSee Also:$u ($N) set style, access, myaccess, adduser");
 
 "MYACCESS" ("/msg $S MYACCESS [<nick|*account>]",
         "Lists channels where you have access and infolines in each.",
         "  o     AutoOp is active.",
         "  v     AutoVoice is active.",
         "  i     AutoInvite is active.",
-        "$uSee Also:$u access, users");
+        "  j     AutoJoin is active.",
+        "$uSee Also:$u access, users, levels");
+
 "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");
+        "$uSee Also:$u myaccess, users, levels");
+
 "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>",
+
+"ADDUSER" ("/msg $C ADDUSER <#channel> <nick|*account> <level> [duration]",
         "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>",
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically removed from the channel.",
+        "$uSee Also:$u deluser, users, levels, durations");
+
+"ADDPEON" ("/msg $C ADDPEON <#channel> <nick|*account> [duration]",
+        "This command adds someone to the channel user list with PEON access level. (You may only add users to levels less than your own.)",
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically removed from the channel.",
+        "$uSee Also:$u adduser, deluser, users, durations");
+
+"ADDOP" ("/msg $C ADDOP <#channel> <nick|*account> [duration]",
         "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");
-"ADDHOP" ("/msg $C ADDHOP <#channel> <nick|*account>",
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically removed from the channel.",
+        "$uSee Also:$u adduser, deluser, users, durations");
+
+"ADDHOP" ("/msg $C ADDHOP <#channel> <nick|*account> [duration]",
         "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");
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically removed from the channel.",
+        "$uSee Also:$u adduser, deluser, users, durations");
+
+"ADDMANAGER" ("/msg $C ADDMANAGER <#channel> <nick|*account> [duration]",
+        "This command adds someone to the channel user list with MANAGER access level. (You may only add users to levels less than your own.)",
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically removed from the channel.",
+        "$uSee Also:$u adduser, deluser, users, durations");
+
+"ADDCOOWNER" ("/msg $C ADDCOOWNER <#channel> <nick|*account> [duration]",
+        "This command adds someone to the channel user list with COOWNER access level. (You may only add users to levels less than your own.)",
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically removed from the channel.",
+        "$uSee Also:$u adduser, deluser, users, 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. ",
 "CLIST" ("/msg $C CLIST <#channel> [mask]",
         "This command lists all users of level $bCoowner$b on a channel's userlist. If a mask is supplied, only coowners matching the mask will be shown.",
         "$uSee Also:$u addcoowner, delcoowner, mdelcoowner, users");
-"CLVL" ("/msg $C CLVL <#channel> <nick|*account> <level>",
+"CLVL" ("/msg $C CLVL <#channel> <nick|*account> <level> [duration]",
         "Modifies a channel user's access level. You cannot give users access greater than or equal to your own.",
        "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 access, users, giveownership");
+        "An optional duration can be specified, if specified then the after the given duration has expired the person will be automatically reverted back to their previous access level.",
+        "$uSee Also:$u access, users, giveownership, durations");
 "CREATENOTE" ("/msg $S CREATENOTE <typename> <set-access> [access-arg] <view-access> <max-length>",
         "Defines a new note type.  $btypename$b is the name of the note type.  $bset-access$b is one of:",
         "  $bPRIVILEGED$b with required $baccess-arg$b being the minimum OpServ level to set",
         "Deletes all managers with accounts matching the given pattern from the channel user list.",
         "$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.");
+        "Deletes all ops with accounts matching the given pattern from the channel user list.",
+        "$uSee Also:$u addop, mdelowner, mdelcoowner, mdelmanager");
 "MDELOWNER" ("/msg $C MDELOWNER <#channel> <pattern>",
         "Deletes all owners with accounts matching the given pattern from the channel user list.",
         "$uSee Also:$u addowner, mdelcoowner, mdelmanager, mdelop, mdelpeon");
         "$uSee Also:$u note, delnote");
 "OLIST" ("/msg $C OLIST <#channel> [mask]",
         "This command lists all users of level $bOp$b on a channel's userlist.  If a mask is supplied, only ops matching the mask will be shown.",
-        "$uSee Also:$u addop, delop, mdelop, users");
+        "$uSee Also:$u addop, deluser, mdelop, users");
 "OP" ("/msg $C OP <#channel> <nick> [nick]...",
         "This command makes $C op the specified user.",
-        "$uSee Also:$u addop, delop, deop");
+        "$uSee Also:$u addop, deluser, deop");
 "OPCHAN" ("/msg $C OPCHAN <#channel>",
         "This command makes $C op itself in the specified channel.");
 "OPEN" ("/msg $C OPEN <#channel>",
 "REMOVENOTE" ("/msg $S REMOVENOTE <typename> [FORCE]",
         "Permanently deletes a note type.  Without the argument $bFORCE$b, it will only delete an unused note type.  With the argument $bFORCE$b, it will delete the note from all channels and then delete the note type.",
         "$uSee Also:$u createnote");
+
 "RESYNC" ("/msg $S RESYNC <#channel>",
-        "Synchronizes users in the channel with the userlist.  This means that if the user can normally get ops, $S makes sure the user has ops.  Otherwise, if the user normally gets voice, $S makes sure the user has voice but not ops.  Otherwise, $S makes sure the user has neither voice nor ops.");
+        "Synchronizes users in the channel with the userlist, according to the SET AUTOMODE setting.",
+        "It will give and take ops, halfops, and voice modes to users to make the channel match the userlist and automode setting.",
+        "$uSee Also:$u set automode, up, op, hop, voice");
+
 "SAY" ("/msg $C SAY <#channel> <text>",
         "Makes $b$C$b send a message to the specified channel.",
         "$uSee Also:$u emote");
         "USERGREETING: A greeting message for users on the channel's userlist.",
         "MODES:        The channel's default modes.",
        "PUBCMD:       Restrictions to use commands in public.",
-        "INVITEME:     Minimum level for users to use INVITEME or AUTOINVITE.",
+        "INVITEME:     Minimum level for users to use INVITEME, AUTOINVITE or AUTOJOIN.",
         "USERINFO:     Minimum level for users to show an infoline on join.",
         "ENFOPS:       Who can op users.",
         "ENFHALFOPS:   Who can half-op users.",
         "SETTERS:      Who may change channel settings (using $bSET$b).",
         "CTCPREACTION: What happens when a CTCP is sent to the channel.",
         "AUTOMODE:     Who should be auto-voice/hop/oped in the channel.",
+        "BANTIMEOUT:   Removes old bans.",
         "PROTECT:      The protection level $b$C$b provides.",
        "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.",
+        "RESYNC:       Controls if (and how often) $b$C$b will reset the userlist.",
         "DYNLIMIT:     Adjusts user limit (+l channel mode) to prevent join floods.",
         "$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.",
-        "$uSee Also:$u set pubcmd, set enfops, set enfhalfops, set enfmodes, set enftopic, set protect, set toys, set setters, set topicrefresh, set ctcpusers, set ctcpreaction, set defaults");
+        "$uSee Also:$u set pubcmd, set enfops, set enfhalfops, set enfmodes, set enftopic, set protect, set toys, set setters, set topicrefresh, set resync, set ctcpreaction, set defaults");
 
 "SET DEFAULTTOPIC" ("/msg $C SET <#channel> DEFAULTTOPIC <New default topic>",
         "This changes the default topic for the channel.  $C will set the IRC topic to this value when the $btopic$b command is used with no arguments, when the topic refresh happens (if you have $bset topicrefresh$b), or when an unauthorized user changes the topic to something else.",
         "$uSee Also:$u set, set topic, set topicmask");
 
 "SET AUTOMODE" ("/msg $C SET <#channel> AUTOMODE <value>",
-        "This setting configures who $C auto-voices.  Valid settings are:",
-        "$b0$b  Noone will be automatically oped, half-oped, or voiced.",
-        "$b1$b  Give voice to peons, half-op to halfops, and op to ops.",
-        "$b2$b  Give voice to strangers.",
-        "$b3$b  Give halfops to strangers.",
-        "$b4$b  Give ops to strangers (not advised.)",
-        "$b5$b  Give half-op to halfops, and op to ops (no voice to peons).",
-        "$uSee Also:$u set, uset autoop");
+        "This setting configures who $C gives different channel modes to on join or RESYNC.  ",
+        "Valid settings are:",
+        "  $b0$b  Noone will be automatically oped, half-oped, or voiced.",
+        "  $b1$b  Give voice to peons, half-op to halfops, and op to ops.",
+        "  $b2$b  #1 Plus Give voice to everyone.",
+        "  $b3$b  #1 Plus give halfops to everyone.",
+        "  $b4$b  #1 Plus give ops to everyone (not advised.)",
+        "  $b5$b  Give half-op to halfops, and op to ops only, but peons do not get voice. ",
+        "$uSee Also:$u set, up, uset autoop, resync");
+
+"SET BANTIMEOUT" ("/msg $C SET <#channel> BANTIMEOUT <value>",
+        "This setting configures $C to automatically remove bans older than the set age. It is useful for avoiding buildup of old bans, eventually running out of ban slots.",
+        "Valid settings are:",
+        "  $b0$b  Does not remove bans",
+        "  $b1$b  Bans will be removed after 10 minutes",
+        "  $b2$b  Bans will be removed after 2 hours",
+        "  $b3$b  Bans will be removed after 4 hours",
+        "  $b4$b  Bans will be removed after 24 hours",
+        "  $b5$b  Bans will be removed after 1 week",
+        "It should be noted that this setting expires channel bans (mode +b) NOT perminantly banned \"LAMERs\", although it will expire the individual host-bans $C sets on those who match LAMER entries.",
+        "$uSee Also:$u unban, addlamer, addtimedlamer");
 
 "SET PROTECT" ("/msg $C SET <#channel> PROTECT <value>",
         "This setting restricts the protection that $C enforces.  Valid settings are:",
         "$b4$b  Refresh every 24 hours.",
         "$uSee Also:$u set, set topic");
 
+"SET RESYNC" ("/msg $C SET <#channel> RESYNC <value>",
+        "This setting controls if (and how often) $C refreshes the userlist to the current list.  Valid settings are:",
+        "$b0$b  Never refresh userlist.",
+        "$b1$b  Refresh every 3 hours.",
+        "$b2$b  Refresh every 6 hours.",
+        "$b3$b  Refresh every 12 hours.",
+        "$b4$b  Refresh every 24 hours.",
+        "$uSee Also:$u set");
+
 "SET CTCPREACTION" ("/msg $C SET <#channel> CTCPREACTION <value>",
         "This setting controls what happens to those who send disallowed CTCPs to the channel:",
         "$b0$b  CTCPs are allowed. Do nothing.",
         "$b2$b  Kickban on disallowed CTCPs.",
         "$b3$b  Short timed ban (defaults to 3 minutes) on disallowed CTCPs.",
         "$b4$b  Long timed ban (defaults to 1 hour) on disallowed CTCPs.",
-        "$uSee Also:$u set, set ctcpusers");
+        "$uSee Also:$u set");
 
 "SET DEFAULTS" ("/msg $C SET <#channel> DEFAULTS [<confirmation>]",
         "With the proper confirmation string, resets all the options for the channel to their default values.",
         "With no confirmation string, displays the appropriate confirmation string.",
         "$uSee Also:$u set");
 
+"SET GREETING" ("/msg $C SET <#channel> GREETING <message>",
+        "Sets a message X3 will send to everyone who joins your channel, unless they are on your userlist.",
+        "This feature should be used sparingly, as many people find it annoying.",
+        "Another set command, SET USERGREETING, is shown to people who ARE on your userlist.",
+        "$uSee Also:$u set usergreeting");
+
+"SET USERGREETING" ("/msg $C SET <#channel> USERGREETING <message>",
+        "Sets a message X3 will send to your users (PEONs, OPs, etc) when they join your channel.",
+        "This feature should be used sparingly, as many people find it annoying.",
+        "Another set command, SET GREETING, is shown to people who are NOT on your userlist.",
+        "$uSee Also:$u set greeting");
+
 "STAFF" ("/msg $C STAFF",
         "Lists all the IRC operators and helpers currently online. Nicknames enclosed in parentheses are away, and likely unavailable.",
         "$uSee Also:$u helpers, ircops, netinfo");
 
-"SUSPEND" ("/msg $C SUSPEND <#channel> <nick|*account>",
+"SUSPEND" ("/msg $C SUSPEND <#channel> <nick|*account> <duration>",
         "This disables the target's access to the channel.  That access can be restored using the unsuspend command.",
-        "$uSee Also:$u unsuspend, deluser");
+        "The duration may be \"0\" to make it never expire; otherwise, $C will automatically unsuspend the user after the duration",
+        "$uSee Also:$u durations, unsuspend, deluser");
 
 "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>",
+"TRIM" ("/msg $C TRIM <#channel> <target> <duration> [vacation]",
        "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.",
+        "If the vacation argument is given for the users target, users who are on vacation will be trimmed. By default they are skipped.",
         "$uSee Also:$u durations");
 
 "UNBAN" ("/msg $C UNBAN <#channel> <mask|nick>",
          "INFO:       Sets the infoline that $C sends when you join the channel.",
          "AUTOOP:     Enable or disable $C automatically opping you upon joining or authenticating.",
         "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.",
+        "AUTOJOIN: $C will forcibly join you into this channel if you have access to and are not in it when you authenticate if this setting is on.",
          "$uSee Also:$u set");
 "USET INFO" ("/msg $C USET <#channel> INFO <info>",
         "This command will set a user defined information message to be displayed when you join the channel. Set to '*' to clear the message.",
         "$uSee Also:$u addcoowner, delcoowner, mdelcoowner, users");
 
 "ME"   "I am at your service. /msg $C help command, or /join #help ";
+
 "thanks" ("AfterNET's own X3 is based on the hard work of the origional srvx developers.  They would like to thank the following people for their help in making the origional srvx:",
         "     $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.",