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