Variable: erc-services-regain-alist

erc-services-regain-alist is a customizable variable defined in erc-services.el.gz.

Value

nil

Documentation

Alist mapping networks to nickname-regaining functions.

This option depends on the services-regain module being loaded. Keys can also be symbols for user-provided "context IDs" (see Info node (emacs)Network Identifier). Functions run once, when first establishing a logical IRC connection. Although ERC currently calls them with one argument, the desired but rejected nickname, robust user implementations should leave room for later additions by defining an &rest _ parameter, as well.

The simplest value is erc-services-retry-nick-on-connect, which attempts to kill off stale connections without engaging services at all. Others, like erc-services-issue-regain, and erc-services-issue-ghost-and-retry-nick, only speak a particular flavor of NickServ. See their respective doc strings for details and use cases.

This variable was added, or its default value changed, in ERC version
5.6.

Source Code

;; Defined in /usr/src/emacs/lisp/erc/erc-services.el.gz
;;;; Regaining nicknames

(defcustom erc-services-regain-alist nil
  "Alist mapping networks to nickname-regaining functions.
This option depends on the `services-regain' module being loaded.
Keys can also be symbols for user-provided \"context IDs\" (see
Info node `Network Identifier').  Functions run once, when first
establishing a logical IRC connection.  Although ERC currently
calls them with one argument, the desired but rejected nickname,
robust user implementations should leave room for later additions
by defining an &rest _ parameter, as well.

The simplest value is `erc-services-retry-nick-on-connect', which
attempts to kill off stale connections without engaging services
at all.  Others, like `erc-services-issue-regain', and
`erc-services-issue-ghost-and-retry-nick', only speak a
particular flavor of NickServ.  See their respective doc strings
for details and use cases."
  :package-version '(ERC . "5.6")
  :group 'erc-hooks
  :type '(alist :key-type (symbol :tag "Network")
                :value-type
                (choice :tag "Strategy function"
                        (function-item erc-services-retry-nick-on-connect)
                        (function-item erc-services-issue-regain)
                        (function-item erc-services-issue-ghost-and-retry-nick)
                        function)))