[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to erc.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to erc.texi |
|
Date: |
Thu, 06 Sep 2007 04:59:39 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 04:59:39
Index: erc.texi
===================================================================
RCS file: erc.texi
diff -N erc.texi
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ erc.texi 6 Sep 2007 04:59:39 -0000 1.1
@@ -0,0 +1,1027 @@
+\input texinfo
address@hidden %**start of header
address@hidden ../info/erc
address@hidden ERC Manual
address@hidden %**end of header
+
address@hidden Emacs
address@hidden
+* ERC: (erc). Powerful, modular, and extensible IRC client for Emacs.
address@hidden direntry
+
address@hidden fn cp
+
address@hidden
+This manual is for ERC version 5.2.
+
+Copyright @copyright{} 2005, 2006, 2007 Free Software Foundation, Inc.
+
address@hidden
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, Front-Cover texts, or Back-Cover Texts. A copy of
+the license is included in the section entitled ``GNU Free
+Documentation License'' in the Emacs manual.
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
+
+All Emacs Lisp code contained in this document may be used, distributed,
+and modified without restriction.
address@hidden quotation
address@hidden copying
+
address@hidden
address@hidden ERC manual
address@hidden a full-featured IRC client
address@hidden for GNU Emacs and XEmacs
+
address@hidden The following two commands
address@hidden start the copyright page.
address@hidden
address@hidden 0pt plus 1filll
address@hidden
address@hidden titlepage
+
address@hidden So the toc is printed at the start
address@hidden
+
address@hidden
address@hidden Top, Introduction, (dir), (dir)
address@hidden node-name, next, previous, up
address@hidden ERC
+
address@hidden
address@hidden ifnottex
+
address@hidden
+* Introduction:: What is ERC?
+* Obtaining ERC:: How to get ERC releases and development
+ versions.
+* Installation:: Compiling and installing ERC.
+* Getting Started:: Quick Start guide to using ERC.
+* Keystroke Summary:: Keystrokes used in ERC buffers.
+* Modules:: Available modules for ERC.
+* Advanced Usage:: Cool ways of using ERC.
+* Getting Help and Reporting Bugs::
+* History:: The history of ERC.
+* GNU Free Documentation License:: The license for this documentation.
+* Concept Index:: Search for terms.
+
address@hidden
+ --- The Detailed Node Listing ---
+
+Obtaining ERC
+
+* Releases:: Released versions of ERC.
+* Development:: Latest unreleased development changes.
+
+Getting Started
+
+* Sample Session:: Example of connecting to the #emacs channel
+* Special Features:: Differences from standalone IRC clients
+
+Advanced Usage
+
+* Connecting:: Ways of connecting to an IRC server.
+* Sample Configuration:: An example configuration file.
+* Options:: Options that are available for ERC.
+
address@hidden detailmenu
address@hidden menu
+
address@hidden Introduction, Obtaining ERC, Top, Top
address@hidden node-name, next, previous, up
address@hidden Introduction
+
+ERC is a powerful, modular, and extensible IRC client for Emacs.
+
+It comes with the following capabilities enabled by default.
+
address@hidden @bullet
address@hidden Flood control
address@hidden Timestamps
address@hidden Join channels automatically
address@hidden Buttonize URLs, nicknames, and other text
address@hidden Wrap long lines
address@hidden Highlight or remove IRC control characters
address@hidden Highlight pals, fools, and other keywords
address@hidden Detect netsplits
address@hidden Complete nicknames and commands in a programmable fashion
address@hidden Make displayed lines read-only
address@hidden Input history
address@hidden Track channel activity in the mode-line
+
address@hidden itemize
+
address@hidden Obtaining ERC, Installation, Introduction, Top
address@hidden node-name, next, previous, up
address@hidden Obtaining ERC
+
address@hidden
+* Releases:: Released versions of ERC.
+* Development:: Latest unreleased development changes.
address@hidden menu
+
+Note that some ERC files are not included with Emacs due to copyright or
+dependency issues. If desired, they may be found at the following
+locations, or from your local GNU mirror.
+
address@hidden @bullet
address@hidden @uref{http://ftp.gnu.org/gnu/erc/erc-5.2-extras.tar.gz}
address@hidden @uref{http://ftp.gnu.org/gnu/erc/erc-5.2-extras.zip}
address@hidden itemize
+
+The rest of this chapter may be skipped if you are using the version of
+ERC that comes with Emacs.
+
address@hidden Releases, Development, Obtaining ERC, Obtaining ERC
address@hidden node-name, next, previous, up
address@hidden Releases
+
+Choose to install a release if you want to minimize risk.
+
+Errors are corrected in development first. User-visible changes will be
+announced on the @email{erc-discuss@@gnu.org} mailing list.
address@hidden Help and Reporting Bugs}.
+
address@hidden releases, Debian package
address@hidden Debian package for ERC
+Debian users can get ERC via apt-get. The @file{erc} package is
+available in the official Debian repository.
+
address@hidden releases, from source
+Alternatively, you can download the latest release from
address@hidden://ftp.gnu.org/gnu/erc}, or your local GNU mirror.
+
address@hidden Development, , Releases, Obtaining ERC
address@hidden node-name, next, previous, up
address@hidden Development
address@hidden development
+
+Choose the development version if you want to live on the bleeding edge
+of ERC development or try out new features before release.
+
address@hidden GNU Arch
+
+ERC is developed using GNU Arch. Downloading ERC with Arch and staying
+up-to-date involves the following steps.
+
address@hidden
address@hidden GNU Arch, installing
address@hidden Install arch
+
address@hidden @bullet
address@hidden Debian: @kbd{apt-get install tla}.
address@hidden Other distributions: see @uref{ftp://ftp.gnu.org/gnu/gnu-arch/}.
address@hidden itemize
+
address@hidden GNU Arch, downloading ERC
address@hidden Register the archive.
address@hidden
+tla register-archive -f http://arch.sv.gnu.org/archives/erc/erc
address@hidden example
+
address@hidden Download the ERC source code.
address@hidden
+# Download ERC into the @file{erc} directory.
+tla get erc@@sv.gnu.org/erc--main--0 erc
address@hidden example
+
address@hidden List upstream changes that are missing from your local copy.
+Do this whenever you want to see whether new changes have been committed
+to ERC.
+
address@hidden
+# Change to the source directory you are interested in.
+cd erc/
+
+# Display the summary of changes
+tla missing --summary
address@hidden example
+
address@hidden GNU Arch, updating ERC
address@hidden Update to the latest version by replaying missing changes.
address@hidden
+cd erc
+tla update
address@hidden example
+
address@hidden enumerate
+
+If you are new to Arch and want to learn more about developing ERC with
+it, visit @uref{http://emacswiki.org/cgi-bin/wiki/ErcDevelopment} for
+full instructions.
+
address@hidden Development snapshots
+
address@hidden development snapshot
+Alternatively, the latest development snapshot may be downloaded in both
+``.tar.gz'' and ``.zip'' forms.
+
address@hidden @bullet
address@hidden @uref{http://www.mwolson.org/static/dist/erc-latest.tar.gz}
address@hidden @uref{http://www.mwolson.org/static/dist/erc-latest.zip}
address@hidden itemize
+
+
address@hidden Installation, Getting Started, Obtaining ERC, Top
address@hidden node-name, next, previous, up
address@hidden Installation
+
+ERC may be compiled and installed on your machine.
+
+This section may be skipped if you are using the version of ERC that
+comes with Emacs.
+
address@hidden Compilation
+
+This is an optional step, since Emacs Lisp source code does not
+necessarily have to be byte-compiled. It will yield a speed increase,
+though.
+
+A working copy of Emacs or XEmacs is needed in order to compile ERC. By
+default, the program that is installed with the name @command{emacs}
+will be used.
+
+If you want to use the @command{xemacs} binary to perform the
+compilation, you would need to edit @file{Makefile} in the top-level
+directory as follows. You can put either a full path to an Emacs or
+XEmacs binary or just the command name, as long as it is in the
address@hidden
+
address@hidden
+EMACS = xemacs
+SITEFLAG = -no-site-file
address@hidden example
+
+Running @code{make} should compile the ERC source files in the
address@hidden directory.
+
address@hidden Installation
+
+ERC may be installed into your file hierarchy by doing the following.
+
+Edit the @file{Makefile} file so that @env{ELISPDIR} points to where you
+want the source and compiled ERC files to be installed and
address@hidden indicates where to put the ERC manual. Of course, you
+will want to edit @env{EMACS} and @env{SITEFLAG} as shown in the
+Compilation section if you are using XEmacs.
+
+If you are installing ERC on a Debian system, you might want to change
+the value of @env{INSTALLINFO} as specified in @file{Makefile}.
+
+Run @code{make} as a normal user.
+
+Run @code{make install} as the root user if you have chosen installation
+locations that require this.
+
+
address@hidden Getting Started, Keystroke Summary, Installation, Top
address@hidden node-name, next, previous, up
address@hidden Getting Started
address@hidden settings
+
+To use ERC, add the directory containing its files to your
address@hidden variable, in your @file{.emacs} file. Then, load ERC
+itself. An example follows.
+
address@hidden
+(require 'erc)
address@hidden lisp
+
+Once ERC is loaded, the command @kbd{M-x erc} will start ERC and
+prompt for the server to connect to.
+
+If you want to place ERC settings in their own file, you can place them
+in @file{~/.emacs.d/.ercrc.el}, creating it if necessary.
+
+If you would rather use the Customize interface to change how ERC works,
+do @kbd{M-x customize-group RET erc RET}. In particular, ERC comes with
+lots of modules that may be enabled or disabled; to select which ones
+you want, do @kbd{M-x customize-variable RET erc-modules RET}.
+
address@hidden
+* Sample Session:: Example of connecting to the #emacs channel
+* Special Features:: Differences from standalone IRC clients
address@hidden menu
+
address@hidden Sample Session, Special Features, Getting Started, Getting
Started
address@hidden node-name, next, previous, up
address@hidden Sample Session
+
+This is an example ERC session which shows how to connect to the #emacs
+channel on Freenode. Another IRC channel on Freenode that may be of
+interest is #erc, which is a channel where ERC users and developers hang
+out.
+
address@hidden @bullet
+
address@hidden Connect to Freenode
+
+Run @kbd{M-x erc}. Use ``irc.freenode.net'' as the IRC server, ``6667''
+as the port, and choose a nickname.
+
address@hidden Get used to the interface
+
+Switch to the ``irc.freenode.net:6667'' buffer, if you're not already
+there. You will see first some messages about checking for ident, and
+then a bunch of other messages that describe the current IRC server.
+
address@hidden Join the #emacs channel
+
+In that buffer, type ``/join SPC #emacs'' and hit @kbd{RET}. Depending
+on how you've set up ERC, either a new buffer for ``#emacs'' will be
+displayed, or a new buffer called ``#emacs'' will be created in the
+background. If the latter, switch to the ``#emacs'' buffer. You will
+see the channel topic and a list of the people who are currently on the
+channel.
+
address@hidden Register your nickname with Freenode
+
+If you would like to be able to talk with people privately on the
+Freenode network, you will have to ``register'' your nickname. To do
+so, switch to the ``irc.freenode.net:6667'' buffer and type ``/msg
+NickServ register <password>'', replacing ``<password>'' with your
+desired password. It should tell you that the operation was successful.
+
address@hidden Talk to people in the channel
+
+If you switch back to the ``#emacs'' buffer, you can type a message, and
+everyone on the channel will see it.
+
address@hidden Open a query buffer to talk to someone
+
+If you want to talk with someone in private (this should usually not be
+done for technical help, only for personal questions), type ``/query
+<nick>'', replacing ``<nick>'' with the nickname of the person you would
+like to talk to. Depending on how ERC is set up, you will either see a
+new buffer with the name of the person, or such a buffer will be created
+in the background and you will have to switch to it. Begin typing
+messages, and you will be able to have a conversation.
+
+Note that if the other person is not registered, you will not be able to
+talk with them.
+
address@hidden itemize
+
address@hidden Special Features, , Sample Session, Getting Started
address@hidden node-name, next, previous, up
address@hidden Special Features
+
+ERC has some features that distinguish it from some IRC clients.
+
address@hidden @bullet
+
address@hidden multiple channels and multiple servers
+
+Every channel is put in a separate buffer. Several IRC servers may be
+connected to at the same time.
+
address@hidden query buffers
address@hidden private message separation
+
+Private conversations are treated as channels, and are put into separate
+buffers in Emacs. We call these ``query buffers''.
+
address@hidden highlighting
+
+Some occurences of words can be highlighted, which makes it easier to
+track different kinds of conversations.
+
address@hidden notification
+
+ERC can notify you that certain users are online.
+
address@hidden channel tracking
+
+Channels can be hidden and conversation continue in the background. You
+are notified when something is said in such a channel that is not
+currently visible. This makes it easy to get Real Work done while still
+maintaining an IRC presence.
+
address@hidden nick completion
+
+ERC can complete words upon hitting @kbd{TAB}, which eases the writing
+of nicknames in messages.
+
address@hidden history ring
address@hidden history
+
+Past actions are kept in history rings for future use. To navigate a
+history ring, hit @kbd{M-p} to go backwards and @kbd{M-n} to go
+forwards.
+
address@hidden multiple languages
+
+Different channels and servers may have different language encodings.
+
+In addition, it is possible to translate the messages that ERC uses into
+multiple languages. Please contact the developers of ERC at
address@hidden@@gnu.org} if you are interested in helping with the
+translation effort.
+
address@hidden user scripting
+
+Users can load scripts (e.g. auto greeting scripts) when ERC starts up.
+
+It is also possible to make custom IRC commands, if you know a little
+Emacs Lisp. Just make an Emacs Lisp function and call it
address@hidden, where @code{NEWCOMMAND} is the name of the
+new command in capital letters.
+
address@hidden auto reconnect
+
+If the connection goes away at some point, ERC will try to reconnect
+automatically. If it fails to reconnect, and you want to try to
+manually reestablish the connection at some later point, switch to an
+ERC buffer and run the @code{/RECONNECT} command.
+
address@hidden itemize
+
+
address@hidden Keystroke Summary, Modules, Getting Started, Top
address@hidden node-name, next, previous, up
address@hidden Keys Used in ERC
address@hidden keystrokes
+
+This is a summary of keystrokes available in every ERC buffer.
+
address@hidden @kbd
+
address@hidden C-a or <home> (`erc-bol')
+Go to beginning of line or end of prompt.
+
address@hidden RET (`erc-send-current-line')
+Send the current line
+
address@hidden TAB (`erc-complete-word')
+If at prompt, complete the current word.
+Otherwise, move to the next link or button.
+
address@hidden M-TAB (`ispell-complete-word')
+Complete the given word, using ispell.
+
address@hidden C-c C-a (`erc-bol')
+Go to beginning of line or end of prompt.
+
address@hidden C-c C-b (`erc-iswitchb')
+Use `iswitchb-read-buffer' to prompt for a ERC buffer to switch to.
+
address@hidden C-c C-c (`erc-toggle-interpret-controls')
+Toggle interpretation of control sequences in messages.
+
address@hidden C-c C-d (`erc-input-action')
+Interactively input a user action and send it to IRC.
+
address@hidden C-c C-e (`erc-toggle-ctcp-autoresponse')
+Toggle automatic CTCP replies (like VERSION and PING).
+
address@hidden C-c C-f (`erc-toggle-flood-control')
+Toggle use of flood control on sent messages.
+
address@hidden C-c TAB (`erc-invite-only-mode')
+Turn on the invite only mode (+i) for the current channel.
+
address@hidden C-c C-j (`erc-join-channel')
+Join channel. If point is at the beginning of a channel name, use that
+as default.
+
address@hidden C-c C-k (`erc-go-to-log-matches-buffer')
+Interactively open an erc-log-matches buffer
+
address@hidden C-c C-l (`erc-save-buffer-in-logs')
+Append buffer contents to the log file, if logging is enabled.
+
address@hidden C-c C-n (`erc-channel-names')
+Run "/names #channel" in the current channel.
+
address@hidden C-c C-o (`erc-get-channel-mode-from-keypress')
+Read a key sequence and call the corresponding channel mode function.
+After doing @kbd{C-c C-o}, type in a channel mode letter.
+
address@hidden means quit.
address@hidden lets you type more than one mode at a time.
+If @kbd{l} is pressed, @code{erc-set-channel-limit} gets called.
+If @kbd{k} is pressed, @code{erc-set-channel-key} gets called.
+Anything else will be sent to `erc-toggle-channel-mode'.
+
address@hidden C-c C-p (`erc-part-from-channel')
+Part from the current channel and prompt for a reason.
+
address@hidden C-c C-q (`erc-quit-server')
+Disconnect from current server after prompting for reason.
+
address@hidden C-c C-r (`erc-remove-text-properties-region')
+Clears the region (start,end) in object from all colors, etc.
+
address@hidden C-c C-t (`erc-set-topic')
+Prompt for a topic for the current channel.
+
address@hidden C-c C-u (`erc-kill-input')
+Kill current input line using `erc-bol' followed by `kill-line'.
+
address@hidden table
+
+
address@hidden Modules, Advanced Usage, Keystroke Summary, Top
address@hidden node-name, next, previous, up
address@hidden Modules
address@hidden modules
+
+One way to add functionality to ERC is to customize which of its many
+modules are loaded.
+
+There is a spiffy customize interface, which may be reached by typing
address@hidden customize-option erc-modules RET}. Alternatively, set
address@hidden manually and then call @code{erc-update-modules}.
+
+The following is a list of available modules.
+
address@hidden @code
+
address@hidden modules, autoaway
address@hidden autoaway
+Set away status automatically
+
address@hidden modules, autojoin
address@hidden autojoin
+Join channels automatically
+
address@hidden modules, bbdb
address@hidden bbdb
+Integrate with the Big Brother Database
+
address@hidden modules, button
address@hidden button
+Buttonize URLs, nicknames, and other text
+
address@hidden modules, capab-identify
address@hidden capab-identify
+Mark unidentified users on freenode and other servers supporting CAPAB.
+
address@hidden modules, completion
address@hidden modules, pcomplete
address@hidden completion (aka pcomplete)
+Complete nicknames and commands (programmable)
+
address@hidden modules, fill
address@hidden fill
+Wrap long lines
+
address@hidden modules, hecomplete
address@hidden hecomplete
+Complete nicknames and commands (old). This is the old module---you
+might prefer the ``completion'' module instead.
+
address@hidden modules, identd
address@hidden identd
+Launch an identd server on port 8113
+
address@hidden modules, irccontrols
address@hidden irccontrols
+Highlight or remove IRC control characters
+
address@hidden modules, log
address@hidden log
+Save buffers in logs
+
address@hidden modules, match
address@hidden match
+Highlight pals, fools, and other keywords
+
address@hidden modules, menu
address@hidden menu
+Display a menu in ERC buffers
+
address@hidden modules, netsplit
address@hidden netsplit
+Detect netsplits
+
address@hidden modules, noncommands
address@hidden noncommands
+Don't display non-IRC commands after evaluation
+
address@hidden modules, notify
address@hidden notify
+Notify when the online status of certain users changes
+
address@hidden modules, page
address@hidden page
+Process CTCP PAGE requests from IRC
+
address@hidden modules, readonly
address@hidden readonly
+Make displayed lines read-only
+
address@hidden modules, replace
address@hidden replace
+Replace text in messages
+
address@hidden modules, ring
address@hidden ring
+Enable an input history
+
address@hidden modules, scrolltobottom
address@hidden scrolltobottom
+Scroll to the bottom of the buffer
+
address@hidden modules, services
address@hidden services
+Identify to Nickserv (IRC Services) automatically
+
address@hidden modules, smiley
address@hidden smiley
+Convert smileys to pretty icons
+
address@hidden modules, sound
address@hidden sound
+Play sounds when you receive CTCP SOUND requests
+
address@hidden modules, spelling
address@hidden spelling
+Check spelling of messages
+
address@hidden modules, stamp
address@hidden stamp
+Add timestamps to messages
+
address@hidden modules, track
address@hidden track
+Track channel activity in the mode-line
+
address@hidden modules, truncate
address@hidden truncate
+Truncate buffers to a certain size
+
address@hidden modules, unmorse
address@hidden unmorse
+Translate morse code in messages
+
address@hidden table
+
address@hidden PRE5_3: Document every option of every module in its own subnode
+
+
address@hidden Advanced Usage, Getting Help and Reporting Bugs, Modules, Top
address@hidden node-name, next, previous, up
address@hidden Advanced Usage
address@hidden advanced topics
+
address@hidden
+* Connecting:: Ways of connecting to an IRC server.
+* Sample Configuration:: An example configuration file.
+* Options:: Options that are available for ERC.
address@hidden menu
+
address@hidden Connecting, Sample Configuration, Advanced Usage, Advanced Usage
address@hidden node-name, next, previous, up
address@hidden Connecting to an IRC Server
address@hidden connecting
+
+The easiest way to connect to an IRC server is to call @kbd{M-x erc}.
+If you want to assign this function to a keystroke, the following will
+help you figure out its parameters.
+
address@hidden erc
+Select connection parameters and run ERC.
+Non-interactively, it takes the following keyword arguments.
+
address@hidden @bullet
address@hidden @var{server}
address@hidden @var{port}
address@hidden @var{nick}
address@hidden @var{password}
address@hidden @var{full-name}
address@hidden itemize
+
+That is, if called with the following arguments, @var{server} and
address@hidden will be set to those values, whereas
address@hidden, @code{erc-compute-nick} and
address@hidden will be invoked for the values of the other
+parameters.
+
address@hidden
+(erc :server "irc.freenode.net" :full-name "Harry S Truman")
address@hidden example
address@hidden defun
+
address@hidden Server
+
address@hidden erc-compute-server &optional server
+Return an IRC server name.
+
+This tries a number of increasingly more default methods until a non-nil
+value is found.
+
address@hidden @bullet
address@hidden @var{server} (the argument passed to this function)
address@hidden The @code{erc-server} option
address@hidden The value of the IRCSERVER environment variable
address@hidden The @code{erc-default-server} variable
address@hidden itemize
+
address@hidden defun
+
address@hidden erc-server nil
+IRC server to use if one is not provided.
address@hidden defopt
+
address@hidden Port
+
address@hidden erc-compute-port &optional port
+Return a port for an IRC server.
+
+This tries a number of increasingly more default methods until a non-nil
+value is found.
+
address@hidden @bullet
address@hidden @var{port} (the argument passed to this function)
address@hidden The @code{erc-port} option
address@hidden The @code{erc-default-port} variable
address@hidden itemize
+
address@hidden defun
+
address@hidden erc-port
+IRC port to use if not specified.
+
+This can be either a string or a number.
address@hidden defopt
+
address@hidden Nick
+
address@hidden erc-compute-nick &optional nick
+Return user's IRC nick.
+
+This tries a number of increasingly more default methods until a
+non-nil value is found.
+
address@hidden
address@hidden @var{nick} (the argument passed to this function)
address@hidden The @code{erc-nick} option
address@hidden The value of the IRCNICK environment variable
address@hidden The result from the @code{user-login-name} function
address@hidden itemize
+
address@hidden defun
+
address@hidden erc-nick
+Nickname to use if one is not provided.
+
+This can be either a string, or a list of strings.
+In the latter case, if the first nick in the list is already in use,
+other nicks are tried in the list order.
address@hidden defopt
+
address@hidden erc-nick-uniquifier
+The string to append to the nick if it is already in use.
address@hidden defopt
+
address@hidden erc-try-new-nick-p
+If the nickname you chose isn't available, and this option is non-nil,
+ERC should automatically attempt to connect with another nickname.
+
+You can manually set another nickname with the /NICK command.
address@hidden defopt
+
address@hidden Full name
+
address@hidden erc-compute-full-name &optional full-name
+Return user's full name.
+
+This tries a number of increasingly more default methods until a
+non-nil value is found.
+
address@hidden @bullet
address@hidden @var{full-name} (the argument passed to this function)
address@hidden The @code{erc-user-full-name} option
address@hidden The value of the IRCNAME environment variable
address@hidden The result from the @code{user-full-name} function
address@hidden itemize
+
address@hidden defun
+
address@hidden erc-user-full-name
+User full name.
+
+This can be either a string or a function to call.
address@hidden defopt
+
address@hidden Sample Configuration, Options, Connecting, Advanced Usage
address@hidden node-name, next, previous, up
address@hidden Sample Configuration
address@hidden configuration, sample
+
+Here is an example of configuration settings for ERC. This can go into
+your Emacs configuration file. Everything after the @code{(require
+'erc)} command can optionally go into @file{~/.emacs.d/.ercrc.el}.
+
address@hidden
+;;; Sample ERC configuration
+
+;; Add the ERC directory to load path -- you don't need this if you are
+;; using the version of ERC that comes with Emacs
+(add-to-list 'load-path "~/elisp/erc")
+
+;; Load ERC
+(require 'erc)
+
+;; Load authentication info from an external source. Put sensitive
+;; passwords and the like in here.
+(load "~/.emacs.d/.erc-auth")
+
+;; This is an example of how to make a new command. Type "/uptime" to
+;; use it.
+(defun erc-cmd-UPTIME (&rest ignore)
+ "Display the uptime of the system, as well as some load-related
+stuff, to the current ERC buffer."
+ (let ((uname-output
+ (replace-regexp-in-string
+ ", load average: " "] @{Load address@hidden ["
+ ;; Collapse spaces, remove
+ (replace-regexp-in-string
+ " +" " "
+ ;; Remove beginning and trailing whitespace
+ (replace-regexp-in-string
+ "^ +\\|[ \n]+$" ""
+ (shell-command-to-string "uptime"))))))
+ (erc-send-message
+ (concat "@address@hidden [" uname-output "]"))))
+
+;; This causes ERC to connect to the Freenode network upon hitting
+;; C-c e f. Replace MYNICK with your IRC nick.
+(global-set-key "\C-cef" (lambda () (interactive)
+ (erc :server "irc.freenode.net" :port "6667"
+ :nick "MYNICK")))
+
+;; This causes ERC to connect to the IRC server on your own machine (if
+;; you have one) upon hitting C-c e b. Replace MYNICK with your IRC
+;; nick. Often, people like to run bitlbee (http://bitlbee.org/) as an
+;; AIM/Jabber/MSN to IRC gateway, so that they can use ERC to chat with
+;; people on those networks.
+(global-set-key "\C-ceb" (lambda () (interactive)
+ (erc :server "localhost" :port "6667"
+ :nick "MYNICK")))
+
+;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has
+;; been commented out to avoid confusing new users.
+;; (define-key erc-mode-map (kbd "RET") nil)
+;; (define-key erc-mode-map (kbd "C-c RET") 'erc-send-current-line)
+;; (define-key erc-mode-map (kbd "C-c C-RET") 'erc-send-current-line)
+
+;;; Options
+
+;; Join the #emacs and #erc channels whenever connecting to Freenode.
+(setq erc-autojoin-channels-alist '(("freenode.net" "#emacs" "#erc")))
+
+;; Interpret mIRC-style color commands in IRC chats
+(setq erc-interpret-mirc-color t)
+
+;; The following are commented out by default, but users of other
+;; non-Emacs IRC clients might find them useful.
+;; Kill buffers for channels after /part
+;; (setq erc-kill-buffer-on-part t)
+;; Kill buffers for private queries after quitting the server
+;; (setq erc-kill-queries-on-quit t)
+;; Kill buffers for server messages after quitting the server
+;; (setq erc-kill-server-buffer-on-quit t)
address@hidden lisp
+
address@hidden Options, , Sample Configuration, Advanced Usage
address@hidden node-name, next, previous, up
address@hidden Options
address@hidden options
+
address@hidden PRE5_3: (Node) Document every ERC option (module options go in
address@hidden previous chapter)
+
+This section has not yet been written. For now, the easiest way to
+check out the available option for ERC is to do
address@hidden customize-group erc RET}.
+
+
address@hidden Getting Help and Reporting Bugs, History, Advanced Usage, Top
address@hidden node-name, next, previous, up
address@hidden Getting Help and Reporting Bugs
address@hidden help, getting
address@hidden bugs, reporting
+
+After you have read this guide, if you still have questions about ERC,
+or if you have bugs to report, there are several places you can go.
+
address@hidden @bullet
+
address@hidden
address@hidden://www.emacswiki.org/cgi-bin/wiki/EmacsIRCClient} is the
+emacswiki.org page for ERC. Anyone may add tips, hints, or bug
+descriptions to it.
+
address@hidden
+There are several mailing lists for ERC. To subscribe, visit
address@hidden://savannah.gnu.org/mail/?group=erc}.
+
+The mailing lists are also available on Gmane.
+(@url{http://gmane.org/}). Gmane provides additional methods for
+accessing the mailing lists, adding content to them, and searching them.
+
address@hidden
address@hidden gmane.emacs.erc.announce
+Announcements
+
address@hidden gmane.emacs.erc.discuss
+General discussion
+
address@hidden gmane.emacs.erc.cvs
+Log messages for changes to the ERC source code
+
address@hidden enumerate
+
address@hidden
+You can visit the IRC Freenode channel @samp{#emacs}. Many of the
+contributors are frequently around and willing to answer your
+questions.
+
address@hidden itemize
+
+
address@hidden History, GNU Free Documentation License, Getting Help and
Reporting Bugs, Top
address@hidden node-name, next, previous, up
address@hidden History
address@hidden history, of ERC
+
+ERC was originally written by Alexander L. Belikoff
address@hidden@@bfr.co.il} and Sergey Berezin
address@hidden@@cs.cmu.edu}. They stopped development around
+December 1999. Their last released version was ERC 2.0.
+
+P.S.: If one of the original developers of ERC reads this, we'd like to
+receive additional information for this file and hear comments in
+general.
+
address@hidden
address@hidden 2001
+
+In June 2001, Mario Lang @email{mlang@@delysid.org} and Alex Schroeder
address@hidden@@gnu.org} took over development and created a ERC Project at
address@hidden://sourceforge.net/projects/erc}.
+
+In reaction to a mail about the new ERC development effort, Sergey
+Berezin said, ``First of all, I'm glad that my version of ERC is being
+used out there. The thing is, I do not have free time and enough
+incentive anymore to work on ERC, so I would be happy if you guys take
+over the project entirely.''
+
+So we happily hacked away on ERC, and soon after (September 2001)
+released the next "stable" version, 2.1.
+
+Most of the development of the new ERC happened on #emacs on
+irc.openprojects.net. Over time, many people contributed code, ideas,
+bugfixes, and a lot of alpha/beta/gamma testing.
+
+See the @file{CREDITS} file for a list of contributors.
+
address@hidden 2003
+
+ERC 3.0 was released.
+
address@hidden 2004
+
+ERC 4.0 was released.
+
address@hidden 2005
+
+ERC 5.0 was released. Michael Olson @email{mwolson@@gnu.org} became
+the release manager and eventually the maintainer.
+
+After some discussion between him and the Emacs developers, it was
+decided to include ERC in Emacs.
+
address@hidden 2006
+
+ERC 5.1 was released. It was subsequently included in Emacs 22.
+
+ERC became an official GNU project, and development moved to
address@hidden://sv.gnu.org/projects/erc}. We switched to using GNU Arch as
+our revision control system. Our mailing list address changed as well.
+
address@hidden itemize
+
address@hidden GNU Free Documentation License, Concept Index, History, Top
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
+
address@hidden Concept Index, , GNU Free Documentation License, Top
address@hidden node-name, next, previous, up
address@hidden Index
+
address@hidden cp
+
address@hidden
+
address@hidden
+ arch-tag: cf9cfaff-fc12-4297-ad15-ec2493002b1e
address@hidden ignore