NickServ

From freenode wiki
Jump to: navigation, search

NickServ allows you to register a nickname and prevent others from using it. The following commands allow for registration and maintenance of nicknames; to use them, type /msg NickServ command. For more information on a specific command, type /msg NickServ HELP command.

ACCESS

Modifies or displays the access list for your nick. This is the list of addresses which will be automatically recognized by NickServ as allowed to use the nick. If you want to use the nick from a different address, you need to send an IDENTIFY command to make NickServ recognize you. Services Operators may provide a nick to modify other users' access lists.

Syntax:

ACCESS ADD [nickname] mask
ACCESS DEL [nickname] mask
ACCESS LIST [nickname]


Examples:

ACCESS ADD anyone@*.bepeg.com

Allows access to the user, anyone, from any machine in the bepeg.com domain.

ACCESS DEL anyone@*.bepeg.com

Reverses the previous command.

ACCESS LIST

Displays the current access list.


AJOIN

Syntax:

AJOIN ADD [nickname] channel [key]
AJOIN DEL [nickname] channel
AJOIN LIST [nickname]

This command manages your auto-join list. When you identify you will automatically join the channels on your auto-join list. Services Operators may provide a nick to modify other users' auto-join lists.


ALIST

Syntax:

ALIST [nickname]

Lists all channels you have access to.

Channels that have the NOEXPIRE option set will be prefixed with an exclamation mark. The nickname parameter is limited to Services Operators


CERT

Syntax:

CERT ADD [nickname] [fingerprint]
CERT DEL [nickname] [fingerprint]
CERT LIST [nickname]

Modifies or displays the certificate list for your nick. If you connect to IRC and provide a client certificate with a matching fingerprint in the cert list, you will be automatically identified to services. Services Operators may provide a nick to modify other users' certificate lists.


Examples:

CERT ADD

Adds your current fingerprint to the certificate list and automatically identify you when you connect to IRC using this fingerprint.

CERT DEL <fingerprint>

Removes the fingerprint <fingerprint> from your certificate list.

CERT LIST

Displays the current certificate list.


CONFIRM

Syntax:

CONFIRM passcode

This command is used by several commands as a way to confirm changes made to your account.

This is most commonly used to confirm your email address once you register or change it.

This is also used after the RESETPASS command has been used to force identify you to your nick so you may change your password. Additionally, Services Operators with the nickserv/confirm permission can replace passcode with a users nick to force validate them.


DROP

Syntax:

DROP nickname

Drops the given nick from the database. Once your nickname is dropped you may lose all of your access and channels that you may own. Any other user will be able to gain control of this nick. As a Services Operator, you may drop any nick.


GLIST

Syntax:

GLIST [nickname]

Without a parameter, lists all nicknames that are in your group.

With a parameter, lists all nicknames that are in the group of the given nick. Specifying a nick is limited to Services Operators.


GROUP

Syntax:

GROUP [target] [password]

This command makes your nickname join the target nickname's group. The password is the password of the target nickname.

Joining a group will allow you to share your configuration, memos, and channel privileges with all the nicknames in the group, and much more!

A group exists as long as it is useful. This means that even if a nick of the group is dropped, you won't lose the shared things described above, as long as there is at least one nick remaining in the group.

You may be able to use this command even if you have not registered your nick yet. If your nick is already registered, you'll need to identify yourself before using this command.

It is recommended to use this command with a non-registered nick because it will be registered automatically when using this command. You may use it with a registered nick (to change your group) only if your network administrators allowed it.

You can only be in one group at a time. Group merging is not possible.

Note: all the nicknames of a group have the same password.


IDENTIFY

Syntax:

IDENTIFY [account] password

Tells NickServ that you are really the owner of this nick. Many commands require you to authenticate yourself with this command before you use them. The password should be the same one you sent with the REGISTER command.


INFO

Syntax:

INFO [nickname]

Displays information about the given nickname, such as the nick's owner, last seen address and time, and nick options. If no nick is given, and you are identified, your account name is used, else your current nickname is used.


LIST

Syntax:

LIST pattern [SUSPENDED] [NOEXPIRE] [UNCONFIRMED]

Lists all registered nicknames which match the given pattern, in nick!user@host format. Nicks with the PRIVATE option set will only be displayed to Services Operators with the proper access. Nicks with the NOEXPIRE option set will have a ! prefixed to the nickname for Services Operators to see.

