*** empty log message ***
[emacs.git] / man / erc.texi
blobd8ae4157a4724f595536cd9bb95fb335a021a76e
1 \input texinfo
2 @c %**start of header
3 @setfilename ../info/erc
4 @settitle ERC Manual
5 @c %**end of header
7 @dircategory Emacs
8 @direntry
9 * ERC: (erc).           Powerful, modular, and extensible IRC client for Emacs.
10 @end direntry
12 @syncodeindex fn cp
14 @copying
15 This manual is for ERC version 5.2 stable pre-release.
17 Copyright @copyright{} 2005, 2006 Free Software Foundation, Inc.
19 @quotation
20 Permission is granted to copy, distribute and/or modify this document
21 under the terms of the GNU Free Documentation License, Version 1.2 or
22 any later version published by the Free Software Foundation; with no
23 Invariant Sections, Front-Cover texts, or Back-Cover Texts.
24 @end quotation
25 @end copying
27 @titlepage
28 @title ERC manual
29 @subtitle a full-featured IRC client
30 @subtitle for GNU Emacs and XEmacs
32 @c The following two commands
33 @c start the copyright page.
34 @page
35 @vskip 0pt plus 1filll
36 @insertcopying
37 @end titlepage
39 @c So the toc is printed at the start
40 @contents
42 @ifnottex
43 @node Top, Introduction, (dir), (dir)
44 @comment  node-name,  next,  previous,  up
45 @top ERC
47 @insertcopying
48 @end ifnottex
50 @menu
51 * Introduction::                What is ERC?
52 * Obtaining ERC::               How to get ERC releases and development
53                                   versions.
54 * Installation::                Compiling and installing ERC.
55 * Getting Started::             Quick Start guide to using ERC.
56 * Keystroke Summary::           Keystrokes used in ERC buffers.
57 * Modules::                     Available modules for ERC.
58 * Advanced Usage::              Cool ways of using ERC.
59 * Getting Help and Reporting Bugs::  
60 * History::                     The history of ERC.
61 * Concept Index::               Search for terms.
63 @detailmenu
64  --- The Detailed Node Listing ---
66 Obtaining ERC
68 * Releases::                    Released versions of ERC.
69 * Development::                 Latest unreleased development changes.
71 Advanced Usage
73 * Connecting::                  Ways of connecting to an IRC server.
74 * Options::                     Options that are available for ERC.
75 * Tips and Tricks::             Ways of enhancing your ERC experience.
76 * Sample Configuration::        An example configuration file.
78 @end detailmenu
79 @end menu
81 @node Introduction, Obtaining ERC, Top, Top
82 @comment  node-name,  next,  previous,  up
83 @chapter Introduction
85 ERC is a powerful, modular, and extensible IRC client for Emacs.
87 It comes with the following capabilities enabled by default.
89 @itemize @bullet
90 @item Flood control
91 @item Timestamps
92 @item Join channels automatically
93 @item Buttonize URLs, nicknames, and other text
94 @item Wrap long lines
95 @item Highlight or remove IRC control characters
96 @item Highlight pals, fools, and other keywords
97 @item Detect netsplits
98 @item Complete nicknames and commands in a programmable fashion
99 @item Make displayed lines read-only
100 @item Input history
101 @item Track channel activity in the mode-line
103 @end itemize
105 @node Obtaining ERC, Installation, Introduction, Top
106 @comment  node-name,  next,  previous,  up
107 @chapter Obtaining ERC
109 @menu
110 * Releases::                    Released versions of ERC.
111 * Development::                 Latest unreleased development changes.
112 @end menu
114 These sections may be skipped if you are using the version of ERC that
115 comes with Emacs.
117 @node Releases, Development, Obtaining ERC, Obtaining ERC
118 @comment  node-name,  next,  previous,  up
119 @section Releases
121 Choose to install a release if you want to minimize risk.
123 Errors are corrected in development first.  User-visible changes will be
124 announced on the @email{erc-discuss@@gnu.org} mailing list.
125 @pxref{Getting Help and Reporting Bugs}.
127 @cindex releases, Debian package
128 @cindex Debian package for ERC
129 Debian users can get ERC via apt-get.  The @file{erc} package is
130 available in the official Debian repository.
132 @cindex releases, from source
133 Alternatively, you can download the latest release from
134 @uref{http://ftp.gnu.org/gnu/erc}.
136 @node Development,  , Releases, Obtaining ERC
137 @comment  node-name,  next,  previous,  up
138 @section Development
139 @cindex development
141 Choose the development version if you want to live on the bleeding edge
142 of ERC development or try out new features before release.
144 @subheading GNU Arch
146 ERC is developed using GNU Arch.  Downloading ERC with Arch and staying
147 up-to-date involves the following steps.
149 @enumerate
150 @cindex GNU Arch, installing
151 @item Install arch
153 @itemize @bullet
154 @item Debian: @kbd{apt-get install tla}.
155 @item Other distributions: see @uref{ftp://ftp.gnu.org/gnu/gnu-arch/}.
156 @end itemize
158 @cindex GNU Arch, downloading ERC
159 @item Register the archive.
160 @example
161 tla register-archive -f http://arch.sv.gnu.org/archives/erc/erc
162 @end example
164 @item Download the ERC source code.
165 @example
166 # Download ERC into the @file{erc} directory.
167 tla get erc@@sv.gnu.org/erc--main--0 erc
168 @end example
170 @item List upstream changes that are missing from your local copy.
171 Do this whenever you want to see whether new changes have been committed
172 to ERC.
174 @example
175 # Change to the source directory you are interested in.
176 cd erc/
178 # Display the summary of changes
179 tla missing --summary
180 @end example
182 @cindex GNU Arch, updating ERC
183 @item Update to the latest version by replaying missing changes.
184 @example
185 cd erc
186 tla update
187 @end example
189 @end enumerate
191 If you are new to Arch and want to learn more about developing with it,
192 you might find this tutorial helpful:
193 @uref{http://www.mwolson.org/projects/ArchTutorial.html}.
195 @subheading Development snapshots
197 @cindex development snapshot
198 Alternatively, the latest development snapshot may be downloaded in both
199 ``.tar.gz'' and ``.zip'' forms.
201 @itemize @bullet
202 @item @uref{http://www.mwolson.org/static/dist/erc-latest.tar.gz}
203 @item @uref{http://www.mwolson.org/static/dist/erc-latest.zip}
204 @end itemize
207 @node Installation, Getting Started, Obtaining ERC, Top
208 @comment  node-name,  next,  previous,  up
209 @chapter Installation
211 ERC may be compiled and installed on your machine.
213 This section may be skipped if you are using the version of ERC that
214 comes with Emacs.
216 @subsubheading Compilation
218 This is an optional step, since Emacs Lisp source code does not
219 necessarily have to be byte-compiled.  It will yield a speed increase,
220 though.
222 A working copy of Emacs or XEmacs is needed in order to compile ERC.  By
223 default, the program that is installed with the name @command{emacs}
224 will be used.
226 If you want to use the @command{xemacs} binary to perform the
227 compilation, you would need to edit @file{Makefile} in the top-level
228 directory as follows.  You can put either a full path to an Emacs or
229 XEmacs binary or just the command name, as long as it is in the
230 @env{PATH}.
232 @example
233 EMACS    = xemacs
234 SITEFLAG = -no-site-file
235 @end example
237 Running @code{make} should compile the ERC source files in the
238 @file{lisp} directory.
240 @subsubheading Installation
242 ERC may be installed into your file hierarchy by doing the following.
244 Edit the @file{Makefile} file so that @env{ELISPDIR} points to where you
245 want the source and compiled ERC files to be installed and
246 @env{INFODIR} indicates where to put the ERC manual.  Of course, you
247 will want to edit @env{EMACS} and @env{SITEFLAG} as shown in the
248 Compilation section if you are using XEmacs.
250 If you are installing ERC on a Debian system, you might want to change
251 the value of @env{INSTALLINFO} as specified in @file{Makefile}.
253 Run @code{make} as a normal user.
255 Run @code{make install} as the root user if you have chosen installation
256 locations that require this.
259 @node Getting Started, Keystroke Summary, Installation, Top
260 @comment  node-name,  next,  previous,  up
261 @chapter Getting Started
262 @cindex settings
264 @c PRE5_2: Mention .ercrc.el
266 To use ERC, add the directory containing its files to your
267 @code{load-path} variable, in your @file{.emacs} file.  Then, load ERC
268 itself.  An example follows.
270 @lisp
271 (require 'erc)
272 @end lisp
274 Once ERC is loaded, the command @kbd{M-x erc} will start ERC and
275 prompt for the server to connect to.
277 @c PRE5_2: Sample session, including:
278 @c - connect to Freenode
279 @c - /join #emacs
280 @c - see messages flying past, point out topic lines, messages, channel
281 @c   members
282 @c - identifying your nick with NickServ (most IRC servers have this)
283 @c - talking to the channel
284 @c - open a /query buffer to talk to someone (must identify first in
285 @c   FreeNode)
288 @node Keystroke Summary, Modules, Getting Started, Top
289 @comment  node-name,  next,  previous,  up
290 @chapter Keys Used in ERC
291 @cindex keystrokes
293 This is a summary of keystrokes available in every ERC buffer.
295 @table @kbd
297 @item C-a or <home> (`erc-bol')
298 Go to beginning of line or end of prompt.
300 @item RET (`erc-send-current-line')
301 Send the current line
303 @item TAB (`erc-complete-word')
304 If at prompt, complete the current word.
305 Otherwise, move to the next link or button.
307 @item M-TAB (`ispell-complete-word')
308 Complete the given word, using ispell.
310 @item C-c C-a (`erc-bol')
311 Go to beginning of line or end of prompt.
313 @item C-c C-b (`erc-iswitchb')
314 Use `iswitchb-read-buffer' to prompt for a ERC buffer to switch to.
316 @item C-c C-c (`erc-toggle-interpret-controls')
317 Toggle interpretation of control sequences in messages.
319 @item C-c C-d (`erc-input-action')
320 Interactively input a user action and send it to IRC.
322 @item C-c C-e (`erc-toggle-ctcp-autoresponse')
323 Toggle automatic CTCP replies (like VERSION and PING).
325 @item C-c C-f (`erc-toggle-flood-control')
326 Toggle use of flood control on sent messages.
328 @item C-c TAB (`erc-invite-only-mode')
329 Turn on the invite only mode (+i) for the current channel.
331 @item C-c C-j (`erc-join-channel')
332 Join channel.  If point is at the beginning of a channel name, use that
333 as default.
335 @item C-c C-k (`erc-go-to-log-matches-buffer')
336 Interactively open an erc-log-matches buffer
338 @item C-c C-l (`erc-save-buffer-in-logs')
339 Append buffer contents to the log file, if logging is enabled.
341 @item C-c C-n (`erc-channel-names')
342 Run "/names #channel" in the current channel.
344 @item C-c C-o (`erc-get-channel-mode-from-keypress')
345 Read a key sequence and call the corresponding channel mode function.
346 After doing @kbd{C-c C-o}, type in a channel mode letter.
348 @kbd{C-g} means quit.
349 @kbd{RET} lets you type more than one mode at a time.
350 If @kbd{l} is pressed, @code{erc-set-channel-limit} gets called.
351 If @kbd{k} is pressed, @code{erc-set-channel-key} gets called.
352 Anything else will be sent to `erc-toggle-channel-mode'.
354 @item C-c C-p (`erc-part-from-channel')
355 Part from the current channel and prompt for a reason.
357 @item C-c C-q (`erc-quit-server')
358 Disconnect from current server after prompting for reason.
360 @item C-c C-r (`erc-remove-text-properties-region')
361 Clears the region (start,end) in object from all colors, etc.
363 @item C-c C-t (`erc-set-topic')
364 Prompt for a topic for the current channel.
366 @item C-c C-u (`erc-kill-input')
367 Kill current input line using `erc-bol' followed by `kill-line'.
369 @end table
372 @node Modules, Advanced Usage, Keystroke Summary, Top
373 @comment  node-name,  next,  previous,  up
374 @chapter Modules
375 @cindex modules
377 One way to add functionality to ERC is to customize which of its many
378 modules are loaded.
380 There is a spiffy customize interface, which may be reached by typing
381 @kbd{M-x customize-option erc-modules RET}.  Alternatively, set
382 @code{erc-modules} manually and then call @code{erc-update-modules}.
384 The following is a list of available modules.
386 @table @code
388 @cindex modules, autoaway
389 @item autoaway
390 Set away status automatically
392 @cindex modules, autojoin
393 @item autojoin
394 Join channels automatically
396 @cindex modules, bbdb
397 @item bbdb
398 Integrate with the Big Brother Database
400 @cindex modules, button
401 @item button
402 Buttonize URLs, nicknames, and other text
404 @cindex modules, completion
405 @item pcomplete
406 Complete nicknames and commands (programmable)
408 @cindex modules, fill
409 @item fill
410 Wrap long lines
412 @cindex modules, hecomplete
413 @item completion
414 Complete nicknames and commands (old).  This is the old module---you
415 might prefer the ``completion'' module instead.
417 @cindex modules, identd
418 @item identd
419 Launch an identd server on port 8113
421 @cindex modules, irccontrols
422 @item irccontrols
423 Highlight or remove IRC control characters
425 @cindex modules, log
426 @item log
427 Save buffers in logs
429 @cindex modules, match
430 @item match
431 Highlight pals, fools, and other keywords
433 @cindex modules, netsplit
434 @item netsplit
435 Detect netsplits
437 @cindex modules, noncommands
438 @item noncommands
439 Don't display non-IRC commands after evaluation
441 @cindex modules, notify
442 @item notify
443 Notify when the online status of certain users changes
445 @cindex modules, page
446 @item page
447 Process CTCP PAGE requests from IRC
449 @cindex modules, readonly
450 @item readonly
451 Make displayed lines read-only
453 @cindex modules, replace
454 @item replace
455 Replace text in messages
457 @cindex modules, ring
458 @item ring
459 Enable an input history
461 @cindex modules, scrolltobottom
462 @item scrolltobottom
463 Scroll to the bottom of the buffer
465 @cindex modules, services
466 @item services
467 Identify to Nickserv (IRC Services) automatically
469 @cindex modules, smiley
470 @item smiley
471 Convert smileys to pretty icons
473 @cindex modules, sound
474 @item sound
475 Play sounds when you receive CTCP SOUND requests
477 @cindex modules, spelling
478 @item spelling
479 Check spelling of messages
481 @cindex modules, stamp
482 @item stamp
483 Add timestamps to messages
485 @cindex modules, track
486 @item track
487 Track channel activity in the mode-line
489 @cindex modules, truncate
490 @item truncate
491 Truncate buffers to a certain size
493 @cindex modules, unmorse
494 @item unmorse
495 Translate morse code in messages
497 @end table
499 @c PRE5_2: Document every option of every module in its own subnode
502 @node Advanced Usage, Getting Help and Reporting Bugs, Modules, Top
503 @comment  node-name,  next,  previous,  up
504 @chapter Advanced Usage
505 @cindex advanced topics
507 @menu
508 * Connecting::                  Ways of connecting to an IRC server.
509 * Options::                     Options that are available for ERC.
510 * Tips and Tricks::             Ways of enhancing your ERC experience.
511 * Sample Configuration::        An example configuration file.
512 @end menu
514 @node Connecting, Options, Advanced Usage, Advanced Usage
515 @comment  node-name,  next,  previous,  up
516 @section Connecting to an IRC Server
517 @cindex connecting
519 The easiest way to connect to an IRC server is to call @kbd{M-x erc}.
520 If you want to assign this function to a keystroke, the following will
521 help you figure out its parameters.
523 @defun erc
524 Select connection parameters and run ERC.
525 Non-interactively, it takes the following keyword arguments.
527 @itemize @bullet
528 @item @var{server}
529 @item @var{port}
530 @item @var{nick}
531 @item @var{password}
532 @item @var{full-name}
533 @end itemize
535 That is, if called with the following arguments, @var{server} and
536 @var{full-name} will be set to those values, whereas
537 @code{erc-compute-port}, @code{erc-compute-nick} and
538 @code{erc-compute-full-name} will be invoked for the values of the other
539 parameters.
541 @example
542 (erc :server "irc.freenode.net" :full-name "Harry S Truman")
543 @end example
544 @end defun
546 @subheading Server
548 @defun erc-compute-server &optional server
549 Return an IRC server name.
551 This tries a number of increasingly more default methods until a non-nil
552 value is found.
554 @itemize @bullet
555 @item @var{server} (the argument passed to this function)
556 @item The @code{erc-server} option
557 @item The value of the IRCSERVER environment variable
558 @item The @code{erc-default-server} variable
559 @end itemize
561 @end defun
563 @defopt erc-server nil
564 IRC server to use if one is not provided.
565 @end defopt
567 @subheading Port
569 @defun erc-compute-port &optional port
570 Return a port for an IRC server.
572 This tries a number of increasingly more default methods until a non-nil
573 value is found.
575 @itemize @bullet
576 @item @var{port} (the argument passed to this function)
577 @item The @code{erc-port} option
578 @item The @code{erc-default-port} variable
579 @end itemize
581 @end defun
583 @defopt erc-port
584 IRC port to use if not specified.
586 This can be either a string or a number.
587 @end defopt
589 @subheading Nick
591 @defun erc-compute-nick &optional nick
592 Return user's IRC nick.
594 This tries a number of increasingly more default methods until a
595 non-nil value is found.
597 @itemize
598 @item @var{nick} (the argument passed to this function)
599 @item The @code{erc-nick} option
600 @item The value of the IRCNICK environment variable
601 @item The result from the @code{user-login-name} function
602 @end itemize
604 @end defun
606 @defopt erc-nick
607 Nickname to use if one is not provided.
609 This can be either a string, or a list of strings.
610 In the latter case, if the first nick in the list is already in use,
611 other nicks are tried in the list order.
612 @end defopt
614 @defopt erc-nick-uniquifier
615 The string to append to the nick if it is already in use.
616 @end defopt
618 @defopt erc-try-new-nick-p
619 If the nickname you chose isn't available, and this option is non-nil,
620 ERC should automatically attempt to connect with another nickname.
622 You can manually set another nickname with the /NICK command.
623 @end defopt
625 @subheading Full name
627 @defun erc-compute-full-name &optional full-name
628 Return user's full name.
630 This tries a number of increasingly more default methods until a
631 non-nil value is found.
633 @itemize @bullet
634 @item @var{full-name} (the argument passed to this function)
635 @item The @code{erc-user-full-name} option
636 @item The value of the IRCNAME environment variable
637 @item The result from the @code{user-full-name} function
638 @end itemize
640 @end defun
642 @defopt erc-user-full-name
643 User full name.
645 This can be either a string or a function to call.
646 @end defopt
648 @node Options, Tips and Tricks, Connecting, Advanced Usage
649 @comment  node-name,  next,  previous,  up
650 @section Options
651 @cindex options
653 @c PRE5_2: (Node) Document every ERC option (module options go in
654 @c previous chapter)
656 This section has not yet been written.
658 @node Tips and Tricks, Sample Configuration, Options, Advanced Usage
659 @comment  node-name,  next,  previous,  up
660 @section Tips and Tricks
661 @cindex tips and tricks
663 @c PRE5_2: (Node) Tips and tricks
665 This section has not yet been written.
667 @node Sample Configuration, , Tips and Tricks, Advanced Usage
668 @comment  node-name,  next,  previous,  up
669 @section Sample Configuration
670 @cindex configuration, sample
672 @c PRE5_2: (Node) Sample configs
674 This section has not yet been written.
677 @node Getting Help and Reporting Bugs, History, Advanced Usage, Top
678 @comment  node-name,  next,  previous,  up
679 @chapter Getting Help and Reporting Bugs
680 @cindex help, getting
681 @cindex bugs, reporting
683 After you have read this guide, if you still have questions about ERC,
684 or if you have bugs to report, there are several places you can go.
686 @itemize @bullet
688 @item
689 @uref{http://www.emacswiki.org/cgi-bin/wiki/EmacsIRCClient} is the
690 emacswiki.org page for ERC.  Anyone may add tips, hints, or bug
691 descriptions to it.
693 @item
694 There are several mailing lists for ERC.  To subscribe, visit
695 @uref{http://savannah.gnu.org/mail/?group=erc}.
697 The mailing lists are also available on Gmane.
698 (@url{http://gmane.org/}).  Gmane provides additional methods for
699 accessing the mailing lists, adding content to them, and searching them.
701 @enumerate
702 @item gmane.emacs.erc.announce
703 Announcements
705 @item gmane.emacs.erc.discuss
706 General discussion
708 @item gmane.emacs.erc.cvs
709 Log messages for changes to the ERC source code
711 @end enumerate
713 @item
714 You can visit the IRC Freenode channel @samp{#emacs}. Many of the
715 contributors are frequently around and willing to answer your
716 questions.
718 @end itemize
721 @node History, Concept Index, Getting Help and Reporting Bugs, Top
722 @comment  node-name,  next,  previous,  up
723 @chapter History
724 @cindex history, of ERC
726 ERC was originally written by Alexander L. Belikoff
727 @email{abel@@bfr.co.il} and Sergey Berezin
728 @email{sergey.berezin@@cs.cmu.edu}.  They stopped development around
729 December 1999.  Their last released version was ERC 2.0.
731 P.S.: If one of the original developers of ERC reads this, we'd like to
732 receive additional information for this file and hear comments in
733 general.
735 @itemize
736 @item 2001
738 In June 2001, Mario Lang @email{mlang@@delysid.org} and Alex Schroeder
739 @email{alex@@gnu.org} took over development and created a ERC Project at
740 @uref{http://sourceforge.net/projects/erc}.
742 In reaction to a mail about the new ERC development effort, Sergey
743 Berezin said, ``First of all, I'm glad that my version of ERC is being
744 used out there.  The thing is, I do not have free time and enough
745 incentive anymore to work on ERC, so I would be happy if you guys take
746 over the project entirely.''
748 So we happily hacked away on ERC, and soon after (September 2001)
749 released the next "stable" version, 2.1.
751 Most of the development of the new ERC happened on #emacs on
752 irc.openprojects.net.  Over time, many people contributed code, ideas,
753 bugfixes, and a lot of alpha/beta/gamma testing.
755 See the @file{CREDITS} file for a list of contributors.
757 @item 2003
759 ERC 3.0 was released.
761 @item 2004
763 ERC 4.0 was released.
765 @item 2005
767 ERC 5.0 was released.  Michael Olson @email{mwolson@@gnu.org} became
768 the release manager and eventually the maintainer.
770 After some discussion between him and the Emacs developers, it was
771 decided to include ERC in Emacs.
773 @item 2006
775 ERC 5.1 was released.  It was subsequently included in Emacs 22.
777 ERC became an official GNU project, and development moved to
778 @uref{http://sv.gnu.org/projects/erc}.  We switched to using GNU Arch as
779 our revision control system.  Our mailing list address changed as well.
781 @end itemize
783 @node Concept Index,  , History, Top
784 @comment  node-name,  next,  previous,  up
785 @unnumbered Index
787 @printindex cp
789 @bye
791 @ignore
792    arch-tag: cf9cfaff-fc12-4297-ad15-ec2493002b1e
793 @end ignore