src/nickserv.help.m4

   1 changequote({,})
   2 "<INDEX>" ("$b$N Help$b",
   3         "$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. The other component allows for ownership of a nickname, but is not necessarily enabled.",
   4         "$b$N$b command categories:",
   5         "  ACCOUNT    Account management.",
   6 ifdef({/services/nickserv/disable_nicks},
   7 {        "  NOT NICKSERV   A note on what this service does and does not do.",},
   8 {        "  NICK       Nick management.",})
   9 ifdef({/services/nickserv/email_enabled},
  10 {        "  EMAIL      Email maintenance commands",})
  11         "  OTHERS     Other functions.",
  12         "  COMMANDS   A list of all available commands.");
  13
  14 "HANDLE" ("The term $uhandle$u from earlier versions was confusing to many new users.  Therefore, it has been changed to $uaccount$u.");
  15
  16 "ACCOUNT" ("Accounts are the way that $b$C$b identifies you for access to channels.  They are slightly similar to IRC nicks, but only have meaning to the services bots.  Until you authenticate to $b$N$b on an account, you can only use the $bREGISTER$b and $bAUTH$b commands.",
  17         "Account management commands are:",
  18         "  REGISTER   Register a new account.",
  19         "  AUTH       Authenticate yourself to $b$N$b using an existing account.",
  20         "  PASS       Change your account's password.",
  21         "  ADDMASK    Add a hostmask to your account.",
  22         "  DELMASK    Remove a hostmask from your account.",
  23         "  SET        Set per-account options.",
  24         "  UNREGISTER Unregister an account.",
  25         "  RENAME     Renames an account",
  26 ifdef({/services/nickserv/enable_ghost},
  27 {        "  GHOST      Disconnects your old clients",})
  28         "  ACCOUNT FLAGS Definition for each account flag");
  29
  30 ifdef({/services/nickserv/disable_nicks},
  31 {"NOT NICKSERV" ("$bNOT NICKSERV$b",
  32         "This $b$N$b is not a standard NickServ.",
  33         "Most NickServs provide \"nick ownership\", and will either issue a /KILL or a forced nick change if you try to use a registered nick without providing the password.",
  34         "This $b$N$b will not do this.  It only allows you to register an $baccount$b, which identifies users to $b$C$b.  In a way, it is a virtual nick.  When you authenticate to $b$N$b, it does not care what your IRC nick is -- only account you are logged in as.",
  35         "$b$N$b can tell you what account a user is authenticated to using the $bUSERINFO$b command.  Any problems with account registration or $b$N$b should be directed to the normal support channel.");
  36
  37 "OUNREGISTER" ("/msg $N OUNREGISTER <nick|*account>",
  38         "Un-registers the specified account.",
  39         "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).",
  40         "$uSee Also:$u oregister");
  41
  42 "UNREGISTER" ("/msg $N@$s UNREGISTER <password>",
  43         "Un-registers the account you are authenticated as.",
  44         "$uSee Also:$u register");},
  45 {"NICK" ("You may register IRC nicknames to be associated with your accounts, and will be able to request a KILL for anyone using a nickname registered to you.",
  46         "Nick management commands are:",
  47         "  NICKINFO   Find out who has registered a nick.",
  48         "  REGNICK    Register a nickname.",
  49         "  UNREGNICK  Unregister a nickname.",
  50         "  RECLAIM    Reclaim a nick registered to you.");
  51
  52 "NICKINFO" ("/msg $N NICKINFO <nick>",
  53         "Displays information on the nick specified.",
  54         "$uSee Also:$u accountinfo, userinfo");
  55
  56 "REGNICK" ("/msg $N REGNICK ",
  57         "Registers your current nick to the account you are authenticated to.",
  58         "$uSee Also:$u register, unregister, unregnick");
  59
  60 "OUNREGISTER" ("/msg $N OUNREGISTER <nick|*account>",
  61         "Un-registers the specified account, and any nicks that have been registered to that account.",
  62         "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).",
  63         "$uSee Also:$u oregister, oregnick, ounregnick");
  64
  65 "OREGNICK" ("/msg $N OREGNICK [<nick|*account> <nick>]",
  66         "Registers specified nick to the specified account. If nick and account are not specified, then $boregnick$b registers your current nick to the account you are authenticated to.",
  67         "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).",
  68         "$uSee Also:$u oregister, ounregister, ounregnick");
  69
  70 "OUNREGNICK" ("/msg $N OUNREGNICK <nick>",
  71         "Un-registers a nick that was previously registered to an account.",
  72         "$uSee Also:$u oregister, oregnick, ounregister");
  73
  74 "UNREGISTER" ("/msg $N@$s UNREGISTER <password>",
  75         "Un-registers the account you are authenticated with, and any nicks that have been registered to that account.",
  76         "$uSee Also:$u register, regnick, unregnick");
  77
  78 "UNREGNICK" ("/msg $N UNREGNICK [nick]",
  79         "Un-registers a nick that was previously registered to your account.  If you do not specify a nick, your current nick will be un-registered.",
  80         "$uSee Also:$u register, regnick, unregister");
  81
  82 "RECLAIM" ("/msg $N RECLAIM <nick>",
  83         "Reclaims the specified nick. You must be authenticated to the account that registered the nick.",
  84         "Depending on configuration, this may do nothing, may ask the user nicely, may force a nick change on them, or may /KILL (disconnect) the target user.");})
  85
  86 ifdef({/services/nickserv/email_enabled},
  87 {"EMAIL" ("Email-based maintenance commands and topics are:",
  88         "  AUTHCOOKIE Email a cookie to allow you to authenticate (auth) without a matching hostmask.",
  89         "  RESETPASS  Request a password change if you forgot your old password.",
  90         "  COOKIE     Complete an email-based maintenance action.",
  91         "  DELCOOKIE  For AUTHCOOKIE or RESETPASS, cancel the requested cookie.",
  92         "  EMAIL POLICY  This network's policy on account email addresses.");
  93
  94 "AUTHCOOKIE" ("/msg $N AUTHCOOKIE <account>",
  95         "Requests that $N send you email with a cookie that allows you to auth to your account if you do not have a matching hostmask.  (For example, if your ISP changed your IP or hostname.)",
  96         "Once you receive the cookie in email, you can use the $bcookie$b command to log in.",
  97         "$uSee Also:$u cookie, delcookie");
  98
  99 "RESETPASS" ("/msg $N@$s RESETPASS <account> <newpassword>",
 100         "Requests that $N send you email with a cookie that will change your password (in case you have forgotten it).  Once you receive the cookie in email, use the $bcookie$b command to actually change your password.",
 101         "$bYour password will not be changed, and you will not be able to use it to log in, until you confirm the change using the $ucookie$u command.$b",
 102         "$uSee Also:$u cookie, delcookie");
 103
 104 "DELCOOKIE" ("/msg $N DELCOOKIE",
 105         "Requests that $N cancel your authcookie or resetpass cookie.",
 106         "(Since set-email cookies and registration cookies send email to unverified addresses, to prevent mail flooding, they cannot be cancelled.)",
 107         "$uSee Also:$u authcookie, resetpass, cookie");
 108
 109 "COOKIE" ("/msg $N@$s COOKIE <account> <cookie>",
 110         "Completes the maintenance action (for example, activating an account or changing your password) for which a cookie was issued.  The cookie will then be forgotten.",
 111         "$uSee Also:$u authcookie, resetpass, set, delcookie");
 112
 113 "EMAIL POLICY" ("$bEMAIL POLICY",
 114         "FooNET 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.",
 115         "(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.)");})
 116
 117 "OTHERS" ("Other commands are:",
 118         "  USERINFO    Displays the account a user is authenticated to.",
 119         "  ACCOUNTINFO Displays information about an account.",
 120         "  VERSION     $b$N$b version information.",
 121         "  STATUS      $b$N$b status.",
 122         "  SEARCH      Search for accounts by various criteria.",
 123         "  MERGE       Merge one account into another.",
 124         "  MERGEDB     Load a database into memory.",
 125         "  HELP        Get help on $b$N$b.");
 126
 127 "ADDMASK" ("/msg $N ADDMASK [user@host]",
 128         "Adds the specified user@host to the account you are authenticated to with $b$N$b.  If no mask is given, it uses your current mask.",
 129         "$uSee Also:$u auth, delmask");
 130 "ALLOWAUTH" ("/msg $N ALLOWAUTH <nick> [account] [STAFF]",
 131         "Allows the specified nick to $bauth$b to the specified account. $bAllowauth$b does NOT add the hostmask of that nick to the specified account.",
 132         "If no account is given, it will cancel the allowauth for the user (assuming the user has an allowauth).",
 133         "If the account is marked as a helper or oper, the STAFF qualifier must be given afterwards.  This reduces social engineering attacks.",
 134         "$uSee Also:$u addmask, auth");
 135 "AUTH" ("/msg $N@$s AUTH [account] <password>",
 136         "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.",
 137         "If you omit the account, it uses your current nick as your account name.",
 138 ifdef({/services/nickserv/email_enabled},
 139 {        "$uSee Also:$u pass, resetpass, authcookie"},
 140 {        "$uSee Also:$u pass"})
 141 );
 142 "DELMASK" ("/msg $N DELMASK <user@host>",
 143         "Removes a hostmask from the account you are authenticated on.",
 144         "An account must have at least one hostmask; you cannot remove the last mask for an account.",
 145         "$uSee Also:$u addmask");
 146 "ACCOUNTINFO" ("/msg $N ACCOUNTINFO <nick|*account>",
 147         "Displays infomation on the specified account, including the date the account was registered, the last time that person was seen, the account's $b$N$b info, its flags, its hostmask(s), its channels, and the account's current nickname.",
 148         "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).",
 149 ifdef({/services/nickserv/disable_nicks},
 150 {        "$uSee Also:$u userinfo, account flags"},
 151 {        "$uSee Also:$u nickinfo, userinfo, account flags"}));
 152 "ACCOUNT FLAGS" ("$bACCOUNT FLAGS$b",
 153         "The following flags on accounts are defined:",
 154         "$bS$b  $O access suspended",
 155         "$bp$b  Use PRIVMSG for messages rather than NOTICE",
 156         "$bh$b  User is a support helper (must be in support channel to override security)",
 157         "$bH$b  User is a network helper (can toggle security override)",
 158         "$bg$b  God mode (security override for IRC staff)",
 159         "$bs$b  Account suspended",
 160         "$bc$b  Use mIRC color codes in responses",
 161         "$bf$b  Account frozen/on vacation (will not be unregistered for inactivity; cleared when account is authenticated against)",
 162         "$bn$b  No-delete (will never be unregistered for inactivity)",
 163         "$uSee Also:$u accountinfo, set");
 164 "OADDMASK" ("/msg $N OADDMASK <nick|*account> <user@host>",
 165         "Adds a hostmask to the specified account.",
 166         "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).",
 167         "$uSee Also:$u odelmask");
 168 "ODELMASK" ("/msg $N ODELMASK <nick|*account> <user@host>",
 169         "Removes a hostmask from the specified account.",
 170         "An account must have at least one hostmask; you cannot remove the last mask for an account.",
 171         "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).",
 172         "$uSee Also:$u oaddmask");
 173 "OREGISTER" ("/msg $N@$s OREGISTER <account> <password> <user@host|nick>",
 174         "Registers an account with $b$N$b using the specified account, password, and user@host. If then nick of an online user is specified, then that user's user@host is used.",
 175 ifdef({/services/nickserv/disable_nicks},
 176 {        "$uSee Also:$u ounregister"},
 177 {        "$uSee Also:$u oregnick, ounregister, ounregnick"}));
 178 "OSET" ("/msg $N OSET <nick|*account> [<setting> <value>]",
 179         "Changes an account's settings for srvx. In addition to the normal $bset$b settings, you may set:",
 180         "$bPASSWORD$b: Sets user's password.",
 181         "$bFLAGS$b: Changes account flags for user.",
 182         "$bLEVEL$b: Sets $O access level.",
 183         "$bEPITHET$b: The description $C shows for the user's access.",
 184         "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).",
 185 ifdef({/services/nickserv/disable_nicks},
 186 {        "$uSee Also:$u accountinfo, account flags, set, userinfo"},
 187 {        "$uSee Also:$u accountinfo, account flags, nickinfo, set, userinfo"}));
 188 "PASS" ("/msg $N@$s PASS <oldpass> <newpass>",
 189         "Changes your $b$N$b password.",
 190         "$uSee Also:$u auth");
 191 "REGISTER" (
 192 ifdef({/services/nickserv/email_enabled},
 193 {ifdef({/services/nickserv/email_required},
 194 {        "/msg $N@$s REGISTER <account> <password> <email>",},
 195 {        "/msg $N@$s REGISTER <account> <password> [email]",})},
 196 {        "/msg $N@$s REGISTER <account> <password>",})
 197         "Registers a specified account with $b$N$b, adding your current user@host to your new account. You will be required to know the password you specify with $bregister$b in order to be able to use $bauth$b to authenticate to your account.",
 198 ifdef({/services/nickserv/email_enabled},
 199 {ifdef({/services/nickserv/email_required},
 200 {        "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.",},
 201 {        "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.",})})
 202         "NOTE: It is strongly recommended that you use the long form ($N@$s) rather than just nick ($N) for this command, to protect against impersonators on other networks.",
 203 ifdef({/services/nickserv/disable_nicks},
 204 {        "$uSee Also:$u auth, unregister"},
 205 {        "$uSee Also:$u auth, regnick, unregister, unregnick"}));
 206 "SET" ("/msg $N SET [<setting> [value]]",
 207         "Changes your account settings for srvx. Settings are:",
 208         "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
 209         "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
 210 ifdef({/services/nickserv/email_enabled},
 211 {        "$bEMAIL$b: Sets (or changes) your email address.",})
 212         "$bINFO$b:  Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
 213         "$bLANGUAGE$b: Your preferred language for private messages from the services.",
 214         "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
 215         "$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.",
 216         "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
 217         "$bWIDTH$b: The width you want srvx to wrap text it sends you.  (Use 0 for the default.)",
 218         "$bMAXLOGINS$b: The number of users that can log into your account at once.  (Use 0 for the default.)",
 219         "$bset$b with no arguments returns your current settings.",
 220 ifdef({/services/nickserv/disable_nicks},
 221 {        "$uSee Also:$u accountinfo, userinfo"},
 222 {        "$uSee Also:$u accountinfo, nickinfo, userinfo"}));
 223 "STATUS" ("/msg $N STATUS",
 224 ifdef({/services/nickserv/disable_nicks},
 225 {        "Displays information about the status of $b$N$b, including the total number of accounts in its database."},
 226 {        "Displays information about the status of $b$N$b, including the total number of accounts and nicks that are registered in its database, and how many nicks are registered to your account (if you are authenticated to one)."}));
 227 "USERINFO" ("/msg $N USERINFO <nick>",
 228         "Shows what account the nick specified is authenticated to.",
 229         "$uSee Also:$u auth, accountinfo");
 230 "VERSION" ("/msg $N VERSION",
 231         "Sends you the srvx version and some additional version information that is specific to $b$N$b.");
 232 "GHOST" ("/msg $N GHOST <nick>",
 233         "This disconnects an old client that is authed to your account.  This is $bnot$b the same thing as nick ownership; the user $bmust$b be authenticated to the same account you are.",
 234         "$uSee Also:$u auth");
 235 "RENAME" ("/msg $N RENAME <nick|*old-account> <new-account>",
 236         "Renames an account.",
 237         "This command is only accessible to helpers and IRC operators.",
 238         "$uSee Also:$u merge");
 239 "VACATION" ("/msg $N VACATION",
 240         "Marks your account as \"on vacation\" until the next time you authenticate to $N.",
 241         "While you are \"on vacation\", your account will not be deleted for inactivity.");
 242 "SEARCH" ("/msg $N SEARCH <action> <criteria> <value> [<criteria> <value>]...",
 243         "Searches for accounts matching the critera, and then does something to them.",
 244         "$uSee Also:$u search action, search criteria");
 245 "SEARCH ACTION" ("$bSEARCH ACTION$b",
 246         "The following actions are valid:",
 247         "  PRINT      - Print matching accounts",
 248         "  COUNT      - Count matching accounts",
 249         "  UNREGISTER - Unregister matching accounts",
 250         "$uSee Also:$u search, search criteria");
 251 "SEARCH CRITERIA" ("$bSEARCH CRITERIA$b",
 252         "The following account search criteria are valid.  Each takes an additional argument, giving the actual criteria:",
 253         "  LIMIT      - Limits the number of matches",
 254         "  FLAGS      - Bits that must be turned on (e.g. +h) and/or off (e.g. -S) in an account",
 255         "  REGISTERED - Registered time constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
 256         "  SEEN       - Accounts not seen for at least this long",
 257         "  ACCOUNTMASK - A glob that must match the account name",
 258         "  EMAIL      - A glob that must match the account's email address",
 259 ifdef({/services/nickserv/disable_nicks},,
 260 {        "  NICKMASK   - A glob that must match a nick registered to the account",})
 261         "  HOSTMASK SUPERSET - Account matches if someone with this hostmask can auth to the account",
 262         "  HOSTMASK EXACT - Account matches if this exact hostmask is in list",
 263         "  HOSTMASK SUBSET - Account matches if this mask \"covers\" one in their userlist",
 264         "  HOSTMASK   - A glob that must match a hostmask for the account (equivalent to HOSTMASK SUPERSET)",
 265         "  ACCESS     - An $O access constraint (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
 266         "$uSee Also:$u search, search action");
 267 "MERGE" ("/msg $N MERGE <from-nick|*from-account> <to-nick|*to-account>",
 268         "Merge access from $bfrom-account$b into $bto-account$b.  This includes hostmasks, registered nicks, authed users, access in channels, and OpServ access (if any).  If $bto-account$b has equal  or greater access than $bfrom-account$b (or more a general hostmask, etc), $bto-account$b keeps that information.",
 269         "This command is only accessible to helpers and IRC operators.",
 270         "$uSee Also:$u rename");
 271 "MERGEDB" ("/msg $N MERGE <dbfilename>",
 272         "Merge contents of $bdbfilename$b into in-memory database.  Any accounts in both will be $bOVERWRITTEN$b with the information from $bdbfilename$b, although authed users will be authed to the new account.",
 273         "This command is only accessible to IRC operators.",
 274         "$uSee Also:$u write");