-"<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: ",
+ " 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 ",
" 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.",
"$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:",
"DOWNALL" ("/msg $C DOWNALL",
"Executes the $bdown$b command for each channel you have access to.",
"$uSee Also:$u down, up, upall");
-"DURATIONS" ("[<n>y][<n>M][<n>w][<n>d][<n>h][<n>m][<n>[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> <text>",
"Makes $b$C$b send a CTCP ACTION message to the specified channel.",
"$uSee Also:$u say");
"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 <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");
projects / irc / evilnet / x3.git / blobdiff