X-Git-Url: https://jfr.im/git/irc/evilnet/x3.git/blobdiff_plain/95a73185b80049bba998673f9c1bba085b4f12ad..dee9951d5f32dee38cf29861acdb4a347931e147:/src/chanserv.help diff --git a/src/chanserv.help b/src/chanserv.help index 7b9d5a9..5207660 100644 --- a/src/chanserv.help +++ b/src/chanserv.help @@ -1,12 +1,16 @@ -"" ("=--------------- $b$C Help$b --------------=", +"" ( " 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: ", + " help system uses the format: ", " $b/MSG $C HELP <$bsubject$b>$b ", + " (In help, words in <> represent required", + " parameters. 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 ", @@ -16,9 +20,11 @@ " 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.", @@ -54,11 +60,10 @@ "$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.", @@ -76,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.", @@ -87,20 +92,19 @@ " $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", + " $bMYACCESS$b Show all the channels you have access to.", " $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", @@ -124,11 +128,10 @@ " $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. ", @@ -157,12 +160,11 @@ " expected as well. ", " See $b/msg $C HELP $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 ", " or the shortcut:", @@ -220,8 +222,11 @@ "For example: CALC sqrt [5 + .43 * (tan[75])] / 2", "If you do not have access in the channel, the answer may be reported", "to you privately (via MSG or NOTICE) instead of in the channel.", - "CALC can be used by all users.", "$uSee Also:$u dice, 8ball"); +"8BALL" ("/msg $C 8BALL [yes no question|what color is..|how many..|where is..]?", + "8BALL answers yes or no questions, color queistions, numerical questions, and location questions.", + "If you do not have access in the channel, the answer may be reported to you privately instead of in the channel.", + "$uSee Also:$u dice, calc"); "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"); @@ -279,11 +284,24 @@ "DOWNALL" ("/msg $C DOWNALL", "Executes the $bdown$b command for each channel you have access to.", "$uSee Also:$u down, up, upall"); -"DURATIONS" ("[y][M][w][d][h][m][[s]]", - "There is a standard syntax for durations that let you easily specify longer periods of time. A duration consists of one or more \"duration parts\", which are sequences of digits, separated by duration letters.", - "The valid duration letters are $by$b (for year, or 365 days), $bM$b (for month, or 31 days), $bw$b (for week, or 7 days), $bd$b (for day, or 24 hours), $bh$b (for hour, or 60 minutes), $bm$b (for minute, or 60 seconds), and $bs$b (for second). We know not all years are 365 days and not all months are 31 days, but we pretend they are for parsing durations.", - "If the last duration part does not have any letter to indicate the units, seconds are assumed.", - "$uExamples$u: 1y1M is 365 days plus 31 days; 1y1m is 365 days plus 1 minute; 1h30m45 is ninety minutes and forty-five seconds; and so forth."); +"DURATIONS" ( + "This is the syntax used for commands that require time durations. A time duration is made up of numbers and units. Multiple units may be used in a row.", + "The valid unit letters are:", + "$by$b - years (365 days)", + "$bM$b - months (30 days)", + "$bw$b - weeks (7 days)", + "$bd$b - days (24 hours)", + "$bh$b - hours (60 minutes)", + "$bm$b - minutes (60 seconds)", + "$bs$b - seconds", + "If the unit letter is not givin, seconds are assumed.", + "$b$b", + "$uExamples$u:", + "$b5d$b is 5 days.", + "$b1y2M$b is 1 year and 2 months (425 days.)", + "$b1d1h$b is 1 day and 1 hour (25 hours.)", + "$b1h25m30s$b is 1 hour, 25 minutes and 30 seconds." + ); "EMOTE" ("/msg $C EMOTE <#channel> ", "Makes $b$C$b send a CTCP ACTION message to the specified channel.", "$uSee Also:$u say"); @@ -377,16 +395,29 @@ "PLIST" ("/msg $C PLIST <#channel>", "This command lists all users of level $bPeon$b on a channel's userlist. If a mask is supplied, only peons matching the mask will be shown.", "$uSee Also:$u addpeon, delpeon, mdelpeon, users"); -"REGISTER" ("/msg $C REGISTER <#channel> [user|*account] [force]", - "Registers a channel with $b$C$b, automatically granting owner access to the specified user. If no user is provided, $b$C$b gives owner access to the user executing the command.", - "If the registrar is on the network staff and provides the third argument, $bforce$b, it will allow a do-not-register channel to be registered anyway.", - "In addition, $bregister$b will only allow one user to own a certain number of channels without the $bforce$b argument.", - "$uSee Also:$u addowner, noregister, unregister"); + +"REGISTER" ( + "/msg $C REGISTER <#channel>", + "Registers a channel to you with $b$C$b. X3 will protect your channel, preserve your ownership of the channel, and provide handy features such as userlists and stats.", + "If the channel exists, you must have ops (+o) and there is a limit to the number of channels you may have at once.", + "Network staff see /MSG $C HELP STAFF REGISTER", + "$uSee Also:$u unregister, giveownership"); + +"STAFF REGISTER" ( + "/msg $C REGISTER <#channel> [user|*account] [force]", + "Registers a channel to the givin user with $b$C$b.", + "If staff provides the third argument, $bforce$b, it will allow the registration even if it is a do-not-register channel or ther register limit will be exceded.", + "$uSee Also:$u addowner, noregister, register, unregister"); + "REMOVENOTE" ("/msg $S REMOVENOTE [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> ", "Makes $b$C$b send a message to the specified channel.", "$uSee Also:$u emote"); @@ -421,15 +452,14 @@ "PUBCMD: Restrictions to use commands in public.", "INVITEME: Minimum level for users to use INVITEME or AUTOINVITE.", "USERINFO: Minimum level for users to show an infoline on join.", - "ENFOPS: Restrictions for opping users.", - "ENFHALFOPS: Restrictions for halfopping users.", - "ENFMODES: Restrictions to change the default modes.", - "ENFTOPIC: Restrictions on changing the topic.", + "ENFOPS: Who can op users.", + "ENFHALFOPS: Who can half-op users.", + "ENFMODES: Who can change the channel modes.", + "ENFTOPIC: Who can chang the topic.", "TOPICSNARF: Manual topics changes (by /TOPIC) from users this level and above will 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.", - "VOICE: Who should be auto-voiced in the channel.", + "CTCPREACTION: What happens when a CTCP is sent to the channel.", + "AUTOMODE: Who should be auto-voice/hop/oped in the channel.", "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.", @@ -438,9 +468,11 @@ "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"); + "SET DEFAULTTOPIC" ("/msg $C SET <#channel> DEFAULTTOPIC ", "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 topicrefresh, set enftopic, set topicmask"); + "SET TOPICMASK" ("/msg $C SET <#channel> TOPICMASK ", "This sets a pattern that $C forces all topics to match. 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.", "For example, $b!set topicmask Hello *$b allows the topic to be set to $bHello world$b, but not $bGoodbye world$b.", @@ -449,41 +481,47 @@ " $btopic something$b", "will replace the * with the text $bsomething$b.", "$uSee Also:$u set, set topic, set enftopic"); + "SET TOYS" ("/msg $C SET <#channel> TOYS ", "This setting changes how $C will respond to commands like 8ball, or whether it responds at all. Valid settings are:", "$b0$b Toys are completely disabled.", "$b1$b Toys will only reply privately.", "$b2$b Toys will reply publicly.", "$uSee Also:$u set"); + "SET PUBCMD" ("/msg $C SET <#channel> PUBCMD ", "This setting restricts the access necessary to use in-channel commands. It is a numeric user level, or 501 to mean no one may use public commands.", "$uSee Also:$u set"); + "SET ENFOPS" ("/msg $C SET <#channel> ENFOPS ", "This setting restricts who may op users who are not at least ops on the userlist. If $C sees someone with access below the specified access op someone not on the userlist (or who is a peon), it will deop the second user. It is a numeric user level, or 501 to mean no one may op unrecognized users.", "$uSee Also:$u set"); + "SET ENFHALFOPS" ("/msg $C SET <#channel> ENFHALFOPS ", "This setting restricts who may halfop users who are not at least halfops on the userlist. If $C sees someone with access below the specified access halfop someone not on the userlist (or who is a peon), it will dehalfop the second user. It is a numeric user level, or 501 to mean no one may op unrecognized users.", "$uSee Also:$u set"); -"SET GIVEOPS" ("/msg $C SET <#channel> GIVEOPS ", - "This setting restricts the minimum access someone must be to be automatically op'ed by $C. It is a numeric user level.", - "$uSee Also:$u set"); -"SET GIVEHOPS" ("/msg $C SET <#channel> GIVEHOPS ", - "This setting restricts the minimum access someone must be to be automatically halfop'ed by $C. It is a numeric user level.", - "$uSee Also:$u set"); + "SET ENFMODES" ("/msg $C SET <#channel> ENFMODES ", "This setting restricts the minimum access someone must have to change the channel modes from what is specified in the channel settings. It is a numeric user level, or 501 to mean no one may override the default modes.", "$uSee Also:$u set"); + "SET ENFTOPIC" ("/msg $C SET <#channel> ENFTOPIC ", "This setting restricts the minimum access someone must have to change the channel topic. It is a numeric user level, or 501 to mean no one may override the default topic.", "If a topic mask is set, then a person may change the topic as long as it matches that mask $bor$b they have the above access.", "If no topic mask is set, then a person must have the above access to change the topic from the default.", "$uSee Also:$u set, set topic, set topicmask"); -"SET VOICE" ("/msg $C SET <#channel> VOICE ", - "This setting configures who $C auto-voices. Valid settings are:", - "$b0$b Noone will get voice", - "$b1$b PEONs will get voice (default).", - "$b2$b Everyone will get voice.", - "$uSee Also:$u set, uset autoop"); + +"SET AUTOMODE" ("/msg $C SET <#channel> AUTOMODE ", + "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 PROTECT" ("/msg $C SET <#channel> PROTECT ", "This setting restricts the protection that $C enforces. Valid settings are:", "$b0$b Non-users and users will be protected from those of equal or lower access", @@ -491,9 +529,11 @@ "$b2$b Users will be protected from those of lower access.", "$b3$b No users will be protected.", "$uSee Also:$u set"); + "SET SETTERS" ("/msg $C SET <#channel> SETTERS ", "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 ", "This setting controls if (and how often) $C refreshes the topic to the default value. Valid settings are:", "$b0$b Never refresh topic.", @@ -502,35 +542,40 @@ "$b3$b Refresh every 12 hours.", "$b4$b Refresh every 24 hours.", "$uSee Also:$u set, set topic"); -"SET CTCPUSERS" ("/msg $C SET <#channel> CTCPUSERS ", - "This setting controls who is allowed to send CTCPs to the channel. CTCP ACTION, the way that /me is implemented, are always allowed. For any other CTCP, the user must have this access level. 501 indicates no users may use CTCPs in the channel.", - "If a user below the specified level sends a CTCP (besides ACTION) to the channel, the enforcement is specified by the $bCTCPReaction$b setting.", - "$uSee Also:$u set, set ctcpreaction"); + "SET CTCPREACTION" ("/msg $C SET <#channel> CTCPREACTION ", "This setting controls what happens to those who send disallowed CTCPs to the channel:", - "$b0$b Kick on disallowed CTCPs.", - "$b1$b Kickban on disallowed CTCPs.", - "$b2$b Short timed ban (defaults to 3 minutes) on disallowed CTCPs.", - "$b3$b Long timed ban (defaults to 1 hour) on disallowed CTCPs.", + "$b0$b CTCPs are allowed. Do nothing.", + "$b1$b Kick on disallowed CTCPs.", + "$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"); + "SET DEFAULTS" ("/msg $C SET <#channel> DEFAULTS []", "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"); + "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> ", "This disables the target's access to the channel. That access can be restored using the unsuspend command.", "$uSee Also:$u 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> ", "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> ", "Unbans the specified nick or hostmask. If a nick is given, $b$C$b determines what hostmask(s) to unban.", "$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.", "$uSee Also:$u ban, unban, unbanme");