[Erc-commit] [commit][emacs22] manual: Finish some FOR-RELEASE items and defer others to 5.3.

[mwolson]

commit 0a9acb73e3e06075d3c91e4e6189f5e1bfececfa
Author: Michael Olson <address@hidden>
Date:   Sat Mar 31 20:14:14 2007 +0000

    manual: Finish some FOR-RELEASE items and defer others to 5.3.
    
    2007-03-31  Michael Olson  <address@hidden>
    
        * FOR-RELEASE: Finish up 5.2 manual item.  Add documentation item
        for 5.3.
    
        * erc.texi (Sample Session): Mention #erc.
        (Modules): Defer to 5.3 release.
        (Advanced Usage): Move Sample Configuration chapter ahead of
        unfinished chapters.
        (Sample Configuration): Write.
        (Options): Mention how to see available ERC options.  Defer to 5.3
            release.
        (Tips and Tricks): Remove, since it seems better to just include
        tips and tricks in the sample configuration, commented out.
    git-archimport-id: address@hidden/erc--main--0--patch-127

diff --git a/ChangeLog b/ChangeLog
index 685b51d..5ad9d92 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,17 @@
 2007-03-31  Michael Olson  <address@hidden>
 
-       * erc.texi (Sample Session): Flesh out.
+       * FOR-RELEASE: Finish up 5.2 manual item.  Add documentation item
+       for 5.3.
+
+       * erc.texi (Sample Session): Flesh out.  Mention #erc.
+       (Modules): Defer to 5.3 release.
+       (Advanced Usage): Move Sample Configuration chapter ahead of
+       unfinished chapters.
+       (Sample Configuration): Write.
+       (Options): Mention how to see available ERC options.  Defer to 5.3
+       release.
+       (Tips and Tricks): Remove, since it seems better to just include
+       tips and tricks in the sample configuration, commented out.
 
        * erc-bbdb.el (erc-bbdb-search-name-and-create): Make prompt more
        informative about how to skip merging.
diff --git a/FOR-RELEASE b/FOR-RELEASE
index 0a26ba5..116b5bc 100644
--- a/FOR-RELEASE
+++ b/FOR-RELEASE
@@ -2,6 +2,10 @@ Tasks that need to be accomplished in order for a release to 
happen.
 
 * 5.3 release (future)
 
+** Documentation
+
+*** Finish items marked with "@c PRE5_3" in the documentation.
+
 ** Source
 
 *** Make erc-backend not need to (require) any other part of ERC.
@@ -12,8 +16,7 @@ other IRC clients, like Circe.
 
 ** Documentation
 
-*** Items with "@c PRE5_2" won't block the 5.1 release, but may block
-the release of 5.2.
+*** [DONE] Finish items marked with "@c PRE5_2" in the documentation.
 
 *** Update NEWS for changes since 5.1.4.
 
@@ -45,7 +48,7 @@ overridden, so this solution should be OK to install in Emacs.
 *** Make a tarball with the modules that weren't included with
 Emacs 22 that can be downloaded from GNU's ftp server.
 
-* 5.1 release
+* 5.1 release (old)
 
 ** [DONE] Documentation
 
diff --git a/erc.texi b/erc.texi
index d098782..ae5d85d 100644
--- a/erc.texi
+++ b/erc.texi
@@ -81,9 +81,8 @@ Getting Started
 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.
+* Options::                     Options that are available for ERC.
 
 @end detailmenu
 @end menu
@@ -300,7 +299,9 @@ you want, do @kbd{M-x customize-variable RET erc-modules 
RET}.
 @section Sample Session
 
 This is an example ERC session which shows how to connect to the #emacs
-channel on Freenode.
+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.
 
 @itemize @bullet
 
@@ -650,7 +651,7 @@ Translate morse code in messages
 
 @end table
 
address@hidden PRE5_2: Document every option of every module in its own subnode
address@hidden PRE5_3: Document every option of every module in its own subnode
 
 
 @node Advanced Usage, Getting Help and Reporting Bugs, Modules, Top
@@ -660,12 +661,11 @@ Translate morse code in messages
 
 @menu
 * 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.
+* Options::                     Options that are available for ERC.
 @end menu
 
address@hidden Connecting, Options, Advanced Usage, Advanced Usage
address@hidden Connecting, Sample Configuration, Advanced Usage, Advanced Usage
 @comment  node-name,  next,  previous,  up
 @section Connecting to an IRC Server
 @cindex connecting
@@ -799,33 +799,100 @@ User full name.
 This can be either a string or a function to call.
 @end defopt
 
address@hidden Options, Tips and Tricks, Connecting, Advanced Usage
address@hidden Sample Configuration, Options, Connecting, Advanced Usage
 @comment  node-name,  next,  previous,  up
address@hidden Options
address@hidden options
address@hidden Sample Configuration
address@hidden configuration, sample
 
address@hidden PRE5_2: (Node) Document every ERC option (module options go in
address@hidden previous chapter)
+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}.
 
-This section has not yet been written.
address@hidden
+;;; Sample ERC configuration
 
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
+;; The code in this section (Sample Configuration) may be used,
+;; distributed, and modified without restriction.
 
address@hidden PRE5_2: (Node) Tips and tricks
+;; 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")
 
-This section has not yet been written.
+;; Load ERC
+(require 'erc)
 
address@hidden Sample Configuration, , Tips and Tricks, Advanced Usage
+;; 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
 @comment  node-name,  next,  previous,  up
address@hidden Sample Configuration
address@hidden configuration, sample
address@hidden Options
address@hidden options
 
address@hidden PRE5_2: (Node) Sample configs
address@hidden PRE5_3: (Node) Document every ERC option (module options go in
address@hidden previous chapter)
 
-This section has not yet been written.
+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}.
 
 
 @node Getting Help and Reporting Bugs, History, Advanced Usage, Top