[Emacs-diffs] Changes to emacs/man/erc.texi,v

[Miles Bader]

CVSROOT:        /cvsroot/emacs
Module name:    emacs
Changes by:     Miles Bader <miles>     06/07/14 02:29:50

Index: man/erc.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/man/erc.texi,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- man/erc.texi        5 Jun 2006 11:44:42 -0000       1.5
+++ man/erc.texi        14 Jul 2006 02:29:49 -0000      1.6
@@ -12,7 +12,7 @@
 @syncodeindex fn cp
 
 @copying
-This manual is for ERC version 5.1.2.
+This manual is for ERC version 5.1.3.
 
 Copyright @copyright{} 2005, 2006 Free Software Foundation, Inc.
 
@@ -68,6 +68,13 @@
 * Releases::                    Released versions of ERC.
 * Development::                 Latest unreleased development changes.
 
+Advanced Usage
+
+* Connecting::                  Ways of connecting to an IRC server.
+* Options::                     Options that are available for ERC.
+* Tips and Tricks::             Ways of enhancing your ERC experience.
+* Sample Configuration::        An example configuration file.
+
 @end detailmenu
 @end menu
 
@@ -114,7 +121,7 @@
 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-help@@lists.sourceforge.net} mailing list.
+announced on the @email{erc-discuss@@gnu.org} mailing list.
 @pxref{Getting Help and Reporting Bugs}.
 
 @cindex releases, Debian package
@@ -124,7 +131,7 @@
 
 @cindex releases, from source
 Alternatively, you can download the latest release from
address@hidden://sourceforge.net/project/showfiles.php?group_id=30118}.
address@hidden://ftp.gnu.org/gnu/erc}.
 
 @node Development,  , Releases, Obtaining ERC
 @comment  node-name,  next,  previous,  up
@@ -134,43 +141,13 @@
 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 Using CVS
address@hidden CVS, using
-
-ERC is primarily developed using a CVS repository on sourceforge.net.
-To check out a copy of the latest changes, do the following.
-
address@hidden
-cvs -d:pserver:anonymous@@cvs.sourceforge.net:/cvsroot/erc login
-cvs -z3 -d:pserver:anonymous@@cvs.sourceforge.net:/cvsroot/erc co -P erc
address@hidden example
-
address@hidden CVS snapshot
-Alternatively, the latest CVS snapshot may be downloaded in the
-following forms.
-
address@hidden @bullet
address@hidden http://mwolson.org/static/dist/erc-latest.tar.gz
address@hidden http://mwolson.org/static/dist/erc-latest.zip
address@hidden itemize
-
address@hidden Using the GNU Arch Revision Control System
address@hidden arch revision control system, using
-The Arch revision control system allows you to retrieve previous
-versions and select specific features and bug fixes.
-
-Michael Olson maintains an official Arch branch for ERC which stays
-current with the CVS repository for ERC.  If you would like to
-contribute to ERC development, and would prefer to use a modern Revision
-Control System, feel free to make your own branch.
-
-If you are new to Arch, you might find this tutorial helpful:
address@hidden://www.mwolson.org/projects/ArchTutorial.html}.
address@hidden GNU Arch
 
-Downloading ERC with Arch and staying up-to-date involves the following
-steps.
+ERC is developed using GNU Arch.  Downloading ERC with Arch and staying
+up-to-date involves the following steps.
 
 @enumerate
address@hidden GNU Arch, installing
 @item Install arch
 
 @itemize @bullet
