]> jfr.im git - irc/evilnet/x3.git/blobdiff - src/nickserv.help
Some tweaks to automode help
[irc/evilnet/x3.git] / src / nickserv.help
index c57ba797294559ecc4f59465c483ead51a49d87f..089d2b38d6124d9213574b8e33c97d2a11244d84 100644 (file)
@@ -1,7 +1,6 @@
 "<INDEX>" {
         "/services/nickserv/disable_nicks" {
         "/services/nickserv/email_enabled" (
-                "=------------ $b$N Help$b -----------=",
                 " $b$N$b is an authentication service,",
                 " providing login identification for",
                 " the network. $N is how you 'log in'",
@@ -9,6 +8,14 @@
                 " with $C, and its how ircops are known",
                 " to $O and $G.",
                 " $b$b",
+                " The help system uses the format:",
+                "   $b/MSG $N HELP <$bsubject$b>$b       ",
+                " (In help, words in <> represent required",
+                " parameters. Words in [] are optional.)",
+                " For example: $b/msg $N HELP RESETPASS$b",
+                " shows help with the command to reset a",
+                " lost password.",
+                " $b$b",
                " $b$N$b help categories:",
                "  $bACCOUNT$b      Account management.",
                 "  $bEMAIL$b        Email based commands",
                 "$b$b",
                 " $b$N is $uNOT$u a NickServ$b!        ",
                 "  see $b/msg $N HELP NOT NICKSERV$b   ",
-                "  for details ",
-                "=--------------------------------------="
+                "  for details "
         );
         "!/services/nickserv/email_enabled" (
-                "=------------ $b$N Help$b -----------=",
                 " $b$N$b is an authentication service,",
                 " providing login identification for",
                 " the network. $N is how you 'log in'",
                 "$b$b",
                 " $b$N is $uNOT$u a NickServ$b!        ",
                 "  see $b/msg $N HELP NOT NICKSERV$b   ",
-                "  for details ",
-                "=--------------------------------------="
+                "  for details "
         );
         };
         "!/services/nickserv/disable_nicks" {
         "/services/nickserv/email_enabled" (
-                "=------------ $b$N Help$b -----------=",
                 "$b$N Help$b",
                 "$b$N$b is a nickname and authentication service, intended to serve as a central authentication point for all other network services. $b$C$b, $b$O$b, and $b$G$b all depend on $b$N$b to verify that users are valid.  It also manages nickname ownership.",
                "$b$N$b command categories:",
                 "  EMAIL       Email maintenance commands.",
                "  INFORMATION Other functions.",
                 "  COMMANDS    A list of all available commands.",
-                "  OPER        $N commands for IRC Operators.",
-                "=----------- End of Help --------------="
+                "  OPER        $N commands for IRC Operators."
         );
         "!/services/nickserv/email_enabled" (
-                "=------------ $b$N Help$b -----------=",
                 "$b$N Help$b",
                 "$b$N$b is a nickname and authentication service, intended to serve as a central authentication point for all other network services. $b$C$b, $b$O$b, and $b$G$b all depend on $b$N$b to verify that users are valid. It also manages nickname ownership.",
                "$b$N$b command categories:",
@@ -65,8 +66,7 @@
                 "  NICK        Nick management.",
                "  INFORMATION Other functions.",
                 "  COMMANDS    A list of all available commands.",
-                "  OPER        $N commands for IRC Operators.",
-                "=----------- End of Help --------------="
+                "  OPER        $N commands for IRC Operators."
         );
         };
 };
