X-Git-Url: https://jfr.im/git/irc/evilnet/x3.git/blobdiff_plain/180e0971962fa45f6fae9e072d585620ae386d7f..f8f30e75066e4a0b84034e50e392ba713f27732d:/src/nickserv.help?ds=sidebyside diff --git a/src/nickserv.help b/src/nickserv.help index b4f92b4..089d2b3 100644 --- a/src/nickserv.help +++ b/src/nickserv.help @@ -1,7 +1,6 @@ "" { "/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", @@ -19,11 +26,9 @@ "$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'", @@ -38,13 +43,11 @@ "$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:", @@ -53,11 +56,9 @@ " 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, ", @@ -93,11 +92,9 @@ " $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, ", @@ -116,14 +113,12 @@ " $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 ", @@ -131,20 +126,18 @@ " 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.", @@ -155,8 +148,7 @@ "*$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." ); @@ -406,19 +398,22 @@ "REGISTER" { "0: /services/nickserv/email_required" ( "/msg $N@$s REGISTER ", - "Registers a specified account with $b$N$b, adding your current user@host to your new account. You must use the same password with $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 [email]", - "Registers a specified account with $b$N$b, adding your current user@host to your new account. You must use the same password with $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 ", - "Registers a specified account with $b$N$b, adding your current user@host to your new account. You must use the same password with $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" ); }; @@ -432,10 +427,11 @@ "$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 X3 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 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" ); @@ -448,10 +444,11 @@ "$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 X3 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 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" ); @@ -463,10 +460,11 @@ "$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 X3 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 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" ); @@ -478,10 +476,11 @@ "$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 X3 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 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" );