File: erc.el.html
ERC is a powerful, modular, and extensible IRC client for Emacs.
For more information, visit the ERC page at
<https://www.gnu.org/software/emacs/erc.html>.
Configuration:
Use M-x customize-group RET erc RET to get an overview of all the variables you can tweak.
Usage:
To connect to an IRC server, do
M-x erc RET
or
M-x erc-tls RET
to connect over TLS (encrypted). Once you are connected to a server, you can use C-h m or have a look at the ERC menu.
Defined variables (149)
erc-accidental-paste-threshold-seconds | Minimum time, in seconds, before sending new lines via IRC. |
erc-action-history-list | History list for interactive action input. |
erc-active-buffer | The current active buffer, the one where the user typed the last command. |
erc-after-connect | Functions called after connecting to a server. |
erc-anonymous-login | Be paranoid, don’t give away your machine name. |
erc-auto-query | If non-nil, create a query buffer each time you receive a private message. |
erc-away | Non-nil indicates that we are away. |
erc-away-nickname | The nickname to take when you are marked as being away. |
erc-bad-nick | Non-nil indicates that we got a ‘nick in use’ error while connecting. |
erc-before-connect | Functions called before connecting to a server. |
erc-channel-banlist | A list of bans seen for the current channel. |
erc-channel-hide-list | A list of IRC channels to hide message types from. |
erc-channel-key | Key needed to join channel. |
erc-channel-list | Server channel list. |
erc-channel-members-changed-hook | This hook is called every time the variable ‘channel-members’ changes. |
erc-channel-modes | List of strings representing channel modes. |
erc-channel-new-member-names | If non-nil, a names list is currently being received. |
erc-channel-topic | A topic string for the channel. Should only be used in channel-buffers. |
erc-channel-user-limit | Limit of users per channel. |
erc-channel-users | Hash table of members in the current channel. |
erc-clientinfo-alist | Alist of CTCP CLIENTINFO for ERC commands. |
erc-command-indicator | Indicator used by ERC for showing commands. |
erc-command-regexp | Regular expression used for matching commands in ERC. |
erc-common-server-suffixes | Alist of common server name suffixes. |
erc-complete-functions | These functions get called when the user hits TAB in ERC. |
erc-connect-pre-hook | Hook called just before ‘erc’ calls ‘erc-connect’. |
erc-debug-irc-protocol | If non-nil, log all IRC protocol traffic to the buffer "*erc-protocol*". |
erc-debug-irc-protocol-time-format | Timestamp format string for protocol logger. |
erc-debug-irc-protocol-version | Protocol log format version number. |
erc-debug-log-file | Debug log file name. |
erc-default-nicks | The local copy of ‘erc-nick’ - the list of nicks to choose from. |
erc-default-port | IRC port to use if it cannot be detected otherwise. |
erc-default-port-tls | IRC port to use for encrypted connections if it cannot be detected otherwise. |
erc-default-recipients | List of default recipients of the current buffer. |
erc-default-server | IRC server to use if it cannot be detected otherwise. |
erc-default-server-hook | Default for server messages which aren’t covered by ‘erc-server-hooks’. |
erc-disable-ctcp-replies | Disable replies to CTCP requests that require a reply. |
erc-disconnected-hook | Run this hook with arguments (NICK IP REASON) when disconnected. |
erc-echo-notice-always-hook | List of functions to call to echo a private notice. |
erc-echo-notice-hook | List of functions to call to echo a private notice. |
erc-email-userid | Use this as your email user ID. |
erc-flood-protect | If non-nil, flood protection is enabled. |
erc-format-nick-function | Function to format a nickname for message display. |
erc-format-query-as-channel-p | If non-nil, format text from others in a query buffer like in a channel. |
erc-frame-alist | Alist of frame parameters for creating erc frames. |
erc-frame-dedicated-flag | Non-nil means the erc frames are dedicated to that buffer. |
erc-grab-buffer-name | The name of the buffer created by ‘erc-grab-region’. |
erc-header-line-face-method | Determine what method to use when colorizing the header line text. |
erc-header-line-format | A string to be formatted and shown in the header-line in ‘erc-mode’. |
erc-header-line-uses-help-echo-p | Show header line in echo area or as a tooltip |
erc-header-line-uses-tabbar-p | Use tabbar mode instead of the header line to display the header. |
erc-hide-list | A global list of IRC message types to hide. |
erc-hide-prompt | If non-nil, do not display the prompt for commands. |
erc-ignore-list | List of regexps matching user identifiers to ignore. |
erc-ignore-reply-list | List of regexps matching user identifiers to ignore completely. |
erc-input-marker | The marker where input should be inserted. |
erc-insert-done-hook | This hook is called after inserting strings into the buffer. |
erc-insert-marker | The place where insertion of new text in erc buffers should happen. |
erc-insert-modify-hook | Insertion hook for functions that will change the text’s appearance. |
erc-insert-post-hook | This hook is called just after ‘erc-insert-modify-hook’. |
erc-insert-pre-hook | Hook called first when some text is inserted through ‘erc-display-line’. |
erc-insert-this | Insert the text into the target buffer or not. |
erc-invitation | Last invitation channel. |
erc-join-buffer | Determines how to display a newly created IRC buffer. |
erc-join-hook | Hook run when we join a channel. |
erc-kick-hook | Hook run when processing a KICK message directed at our nick. |
erc-kill-buffer-hook | Hook run whenever a non-server or channel buffer is killed. |
erc-kill-buffer-on-part | Kill the channel buffer on PART. |
erc-kill-channel-hook | Invoked whenever a channel-buffer is killed via ‘kill-buffer’. |
erc-kill-queries-on-quit | Kill all query (also channel) buffers of this server on QUIT. |
erc-kill-server-buffer-on-quit | Kill the server buffer of the process on QUIT. |
erc-kill-server-hook | Invoked whenever a server buffer is killed via ‘kill-buffer’. |
erc-last-input-time | Time of last call to ‘erc-send-current-line’. |
erc-last-saved-position | A marker containing the position the current buffer was last saved at. |
erc-log-p | When set to t, generate debug messages in a separate debug buffer. |
erc-logged-in | Non-nil indicates that we are logged in. |
erc-lurker-cleanup-count | Internal counter variable for use with ‘erc-lurker-cleanup-interval’. |
erc-lurker-cleanup-interval | Frequency of cleaning up stale erc-lurker state. |
erc-lurker-hide-list | List of IRC type messages to hide when sent by lurkers. |
erc-lurker-ignore-chars | Characters at the end of a nick to strip for activity tracking purposes. |
erc-lurker-state | Track the time of the last PRIVMSG for each (server,nick) pair. |
erc-lurker-threshold-time | Nicks from which no PRIVMSGs have been received within this |
erc-lurker-trim-nicks | If t, trim trailing ‘erc-lurker-ignore-chars’ from nicks. |
erc-minibuffer-ignored | If non-nil, print a message in the minibuffer if we ignored something. |
erc-minibuffer-notice | If non-nil, print ERC notices for the user in the minibuffer. |
erc-mode-abbrev-table | Abbrev table used while in ERC mode. |
erc-mode-hook | Hook run after ‘erc-mode’ setup is finished. |
erc-mode-line-away-status-format | When you’re away on a server, this is shown in the mode line. |
erc-mode-line-format | A string to be formatted and shown in the mode-line in ‘erc-mode’. |
erc-mode-map | ERC keymap. |
erc-mode-syntax-table | Syntax table used while in ERC mode. |
erc-modules | A list of modules which ERC should enable. |
erc-network-hide-list | A list of IRC networks to hide message types from. |
erc-nick | Nickname to use if one is not provided. |
erc-nick-change-attempt-count | Used to keep track of how many times an attempt at changing nick is made. |
erc-nick-changed-functions | List of functions run when your nick was successfully changed. |
erc-nick-history-list | Nickname interactive selection history list. |
erc-nick-uniquifier | The string to append to the nick if it is already in use. |
erc-notice-highlight-type | Determines how to highlight notices. |
erc-notice-prefix | Prefix for all notices. |
erc-official-location | Location of the ERC client on the Internet. |
erc-paranoid | If non-nil, then all incoming CTCP requests will be shown. |
erc-part-hook | Hook run when processing a PART message directed at our nick. |
erc-part-reason | A function which returns the reason for parting a channel. |
erc-part-reason-various-alist | Alist of possible arguments to the /part command. |
erc-password | Password to use when authenticating to an IRC server. |
erc-port | IRC port to use if not specified. |
erc-pre-send-functions | Special hook run to possibly alter the string that is sent. |
erc-prompt | Prompt used by ERC. Trailing whitespace is not required. |
erc-prompt-for-channel-key | Prompt for channel key when using ‘erc-join-channel’ interactively. |
erc-prompt-for-password | Asks before using the default password, or whether to enter a new one. |
erc-public-away-p | Let others know you are back when you are no longer marked away. |
erc-query-display | How to display query buffers when using the /QUERY command to talk to someone. |
erc-query-on-unjoined-chan-privmsg | If non-nil create query buffer on receiving any PRIVMSG at all. |
erc-quit-hook | Hook run when processing a quit command directed at our nick. |
erc-quit-reason | A function which returns the reason for quitting. |
erc-quit-reason-various-alist | Alist of possible arguments to the /quit command. |
erc-remove-parsed-property | Whether to remove the erc-parsed text property after displaying a message. |
erc-rename-buffers | Non-nil means rename buffers with network name, if available. |
erc-reuse-buffers | If nil, create new buffers on joining a channel/query. |
erc-reuse-frames | Determines whether new frames are always created. |
erc-script-echo | If non-nil, echo the IRC script commands locally. |
erc-script-path | List of directories to look for a script in /load command. |
erc-send-completed-hook | Hook called after a message has been parsed by ERC. |
erc-send-modify-hook | Sending hook for functions that will change the text’s appearance. |
erc-send-post-hook | This hook is called just after ‘erc-send-modify-hook’. |
erc-send-pre-hook | Hook called first when some text is sent through ‘erc-send-current-line’. |
erc-send-this | Send the text to the target or not. |
erc-send-whitespace-lines | If set to non-nil, send lines consisting of only whitespace. |
erc-server | IRC server to use if one is not provided. |
erc-server-history-list | IRC server interactive selection history list. |
erc-server-users | Hash table of users on the current server. |
erc-server-vectors | List of received server messages which ERC does not specifically handle. |
erc-session-password | The password used for the current session. |
erc-session-user-full-name | Full name of the user on the current server. |
erc-show-channel-key-p | Show the channel key in the header line. |
erc-show-my-nick | If non-nil, display one’s own nickname when sending a message. |
erc-startup-file-list | List of files to try for a startup script. |
erc-system-name | Use this as the name of your system. |
erc-timer-hook | Put functions which should get called more or less periodically here. |
erc-try-new-nick-p | Non-nil means attempt to connect with another nickname if nickname unavailable. |
erc-user-full-name | User full name. |
erc-user-information | USER_INFORMATION IRC variable. |
erc-user-mode | Initial user modes to be set after a connection is established. |
erc-valid-nick-regexp | Regexp which matches all valid characters in a IRC nickname. |
erc-verbose-server-ping | If non-nil, show every time you get a PING or PONG from the server. |
erc-version | This version of ERC. |
erc-warn-about-blank-lines | Warn the user if they attempt to send a blank line. |
erc-whowas-on-nosuchnick | If non-nil, do a whowas on a nick if no such nick. |