]> code.delx.au - gnu-emacs/blobdiff - doc/misc/erc.texi
Add doclicense.texi dependency for doc/misc/Makefile targets
[gnu-emacs] / doc / misc / erc.texi
index ea315cd86fad24ab225dafd374c78ec92b7fcaa2..569750bd1e5906b7526545e5d2f6b38a2d149a0a 100644 (file)
@@ -9,7 +9,7 @@
 @copying
 This manual is for ERC as distributed with Emacs @value{EMACSVER}.
 
-Copyright @copyright{} 2005-2012 Free Software Foundation, Inc.
+Copyright @copyright{} 2005--2012 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -20,8 +20,7 @@ and with the Back-Cover Texts as in (a) below.  A copy of the license
 is included in the section entitled ``GNU Free Documentation License''.
 
 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual.  Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
 
 All Emacs Lisp code contained in this document may be used, distributed,
 and modified without restriction.
@@ -60,12 +59,8 @@ and modified without restriction.
 * Keystroke Summary::           Keystrokes used in ERC buffers.
 * Modules::                     Available modules for ERC.
 * Advanced Usage::              Cool ways of using ERC.
-* Getting Help and Reporting Bugs::  
+* Getting Help and Reporting Bugs::
 * History::                     The history of ERC.
-* Copying::                     The GNU General Public License gives you
-                                  permission to redistribute ERC on
-                                  certain terms; it also explains that
-                                  there is no warranty.
 * GNU Free Documentation License::  The license for this documentation.
 * Concept Index::               Search for terms.
 
@@ -246,7 +241,7 @@ translation effort.
 
 @item user scripting
 
-Users can load scripts (e.g. auto greeting scripts) when ERC starts up.
+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
@@ -503,7 +498,7 @@ If you want to assign this function to a keystroke, the following will
 help you figure out its parameters.
 
 @defun erc
-Select connection parameters and run ERC.
+Select connection parameters and run ERC@.
 Non-interactively, it takes the following keyword arguments.
 
 @itemize @bullet
@@ -530,7 +525,7 @@ parameters.
 @defun erc-compute-server &optional server
 Return an IRC server name.
 
-This tries a number of increasingly more default methods until a non-nil
+This tries a number of increasingly more default methods until a non-@code{nil}
 value is found.
 
 @itemize @bullet
@@ -542,7 +537,7 @@ value is found.
 
 @end defun
 
-@defopt erc-server nil
+@defopt erc-server
 IRC server to use if one is not provided.
 @end defopt
 
@@ -551,7 +546,7 @@ IRC server to use if one is not provided.
 @defun 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
+This tries a number of increasingly more default methods until a non-@code{nil}
 value is found.
 
 @itemize @bullet
@@ -574,7 +569,7 @@ This can be either a string or a number.
 Return user's IRC nick.
 
 This tries a number of increasingly more default methods until a
-non-nil value is found.
+non-@code{nil} value is found.
 
 @itemize
 @item @var{nick} (the argument passed to this function)
@@ -598,7 +593,7 @@ The string to append to the nick if it is already in use.
 @end defopt
 
 @defopt erc-try-new-nick-p
-If the nickname you chose isn't available, and this option is non-nil,
+If the nickname you chose isn't available, and this option is non-@code{nil},
 ERC should automatically attempt to connect with another nickname.
 
 You can manually set another nickname with the /NICK command.
@@ -634,7 +629,7 @@ For more details, @pxref{Top,,auth-source, auth, Emacs auth-source Library}.
 Return user's full name.
 
 This tries a number of increasingly more default methods until a
-non-nil value is found.
+non-@code{nil} value is found.
 
 @itemize @bullet
 @item @var{full-name} (the argument passed to this function)
@@ -655,7 +650,7 @@ This can be either a string or a function to call.
 @section Sample Configuration
 @cindex configuration, sample
 
-Here is an example of configuration settings for ERC.  This can go into
+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}.
 
@@ -706,7 +701,7 @@ stuff, to the current ERC buffer."
                            (erc :server "localhost" :port "6667"
                                 :nick "MYNICK")))
 
-;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has
+;; 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)
@@ -737,10 +732,24 @@ stuff, to the current ERC buffer."
 @c PRE5_4: (Node) Document every ERC option (module options go in
 @c previous chapter)
 
-This section has not yet been written.  For now, the easiest way to
-check out the available options for ERC is to do
+This section is extremely incomplete.  For now, the easiest way to
+check out all the available options for ERC is to do
 @kbd{M-x customize-group erc RET}.
 
+@defopt erc-hide-list
+If non, @code{nil}, this is a list of IRC message types to hide, e.g.:
+
+@example
+(setq erc-hide-list '("JOIN" "PART" "QUIT"))
+@end example
+@end defopt
+
+@defopt erc-lurker-hide-list
+Like @code{erc-hide-list}, but only applies to messages sent by
+lurkers.  The function @code{erc-lurker-p} determines whether a given
+nickname is considerd a lurker.
+@end defopt
+
 
 @node Getting Help and Reporting Bugs
 @chapter Getting Help and Reporting Bugs
@@ -754,7 +763,7 @@ or if you have bugs to report, there are several places you can go.
 
 @item
 @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the
-emacswiki.org page for ERC.  Anyone may add tips, hints, etc. to it.
+emacswiki.org page for ERC@.  Anyone may add tips, hints, etc. to it.
 
 @item
 You can ask questions about using ERC on the Emacs mailing list,
@@ -841,10 +850,6 @@ is maintained as part of Emacs.
 
 @end itemize
 
-@node Copying
-@appendix GNU GENERAL PUBLIC LICENSE
-@include gpl.texi
-
 @node GNU Free Documentation License
 @appendix GNU Free Documentation License
 @include doclicense.texi