@copying
This manual is for ERC as distributed with Emacs @value{EMACSVER}.
-Copyright @copyright{} 2005-2012 Free Software Foundation, Inc.
+Copyright @copyright{} 2005--2013 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
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.
* 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.
@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
@item fill
Wrap long lines
-@cindex modules, hecomplete
-@item hecomplete
-Complete nicknames and commands (old). This is the old module---you
-might prefer the ``completion'' module instead.
-
@cindex modules, identd
@item identd
Launch an identd server on port 8113
@item notify
Notify when the online status of certain users changes
+@cindex modules, notifications
+@item notifications
+Send you a notification when you get a private message,
+or your nickname is mentioned
+
@cindex modules, page
@item page
Process CTCP PAGE requests from IRC
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
@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
@end defun
-@defopt erc-server nil
+@defopt erc-server
IRC server to use if one is not provided.
@end defopt
@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
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)
@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.
@end defopt
+@subheading Password
+@cindex password
+
+@defopt erc-prompt-for-password
+If non-@code{nil} (the default), @kbd{M-x erc} prompts for a password.
+@end defopt
+
+If you prefer, you can set this option to @code{nil} and use the
+@code{auth-source} mechanism to store your password. For instance, if
+you use @file{~/.authinfo} as your auth-source backend, then put
+something like the following in that file:
+
+@example
+machine irc.example.net login "#fsf" password sEcReT
+@end example
+
+@noindent
+ERC also consults @code{auth-source} to find any channel keys required
+for the channels that you wish to autojoin, as specified by the
+variable @code{erc-autojoin-channels-alist}.
+
+For more details, @pxref{Top,,auth-source, auth, Emacs auth-source Library}.
+
+
@subheading Full name
@defun 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.
+non-@code{nil} value is found.
@itemize @bullet
@item @var{full-name} (the argument passed to this function)
@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}.
(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)
@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 considered a lurker.
+@end defopt
+
@node Getting Help and Reporting Bugs
@chapter Getting Help and Reporting Bugs
@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,
@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