[Emacs-diffs] trunk r118025: Updating ERC documentation

[Kelvin White]

------------------------------------------------------------
revno: 118025
revision-id: address@hidden
parent: address@hidden
committer: Kelvin White <address@hidden>
branch nick: trunk
timestamp: Fri 2014-10-03 08:13:31 -0400
message:
  Updating ERC documentation
modified:
  doc/misc/ChangeLog             changelog-20091113204419-o5vbwnq5f7feedwu-6331
  doc/misc/erc.texi              erc.texi-20091113204419-o5vbwnq5f7feedwu-6298

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2014-09-26 00:15:21 +0000
+++ b/doc/misc/ChangeLog        2014-10-03 12:13:31 +0000
@@ -1,3 +1,8 @@
+2014-10-03  Kelvin White  <address@hidden>
+
+       * erc.texi (Advanced Usage, Options): Add descriptions and examples
+       for erc-format-nick-function and erc-rename-buffers options.
+
 2014-09-26  Leo Liu  <address@hidden>
 
        * cl.texi (Predicates on Numbers): Document cl-digit-char-p.

=== modified file 'doc/misc/erc.texi'
--- a/doc/misc/erc.texi 2014-06-10 02:20:31 +0000
+++ b/doc/misc/erc.texi 2014-10-03 12:13:31 +0000
@@ -588,6 +588,16 @@
 other nicks are tried in the list order.
 @end defopt
 
address@hidden erc-format-nick-function
+A function to format a nickname for message display
+
+You can set this to @address@hidden@nick} to display user mode prefix
address@hidden defopt
+
address@hidden
+(setq erc-format-nick-function 'erc-format-@@nick)
address@hidden example
+
 @defopt erc-nick-uniquifier
 The string to append to the nick if it is already in use.
 @end defopt
@@ -661,7 +671,8 @@
 ;; using the version of ERC that comes with Emacs
 (add-to-list 'load-path "~/elisp/erc")
 
-;; Load ERC
+;; Load ERC -- again, you don't need this if you are using the version
+;; of ERC that comes with Emacs
 (require 'erc)
 
 ;; Load authentication info from an external source.  Put sensitive
@@ -712,6 +723,12 @@
 ;; Join the #emacs and #erc channels whenever connecting to Freenode.
 (setq erc-autojoin-channels-alist '(("freenode.net" "#emacs" "#erc")))
 
+;; Rename server buffers to reflect the current network name instead
+;; of IP:PORT. (e.g. "freenode" instead of "84.240.3.129:6667"). This
+;; is useful when using a bouncer like ZNC where you have multiple
+;; connections to the same server.
+(setq erc-rename-buffers t)
+
 ;; Interpret mIRC-style color commands in IRC chats
 (setq erc-interpret-mirc-color t)
 
@@ -750,6 +767,14 @@
 nickname is considered a lurker.
 @end defopt
 
address@hidden erc-rename-buffers
+If non, @code{nil}, this will rename server buffers to reflect the
+current network name instead of IP:PORT
+
address@hidden
+(setq erc-rename-buffers t)
address@hidden example
address@hidden defopt
 
 @node Getting Help and Reporting Bugs
 @chapter Getting Help and Reporting Bugs