@@ -178,15 +155,16 @@
 @item Other distributions: see @uref{ftp://ftp.gnu.org/gnu/gnu-arch/}.
 @end itemize
 
address@hidden GNU Arch, downloading ERC
 @item Register the archive.
 @example
-tla register-archive -f http://www.mwolson.org/archives/2006
+tla register-archive -f http://arch.sv.gnu.org/archives/erc/erc
 @end example
 
 @item Download the ERC source code.
 @example
 # Download ERC into the @file{erc} directory.
-tla get mwolson@@gnu.org--2006/erc--cvs--0 erc
+tla get erc@@sv.gnu.org/erc--main--0 erc
 @end example
 
 @item List upstream changes that are missing from your local copy.
@@ -201,24 +179,29 @@
 tla missing --summary
 @end example
 
address@hidden updating ERC with Arch
address@hidden GNU Arch, updating ERC
 @item Update to the latest version by replaying missing changes.
 @example
 cd erc
-tla replay
+tla update
 @end example
 
 @end enumerate
 
-There are other ways to interact with the ERC archive.
+If you are new to Arch and want to learn more about developing with it,
+you might find this tutorial helpful:
address@hidden://www.mwolson.org/projects/ArchTutorial.html}.
 
address@hidden
address@hidden Browse arch repository: @uref{http://www.mwolson.org/archives/}
address@hidden Latest development snapshot: 
@uref{http://www.mwolson.org/static/dist/erc-latest.tar.gz}
address@hidden itemize
address@hidden Development snapshots
+
address@hidden development snapshot
+Alternatively, the latest development snapshot may be downloaded in both
+``.tar.gz'' and ``.zip'' forms.
 
-The latest development snapshot will be kept up-to-date since it is
-updated at the same time as the Arch repository.
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
 
 
 @node Installation, Getting Started, Obtaining ERC, Top
@@ -282,15 +265,13 @@
 
 To use ERC, add the directory containing its files to your
 @code{load-path} variable, in your @file{.emacs} file.  Then, load ERC
-itself along with any extra modules you desire.  An example follows.
+itself.  An example follows.
 
 @lisp
 (require 'erc)
-
-(require 'erc-spelling)
 @end lisp
 
-Once this is loaded, the command @kbd{M-x erc-select} will start ERC and
+Once ERC is loaded, the command @kbd{M-x erc-select} will start ERC and
 prompt for the server to connect to.
 
 @c PRE5_2: Sample session, including:
@@ -362,12 +343,12 @@
 
 @item C-c C-o (`erc-get-channel-mode-from-keypress')
 Read a key sequence and call the corresponding channel mode function.
-After doing C-c C-o type in a channel mode letter.
+After doing @kbd{C-c C-o}, type in a channel mode letter.
 
-C-g means quit.
-RET let's you type more than one mode at a time.
-If "l" is pressed, `erc-set-channel-limit' gets called.
-If "k" is pressed, `erc-set-channel-key' gets called.
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'.
 
 @item C-c C-p (`erc-part-from-channel')
@@ -406,7 +387,7 @@
 
 @cindex modules, autoaway
 @item autoaway
-Set away status automatically.
+Set away status automatically
 
 @cindex modules, autojoin
 @item autojoin
@@ -420,14 +401,31 @@
 @item button
 Buttonize URLs, nicknames, and other text
 
address@hidden modules, completion
address@hidden pcomplete
+Complete nicknames and commands (programmable)
+
 @cindex modules, fill
 @item fill
 Wrap long lines
 
address@hidden modules, hecomplete
address@hidden completion
+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
+
 @cindex modules, irccontrols
 @item irccontrols
 Highlight or remove IRC control characters
 
address@hidden modules, list
address@hidden list
+List channels nicely in a separate buffer
+
 @cindex modules, log
 @item log
 Save buffers in logs
@@ -448,9 +446,9 @@
 @item notify
 Notify when the online status of certain users changes
 
address@hidden modules, pcomplete
address@hidden pcomplete
-Complete nicknames and commands (programmable)
address@hidden modules, page
address@hidden page
+Process CTCP PAGE requests from IRC
 
 @cindex modules, readonly
 @item readonly
@@ -480,9 +478,9 @@
 @item sound
 Play sounds when you receive CTCP SOUND requests
 
address@hidden modules, spell
address@hidden spell
-Check spelling
address@hidden modules, spelling
address@hidden spelling
+Check spelling of messages
 
 @cindex modules, stamp
 @item stamp
@@ -510,14 +508,175 @@
 @chapter Advanced Usage
 @cindex advanced topics
 
-Write me.
address@hidden
+* Connecting::                  Ways of connecting to an IRC server.
+* Options::                     Options that are available for ERC.
+* Tips and Tricks::             Ways of enhancing your ERC experience.
+* Sample Configuration::        An example configuration file.
address@hidden menu
+
address@hidden Connecting, Options, 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
address@hidden erc-select}.  If you want to assign this function to a
+keystroke, the following will help you figure out its parameters.
+
address@hidden erc-select
+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-select :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 PRE5_2: (Node) Document every ERC option
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 Options, Tips and Tricks, Connecting, Advanced Usage
address@hidden  node-name,  next,  previous,  up
address@hidden Options
address@hidden options
+
address@hidden PRE5_2: (Node) Document every ERC option (module options go in
address@hidden previous chapter)
+
+This section has not yet been written.
+
address@hidden Tips and Tricks, Sample Configuration, Options, Advanced Usage
address@hidden  node-name,  next,  previous,  up
address@hidden Tips and Tricks
address@hidden tips and tricks
 
 @c PRE5_2: (Node) Tips and tricks
 
+This section has not yet been written.
+
address@hidden Sample Configuration, , Tips and Tricks, Advanced Usage
address@hidden  node-name,  next,  previous,  up
address@hidden Sample Configuration
address@hidden configuration, sample
+
 @c PRE5_2: (Node) Sample configs
 
+This section has not yet been written.
+
 
 @node Getting Help and Reporting Bugs, History, Advanced Usage, Top
 @comment  node-name,  next,  previous,  up
@@ -536,14 +695,24 @@
 descriptions to it.
 
 @item
-You can join the mailing list at @email{erc-help@@lists.sourceforge.net}
-using the subscription form at
address@hidden://lists.sourceforge.net/lists/listinfo/erc-help}.
-
-This mailing list is also available via Gmane
-(@url{http://gmane.org/}). The group is called
address@hidden  This provides additional methods for
-accessing the mailing list, adding content to it, and searching it.
+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
 
 @item
 You can visit the IRC Freenode channel @samp{#emacs}. Many of the
@@ -572,42 +741,46 @@
 
 In June 2001, Mario Lang @email{mlang@@delysid.org} and Alex Schroeder
 @email{alex@@gnu.org} took over development and created a ERC Project at
-sourceforge.net.
address@hidden://sourceforge.net/projects/erc}.
 
-In reaction to a mail about the new erc development, 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."
+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 not to forget a lot of alpha/beta/gamma testing.
+bugfixes, and a lot of alpha/beta/gamma testing.
 
 See the @file{CREDITS} file for a list of contributors.
 
 @item 2003
 
-ERC 3.0 is released.
+ERC 3.0 was released.
 
 @item 2004
 
-ERC 4.0 is released.
+ERC 4.0 was released.
 
 @item 2005
 
-ERC 5.0 is released.  Michael Olson @email{mwolson@@gnu.org} becomes
+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 is
+After some discussion between him and the Emacs developers, it was
 decided to include ERC in Emacs.
 
 @item 2006
 
-ERC 5.1 is released.  It is subsequently included in Emacs 22.
+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.
 
 @end itemize