Variable: erc-buffer-display

erc-buffer-display is a customizable variable defined in erc.el.gz.

Value

bury

Documentation

How to display a newly created ERC buffer.

This determines ERC's baseline, "catch-all" buffer-display behavior. It takes a backseat to more specific options, like erc-interactive-display, erc-auto-reconnect-display, and erc-receive-query-display.

The available choices are:

  window - in another window,
  window-noselect - in another window, but don't select that one,
  frame - in another frame,
  bury - bury it in a new buffer,
  buffer - in place of the current buffer,
  DISPLAY-FUNCTION - a display-buffer-like function

Here, DISPLAY-FUNCTION should accept a buffer and an ACTION of the kind described by the Info node (elisp) Choosing Window. At times, ERC may add hints about the calling context to the ACTION's alist. Keys are symbols such as user options, like erc-buffer-display, or module minor modes, like erc-autojoin-mode(var)/erc-autojoin-mode(fun). Values are non-nil constants specific to each. For this particular option, possible values include the symbols

  JOIN, PRIVMSG, NOTICE, erc, and erc-tls.

The first three signify IRC commands received from the server and the rest entry-point commands responsible for the connection. When dealing with the latter two, users may prefer to set this option to bury and instead call DISPLAY-FUNCTION directly on (server) buffers returned by these entry points because the context leading to their creation is plainly obvious. For additional details, see the Info node (erc) display-buffer.

Note that when the selected window already shows the current buffer, ERC pretends this option's value is bury unless the variable erc-skip-displaying-selected-window-buffer is nil or the value of this option is DISPLAY-FUNCTION.

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

Aliases

erc-join-buffer

Source Code

;; Defined in /usr/src/emacs/lisp/erc/erc.el.gz
(defcustom erc-buffer-display 'bury
  "How to display a newly created ERC buffer.
This determines ERC's baseline, \"catch-all\" buffer-display
behavior.  It takes a backseat to more specific options, like
`erc-interactive-display', `erc-auto-reconnect-display', and
`erc-receive-query-display'.

The available choices are:

  `window'          - in another window,
  `window-noselect' - in another window, but don't select that one,
  `frame'           - in another frame,
  `bury'            - bury it in a new buffer,
  `buffer'          - in place of the current buffer,
  DISPLAY-FUNCTION  - a `display-buffer'-like function

Here, DISPLAY-FUNCTION should accept a buffer and an ACTION of
the kind described by the Info node `(elisp) Choosing Window'.
At times, ERC may add hints about the calling context to the
ACTION's alist.  Keys are symbols such as user options, like
`erc-buffer-display', or module minor modes, like
`erc-autojoin-mode'.  Values are non-nil constants specific to
each.  For this particular option, possible values include the
symbols

  `JOIN', `PRIVMSG', `NOTICE', `erc', and `erc-tls'.

The first three signify IRC commands received from the server and
the rest entry-point commands responsible for the connection.
When dealing with the latter two, users may prefer to set this
option to `bury' and instead call DISPLAY-FUNCTION directly
on (server) buffers returned by these entry points because the
context leading to their creation is plainly obvious.  For
additional details, see the Info node `(erc) display-buffer'.

Note that when the selected window already shows the current
buffer, ERC pretends this option's value is `bury' unless the
variable `erc-skip-displaying-selected-window-buffer' is nil or
the value of this option is DISPLAY-FUNCTION."
  :package-version '(ERC . "5.5")
  :group 'erc-buffers
  :type (cons 'choice (nthcdr 2 erc--buffer-display-choices)))