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