To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Keepnick: Difference between revisions

From ZNC
Jump to navigation Jump to search
>Paccer
Andrio (talk | contribs)
Be more clear about when the module will change states.
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:keepnick}}
{{DISPLAYTITLE:keepnick}}
{{Core Module | version = 0.060}}
{{Core Module | version = 0.060}}
This module tries to get you your primary nick.
This module tries to get your primary nick, as specified in the ZNC config. Especially useful on IRC networks that do not have services like NickServ to reserve your name and prevent others from taking it.


== Usage ==
== Usage ==
Line 9: Line 9:


=== Commands ===
=== Commands ===
This module should work on itself.
This module should work without user interaction; when you can't get your primary nick, it should try to get it for you. However, you can manually change states if necessary.
However, you can enable and disable this module explicitly.


After you do
The module has two states:
/msg *keepnick enable
* The enabled state: the module is trying to acquire your primary nick. The module will enter this state if you connect to IRC and someone already has your nick. Your nick will be changed to your primary nick after it becomes available, and the module will enter the disabled state.
This module will regularly try to acquire your primary nick.
* The disabled state: the module is not trying to acquire your primary nick. The module will enter this state if you change to your primary nick, if you intentionally change your nick from your primary nick to something else (so you can change your nick and not be forced back to your primary nick), or if you are prevented from changing nick by a channel mode or ban.


This command stops this:
; <code>/msg *keepnick enable</code>
/msg *keepnick disable
: Manually enters the enabled state


The last command tells you if the module is currently trying to change your nick to your primary nick:
; <code>/msg *keepnick disable</code>
/msg *keepnick state
: Manually enters the disabled state
 
; <code>/msg *keepnick state</code>
: Tells you what state the module is in; whether the module is currently trying to change your nick or not.
 
; <code>Help <?search></code>
: Shows this help, optionally search for word/phrase in help output.

Latest revision as of 02:10, 27 December 2018

This module tries to get your primary nick, as specified in the ZNC config. Especially useful on IRC networks that do not have services like NickServ to reserve your name and prevent others from taking it.

Usage

Arguments

This network module takes no arguments.

Read loading modules to learn more about loading modules.

Commands

This module should work without user interaction; when you can't get your primary nick, it should try to get it for you. However, you can manually change states if necessary.

The module has two states:

  • The enabled state: the module is trying to acquire your primary nick. The module will enter this state if you connect to IRC and someone already has your nick. Your nick will be changed to your primary nick after it becomes available, and the module will enter the disabled state.
  • The disabled state: the module is not trying to acquire your primary nick. The module will enter this state if you change to your primary nick, if you intentionally change your nick from your primary nick to something else (so you can change your nick and not be forced back to your primary nick), or if you are prevented from changing nick by a channel mode or ban.
/msg *keepnick enable
Manually enters the enabled state
/msg *keepnick disable
Manually enters the disabled state
/msg *keepnick state
Tells you what state the module is in; whether the module is currently trying to change your nick or not.
Help <?search>
Shows this help, optionally search for word/phrase in help output.