[Erc-commit] [commit][emacs22] manual: Work on FOR-RELEASE items

[mwolson]

commit a6dd2f7fea27cc7c3db331ef65a5795ebae9db98
Author: Michael Olson <address@hidden>
Date:   Sat Mar 17 00:21:16 2007 +0000

    manual: Work on FOR-RELEASE items
    
    2007-03-17  Michael Olson  <address@hidden>
    
        * erc.texi (Development): Mention ErcDevelopment page on
        emacswiki.
        (Getting Started): Mention ~/.emacs.d/.ercrc.el and the Customize
        interface.
        (Sample Session): New section that has a very rough draft for a
        sample ERC session.
        (Special Features): New section that explains some of the special
        features of ERC.  Taken from ErcFeatures on emacswiki, with
        enhancements.
    git-archimport-id: address@hidden/erc--main--0--patch-120

diff --git a/ChangeLog b/ChangeLog
index 7bffc90..862463e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2007-03-17  Michael Olson  <address@hidden>
+
+       * erc.texi (Development): Mention ErcDevelopment page on
+       emacswiki.
+       (Getting Started): Mention ~/.emacs.d/.ercrc.el and the Customize
+       interface.
+       (Sample Session): New section that has a very rough draft for a
+       sample ERC session.
+       (Special Features): New section that explains some of the special
+       features of ERC.  Taken from ErcFeatures on emacswiki, with
+       enhancements.
+
 2007-03-12  Diane Murray  <address@hidden>
 
        * erc-autoaway.el (erc-autoaway-idle-method): When setting the new
diff --git a/erc.texi b/erc.texi
index e99cbc8..a75a986 100644
--- a/erc.texi
+++ b/erc.texi
@@ -73,6 +73,11 @@ 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.
@@ -193,9 +198,9 @@ tla update
 
 @end enumerate
 
-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}.
+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.
 
 @subheading Development snapshots
 
@@ -266,8 +271,6 @@ locations that require this.
 @chapter Getting Started
 @cindex settings
 
address@hidden PRE5_2: Mention .ercrc.el
-
 To use ERC, add the directory containing its files to your
 @code{load-path} variable, in your @file{.emacs} file.  Then, load ERC
 itself.  An example follows.
@@ -279,20 +282,117 @@ itself.  An example follows.
 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.
+
address@hidden @bullet
+
address@hidden Connect to Freenode
+
address@hidden Get used to the interface
+
address@hidden Join the #emacs channel
+
address@hidden Register your nickname with Freenode
+
address@hidden Talk to people in the channel
+
address@hidden Open a query buffer to talk to someone
+
address@hidden (must identify first in FreeNode)
+
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 /RECONNECT command.
-
address@hidden PRE5_2: Sample session, including:
address@hidden - connect to Freenode
address@hidden - /join #emacs
address@hidden - see messages flying past, point out topic lines, messages, 
channel
address@hidden   members
address@hidden - identifying your nick with NickServ (most IRC servers have 
this)
address@hidden - talking to the channel
address@hidden - open a /query buffer to talk to someone (must identify first in
address@hidden   FreeNode)
+ERC  buffer and run the @code{/RECONNECT} command.
+
address@hidden itemize
 
 
 @node Keystroke Summary, Modules, Getting Started, Top