Function: erc

erc is an autoloaded, interactive and byte-compiled function defined in erc.el.gz.

Signature

(erc &key SERVER PORT NICK USER PASSWORD FULL-NAME ID)

Documentation

Connect to an Internet Relay Chat SERVER on a non-TLS PORT.

Use NICK and USER, when non-nil, to inform the IRC commands of the same name, possibly factoring in a non-nil FULL-NAME as well. When PASSWORD is non-nil, also send an opening server password via the "PASS" command. Interactively, prompt for SERVER, PORT, NICK, and PASSWORD, along with USER and FULL-NAME when given a prefix argument. Non-interactively, expect the rarely needed ID parameter, when non-nil, to be a symbol or a string for naming the server buffer and identifying the connection unequivocally. Once connected, return the server buffer. (See Info node (erc) Connecting for details about all mentioned parameters.)

Together with erc-tls, this command serves as the main entry point for ERC, the powerful, modular, and extensible IRC client. Non-interactively, both commands accept the following keyword arguments, with their defaults supplied by the indicated
"compute" functions:

  :server erc-compute-server
  :port erc-compute-port
  :nick erc-compute-nick
  :user erc-compute-user
  :password N/A
  :full-name erc-compute-full-name
  :id' N/A

For example, when called in the following manner

   (erc :server "irc.libera.chat" :full-name "J. Random Hacker")

ERC assigns SERVER and FULL-NAME the associated keyword values and defers to erc-compute-port, erc-compute-user, and erc-compute-nick for those respective parameters.

Probably introduced at or before Emacs version 22.1.

Key Bindings

Aliases

erc-select

Source Code

;; Defined in /usr/src/emacs/lisp/erc/erc.el.gz
;;;###autoload
(cl-defun erc (&key (server (erc-compute-server))
                    (port   (erc-compute-port))
                    (nick   (erc-compute-nick))
                    (user   (erc-compute-user))
                    password
                    (full-name (erc-compute-full-name))
                    id
                    ;; Used by interactive form
                    ((--interactive-env-- --interactive-env--)))
  "Connect to an Internet Relay Chat SERVER on a non-TLS PORT.
Use NICK and USER, when non-nil, to inform the IRC commands of
the same name, possibly factoring in a non-nil FULL-NAME as well.
When PASSWORD is non-nil, also send an opening server password
via the \"PASS\" command.  Interactively, prompt for SERVER,
PORT, NICK, and PASSWORD, along with USER and FULL-NAME when
given a prefix argument.  Non-interactively, expect the rarely
needed ID parameter, when non-nil, to be a symbol or a string for
naming the server buffer and identifying the connection
unequivocally.  Once connected, return the server buffer.  (See
Info node `(erc) Connecting' for details about all mentioned
parameters.)

Together with `erc-tls', this command serves as the main entry
point for ERC, the powerful, modular, and extensible IRC client.
Non-interactively, both commands accept the following keyword
arguments, with their defaults supplied by the indicated
\"compute\" functions:

  :server    `erc-compute-server'
  :port      `erc-compute-port'
  :nick      `erc-compute-nick'
  :user      `erc-compute-user'
  :password   N/A
  :full-name `erc-compute-full-name'
  :id'        N/A

For example, when called in the following manner

   (erc :server \"irc.libera.chat\" :full-name \"J. Random Hacker\")

ERC assigns SERVER and FULL-NAME the associated keyword values
and defers to `erc-compute-port', `erc-compute-user', and
`erc-compute-nick' for those respective parameters.

\(fn &key SERVER PORT NICK USER PASSWORD FULL-NAME ID)"
  (interactive (let ((erc--display-context `((erc-interactive-display . erc)
                                             ,@erc--display-context)))
                 (erc-select-read-args)))
  (unless (assq 'erc--display-context --interactive-env--)
    (push '(erc--display-context . ((erc-buffer-display . erc)))
          --interactive-env--))
  (erc--with-entrypoint-environment --interactive-env--
    (erc-open server port nick full-name t password nil nil nil nil user id)))