Difference between revisions of "Module:NickServ"
(Initial Page) |
(Add documentation for the nickserv module) |
||
Line 1: | Line 1: | ||
− | + | This module is used to identify you to NickServ automatically when you reconnect to IRC | |
− | [[Category:Modules]] | + | = Usage = |
+ | |||
+ | == Arguments == | ||
+ | This module takes 1 argument | ||
+ | |||
+ | {| class="wikitable" | ||
+ | ! style="font-weight:bold;" | Argument | ||
+ | ! style="font-weight:bold;" | Type | ||
+ | ! style="font-weight:bold;" | Description | ||
+ | |- | ||
+ | | Password* | ||
+ | | Optional | ||
+ | | The password you use to identify to NickServ | ||
+ | |} | ||
+ | |||
+ | '''''Note:''''' ''After the NickServ module is loaded, the password is removed from the module arguments (shown in webpanel) for security reasons but the password is still saved'' | ||
+ | |||
+ | == Commands == | ||
+ | |||
+ | To set your NickServ password so that the module can identify to NickServ, use the following command: | ||
+ | /msg *nickserv set <your nickserv password> | ||
+ | |||
+ | To delete the saved NickServ password, use the following command: | ||
+ | /msg *nickserv clear | ||
+ | |||
+ | The 'SetCommand' allows you to change the pattern used to generate the string passed to the NickServ service on the IRC Network. Normally the default setting works for most networks however if the network for some reason does not conform to the standard NickServ format or has a different NickServ name, the following command can be used to change it: | ||
+ | |||
+ | /msg *nickserv setcommand <command name> <new command pattern> | ||
+ | |||
+ | An example of how this can be used to change the command format to work with the DALNet IRC network is as follows: | ||
+ | /msg *nickserv setcommand IDENTIFY PRIVMSG nickserv@services.dal.net :IDENTIFY {password} | ||
+ | |||
+ | '''''Note:''''' ''Using {password} in the command line will replace '{password}' with the NickServ password you have set in this module.'' | ||
+ | |||
+ | == Further Information == | ||
+ | |||
+ | More information on the format of the NickServ IDENTIFY command for Anope and Atheme IRC services used on a majority of networks can be found below: | ||
+ | * [https://wiki.anope.org/index.php/NickServ#Identify NickServ Identify on Anope IRC Services] | ||
+ | * [https://github.com/atheme/atheme/wiki/NickServ%3AIDENTIFY NickServ Identify on Atheme Services] | ||
+ | |||
+ | [[Category:Modules]] [[Category:Network_Modules]] |
Latest revision as of 19:06, 27 December 2020
This module is used to identify you to NickServ automatically when you reconnect to IRC
Usage
Arguments
This module takes 1 argument
Argument | Type | Description |
---|---|---|
Password* | Optional | The password you use to identify to NickServ |
Note: After the NickServ module is loaded, the password is removed from the module arguments (shown in webpanel) for security reasons but the password is still saved
Commands
To set your NickServ password so that the module can identify to NickServ, use the following command:
/msg *nickserv set <your nickserv password>
To delete the saved NickServ password, use the following command:
/msg *nickserv clear
The 'SetCommand' allows you to change the pattern used to generate the string passed to the NickServ service on the IRC Network. Normally the default setting works for most networks however if the network for some reason does not conform to the standard NickServ format or has a different NickServ name, the following command can be used to change it:
/msg *nickserv setcommand <command name> <new command pattern>
An example of how this can be used to change the command format to work with the DALNet IRC network is as follows:
/msg *nickserv setcommand IDENTIFY PRIVMSG nickserv@services.dal.net :IDENTIFY {password}
Note: Using {password} in the command line will replace '{password}' with the NickServ password you have set in this module.
Further Information
More information on the format of the NickServ IDENTIFY command for Anope and Atheme IRC services used on a majority of networks can be found below: