]> jfr.im git - irc/evilnet/x3.git/blobdiff - src/nickserv.help
fixed spelling
[irc/evilnet/x3.git] / src / nickserv.help
index 9dc638ce25450072b6dcf8afecba46fbceefd605..8134696ca11c1caec7df44fdbad3859dae6cfcaf 100644 (file)
@@ -1,48 +1,53 @@
 "<INDEX>" {
         "/services/nickserv/disable_nicks" {
         "/services/nickserv/email_enabled" (
-                "=------------ $b$N Help$b -----------=",
-                " $b$N$b is an 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.",
+                " $b$N$b is an authentication service,",
+                " providing login identification for",
+                " the network. $N is how you 'log in'",
+                " to get access in channels registered",
+                " 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 maintenance commands.",
-               "  $bINFORMATION$b  Other functions.",
-                "  $bOPER$b         $N commands for IRC Operators.",
+                "  $bEMAIL$b        Email based commands",
+                "                 such as recovering forgotten",
+                "                 passwords.",
+               "  $bINFORMATION$b  Informational functions.",
+                "  $bOPER$b         Commands for IRC Operators.",
                 "$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, ",
-                " 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.",
+                " $b$N$b is an authentication service,",
+                " providing login identification for",
+                " the network. $N is how you 'log in'",
+                " to get access in channels registered",
+                " with $C, and its how ircops are known",
+                " to $O and $G.",
                 " $b$b",
                " $b$N$b help categories:",
                "  $bACCOUNT$b      Account management.",
-               "  $bINFORMATION$b  Other functions.",
-                "  $bOPER$b         $N commands for IRC Operators.",
+               "  $bINFORMATION$b  Informational functions.",
+                "  $bOPER$b         Commands for IRC Operators.",
                 "$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:",
@@ -63,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."
         );
         };
 };
@@ -73,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 AfterNET, ",
+                " $N is $unot$u a NickServ. On this network, ",
                 " nicknames are not owned. $N allows ",
                 " you to register a single account to ",
                 " log in to all channels, seperate from ",
                 " 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."
         );
 
 
         "/services/nickserv/email_enabled" (
         "$bEMAIL POLICY",
         "AfterNET has utmost respect for the privacy of its users.  We will submit your email address to as many spam databases as we can find, and we will even post it on our web site.",
-        "(No, not really.  It looks like somebody forgot to edit nickserv.help or nickserv.help.m4 to remove this entry.  Make sure they edit the mail section of srvx.conf while they are at it.)"
+        "(No, not really.  It looks like somebody forgot to edit nickserv.help or nickserv.help.m4 to remove this entry.  Make sure they edit the mail section of x3.conf while they are at it.)"
         );
 };
 
         "$uSee Also:$u oregnick, ounregister, ounregnick"
         );
 };