@@ -75,7 +75,6 @@
 
 "ACCOUNT" {
         "/services/nickserv/enable_ghost" (
-                "=------------ $bACCOUNT Help$b -----------=",
                 " Accounts are the way that $b$C$b ",
                 " identifies you for access to channels.  ",
                 " They are slightly similar to IRC nicks, ",
                 "  $bDELMASK$b    Remove a hostmask from your account.",
                 "  $bSET$b        Set per-account options.",
                 "  $bGHOST$b      Disconnects your old clients",
-                "  $bACCOUNT FLAGS$b Definition for each account flag",
-                "=----------- End of Help --------------="
+                "  $bACCOUNT FLAGS$b Definition for each account flag"
         );
         "!/services/nickserv/enable_ghost" (
-                "=------------ $bACCOUNT Help$b -----------=",
                 " Accounts are the way that $b$C$b          ",
                 " identifies you for access to channels.    ",
                 " They are slightly similar to IRC nicks,   ",
                 "  $bDELMASK$b    Remove a hostmask from your account.",
                 "  $bSET$b        Set per-account options.",
                 "  $bRENAME$b     Renames an account",
-                "  $bACCOUNT FLAGS$b Definition for each account flag",
-                "=----------- End of Help --------------="
+                "  $bACCOUNT FLAGS$b Definition for each account flag"
         );
 };
 
 "NOT NICKSERV" {
                 "/services/nickserv/disable_nicks" (
-                "=------------ $bNOT NICKSERV$b ------------=",
                 " $N is $unot$u a NickServ. On this network, ",
                 " nicknames are not owned. $N allows ",
                 " you to register a single account to ",
                 " your nickname. ",
                 " $b$N$b can tell you what ",
                 " account a user is authenticated to ",
-                " using the $bUSERINFO$b command. ",
-                "=----------- End of Help --------------="
+                " using the $bUSERINFO$b command. "
                 );
 };
 
-"INFORMATION"  ("=------- $bInformational commands$b -------=",
+"INFORMATION"  ("$bInformational commands:$b",
                 " $bACCOUNTINFO$b   Displays information about an account.",
                 " $bUSERINFO$b      Display what account an online user is authenticated to.",
                 " $bSTATUS$b        $b$N$b status.",
-                " $bVERSION$b       $b$N$b version information.",
-                "=----------- End of Help --------------="
+                " $bVERSION$b       $b$N$b version information."
                 );
 
-"OPER"         ("=---------- $bIRC Operator Help$b ---------=",
+"OPER"         ("$bIRC Operator Help:$b",
                 " $bSEARCH$b      Search accounts and apply an action.",
                 " $bOSET$b        Modify account details including password.",
                 " $bRENAME$b      Rename an account.",
                 "*$bOUNREGNICK$b  Remove a nick from someone's account.",
                 " $bOADDMASK$b    Add a mask to someone's account.",
                 " $bODELMASK$b    Remove a mask from someone's account.",
-                " $bMERGEDB$b     Load a database into memory.",
-                "=----------- End of Help --------------="
+                " $bMERGEDB$b     Load a database into memory."
         );
 
 
         "0: /services/nickserv/email_required" (
         "/msg $N@$s REGISTER <account> <password> <email>",
         "Register is the command to register an account with $b$N$b. Later, you can use your account and password with $bauth$b to authenticate to your account.",
-        "Having an account provides a single login identity for use with $b$C$b.
+        "Having an account provides a single login identity for use with $b$C$b.",
         "Email activation is required: An email will be sent to the email address you give containing a cookie that will let you activate your account.  Once you have that cookie email, use the $bcookie$b command to activate your account.",
         "$uSee Also:$u auth, unregister"
         );
         "1: /services/nickserv/email_enabled" (
         "/msg $N@$s REGISTER <account> <password> [email]",
         "Register is the command to register an account with $b$N$b. Later, you can use your account and password with $bauth$b to authenticate to your account.",
-        "Having an account provides a single login identity for use with $b$C$b.
+        "Having an account provides a single login identity for use with $b$C$b.",
         "Email activation is not required: But, if you specify an email address, an email will be sent to it containing a cookie that will let you activate your account.  Once you have that cookie, use the $bcookie$b command to activate your account.",
         "$uSee Also:$u auth, unregister"
         );
         "2: !/services/nickserv/email_enabled" (
         "/msg $N@$s REGISTER <account> <password>",
         "Register is the command to register an account with $b$N$b. Later, you can use your account and password with $bauth$b to authenticate to your account.",
-        "Having an account provides a single login identity for use with $b$C$b.
+        "Having an account provides a single login identity for use with $b$C$b.",
         "$uSee Also:$u auth, unregister"
         );
 };