X-Git-Url: https://jfr.im/git/irc/evilnet/x3.git/blobdiff_plain/34938510a88c053e2dabe853561c1028cc49b359..73ac2ca6bf965e933233aacdf2c6a56a2d041b81:/src/nickserv.help diff --git a/src/nickserv.help b/src/nickserv.help index b6f6f64..a44308a 100644 --- a/src/nickserv.help +++ b/src/nickserv.help @@ -1,48 +1,73 @@ "" { "/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 the login bot. It provides ", + " accounts for use on 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.", + " To get an account: ", + " $b/msg $N HELP REGISTER$b ", + " To login to your account: ", + " $b/msg $N@$s AUTH accountname password$b", + " $b$b", + " Read more about $N in the help system:", + " To read help, type:", + " $b/msg $N HELP <$bsubject$b>$b ", + " (In help, words in <> represent required", + " parameters. Words in [] are optional.)", + " For example: $b/msg $N HELP REGISTER$b", + " shows help with the command create an ", + " account. ", " $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.", + " $bIGNORE$b Ignore list management.", + " $bINFORMATION$b Informational functions.", + " $bOPER$b Commands for IRC Operators.", "$b$b", " $b$N is $uNOT$u a NickServ$b! ", + " We do not 'own' nicks here. ", " 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 the login bot. It provides ", + " accounts for use on 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.", + " To get an account: ", + " $b/msg $N HELP REGISTER$b ", + " To login to your account: ", + " $b/msg $N@$s AUTH accountname password$b", + " $b$b", + " Read more about $N in the help system:", + " To read help, type:", + " $b/msg $N HELP <$bsubject$b>$b ", + " (In help, words in <> represent required", + " parameters. Words in [] are optional.)", + " For example: $b/msg $N HELP REGISTER$b", + " shows help with the command create an ", + " account. ", " $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.", + " $bIGNORE$b Ignore list management.", + " $bOPER$b Commands for IRC Operators.", "$b$b", " $b$N is $uNOT$u a NickServ$b! ", + " We do not 'own' nicks here. ", " 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:", @@ -50,21 +75,16 @@ " NICK Nick management.", " 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:", " ACCOUNT Account management.", " 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 +93,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, ", @@ -89,13 +108,13 @@ " $bPASS$b Change your account's password.", " $bADDMASK$b Add a hostmask to your account.", " $bDELMASK$b Remove a hostmask from your account.", + " $bADDSSLFP$b Add an SSL fingerprint to your account.", + " $bDELSSLFP$b Remove an SSL fingerprint 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, ", @@ -112,63 +131,67 @@ " $bPASS$b Change your account's password.", " $bADDMASK$b Add a hostmask to your account.", " $bDELMASK$b Remove a hostmask from your account.", + " $bADDSSLFP$b Add an SSL fingerprint to your account.", + " $bDELSSLFP$b Remove an SSL fingerprint 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.", " $bMERGE$b Merge one account into another.", " $bOREGISTER$b Create an account for someone else.", " $bOUNREGISTER$b Remove an account by name.", + " $bODELCOOKIE$b Deletes a pending cookie.", "*$bOREGNICK$b Add a nick to someone's 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 --------------=" + " $bOADDSSLFP$b Add an SSL fingerprint to someone's account.", + " $bODELSSLFP$b Remove an SSL fingerprint from someone's account.", + " $bOADDIGNORE$b Add an ignore to someone's account.", + " $bODELIGNORE$b Remove an ignore from someone's account.", + " $bMERGEDB$b Load a database into memory." ); "OUNREGISTER" { "/services/nickserv/disable_nicks" ( - "/msg $N OUNREGISTER ", + "/msg $N OUNREGISTER [FORCE]", "Un-registers the specified account.", "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).", + "Without FORCE only accounts that are inactive and have no special flags can be unregistered.", "$uSee Also:$u oregister" ); "!/services/nickserv/disable_nicks" ( - "/msg $N OUNREGISTER ", + "/msg $N OUNREGISTER [FORCE]", "Un-registers the specified account, and any nicks that have been registered to that account.", "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).", + "Without FORCE only accounts that are inactive and have no special flags can be unregistered.", "$uSee Also:$u oregister, oregnick, ounregnick" ); }; @@ -313,9 +336,8 @@ "AUTH" { "/services/nickserv/email_enabled" ( - "/msg $N@$s AUTH [account] ", + "/msg $N@$s AUTH ", "Authenticates yourself with $b$N$b to the specified account. You must use $bauth$b before you have any access to network services, including channels that are registered with $b$C$b.", - "If you omit the account, it uses your current nick as your account name.", "$uSee Also:$u pass, resetpass, authcookie", ); "!/services/nickserv/email_enabled" ( @@ -354,7 +376,8 @@ "$bc$b Use mIRC color codes in responses", "$bf$b Account frozen/on vacation (will not be unregistered for inactivity; cleared when account is authenticated against)", "$bn$b No-delete (will never be unregistered for inactivity)", - "$uSee Also:$u accountinfo, set"); + "$bb$b Hides you from the staff list", + "$uSee Also:$u accountinfo, set, $C staff"); "OADDMASK" ("/msg $N OADDMASK ", "Adds a hostmask to the specified account.", "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).", @@ -365,44 +388,50 @@ "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 oaddmask"); "OREGISTER" { - "/services/nickserv/disable_nicks" ( - "/msg $N@$s OREGISTER ", - "Registers an account with $b$N$b using the specified account, password, and user@host. If the nick of an online user is specified, then that user's user@host is used. If no nickname or hostmask is used, it uses a default hostmask the first time the user authenticates.", - "$uSee Also:$u ounregister" - ); - "!/services/nickserv/disable_nicks" ( - "/msg $N@$s OREGISTER ", - "Registers an account with $b$N$b using the specified account, password, and user@host. If the nick of an online user is specified, then that user's user@host is used. If no nickname or hostmask is used, it uses a default hostmask the first time the user authenticates.", - "$uSee Also:$u oregnick, ounregister, ounregnick" - ); -}; -"OSET" { - "/services/nickserv/disable_nicks" ( - "/msg $N OSET [ ]", - "Changes an account's settings for X3. 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 [ ]", - "Changes an account's settings for X3. 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" - ); + "/services/nickserv/disable_nicks" { + "/services/nickserv/email_required" ( + "/msg $N@$s OREGISTER [user@host] [nick]", + "Registers an account for nick with $b$N$b using the specified account name, password, email address and user@host. If the nick of an online user is specified, then they will be logged in, and that user's user@host is used if you don't specify one. If no nickname or hostmask is used, it uses a default hostmask, or adds one when they first authenticate.", + "$uSee Also:$u ounregister, oaddmask, oset" + ); + "!/services/nickserv/email_required" ( + "/msg $N@$s OREGISTER [user@host] [nick]", + "Registers an account for nick with $b$N$b using the specified account name, password, email address and user@host. If the nick of an online user is specified, then they will be logged in, and that user's user@host is used if you don't specify one. If no nickname or hostmask is used, it uses a default hostmask, or adds one when they first authenticate.", + "$uSee Also:$u ounregister, oaddmask, oset" + ); + }; + "!/services/nickserv/disable_nicks" { + "/services/nickserv/email_required" ( + "/msg $N@$s OREGISTER [user@host] [nick]", + "Registers an account for nick with $b$N$b using the specified account name, password, email address and user@host. If the nick of an online user is specified, then they will be logged in, and that user's user@host is used if you don't specify one. If no nickname or hostmask is used, it uses a default hostmask, or adds one when they first authenticate.", + "$uSee Also:$u oregnick, ounregister, ounregnick, oaddmask, oset" + ); + "!/services/nickserv/email_required" ( + "/msg $N@$s OREGISTER [user@host] [nick]", + "Registers an account for nick with $b$N$b using the specified account name, password, email address and user@host. If the nick of an online user is specified, then they will be logged in, and that user's user@host is used if you don't specify one. If no nickname or hostmask is used, it uses a default hostmask, or adds one when they first authenticate.", + "$uSee Also:$u oregnick, ounregister, ounregnick, oaddmask, oset" + ); + }; }; +"OSET" ( + "/msg $N OSET [ ]", + "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.", + "$bNOTE$b: Adds a note to the user's account.", + "$bTITLE$b: The title the user will get (in their 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 ", - "Requests that $N cancels the cookie of the specified account.", + "Requests that $N cancel the cookie of the specified account.", ); }; @@ -413,19 +442,32 @@ "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 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.", + "$bDO NOT TYPE THE < and >!$b <> indicates required fields. ", + "Register is the command to create an an account with $b$N$b. ", + "Having an account provides a single login identity for the network, and for use with $b$C$b.", + "$b$b", + "$bEmail activation is required:$b An email will be sent to the email address you give to verify it. You must", + "provide a valid email address or registration will fail. After you register, check your email for instructions validating your account.", + "$b$b", + "If you already have an account, login using the $bAUTH$b command:", + "$b/msg $N@$s AUTH $b", "$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 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.", - "$uSee Also:$u auth, unregister" + "$bDO NOT TYPE THE < and >!$b <> indicates required fields. ", + "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.", + "$b$b", + "If you already have an account, login using the $bAUTH$b command:", + "$b/msg $N@$s AUTH $b", + "$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 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" ); }; @@ -438,11 +480,15 @@ "$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.", + "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.", "$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).", + "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.", + "$bADVANCED$b: If set advanced options and commands will be shown to you.", "$bset$b with no arguments returns your current settings.", "$uSee Also:$u accountinfo, userinfo" ); @@ -454,11 +500,15 @@ "$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.", + "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.", "$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).", + "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.", + "$bADVANCED$b: If set advanced options and commands will be shown to you.", "$bset$b with no arguments returns your current settings.", "$uSee Also:$u accountinfo, nickinfo, userinfo" ); @@ -469,11 +519,15 @@ "$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.", + "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.", "$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).", + "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.", + "$bADVANCED$b: If set advanced options and commands will be shown to you.", "$bset$b with no arguments returns your current settings.", "$uSee Also:$u accountinfo, userinfo" ); @@ -484,20 +538,34 @@ "$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.", + "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.", "$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).", + "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.", + "$bADVANCED$b: If set advanced options and commands will be shown to you.", "$bset$b with no arguments returns your current settings.", "$uSee Also:$u accountinfo, nickinfo, userinfo" ); }; -"SET LANGUAGE" ("/msg $S SET LANGUAGE ", +"SET LANGUAGE" ("/msg $N SET LANGUAGE ", "Sets the language that $S and other services will use when sending you messages.", "If a particular message is not available in your language, it will use the closest match it has.", "Supported languages are: ${modcmd:languages}", "$uSee Also:$u set"); +"SET STYLE" ("/msg $N SET STYLE