-"OSET" {
-        "/services/nickserv/disable_nicks" (
-        "/msg $N OSET <nick|*account> [<setting> <value>]",
-        "Changes an account's settings for srvx. In addition to the normal $bset$b settings, you may set:",
-        "$bPASSWORD$b: Sets user's password.",
-        "$bFLAGS$b: Changes account flags for user.",
-        "$bLEVEL$b: Sets $O access level.",
-        "$bEPITHET$b: The description $C shows for the user's access.",
-        "You may use *Account instead of Nick as the name argument; the * makes $N use the name of an account directly (useful if the user is not online).",
-        "$uSee Also:$u accountinfo, account flags, set, userinfo"
-        );
-        "!/services/nickserv/disable_nicks" (
-        "/msg $N OSET <nick|*account> [<setting> <value>]",
-        "Changes an account's settings for srvx. In addition to the normal $bset$b settings, you may set:",
-        "$bPASSWORD$b: Sets user's password.",
-        "$bFLAGS$b: Changes account flags for user.",
-        "$bLEVEL$b: Sets $O access level.",
-        "$bEPITHET$b: The description $C shows for the user's access.",
-        "You may use *Account instead of Nick as the name argument; the * makes $N use the name of an account directly (useful if the user is not online).",
-        "$uSee Also:$u accountinfo, account flags, nickinfo, set, userinfo"
+"OSET" (
+          "/msg $N OSET <nick|*account> [<setting> <value>]",
+          "Allows opers/helpers to change a users account settings. You may set:",
+          "$bPASSWORD$b: Sets user's password.",
+          "$bFLAGS$b: Changes account flags (SphHdscfn) for user (see $uaccount flags$u).",
+          "$bLEVEL$b: Sets $O access level.",
+          "$bEPITHET$b: The description shown for the user's access in /whois.",
+          "$bTITLE$b: The title the user will get (in there hostname) when +x.",
+          "$bFAKEHOST$b: The fake hostname the user will get when +x.",
+          "..or anything $bset$b can change.",
+          "You may use *Account instead of Nick as the name argument; the * makes $N use the name of an account directly (useful if the user is not online).",
+          "$uSee Also:$u accountinfo, account flags, set, userinfo"
+);
+
+"ODELCOOKIE" {
+        "/services/nickserv/email_enabled" (
+        "/msg $N ODELCOOKIE <nick|*account>",
+        "Requests that $N cancels the cookie of the specified account.",
         );
 };
+
 "PASS" ("/msg $N@$s PASS <oldpass> <newpass>",
         "Changes your $b$N$b password.",
         "$uSee Also:$u auth");
 "REGISTER" {
         "0: /services/nickserv/email_required" (
         "/msg $N@$s REGISTER <account> <password> <email>",
-        "Registers a specified account with $b$N$b, adding your current user@host to your new account. You must the password you specify with $bregister$b to use $bauth$b to authenticate to your account.",
-        "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, you must use the $bcookie$b command to be able to use your account.",
+        "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.",
+        "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]",
-        "Registers a specified account with $b$N$b, adding your current user@host to your new account. You must the password you specify with $bregister$b to use $bauth$b to authenticate to your account.",
-        "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, you must use the $bcookie$b command to be able to use your account.",
+        "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.",
+        "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>",
-        "Registers a specified account with $b$N$b, adding your current user@host to your new account. You must the password you specify with $bregister$b to use $bauth$b to authenticate to your account.",
+        "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.",
         "$uSee Also:$u auth, unregister"
         );
 };
         "$bINFO$b:  Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
         "$bLANGUAGE$b: Your preferred language for private messages from the services.",
         "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
-        "$bSTYLE$b: The style you want srvx to use for channel userlists it sends you. $bSTYLE$b can be either $bDef$b (default) or $bZoot$b.",
         "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
-        "$bWIDTH$b: The width you want srvx to wrap text it sends you.  (Use 0 for the default.)",
+        "$bWIDTH$b: The width you want X3 to wrap text it sends you.  (Use 0 for the default.)",
         "$bMAXLOGINS$b: The number of users that can log into your account at once.  (Use 0 for the default.)",
+        "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
+        "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
         "$bset$b with no arguments returns your current settings.",
         "$uSee Also:$u accountinfo, userinfo"
         );
         "/services/nickserv/email_enabled && !/services/nickserv/disable_nicks" (
         "/msg $N SET [<setting> [value]]",
-        "Changes your account settings for srvx. Settings are:",
+        "Changes your account settings for X3. Settings are:",
         "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
         "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
         "$bEMAIL$b: Sets (or changes) your email address.",
         "$bINFO$b:  Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
         "$bLANGUAGE$b: Your preferred language for private messages from the services.",
         "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
-        "$bSTYLE$b: The style you want srvx to use for channel userlists it sends you. $bSTYLE$b can be either $bDef$b (default) or $bZoot$b.",
         "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
-        "$bWIDTH$b: The width you want srvx to wrap text it sends you.  (Use 0 for the default.)",
+        "$bWIDTH$b: The width you want X3 to wrap text it sends you.  (Use 0 for the default.)",
         "$bMAXLOGINS$b: The number of users that can log into your account at once.  (Use 0 for the default.)",
+        "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
+        "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
         "$bset$b with no arguments returns your current settings.",
         "$uSee Also:$u accountinfo, nickinfo, userinfo"
         );
         "!/services/nickserv/email_enabled && /services/nickserv/disable_nicks" (
         "/msg $N SET [<setting> [value]]",
-        "Changes your account settings for srvx. Settings are:",
+        "Changes your account settings for X3. Settings are:",
         "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
         "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
         "$bINFO$b:  Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
         "$bLANGUAGE$b: Your preferred language for private messages from the services.",
         "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
-        "$bSTYLE$b: The style you want srvx to use for channel userlists it sends you. $bSTYLE$b can be either $bDef$b (default) or $bZoot$b.",
         "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
-        "$bWIDTH$b: The width you want srvx to wrap text it sends you.  (Use 0 for the default.)",
+        "$bWIDTH$b: The width you want X3 to wrap text it sends you.  (Use 0 for the default.)",
         "$bMAXLOGINS$b: The number of users that can log into your account at once.  (Use 0 for the default.)",
+        "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
+        "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
         "$bset$b with no arguments returns your current settings.",
         "$uSee Also:$u accountinfo, userinfo"
         );
         "!/services/nickserv/email_enabled && !/services/nickserv/disable_nicks" (
         "/msg $N SET [<setting> [value]]",
-        "Changes your account settings for srvx. Settings are:",
+        "Changes your account settings for X3. Settings are:",
         "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
         "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
         "$bINFO$b:  Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
         "$bLANGUAGE$b: Your preferred language for private messages from the services.",
         "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
-        "$bSTYLE$b: The style you want srvx to use for channel userlists it sends you. $bSTYLE$b can be either $bDef$b (default) or $bZoot$b.",
         "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
-        "$bWIDTH$b: The width you want srvx to wrap text it sends you.  (Use 0 for the default.)",
+        "$bWIDTH$b: The width you want X3 to wrap text it sends you.  (Use 0 for the default.)",
         "$bMAXLOGINS$b: The number of users that can log into your account at once.  (Use 0 for the default.)",
+        "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
+        "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
         "$bset$b with no arguments returns your current settings.",
         "$uSee Also:$u accountinfo, nickinfo, userinfo"
         );