Note that a preceding '#' specifies a range.

If the SUSPENDED, UNCONFIRMED, or NOEXPIRE options are given, only nicks which, respectively, are SUSPENDED, UNCONFIRMED, or have the NOEXPIRE flag set will be displayed. If multiple options are given, all nicks matching at least one option will be displayed. Note that these options are limited to Services Operators.


Examples:

LIST *!joeuser@foo.com

Lists all registered nicks owned by joeuser@foo.com.

LIST *Bot*!*@*

Lists all registered nicks with Bot in their names (case insensitive).

LIST * NOEXPIRE

Lists all registered nicks that have been set to not expire.

LIST #51-100

Lists all registered nicks within the given range (51-100).

Regex matches are also supported using the regex/pcre engine. Enclose your pattern in // if this is desired.


LOGOUT

Syntax:

LOGOUT [nickname] [REVALIDATE]

Without a parameter, reverses the effect of the IDENTIFY command, i.e. makes you not recognized as the real owner of the nick anymore. Note, however, that you won't be asked to reidentify yourself.

With a parameter, does the same for the given nick. If you specify REVALIDATE as well, Services will ask the given nick to re-identify. This is limited to Services Operators.


RECOVER

Syntax:

RECOVER nickname [password]

Recovers your nick from another user or from services. If services are currently holding your nick, the hold will be released. If another user is holding your nick and is identified they will be killed (similar to the old GHOST command). If they are not identified they will be forced off of the nick.


REGISTER

Syntax:

REGISTER password email

Registers your nickname in the NickServ database. Once your nick is registered, you can use the SET and ACCESS commands to configure your nick's settings as you like them. Make sure you remember the password you use when registering - you'll need it to make changes to your nick later. (Note that case matters! ANOPE, Anope, and anope are all different passwords!)

Guidelines on choosing passwords:

Passwords should not be easily guessable. For example, using your real name as a password is a bad idea. Using your nickname as a password is a much worse idea ;) and, in fact, NickServ will not allow it. Also, short passwords are vulnerable to trial-and-error searches, so you should choose a password at least 5 characters long. Finally, the space character cannot be used in passwords.

This command also creates a new group for your nickname, that will allow you to register other nicks later sharing the same configuration, the same set of memos and the same channel privileges.


RESEND

Syntax:

RESEND

This command will resend you the registration confirmation email.


RESETPASS

Syntax:

RESETPASS nickname email

Sends a passcode to the nickname with instructions on how to reset their password. Email must be the email address associated to the nickname.

SET

Syntax:

SET option parameters

Sets various nickname options. option can be one of:

  • SET AUTOOP Sets whether services should set channel status modes on you automatically.
  • SET DISPLAY Set the display of your group in Services
  • SET EMAIL Associate an E-mail address with your nickname
  • SET GREET Associate a greet message with your nickname
  • SET HIDE Hide certain pieces of nickname information
  • SET KEEPMODES Enable or disable keep modes
  • SET KILL Turn protection on or off
  • SET LANGUAGE Set the language Services will use when messaging you
  • SET PASSWORD Set your nickname password
  • SET PRIVATE Prevent the nickname from appearing in the LIST command
  • SET SECURE Turn nickname security on or off
  • SET URL Associate a URL with your account

Type /msg NickServ HELP SET option for more information on a specific option.


STATUS

Syntax:

STATUS [nickname]

Returns whether the user using the given nickname is recognized as the owner of the nickname. The response has this format:

nickname status-code account

where nickname is the nickname sent with the command, status-code is one of the following, and account is the account they are logged in as.

  • 0 - no such user online or nickname not registered
  • 1 - user not recognized as nickname's owner
  • 2 - user recognized as owner via access list only
  • 3 - user recognized as owner via password identification

If no nickname is given, your status will be returned.

UNGROUP

Syntax:

UNGROUP [nick]


This command ungroups your nick, or if given, the specificed nick, from the group it is in. The ungrouped nick keeps its registration time, password, email, greet, language, and url. Everything else is reset. You may not ungroup yourself if there is only one nick in your group.

UPDATE

Syntax:

UPDATE

Updates your current status, i.e. it checks for new memos, sets needed channel modes and updates your vhost and your userflags (lastseentime, etc).