]> jfr.im git - irc/evilnet/x3.git/blame - src/nickserv.help
Minor typo in previous commit where returning 0 when it should have been 1 from opser...
[irc/evilnet/x3.git] / src / nickserv.help
CommitLineData
d76ed9a9 1"<INDEX>" {
2 "/services/nickserv/disable_nicks" {
3 "/services/nickserv/email_enabled" (
1478fd13 4 " $b$N$b is the login bot. It provides ",
5 " accounts for use on the network. ",
6 " $N is how you 'log in' to get access ",
7 " in channels registered with $C, and ",
8 " its how ircops are known to $O and $G.",
9 " To get an account: ",
10 " $b/msg $N HELP REGISTER$b ",
11 " To login to your account: ",
12 " $b/msg $N@$s AUTH accountname password$b",
d2dce5ac 13 " $b$b",
1478fd13 14 " Read more about $N in the help system:",
15 " To read help, type:",
16 " $b/msg $N HELP <$bsubject$b>$b ",
1d957482 17 " (In help, words in <> represent required",
7cbbd86a 18 " parameters. Words in [] are optional.)",
1478fd13 19 " For example: $b/msg $N HELP REGISTER$b",
20 " shows help with the command create an ",
21 " account. ",
b1bf690d 22 " $b$b",
d2dce5ac 23 " $b$N$b help categories:",
24 " $bACCOUNT$b Account management.",
180e0971 25 " $bEMAIL$b Email based commands",
26 " such as recovering forgotten",
27 " passwords.",
5177fd21 28 " $bIGNORE$b Ignore list management.",
180e0971 29 " $bINFORMATION$b Informational functions.",
30 " $bOPER$b Commands for IRC Operators.",
d2dce5ac 31 "$b$b",
32 " $b$N is $uNOT$u a NickServ$b! ",
1478fd13 33 " We do not 'own' nicks here. ",
d2dce5ac 34 " see $b/msg $N HELP NOT NICKSERV$b ",
b1bf690d 35 " for details "
d76ed9a9 36 );
37 "!/services/nickserv/email_enabled" (
1478fd13 38 " $b$N$b is the login bot. It provides ",
39 " accounts for use on the network. ",
40 " $N is how you 'log in' to get access ",
41 " in channels registered with $C, and ",
42 " its how ircops are known to $O and $G.",
43 " To get an account: ",
44 " $b/msg $N HELP REGISTER$b ",
45 " To login to your account: ",
46 " $b/msg $N@$s AUTH accountname password$b",
47 " $b$b",
48 " Read more about $N in the help system:",
49 " To read help, type:",
50 " $b/msg $N HELP <$bsubject$b>$b ",
51 " (In help, words in <> represent required",
52 " parameters. Words in [] are optional.)",
53 " For example: $b/msg $N HELP REGISTER$b",
54 " shows help with the command create an ",
55 " account. ",
d2dce5ac 56 " $b$b",
57 " $b$N$b help categories:",
58 " $bACCOUNT$b Account management.",
180e0971 59 " $bINFORMATION$b Informational functions.",
5177fd21 60 " $bIGNORE$b Ignore list management.",
180e0971 61 " $bOPER$b Commands for IRC Operators.",
d2dce5ac 62 "$b$b",
63 " $b$N is $uNOT$u a NickServ$b! ",
1478fd13 64 " We do not 'own' nicks here. ",
d2dce5ac 65 " see $b/msg $N HELP NOT NICKSERV$b ",
b1bf690d 66 " for details "
d76ed9a9 67 );
68 };
69 "!/services/nickserv/disable_nicks" {
70 "/services/nickserv/email_enabled" (
71 "$b$N Help$b",
72 "$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.",
73 "$b$N$b command categories:",
d2dce5ac 74 " ACCOUNT Account management.",
75 " NICK Nick management.",
76 " EMAIL Email maintenance commands.",
77 " INFORMATION Other functions.",
b1bf690d 78 " OPER $N commands for IRC Operators."
d76ed9a9 79 );
80 "!/services/nickserv/email_enabled" (
81 "$b$N Help$b",
82 "$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.",
83 "$b$N$b command categories:",
d2dce5ac 84 " ACCOUNT Account management.",
85 " NICK Nick management.",
86 " INFORMATION Other functions.",
b1bf690d 87 " OPER $N commands for IRC Operators."
d76ed9a9 88 );
89 };
90};
91
92"HANDLE" ("The term $uhandle$u from earlier versions was confusing to many new users. Therefore, it has been changed to $uaccount$u.");
93
94"ACCOUNT" {
95 "/services/nickserv/enable_ghost" (
d2dce5ac 96 " Accounts are the way that $b$C$b ",
97 " identifies you for access to channels. ",
98 " They are slightly similar to IRC nicks, ",
99 " but only have meaning to the services ",
100 " bots. Until you authenticate to $b$N$b ",
101 " on an account, you can only use the ",
102 " $bREGISTER$b and $bAUTH$b commands. ",
103 "$b$b",
104 " Account management commands are:",
105 " $bREGISTER$b Register a new account.",
106 " $bUNREGISTER$b Unregister an account.",
107 " $bAUTH$b Authenticate yourself to $b$N$b using an existing account.",
108 " $bPASS$b Change your account's password.",
109 " $bADDMASK$b Add a hostmask to your account.",
110 " $bDELMASK$b Remove a hostmask from your account.",
2fa83595 111 " $bADDSSLFP$b Add an SSL fingerprint to your account.",
112 " $bDELSSLFP$b Remove an SSL fingerprint from your account.",
d2dce5ac 113 " $bSET$b Set per-account options.",
114 " $bGHOST$b Disconnects your old clients",
b1bf690d 115 " $bACCOUNT FLAGS$b Definition for each account flag"
d76ed9a9 116 );
117 "!/services/nickserv/enable_ghost" (
d2dce5ac 118 " Accounts are the way that $b$C$b ",
119 " identifies you for access to channels. ",
120 " They are slightly similar to IRC nicks, ",
121 " but only have meaning to the services ",
122 " bots. Until you authenticate to $b$N$b ",
123 " on an account, you can only use the ",
124 " $bREGISTER$b and $bAUTH$b commands. ",
125 "$b$b",
126 " Account management commands are: ",
127 " $bREGISTER$b Register a new account.",
128 " $bUNREGISTER$b Unregister an account.",
129 " $bAUTH$b Authenticate yourself to ",
130 " $b$N$b using an existing account.",
131 " $bPASS$b Change your account's password.",
132 " $bADDMASK$b Add a hostmask to your account.",
133 " $bDELMASK$b Remove a hostmask from your account.",
2fa83595 134 " $bADDSSLFP$b Add an SSL fingerprint to your account.",
135 " $bDELSSLFP$b Remove an SSL fingerprint from your account.",
d2dce5ac 136 " $bSET$b Set per-account options.",
137 " $bRENAME$b Renames an account",
b1bf690d 138 " $bACCOUNT FLAGS$b Definition for each account flag"
d76ed9a9 139 );
140};
141
142"NOT NICKSERV" {
d2dce5ac 143 "/services/nickserv/disable_nicks" (
180e0971 144 " $N is $unot$u a NickServ. On this network, ",
d2dce5ac 145 " nicknames are not owned. $N allows ",
146 " you to register a single account to ",
147 " log in to all channels, seperate from ",
148 " your nickname. ",
149 " $b$N$b can tell you what ",
150 " account a user is authenticated to ",
b1bf690d 151 " using the $bUSERINFO$b command. "
d2dce5ac 152 );
d76ed9a9 153};
154
b1bf690d 155"INFORMATION" ("$bInformational commands:$b",
d2dce5ac 156 " $bACCOUNTINFO$b Displays information about an account.",
157 " $bUSERINFO$b Display what account an online user is authenticated to.",
158 " $bSTATUS$b $b$N$b status.",
b1bf690d 159 " $bVERSION$b $b$N$b version information."
d2dce5ac 160 );
161
b1bf690d 162"OPER" ("$bIRC Operator Help:$b",
d2dce5ac 163 " $bSEARCH$b Search accounts and apply an action.",
5073008f 164 " $bOSET$b Modify account details including password.",
d2dce5ac 165 " $bRENAME$b Rename an account.",
166 " $bMERGE$b Merge one account into another.",
167 " $bOREGISTER$b Create an account for someone else.",
168 " $bOUNREGISTER$b Remove an account by name.",
babc1c07 169 " $bODELCOOKIE$b Deletes a pending cookie.",
d2dce5ac 170 "*$bOREGNICK$b Add a nick to someone's account.",
171 "*$bOUNREGNICK$b Remove a nick from someone's account.",
172 " $bOADDMASK$b Add a mask to someone's account.",
173 " $bODELMASK$b Remove a mask from someone's account.",
2fa83595 174 " $bOADDSSLFP$b Add an SSL fingerprint to someone's account.",
175 " $bODELSSLFP$b Remove an SSL fingerprint from someone's account.",
5177fd21 176 " $bOADDIGNORE$b Add an ignore to someone's account.",
177 " $bODELIGNORE$b Remove an ignore from someone's account.",
b1bf690d 178 " $bMERGEDB$b Load a database into memory."
d2dce5ac 179 );
180
181
d76ed9a9 182"OUNREGISTER" {
183 "/services/nickserv/disable_nicks" (
1136f709 184 "/msg $N OUNREGISTER <nick|*account> [FORCE]",
d76ed9a9 185 "Un-registers the specified account.",
186 "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).",
1136f709 187 "Without FORCE only accounts that are inactive and have no special flags can be unregistered.",
d76ed9a9 188 "$uSee Also:$u oregister"
189 );
190 "!/services/nickserv/disable_nicks" (
1136f709 191 "/msg $N OUNREGISTER <nick|*account> [FORCE]",
d76ed9a9 192 "Un-registers the specified account, and any nicks that have been registered to that account.",
193 "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).",
1136f709 194 "Without FORCE only accounts that are inactive and have no special flags can be unregistered.",
d76ed9a9 195 "$uSee Also:$u oregister, oregnick, ounregnick"
196 );
197};
198
199"UNREGISTER" {
200 "/services/nickserv/disable_nicks" (
201 "/msg $N@$s UNREGISTER <password>",
202 "Un-registers the account you are authenticated as.",
203 "$uSee Also:$u register"
204 );
205 "!/services/nickserv/disable_nicks" (
206 "/msg $N@$s UNREGISTER <password>",
207 "Un-registers the account you are authenticated with, and any nicks that have been registered to that account.",
208 "$uSee Also:$u register, regnick, unregnick"
209 );
210};
211
212"NICK" {
213 "!/services/nickserv/disable_nicks" (
214 "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.",
215 "Nick management commands are:",
216 " NICKINFO Find out who has registered a nick.",
217 " REGNICK Register a nickname.",
218 " UNREGNICK Unregister a nickname.",
219 " RECLAIM Reclaim a nick registered to you."
220 );
221};
222
223"NICKINFO" {
224 "!/services/nickserv/disable_nicks" (
225 "/msg $N NICKINFO <nick>",
226 "Displays information on the nick specified.",
227 "$uSee Also:$u accountinfo, userinfo"
228 );
229};
230
231"REGNICK" {
232 "!/services/nickserv/disable_nicks" (
233 "/msg $N REGNICK ",
234 "Registers your current nick to the account you are authenticated to.",
235 "$uSee Also:$u register, unregister, unregnick"
236 );
237};
238
239"OREGNICK" {
240 "!/services/nickserv/disable_nicks" (
241 "/msg $N OREGNICK [<nick|*account> <nick>]",
242 "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.",
243 "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).",
244 "$uSee Also:$u oregister, ounregister, ounregnick"
245 );
246};
247
248"OUNREGNICK" {
249 "!/services/nickserv/disable_nicks" (
250 "/msg $N OUNREGNICK <nick>",
251 "Un-registers a nick that was previously registered to an account.",
252 "$uSee Also:$u oregister, oregnick, ounregister"
253 );
254};
255
256"UNREGNICK" {
257 "!/services/nickserv/disable_nicks" (
258 "/msg $N UNREGNICK [nick]",
259 "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.",
260 "$uSee Also:$u register, regnick, unregister"
261 );
262};
263
264"RECLAIM" {
265 "!/services/nickserv/disable_nicks" (
266 "/msg $N RECLAIM <nick>",
267 "Reclaims the specified nick. You must be authenticated to the account that registered the nick.",
268 "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."
269 );
270};
271
272"EMAIL" {
273 "/services/nickserv/email_enabled" (
274 "Email-based maintenance commands and topics are:",
275 " AUTHCOOKIE Email a cookie to allow you to authenticate (auth) without a matching hostmask.",
276 " RESETPASS Request a password change if you forgot your old password.",
277 " COOKIE Complete an email-based maintenance action.",
278 " DELCOOKIE For AUTHCOOKIE or RESETPASS, cancel the requested cookie.",
279 " EMAIL POLICY This network's policy on account email addresses."
280 );
281};
282
283"AUTHCOOKIE" {
284 "/services/nickserv/email_enabled" (
285 "/msg $N AUTHCOOKIE <account>",
286 "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.)",
287 "Once you receive the cookie in email, you can use the $bcookie$b command to log in.",
288 "$uSee Also:$u cookie, delcookie"
289 );
290};
291
292"RESETPASS" {
293 "/services/nickserv/email_enabled" (
294 "/msg $N@$s RESETPASS <account> <newpassword>",
295 "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.",
296 "$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",
297 "$uSee Also:$u cookie, delcookie"
298 );
299};
300
301"DELCOOKIE" {
302 "/services/nickserv/email_enabled" (
303 "/msg $N DELCOOKIE",
304 "Requests that $N cancel your authcookie or resetpass cookie.",
305 "(Since set-email cookies and registration cookies send email to unverified addresses, to prevent mail flooding, they cannot be cancelled.)",
306 "$uSee Also:$u authcookie, resetpass, cookie"
307 );
308};
309
310"COOKIE" {
311 "/services/nickserv/email_enabled" (
312 "/msg $N@$s COOKIE <account> <cookie>",
313 "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.",
314 "$uSee Also:$u authcookie, resetpass, set, delcookie"
315 );
316};
317
318"EMAIL POLICY" {
319 "/services/nickserv/email_enabled" (
320 "$bEMAIL POLICY",
d2dce5ac 321 "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.",
ceafd592 322 "(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.)"
d76ed9a9 323 );
324};
325
d76ed9a9 326"ADDMASK" ("/msg $N ADDMASK [user@host]",
327 "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.",
328 "$uSee Also:$u auth, delmask");
329"ALLOWAUTH" ("/msg $N ALLOWAUTH <nick> [account] [STAFF]",
330 "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.",
331 "If no account is given, it will cancel the allowauth for the user (assuming the user has an allowauth).",
332 "If the account is marked as a helper or oper, the STAFF qualifier must be given afterwards. This reduces social engineering attacks.",
333 "$uSee Also:$u addmask, auth");
d0cb2fb6 334
335"LOGIN" ("See /MSG $N HELP AUTH");
336
d76ed9a9 337"AUTH" {
338 "/services/nickserv/email_enabled" (
684c56b9 339 "/msg $N@$s AUTH <account> <password>",
d76ed9a9 340 "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.",
d76ed9a9 341 "$uSee Also:$u pass, resetpass, authcookie",
342 );
343 "!/services/nickserv/email_enabled" (
344 "/msg $N@$s AUTH [account] <password>",
345 "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.",
346 "If you omit the account, it uses your current nick as your account name.",
347 "$uSee Also:$u pass",
348 );
349};
350"DELMASK" ("/msg $N DELMASK <user@host>",
351 "Removes a hostmask from the account you are authenticated on.",
352 "An account must have at least one hostmask; you cannot remove the last mask for an account.",
353 "$uSee Also:$u addmask");
354"ACCOUNTINFO" {
355 "/services/nickserv/disable_nicks" (
356 "/msg $N ACCOUNTINFO <nick|*account>",
357 "Displays infomation on the specified account, including the date the account was registered, the last time it was used, its infoline, its flags, its hostmask(s), its channels, and nicknames of users currently using the account.",
358 "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).",
359 "$uSee Also:$u userinfo, account flags"
360 );
361 "! /services/nickserv/disable_nicks" (
362 "/msg $N ACCOUNTINFO <nick|*account>",
363 "Displays infomation on the specified account, including the date the account was registered, the last time it was used, its infoline, its flags, its hostmask(s), its channels, and nicknames of users currently using the account.",
364 "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 "$uSee Also:$u nickinfo, userinfo, account flags"
366 );
367};
368"ACCOUNT FLAGS" ("$bACCOUNT FLAGS$b",
369 "The following flags on accounts are defined:",
370 "$bS$b $O access suspended",
371 "$bp$b Use PRIVMSG for messages rather than NOTICE",
372 "$bh$b User is a support helper (must be in support channel to override security)",
373 "$bH$b User is a network helper (can toggle security override)",
374 "$bg$b God mode (security override for IRC staff)",
375 "$bs$b Account suspended",
376 "$bc$b Use mIRC color codes in responses",
377 "$bf$b Account frozen/on vacation (will not be unregistered for inactivity; cleared when account is authenticated against)",
378 "$bn$b No-delete (will never be unregistered for inactivity)",
90e75ffd 379 "$bb$b Hides you from the staff list",
380 "$uSee Also:$u accountinfo, set, $C staff");
d76ed9a9 381"OADDMASK" ("/msg $N OADDMASK <nick|*account> <user@host>",
382 "Adds a hostmask to the specified account.",
383 "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).",
384 "$uSee Also:$u odelmask");
385"ODELMASK" ("/msg $N ODELMASK <nick|*account> <user@host>",
386 "Removes a hostmask from the specified account.",
387 "An account must have at least one hostmask; you cannot remove the last mask for an account.",
388 "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).",
389 "$uSee Also:$u oaddmask");
390"OREGISTER" {
ac5cb8c5 391 "/services/nickserv/disable_nicks" {
23b7ec6e 392 "/services/nickserv/email_required" (
7293d1d3 393 "/msg $N@$s OREGISTER <account> <password> <email> [user@host] [nick]",
394 "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.",
395 "$uSee Also:$u ounregister, oaddmask, oset"
ac5cb8c5 396 );
23b7ec6e 397 "!/services/nickserv/email_required" (
7293d1d3 398 "/msg $N@$s OREGISTER <account> <password> [user@host] [nick]",
399 "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.",
400 "$uSee Also:$u ounregister, oaddmask, oset"
ac5cb8c5 401 );
402 };
403 "!/services/nickserv/disable_nicks" {
23b7ec6e 404 "/services/nickserv/email_required" (
7293d1d3 405 "/msg $N@$s OREGISTER <account> <password> <email> [user@host] [nick]",
406 "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.",
407 "$uSee Also:$u oregnick, ounregister, ounregnick, oaddmask, oset"
ac5cb8c5 408 );
23b7ec6e 409 "!/services/nickserv/email_required" (
7293d1d3 410 "/msg $N@$s OREGISTER <account> <password> [user@host] [nick]",
411 "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.",
412 "$uSee Also:$u oregnick, ounregister, ounregnick, oaddmask, oset"
ac5cb8c5 413 );
414 };
d76ed9a9 415};
4bffb7bd 416"OSET" (
417 "/msg $N OSET <nick|*account> [<setting> <value>]",
418 "Allows opers/helpers to change a users account settings. You may set:",
419 "$bPASSWORD$b: Sets user's password.",
420 "$bFLAGS$b: Changes account flags (SphHdscfn) for user (see $uaccount flags$u).",
421 "$bLEVEL$b: Sets $O access level.",
180e0971 422 "$bEPITHET$b: The description shown for the user's access in /whois.",
0f6fe38c 423 "$bNOTE$b: Adds a note to the user's account.",
bb869923 424 "$bTITLE$b: The title the user will get (in their hostname) when +x.",
4bffb7bd 425 "$bFAKEHOST$b: The fake hostname the user will get when +x.",
426 "..or anything $bset$b can change.",
427 "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).",
428 "$uSee Also:$u accountinfo, account flags, set, userinfo"
429);
34938510 430
431"ODELCOOKIE" {
432 "/services/nickserv/email_enabled" (
433 "/msg $N ODELCOOKIE <nick|*account>",
1136f709 434 "Requests that $N cancel the cookie of the specified account.",
34938510 435 );
436};
437
d76ed9a9 438"PASS" ("/msg $N@$s PASS <oldpass> <newpass>",
439 "Changes your $b$N$b password.",
440 "$uSee Also:$u auth");
441
442"REGISTER" {
443 "0: /services/nickserv/email_required" (
444 "/msg $N@$s REGISTER <account> <password> <email>",
0779bbcf 445 "$bDO NOT TYPE THE < and >!$b <> indicates required fields. ",
1478fd13 446 "Register is the command to create an an account with $b$N$b. ",
447 "Having an account provides a single login identity for the network, and for use with $b$C$b.",
448 "$b$b",
449 "$bEmail activation is required:$b An email will be sent to the email address you give to verify it. You must",
450 "provide a valid email address or registration will fail. After you register, check your email for instructions validating your account.",
451 "$b$b",
452 "If you already have an account, login using the $bAUTH$b command:",
453 "$b/msg $N@$s AUTH <accountname> <password>$b",
d76ed9a9 454 "$uSee Also:$u auth, unregister"
455 );
456 "1: /services/nickserv/email_enabled" (
457 "/msg $N@$s REGISTER <account> <password> [email]",
0779bbcf 458 "$bDO NOT TYPE THE < and >!$b <> indicates required fields. ",
9666b12d 459 "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.",
b5885247 460 "Having an account provides a single login identity for use with $b$C$b.",
9666b12d 461 "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.",
1478fd13 462 "$b$b",
463 "If you already have an account, login using the $bAUTH$b command:",
464 "$b/msg $N@$s AUTH <accountname> <password>$b",
465 "$uSee Also:$u auth, unregister"
d76ed9a9 466 );
467 "2: !/services/nickserv/email_enabled" (
468 "/msg $N@$s REGISTER <account> <password>",
9666b12d 469 "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.",
b5885247 470 "Having an account provides a single login identity for use with $b$C$b.",
d76ed9a9 471 "$uSee Also:$u auth, unregister"
472 );
473};
474"SET" {
475 "/services/nickserv/email_enabled && /services/nickserv/disable_nicks" (
476 "/msg $N SET [<setting> [value]]",
d2dce5ac 477 "Changes your $N account settings. Settings are:",
d76ed9a9 478 "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
479 "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
480 "$bEMAIL$b: Sets (or changes) your email address.",
481 "$bINFO$b: Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
482 "$bLANGUAGE$b: Your preferred language for private messages from the services.",
d9896a83 483 "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.",
d76ed9a9 484 "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
d76ed9a9 485 "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
ceafd592 486 "$bWIDTH$b: The width you want X3 to wrap text it sends you. (Use 0 for the default.)",
d76ed9a9 487 "$bMAXLOGINS$b: The number of users that can log into your account at once. (Use 0 for the default.)",
9666b12d 488 "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
489 "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
0b587959 490 "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.",
491 "$bADVANCED$b: If set advanced options and commands will be shown to you.",
d76ed9a9 492 "$bset$b with no arguments returns your current settings.",
493 "$uSee Also:$u accountinfo, userinfo"
494 );
495 "/services/nickserv/email_enabled && !/services/nickserv/disable_nicks" (
496 "/msg $N SET [<setting> [value]]",
ceafd592 497 "Changes your account settings for X3. Settings are:",
d76ed9a9 498 "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
499 "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
500 "$bEMAIL$b: Sets (or changes) your email address.",
501 "$bINFO$b: Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
502 "$bLANGUAGE$b: Your preferred language for private messages from the services.",
d9896a83 503 "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.",
d76ed9a9 504 "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
d76ed9a9 505 "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
ceafd592 506 "$bWIDTH$b: The width you want X3 to wrap text it sends you. (Use 0 for the default.)",
d76ed9a9 507 "$bMAXLOGINS$b: The number of users that can log into your account at once. (Use 0 for the default.)",
9666b12d 508 "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
509 "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
0b587959 510 "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.",
511 "$bADVANCED$b: If set advanced options and commands will be shown to you.",
d76ed9a9 512 "$bset$b with no arguments returns your current settings.",
513 "$uSee Also:$u accountinfo, nickinfo, userinfo"
514 );
515 "!/services/nickserv/email_enabled && /services/nickserv/disable_nicks" (
516 "/msg $N SET [<setting> [value]]",
ceafd592 517 "Changes your account settings for X3. Settings are:",
d76ed9a9 518 "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
519 "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
520 "$bINFO$b: Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
521 "$bLANGUAGE$b: Your preferred language for private messages from the services.",
d9896a83 522 "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.",
d76ed9a9 523 "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
d76ed9a9 524 "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
ceafd592 525 "$bWIDTH$b: The width you want X3 to wrap text it sends you. (Use 0 for the default.)",
d76ed9a9 526 "$bMAXLOGINS$b: The number of users that can log into your account at once. (Use 0 for the default.)",
9666b12d 527 "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
528 "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
0b587959 529 "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.",
530 "$bADVANCED$b: If set advanced options and commands will be shown to you.",
d76ed9a9 531 "$bset$b with no arguments returns your current settings.",
532 "$uSee Also:$u accountinfo, userinfo"
533 );
534 "!/services/nickserv/email_enabled && !/services/nickserv/disable_nicks" (
535 "/msg $N SET [<setting> [value]]",
ceafd592 536 "Changes your account settings for X3. Settings are:",
d76ed9a9 537 "$bANNOUNCEMENTS$b: Indicates whether you wish to receive community announcements via the $G service.",
538 "$bCOLOR$b: If set, $b$N$b and $b$C$b will use $bbold$b and $uunderlines$u in text they send you.",
539 "$bINFO$b: Your infoline for $b$N$b (which can be viewed with the $baccountinfo$b command).",
540 "$bLANGUAGE$b: Your preferred language for private messages from the services.",
d9896a83 541 "$bSTYLE$b: Your preferred output style: normal, clean, classic, or advanced.",
d76ed9a9 542 "$bPRIVMSG$b: If set, $b$N$b and $b$C$b will send text to you using PRIVMSGs rather than NOTICEs.",
d76ed9a9 543 "$bTABLEWIDTH$b: Sets the width for wrapping table-formatted text. (Use 0 for the default.)",
ceafd592 544 "$bWIDTH$b: The width you want X3 to wrap text it sends you. (Use 0 for the default.)",
d76ed9a9 545 "$bMAXLOGINS$b: The number of users that can log into your account at once. (Use 0 for the default.)",
9666b12d 546 "$bTITLE$b: A title set on your account by network staff (affects hidden hosts).",
547 "$bEPITHET$b: An epithet set on your account by network staff (shows in whois).",
0b587959 548 "$bAUTOHIDE$b: Automatically sets +x (hides your host) when you login.",
549 "$bADVANCED$b: If set advanced options and commands will be shown to you.",
d76ed9a9 550 "$bset$b with no arguments returns your current settings.",
551 "$uSee Also:$u accountinfo, nickinfo, userinfo"
552 );
553};
7f9e40bf 554"SET LANGUAGE" ("/msg $N SET LANGUAGE <langname>",
d76ed9a9 555 "Sets the language that $S and other services will use when sending you messages.",
556 "If a particular message is not available in your language, it will use the closest match it has.",
557 "Supported languages are: ${modcmd:languages}",
558 "$uSee Also:$u set");
7f9e40bf 559"SET STYLE" ("/msg $N SET STYLE <style>",
338a82b5 560 "Sets the output style that $S and other services will use when sending you messages.",
561 "The style can be:.",
562 " Normal - userlist has ----- seprators and does not show numeric levels.",
563 " Clean - userlist has no ------ seperators and does not show numeric levels.",
d9896a83 564 " Classic - userlist has ----- seperators and also shows ONLY numeric levels.(SrvX Style)",
338a82b5 565 " Advanced - userlist has ----- seperators and also shows numeric levels.",
566 "$b $b",
567 "Many other outputs besides userlist are styled to match as well.",
568 "$uSee Also:$u set");
d76ed9a9 569"STATUS" {
570 "/services/nickserv/disable_nicks" (
571 "/msg $N STATUS",
572 "Displays information about the status of $b$N$b, including the total number of accounts in its database."
573 );
574 "!/services/nickserv/disable_nicks" (
575 "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)."
576 );
577};
578"USERINFO" ("/msg $N USERINFO <nick>",
579 "Shows what account the nick specified is authenticated to.",
d2dce5ac 580 "$uSee Also:$u auth, accountinfo, account flags");
581
d76ed9a9 582"GHOST" ("/msg $N GHOST <nick>",
583 "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.",
584 "$uSee Also:$u auth");
d2dce5ac 585
d76ed9a9 586"RENAME" ("/msg $N RENAME <nick|*old-account> <new-account>",
587 "Renames an account.",
588 "This command is only accessible to helpers and IRC operators.",
589 "$uSee Also:$u merge");
d2dce5ac 590
d76ed9a9 591"VACATION" ("/msg $N VACATION",
592 "Marks your account as \"on vacation\" until the next time you authenticate to $N.",
593 "While you are \"on vacation\", your account will not be deleted for inactivity.");
d2dce5ac 594
d76ed9a9 595"SEARCH" ("/msg $N SEARCH <action> <criteria> <value> [<criteria> <value>]...",
596 "Searches for accounts matching the critera, and then does something to them.",
597 "$uSee Also:$u search action, search criteria");
d2dce5ac 598
d76ed9a9 599"SEARCH ACTION" ("$bSEARCH ACTION$b",
600 "The following actions are valid:",
601 " PRINT - Print matching accounts",
602 " COUNT - Count matching accounts",
603 " UNREGISTER - Unregister matching accounts",
604 "$uSee Also:$u search, search criteria");
605"SEARCH CRITERIA" {
606 "/services/nickserv/disable_nicks" (
607 "$bSEARCH CRITERIA$b",
608 "The following account search criteria are valid. Each takes an additional argument, giving the actual criteria:",
609 " LIMIT - Limits the number of matches",
610 " FLAGS - Bits that must be turned on (e.g. +h) and/or off (e.g. -S) in an account",
611 " REGISTERED - Registered time constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
612 " SEEN - Accounts not seen for at least this long",
613 " ACCOUNTMASK - A glob that must match the account name",
614 " EMAIL - A glob that must match the account's email address",
615 " HOSTMASK SUPERSET - Account matches if someone with this hostmask can auth to the account",
616 " HOSTMASK EXACT - Account matches if this exact hostmask is in list",
617 " HOSTMASK SUBSET - Account matches if this mask \"covers\" one in their userlist",
618 " HOSTMASK LASTQUIT - Account matches if this mask \"covers\" user was last seen using",
619 " HOSTMASK - A glob that must match a hostmask for the account (equivalent to HOSTMASK SUPERSET)",
620 " ACCESS - An $O access constraint (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
621 "$uSee Also:$u search, search action"
622 );
623 "!/services/nickserv/disable_nicks" (
624 "$bSEARCH CRITERIA$b",
625 "The following account search criteria are valid. Each takes an additional argument, giving the actual criteria:",
626 " LIMIT - Limits the number of matches",
627 " FLAGS - Bits that must be turned on (e.g. +h) and/or off (e.g. -S) in an account",
628 " REGISTERED - Registered time constraint (<Nu, <=Nu, =Nu, >=Nu or >Nu)",
629 " SEEN - Accounts not seen for at least this long",
630 " ACCOUNTMASK - A glob that must match the account name",
631 " EMAIL - A glob that must match the account's email address",
632 " NICKMASK - A glob that must match a nick registered to the account",
633 " HOSTMASK SUPERSET - Account matches if someone with this hostmask can auth to the account",
634 " HOSTMASK EXACT - Account matches if this exact hostmask is in list",
635 " HOSTMASK SUBSET - Account matches if this mask \"covers\" one in their userlist",
636 " HOSTMASK LASTQUIT - Account matches if this mask \"covers\" user was last seen using",
637 " HOSTMASK - A glob that must match a hostmask for the account (equivalent to HOSTMASK SUPERSET)",
638 " ACCESS - An $O access constraint (<nnn, <=nnn, =nnn, >=nnn or >nnn)",
639 "$uSee Also:$u search, search action"
640 );
641};
642"MERGE" {
643 "!/services/nickserv/disable_nicks" (
644 "/msg $N MERGE <from-nick|*from-account> <to-nick|*to-account>",
645 "Merge access from $bfrom-account$b into $bto-account$b. This includes hostmasks, registered nicks, authed users, access in channels, and $O 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.",
646 "This command is only accessible to helpers and IRC operators.",
647 "$uSee Also:$u rename"
648 );
649 "/services/nickserv/disable_nicks" ("/msg $N MERGE <from-nick|*from-account> <to-nick|*to-account>",
650 "Merge access from $bfrom-account$b into $bto-account$b. This includes hostmasks, authed users, access in channels, and $O 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.",
651 "This command is only accessible to helpers and IRC operators.",
652 "$uSee Also:$u rename"
653 );
654};
5177fd21 655
d76ed9a9 656"MERGEDB" ("/msg $N MERGEDB <dbfilename>",
657 "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.",
658 "This command is only accessible to IRC operators.",
d2dce5ac 659 "$uSee Also:$u OperServ.write");
5177fd21 660
661"IGNORE" ("Ignore list management commands are:",
662 " $bADDIGNORE$b Adds a hostmask to your ignore list.",
663 " $bDELIGNORE$b Remove an entry from your ignore list.",
664 " $bACCOUNTINFO$b Displays information about an account including ignores.",
665 );
666
667"ADDIGNORE" ("/msg $N ADDIGNORE [user@host]",
668 "Adds the specified user@host to the account ignore list that you are authenticated to with $b$N$b.",
669 "$uSee Also:$u delignore");
670
671"DELIGNORE" ("/msg $N DELIGNORE <user@host>",
672 "Removes a hostmask from the account ignore list that you are authenticated on.",
673 "$uSee Also:$u addignore");
674
675"OADDIGNORE" ("/msg $N OADDIGNORE <nick|*account> <user@host>",
676 "Adds a hostmask to the specified account's ignore list.",
677 "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).",
678 "$uSee Also:$u odelignore");
679
680"ODELIGNORE" ("/msg $N ODELIGNORE <nick|*account> <user@host>",
681 "Removes a hostmask from the specified account's ignore list.",
682 "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).",
683 "$uSee Also:$u oaddignore");
2fa83595 684
685"ADDSSLFP" ("/msg $N ADDSSLFP [fingerprint]",
686 "Adds the specified SSL fingerprint to the account you are authenticated to with $b$N$b. If no SSL fingerprint is given, it uses your current SSL fingerprint if available.",
687 "$uSee Also:$u auth, delsslfp");
688
689"DELSSLFP" ("/msg $N DELSSLFP [fingerprint]",
690 "Removes the specified SSL fingerprint to the account you are authenticated to with $b$N$b. If no SSL fingerprint is given, it uses your current SSL fingerprint if available.",
691 "$uSee Also:$u addsslfp");
692
693"OADDSSLFP" ("/msg $N OADDSSLFP <nick|*account> <fingerprint>",
694 "Adds an SSL fingerprint to the specified account.",
695 "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).",
696 "$uSee Also:$u odelsslfp");
697
698"ODELSSLFP" ("/msg $N ODELSSLFP <nick|*account> <fingerprint>",
699 "Removes an SSL fingerprint from the specified account.",
700 "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).",
701 "$uSee Also:$u oaddsslfp");
702