Mercurial > emacs
annotate doc/misc/erc.texi @ 91688:dc73ee82d684
(rcirc-omit-mode): Suppress invisibility ellipsis
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-1061
author | Miles Bader <miles@gnu.org> |
---|---|
date | Sat, 09 Feb 2008 03:52:59 +0000 |
parents | 7b54e553ca0b |
children | 6f0fce2c3559 |
rev | line source |
---|---|
84293 | 1 \input texinfo |
2 @c %**start of header | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84293
diff
changeset
|
3 @setfilename ../../info/erc |
84293 | 4 @settitle ERC Manual |
5 @c %**end of header | |
6 | |
7 @dircategory Emacs | |
8 @direntry | |
9 * ERC: (erc). Powerful, modular, and extensible IRC client for Emacs. | |
10 @end direntry | |
11 | |
12 @syncodeindex fn cp | |
13 | |
14 @copying | |
88015 | 15 This manual is for ERC version 5.3. |
84293 | 16 |
87903 | 17 Copyright @copyright{} 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
84293 | 18 |
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. A copy of | |
24 the license is included in the section entitled ``GNU Free | |
25 Documentation License'' in the Emacs manual. | |
26 | |
27 This document is part of a collection distributed under the GNU Free | |
28 Documentation License. If you want to distribute this document | |
29 separately from the collection, you can do so by adding a copy of the | |
30 license to the document, as described in section 6 of the license. | |
31 | |
32 All Emacs Lisp code contained in this document may be used, distributed, | |
33 and modified without restriction. | |
34 @end quotation | |
35 @end copying | |
36 | |
37 @titlepage | |
38 @title ERC manual | |
39 @subtitle a full-featured IRC client | |
40 @subtitle for GNU Emacs and XEmacs | |
41 | |
42 @c The following two commands | |
43 @c start the copyright page. | |
44 @page | |
45 @vskip 0pt plus 1filll | |
46 @insertcopying | |
47 @end titlepage | |
48 | |
49 @c So the toc is printed at the start | |
50 @contents | |
51 | |
52 @ifnottex | |
53 @node Top, Introduction, (dir), (dir) | |
54 @comment node-name, next, previous, up | |
55 @top ERC | |
56 | |
57 @insertcopying | |
58 @end ifnottex | |
59 | |
60 @menu | |
61 * Introduction:: What is ERC? | |
62 * Obtaining ERC:: How to get ERC releases and development | |
63 versions. | |
64 * Installation:: Compiling and installing ERC. | |
65 * Getting Started:: Quick Start guide to using ERC. | |
66 * Keystroke Summary:: Keystrokes used in ERC buffers. | |
67 * Modules:: Available modules for ERC. | |
68 * Advanced Usage:: Cool ways of using ERC. | |
69 * Getting Help and Reporting Bugs:: | |
70 * History:: The history of ERC. | |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
71 * Copying:: The GNU General Public License gives you |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
72 permission to redistribute ERC on |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
73 certain terms; it also explains that |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
74 there is no warranty. |
88015 | 75 * GNU Free Documentation License:: The license for this documentation. |
84293 | 76 * Concept Index:: Search for terms. |
77 | |
78 @detailmenu | |
79 --- The Detailed Node Listing --- | |
80 | |
81 Obtaining ERC | |
82 | |
83 * Releases:: Released versions of ERC. | |
84 * Development:: Latest unreleased development changes. | |
85 | |
86 Getting Started | |
87 | |
88 * Sample Session:: Example of connecting to the #emacs channel | |
89 * Special Features:: Differences from standalone IRC clients | |
90 | |
91 Advanced Usage | |
92 | |
93 * Connecting:: Ways of connecting to an IRC server. | |
94 * Sample Configuration:: An example configuration file. | |
95 * Options:: Options that are available for ERC. | |
96 | |
97 @end detailmenu | |
98 @end menu | |
99 | |
100 @node Introduction, Obtaining ERC, Top, Top | |
101 @comment node-name, next, previous, up | |
102 @chapter Introduction | |
103 | |
104 ERC is a powerful, modular, and extensible IRC client for Emacs. | |
105 | |
106 It comes with the following capabilities enabled by default. | |
107 | |
108 @itemize @bullet | |
109 @item Flood control | |
110 @item Timestamps | |
111 @item Join channels automatically | |
112 @item Buttonize URLs, nicknames, and other text | |
113 @item Wrap long lines | |
114 @item Highlight or remove IRC control characters | |
115 @item Highlight pals, fools, and other keywords | |
116 @item Detect netsplits | |
117 @item Complete nicknames and commands in a programmable fashion | |
118 @item Make displayed lines read-only | |
119 @item Input history | |
120 @item Track channel activity in the mode-line | |
121 | |
122 @end itemize | |
123 | |
124 @node Obtaining ERC, Installation, Introduction, Top | |
125 @comment node-name, next, previous, up | |
126 @chapter Obtaining ERC | |
127 | |
128 @menu | |
129 * Releases:: Released versions of ERC. | |
130 * Development:: Latest unreleased development changes. | |
131 @end menu | |
132 | |
133 Note that some ERC files are not included with Emacs due to copyright or | |
134 dependency issues. If desired, they may be found at the following | |
135 locations, or from your local GNU mirror. | |
136 | |
137 @itemize @bullet | |
88015 | 138 @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.3-extras.tar.gz} |
139 @item @uref{http://ftp.gnu.org/gnu/erc/erc-5.3-extras.zip} | |
84293 | 140 @end itemize |
141 | |
142 The rest of this chapter may be skipped if you are using the version of | |
143 ERC that comes with Emacs. | |
144 | |
145 @node Releases, Development, Obtaining ERC, Obtaining ERC | |
146 @comment node-name, next, previous, up | |
147 @section Releases | |
148 | |
149 Choose to install a release if you want to minimize risk. | |
150 | |
151 Errors are corrected in development first. User-visible changes will be | |
152 announced on the @email{erc-discuss@@gnu.org} mailing list. | |
153 @pxref{Getting Help and Reporting Bugs}. | |
154 | |
155 @cindex releases, Debian package | |
156 @cindex Debian package for ERC | |
157 Debian users can get ERC via apt-get. The @file{erc} package is | |
158 available in the official Debian repository. | |
159 | |
160 @cindex releases, from source | |
161 Alternatively, you can download the latest release from | |
162 @uref{http://ftp.gnu.org/gnu/erc}, or your local GNU mirror. | |
163 | |
164 @node Development, , Releases, Obtaining ERC | |
165 @comment node-name, next, previous, up | |
166 @section Development | |
167 @cindex development | |
168 | |
169 Choose the development version if you want to live on the bleeding edge | |
170 of ERC development or try out new features before release. | |
171 | |
88015 | 172 @cindex git version control system, using |
173 The git version control system allows you to keep up-to-date with the | |
174 latest changes to the development version of ERC. It also allows you | |
175 to contribute changes (via commits, if you are have developer access to | |
176 the repository, or via patches, otherwise). If you would like to | |
177 contribute to ERC development, it is highly recommended that you use | |
178 git. | |
84293 | 179 |
88015 | 180 If you are new to git, you might find this tutorial helpful: |
181 @uref{http://www.kernel.org/pub/software/scm/git/docs/tutorial.html}. | |
182 | |
183 Downloading ERC with git and staying up-to-date involves the following | |
184 steps. | |
84293 | 185 |
186 @enumerate | |
88015 | 187 @item Install git. |
84293 | 188 |
189 @itemize @bullet | |
88015 | 190 @item Debian and Ubuntu: @kbd{apt-get install git-core}. |
191 @item Windows: @uref{http://git.or.cz/gitwiki/WindowsInstall}. | |
192 @item Other operating systems: download, compile, and install the source | |
193 from @uref{http://www.kernel.org/pub/software/scm/git/}, or find a git | |
194 package for your operating system. | |
84293 | 195 @end itemize |
196 | |
88015 | 197 @item Download the ERC development branch. |
198 | |
199 If you have developer access to ERC, do: | |
200 | |
84293 | 201 @example |
88015 | 202 git clone ssh://loginname@@git.sv.gnu.org/srv/git/erc.git |
84293 | 203 @end example |
204 | |
88015 | 205 otherwise, do: |
206 | |
84293 | 207 @example |
88015 | 208 git clone git://git.sv.gnu.org/erc.git |
209 @end example | |
210 | |
211 If you are behind a restrictive firewall, and do not have developer | |
212 access, then do the following instead: | |
213 | |
214 @example | |
215 git clone http://git.sv.gnu.org/r/erc.git | |
84293 | 216 @end example |
217 | |
218 @item List upstream changes that are missing from your local copy. | |
219 Do this whenever you want to see whether new changes have been committed | |
88015 | 220 to ERC. If you wish, you may skip this step and proceed directly to |
221 the ``update'' step. | |
84293 | 222 |
223 @example | |
224 # Change to the source directory you are interested in. | |
88015 | 225 cd erc |
84293 | 226 |
88015 | 227 # Fetch new changes from the repository, but don't apply them yet |
228 git fetch origin | |
229 | |
230 # Display log messages for the new changes | |
231 git log HEAD..origin | |
84293 | 232 @end example |
233 | |
88015 | 234 ``origin'' is git's name for the location where you originally got ERC |
235 from. You can change this location at any time by editing the | |
236 @file{.git/config} file in the directory where the ERC source was | |
237 placed. | |
238 | |
239 @cindex updating ERC with git | |
240 @item Update to the latest version by pulling in any missing changes. | |
241 | |
84293 | 242 @example |
243 cd erc | |
88015 | 244 git pull origin |
84293 | 245 @end example |
246 | |
88015 | 247 git will show how many files changed, and will provide a visual display |
248 for how many lines were changed in each file. | |
249 | |
84293 | 250 @end enumerate |
251 | |
88015 | 252 There are other ways to interact with the ERC repository. |
84293 | 253 |
88015 | 254 @itemize |
255 @item Browse git repo: @uref{http://git.sv.gnu.org/gitweb/?p=erc.git} | |
256 @item Latest development snapshot: @uref{http://mwolson.org/static/dist/erc-latest.tar.gz} | |
257 @item Latest development snapshot (zip file): @uref{http://mwolson.org/static/dist/erc-latest.zip} | |
258 @end itemize | |
84293 | 259 |
88015 | 260 The latest development snapshot can lag behind the git repo by as much |
261 as 20 minutes, but never more than that. | |
262 | |
263 For further information on committing changes to ERC and performing | |
264 development, please consult | |
265 @uref{http://emacswiki.org/cgi-bin/wiki/ErcDevelopment}. | |
84293 | 266 |
267 | |
268 @node Installation, Getting Started, Obtaining ERC, Top | |
269 @comment node-name, next, previous, up | |
270 @chapter Installation | |
271 | |
272 ERC may be compiled and installed on your machine. | |
273 | |
274 This section may be skipped if you are using the version of ERC that | |
275 comes with Emacs. | |
276 | |
277 @subsubheading Compilation | |
278 | |
279 This is an optional step, since Emacs Lisp source code does not | |
280 necessarily have to be byte-compiled. It will yield a speed increase, | |
281 though. | |
282 | |
283 A working copy of Emacs or XEmacs is needed in order to compile ERC. By | |
284 default, the program that is installed with the name @command{emacs} | |
285 will be used. | |
286 | |
287 If you want to use the @command{xemacs} binary to perform the | |
288 compilation, you would need to edit @file{Makefile} in the top-level | |
289 directory as follows. You can put either a full path to an Emacs or | |
290 XEmacs binary or just the command name, as long as it is in the | |
291 @env{PATH}. | |
292 | |
293 @example | |
294 EMACS = xemacs | |
295 SITEFLAG = -no-site-file | |
296 @end example | |
297 | |
298 Running @code{make} should compile the ERC source files in the | |
299 @file{lisp} directory. | |
300 | |
301 @subsubheading Installation | |
302 | |
303 ERC may be installed into your file hierarchy by doing the following. | |
304 | |
305 Edit the @file{Makefile} file so that @env{ELISPDIR} points to where you | |
306 want the source and compiled ERC files to be installed and | |
307 @env{INFODIR} indicates where to put the ERC manual. Of course, you | |
308 will want to edit @env{EMACS} and @env{SITEFLAG} as shown in the | |
309 Compilation section if you are using XEmacs. | |
310 | |
311 If you are installing ERC on a Debian system, you might want to change | |
312 the value of @env{INSTALLINFO} as specified in @file{Makefile}. | |
313 | |
314 Run @code{make} as a normal user. | |
315 | |
316 Run @code{make install} as the root user if you have chosen installation | |
317 locations that require this. | |
318 | |
319 | |
320 @node Getting Started, Keystroke Summary, Installation, Top | |
321 @comment node-name, next, previous, up | |
322 @chapter Getting Started | |
323 @cindex settings | |
324 | |
325 To use ERC, add the directory containing its files to your | |
326 @code{load-path} variable, in your @file{.emacs} file. Then, load ERC | |
327 itself. An example follows. | |
328 | |
329 @lisp | |
330 (require 'erc) | |
331 @end lisp | |
332 | |
333 Once ERC is loaded, the command @kbd{M-x erc} will start ERC and | |
334 prompt for the server to connect to. | |
335 | |
336 If you want to place ERC settings in their own file, you can place them | |
337 in @file{~/.emacs.d/.ercrc.el}, creating it if necessary. | |
338 | |
339 If you would rather use the Customize interface to change how ERC works, | |
340 do @kbd{M-x customize-group RET erc RET}. In particular, ERC comes with | |
341 lots of modules that may be enabled or disabled; to select which ones | |
342 you want, do @kbd{M-x customize-variable RET erc-modules RET}. | |
343 | |
344 @menu | |
345 * Sample Session:: Example of connecting to the #emacs channel | |
346 * Special Features:: Differences from standalone IRC clients | |
347 @end menu | |
348 | |
349 @node Sample Session, Special Features, Getting Started, Getting Started | |
350 @comment node-name, next, previous, up | |
351 @section Sample Session | |
352 | |
353 This is an example ERC session which shows how to connect to the #emacs | |
354 channel on Freenode. Another IRC channel on Freenode that may be of | |
355 interest is #erc, which is a channel where ERC users and developers hang | |
356 out. | |
357 | |
358 @itemize @bullet | |
359 | |
360 @item Connect to Freenode | |
361 | |
362 Run @kbd{M-x erc}. Use ``irc.freenode.net'' as the IRC server, ``6667'' | |
363 as the port, and choose a nickname. | |
364 | |
365 @item Get used to the interface | |
366 | |
367 Switch to the ``irc.freenode.net:6667'' buffer, if you're not already | |
368 there. You will see first some messages about checking for ident, and | |
369 then a bunch of other messages that describe the current IRC server. | |
370 | |
371 @item Join the #emacs channel | |
372 | |
373 In that buffer, type ``/join SPC #emacs'' and hit @kbd{RET}. Depending | |
374 on how you've set up ERC, either a new buffer for ``#emacs'' will be | |
375 displayed, or a new buffer called ``#emacs'' will be created in the | |
376 background. If the latter, switch to the ``#emacs'' buffer. You will | |
377 see the channel topic and a list of the people who are currently on the | |
378 channel. | |
379 | |
380 @item Register your nickname with Freenode | |
381 | |
382 If you would like to be able to talk with people privately on the | |
383 Freenode network, you will have to ``register'' your nickname. To do | |
384 so, switch to the ``irc.freenode.net:6667'' buffer and type ``/msg | |
385 NickServ register <password>'', replacing ``<password>'' with your | |
386 desired password. It should tell you that the operation was successful. | |
387 | |
388 @item Talk to people in the channel | |
389 | |
390 If you switch back to the ``#emacs'' buffer, you can type a message, and | |
391 everyone on the channel will see it. | |
392 | |
393 @item Open a query buffer to talk to someone | |
394 | |
395 If you want to talk with someone in private (this should usually not be | |
396 done for technical help, only for personal questions), type ``/query | |
397 <nick>'', replacing ``<nick>'' with the nickname of the person you would | |
398 like to talk to. Depending on how ERC is set up, you will either see a | |
399 new buffer with the name of the person, or such a buffer will be created | |
400 in the background and you will have to switch to it. Begin typing | |
401 messages, and you will be able to have a conversation. | |
402 | |
403 Note that if the other person is not registered, you will not be able to | |
404 talk with them. | |
405 | |
406 @end itemize | |
407 | |
408 @node Special Features, , Sample Session, Getting Started | |
409 @comment node-name, next, previous, up | |
410 @section Special Features | |
411 | |
412 ERC has some features that distinguish it from some IRC clients. | |
413 | |
414 @itemize @bullet | |
415 | |
416 @item multiple channels and multiple servers | |
417 | |
418 Every channel is put in a separate buffer. Several IRC servers may be | |
419 connected to at the same time. | |
420 | |
421 @cindex query buffers | |
422 @item private message separation | |
423 | |
424 Private conversations are treated as channels, and are put into separate | |
425 buffers in Emacs. We call these ``query buffers''. | |
426 | |
427 @item highlighting | |
428 | |
84636
ffc87ddd4025
Sync changes from upstream ERC
Michael Olson <mwolson@gnu.org>
parents:
84387
diff
changeset
|
429 Some occurrences of words can be highlighted, which makes it easier to |
84293 | 430 track different kinds of conversations. |
431 | |
432 @item notification | |
433 | |
434 ERC can notify you that certain users are online. | |
435 | |
436 @item channel tracking | |
437 | |
438 Channels can be hidden and conversation continue in the background. You | |
439 are notified when something is said in such a channel that is not | |
440 currently visible. This makes it easy to get Real Work done while still | |
441 maintaining an IRC presence. | |
442 | |
443 @item nick completion | |
444 | |
445 ERC can complete words upon hitting @kbd{TAB}, which eases the writing | |
446 of nicknames in messages. | |
447 | |
448 @cindex history ring | |
449 @item history | |
450 | |
451 Past actions are kept in history rings for future use. To navigate a | |
452 history ring, hit @kbd{M-p} to go backwards and @kbd{M-n} to go | |
453 forwards. | |
454 | |
455 @item multiple languages | |
456 | |
457 Different channels and servers may have different language encodings. | |
458 | |
459 In addition, it is possible to translate the messages that ERC uses into | |
460 multiple languages. Please contact the developers of ERC at | |
461 @email{erc-discuss@@gnu.org} if you are interested in helping with the | |
462 translation effort. | |
463 | |
464 @item user scripting | |
465 | |
466 Users can load scripts (e.g. auto greeting scripts) when ERC starts up. | |
467 | |
468 It is also possible to make custom IRC commands, if you know a little | |
469 Emacs Lisp. Just make an Emacs Lisp function and call it | |
470 @code{erc-cmd-NEWCOMMAND}, where @code{NEWCOMMAND} is the name of the | |
471 new command in capital letters. | |
472 | |
473 @item auto reconnect | |
474 | |
475 If the connection goes away at some point, ERC will try to reconnect | |
476 automatically. If it fails to reconnect, and you want to try to | |
477 manually reestablish the connection at some later point, switch to an | |
478 ERC buffer and run the @code{/RECONNECT} command. | |
479 | |
480 @end itemize | |
481 | |
482 | |
483 @node Keystroke Summary, Modules, Getting Started, Top | |
484 @comment node-name, next, previous, up | |
485 @chapter Keys Used in ERC | |
486 @cindex keystrokes | |
487 | |
488 This is a summary of keystrokes available in every ERC buffer. | |
489 | |
490 @table @kbd | |
491 | |
492 @item C-a or <home> (`erc-bol') | |
493 Go to beginning of line or end of prompt. | |
494 | |
495 @item RET (`erc-send-current-line') | |
496 Send the current line | |
497 | |
498 @item TAB (`erc-complete-word') | |
499 If at prompt, complete the current word. | |
500 Otherwise, move to the next link or button. | |
501 | |
502 @item M-TAB (`ispell-complete-word') | |
503 Complete the given word, using ispell. | |
504 | |
505 @item C-c C-a (`erc-bol') | |
506 Go to beginning of line or end of prompt. | |
507 | |
508 @item C-c C-b (`erc-iswitchb') | |
509 Use `iswitchb-read-buffer' to prompt for a ERC buffer to switch to. | |
510 | |
511 @item C-c C-c (`erc-toggle-interpret-controls') | |
512 Toggle interpretation of control sequences in messages. | |
513 | |
514 @item C-c C-d (`erc-input-action') | |
515 Interactively input a user action and send it to IRC. | |
516 | |
517 @item C-c C-e (`erc-toggle-ctcp-autoresponse') | |
518 Toggle automatic CTCP replies (like VERSION and PING). | |
519 | |
520 @item C-c C-f (`erc-toggle-flood-control') | |
521 Toggle use of flood control on sent messages. | |
522 | |
523 @item C-c TAB (`erc-invite-only-mode') | |
524 Turn on the invite only mode (+i) for the current channel. | |
525 | |
526 @item C-c C-j (`erc-join-channel') | |
527 Join channel. If point is at the beginning of a channel name, use that | |
528 as default. | |
529 | |
530 @item C-c C-k (`erc-go-to-log-matches-buffer') | |
531 Interactively open an erc-log-matches buffer | |
532 | |
533 @item C-c C-l (`erc-save-buffer-in-logs') | |
534 Append buffer contents to the log file, if logging is enabled. | |
535 | |
536 @item C-c C-n (`erc-channel-names') | |
537 Run "/names #channel" in the current channel. | |
538 | |
539 @item C-c C-o (`erc-get-channel-mode-from-keypress') | |
540 Read a key sequence and call the corresponding channel mode function. | |
541 After doing @kbd{C-c C-o}, type in a channel mode letter. | |
542 | |
543 @kbd{C-g} means quit. | |
544 @kbd{RET} lets you type more than one mode at a time. | |
545 If @kbd{l} is pressed, @code{erc-set-channel-limit} gets called. | |
546 If @kbd{k} is pressed, @code{erc-set-channel-key} gets called. | |
547 Anything else will be sent to `erc-toggle-channel-mode'. | |
548 | |
549 @item C-c C-p (`erc-part-from-channel') | |
550 Part from the current channel and prompt for a reason. | |
551 | |
552 @item C-c C-q (`erc-quit-server') | |
553 Disconnect from current server after prompting for reason. | |
554 | |
555 @item C-c C-r (`erc-remove-text-properties-region') | |
556 Clears the region (start,end) in object from all colors, etc. | |
557 | |
558 @item C-c C-t (`erc-set-topic') | |
559 Prompt for a topic for the current channel. | |
560 | |
561 @item C-c C-u (`erc-kill-input') | |
562 Kill current input line using `erc-bol' followed by `kill-line'. | |
563 | |
564 @end table | |
565 | |
566 | |
567 @node Modules, Advanced Usage, Keystroke Summary, Top | |
568 @comment node-name, next, previous, up | |
569 @chapter Modules | |
570 @cindex modules | |
571 | |
572 One way to add functionality to ERC is to customize which of its many | |
573 modules are loaded. | |
574 | |
575 There is a spiffy customize interface, which may be reached by typing | |
576 @kbd{M-x customize-option erc-modules RET}. Alternatively, set | |
577 @code{erc-modules} manually and then call @code{erc-update-modules}. | |
578 | |
579 The following is a list of available modules. | |
580 | |
581 @table @code | |
582 | |
583 @cindex modules, autoaway | |
584 @item autoaway | |
585 Set away status automatically | |
586 | |
587 @cindex modules, autojoin | |
588 @item autojoin | |
589 Join channels automatically | |
590 | |
591 @cindex modules, bbdb | |
592 @item bbdb | |
593 Integrate with the Big Brother Database | |
594 | |
595 @cindex modules, button | |
596 @item button | |
597 Buttonize URLs, nicknames, and other text | |
598 | |
599 @cindex modules, capab-identify | |
600 @item capab-identify | |
601 Mark unidentified users on freenode and other servers supporting CAPAB. | |
602 | |
603 @cindex modules, completion | |
604 @cindex modules, pcomplete | |
605 @item completion (aka pcomplete) | |
606 Complete nicknames and commands (programmable) | |
607 | |
608 @cindex modules, fill | |
609 @item fill | |
610 Wrap long lines | |
611 | |
612 @cindex modules, hecomplete | |
613 @item hecomplete | |
614 Complete nicknames and commands (old). This is the old module---you | |
615 might prefer the ``completion'' module instead. | |
616 | |
617 @cindex modules, identd | |
618 @item identd | |
619 Launch an identd server on port 8113 | |
620 | |
621 @cindex modules, irccontrols | |
622 @item irccontrols | |
623 Highlight or remove IRC control characters | |
624 | |
625 @cindex modules, log | |
626 @item log | |
627 Save buffers in logs | |
628 | |
629 @cindex modules, match | |
630 @item match | |
631 Highlight pals, fools, and other keywords | |
632 | |
633 @cindex modules, menu | |
634 @item menu | |
635 Display a menu in ERC buffers | |
636 | |
637 @cindex modules, netsplit | |
638 @item netsplit | |
639 Detect netsplits | |
640 | |
641 @cindex modules, noncommands | |
642 @item noncommands | |
643 Don't display non-IRC commands after evaluation | |
644 | |
645 @cindex modules, notify | |
646 @item notify | |
647 Notify when the online status of certain users changes | |
648 | |
649 @cindex modules, page | |
650 @item page | |
651 Process CTCP PAGE requests from IRC | |
652 | |
653 @cindex modules, readonly | |
654 @item readonly | |
655 Make displayed lines read-only | |
656 | |
657 @cindex modules, replace | |
658 @item replace | |
659 Replace text in messages | |
660 | |
661 @cindex modules, ring | |
662 @item ring | |
663 Enable an input history | |
664 | |
665 @cindex modules, scrolltobottom | |
666 @item scrolltobottom | |
667 Scroll to the bottom of the buffer | |
668 | |
669 @cindex modules, services | |
670 @item services | |
671 Identify to Nickserv (IRC Services) automatically | |
672 | |
673 @cindex modules, smiley | |
674 @item smiley | |
675 Convert smileys to pretty icons | |
676 | |
677 @cindex modules, sound | |
678 @item sound | |
679 Play sounds when you receive CTCP SOUND requests | |
680 | |
681 @cindex modules, spelling | |
682 @item spelling | |
683 Check spelling of messages | |
684 | |
685 @cindex modules, stamp | |
686 @item stamp | |
687 Add timestamps to messages | |
688 | |
689 @cindex modules, track | |
690 @item track | |
691 Track channel activity in the mode-line | |
692 | |
693 @cindex modules, truncate | |
694 @item truncate | |
695 Truncate buffers to a certain size | |
696 | |
697 @cindex modules, unmorse | |
698 @item unmorse | |
699 Translate morse code in messages | |
700 | |
701 @end table | |
702 | |
703 @c PRE5_3: Document every option of every module in its own subnode | |
704 | |
705 | |
706 @node Advanced Usage, Getting Help and Reporting Bugs, Modules, Top | |
707 @comment node-name, next, previous, up | |
708 @chapter Advanced Usage | |
709 @cindex advanced topics | |
710 | |
711 @menu | |
712 * Connecting:: Ways of connecting to an IRC server. | |
713 * Sample Configuration:: An example configuration file. | |
714 * Options:: Options that are available for ERC. | |
715 @end menu | |
716 | |
717 @node Connecting, Sample Configuration, Advanced Usage, Advanced Usage | |
718 @comment node-name, next, previous, up | |
719 @section Connecting to an IRC Server | |
720 @cindex connecting | |
721 | |
722 The easiest way to connect to an IRC server is to call @kbd{M-x erc}. | |
723 If you want to assign this function to a keystroke, the following will | |
724 help you figure out its parameters. | |
725 | |
726 @defun erc | |
727 Select connection parameters and run ERC. | |
728 Non-interactively, it takes the following keyword arguments. | |
729 | |
730 @itemize @bullet | |
731 @item @var{server} | |
732 @item @var{port} | |
733 @item @var{nick} | |
734 @item @var{password} | |
735 @item @var{full-name} | |
736 @end itemize | |
737 | |
738 That is, if called with the following arguments, @var{server} and | |
739 @var{full-name} will be set to those values, whereas | |
740 @code{erc-compute-port}, @code{erc-compute-nick} and | |
741 @code{erc-compute-full-name} will be invoked for the values of the other | |
742 parameters. | |
743 | |
744 @example | |
745 (erc :server "irc.freenode.net" :full-name "Harry S Truman") | |
746 @end example | |
747 @end defun | |
748 | |
749 @subheading Server | |
750 | |
751 @defun erc-compute-server &optional server | |
752 Return an IRC server name. | |
753 | |
754 This tries a number of increasingly more default methods until a non-nil | |
755 value is found. | |
756 | |
757 @itemize @bullet | |
758 @item @var{server} (the argument passed to this function) | |
759 @item The @code{erc-server} option | |
760 @item The value of the IRCSERVER environment variable | |
761 @item The @code{erc-default-server} variable | |
762 @end itemize | |
763 | |
764 @end defun | |
765 | |
766 @defopt erc-server nil | |
767 IRC server to use if one is not provided. | |
768 @end defopt | |
769 | |
770 @subheading Port | |
771 | |
772 @defun erc-compute-port &optional port | |
773 Return a port for an IRC server. | |
774 | |
775 This tries a number of increasingly more default methods until a non-nil | |
776 value is found. | |
777 | |
778 @itemize @bullet | |
779 @item @var{port} (the argument passed to this function) | |
780 @item The @code{erc-port} option | |
781 @item The @code{erc-default-port} variable | |
782 @end itemize | |
783 | |
784 @end defun | |
785 | |
786 @defopt erc-port | |
787 IRC port to use if not specified. | |
788 | |
789 This can be either a string or a number. | |
790 @end defopt | |
791 | |
792 @subheading Nick | |
793 | |
794 @defun erc-compute-nick &optional nick | |
795 Return user's IRC nick. | |
796 | |
797 This tries a number of increasingly more default methods until a | |
798 non-nil value is found. | |
799 | |
800 @itemize | |
801 @item @var{nick} (the argument passed to this function) | |
802 @item The @code{erc-nick} option | |
803 @item The value of the IRCNICK environment variable | |
804 @item The result from the @code{user-login-name} function | |
805 @end itemize | |
806 | |
807 @end defun | |
808 | |
809 @defopt erc-nick | |
810 Nickname to use if one is not provided. | |
811 | |
812 This can be either a string, or a list of strings. | |
813 In the latter case, if the first nick in the list is already in use, | |
814 other nicks are tried in the list order. | |
815 @end defopt | |
816 | |
817 @defopt erc-nick-uniquifier | |
818 The string to append to the nick if it is already in use. | |
819 @end defopt | |
820 | |
821 @defopt erc-try-new-nick-p | |
822 If the nickname you chose isn't available, and this option is non-nil, | |
823 ERC should automatically attempt to connect with another nickname. | |
824 | |
825 You can manually set another nickname with the /NICK command. | |
826 @end defopt | |
827 | |
828 @subheading Full name | |
829 | |
830 @defun erc-compute-full-name &optional full-name | |
831 Return user's full name. | |
832 | |
833 This tries a number of increasingly more default methods until a | |
834 non-nil value is found. | |
835 | |
836 @itemize @bullet | |
837 @item @var{full-name} (the argument passed to this function) | |
838 @item The @code{erc-user-full-name} option | |
839 @item The value of the IRCNAME environment variable | |
840 @item The result from the @code{user-full-name} function | |
841 @end itemize | |
842 | |
843 @end defun | |
844 | |
845 @defopt erc-user-full-name | |
846 User full name. | |
847 | |
848 This can be either a string or a function to call. | |
849 @end defopt | |
850 | |
851 @node Sample Configuration, Options, Connecting, Advanced Usage | |
852 @comment node-name, next, previous, up | |
853 @section Sample Configuration | |
854 @cindex configuration, sample | |
855 | |
856 Here is an example of configuration settings for ERC. This can go into | |
857 your Emacs configuration file. Everything after the @code{(require | |
858 'erc)} command can optionally go into @file{~/.emacs.d/.ercrc.el}. | |
859 | |
860 @lisp | |
861 ;;; Sample ERC configuration | |
862 | |
863 ;; Add the ERC directory to load path -- you don't need this if you are | |
864 ;; using the version of ERC that comes with Emacs | |
865 (add-to-list 'load-path "~/elisp/erc") | |
866 | |
867 ;; Load ERC | |
868 (require 'erc) | |
869 | |
870 ;; Load authentication info from an external source. Put sensitive | |
871 ;; passwords and the like in here. | |
872 (load "~/.emacs.d/.erc-auth") | |
873 | |
874 ;; This is an example of how to make a new command. Type "/uptime" to | |
875 ;; use it. | |
876 (defun erc-cmd-UPTIME (&rest ignore) | |
877 "Display the uptime of the system, as well as some load-related | |
878 stuff, to the current ERC buffer." | |
879 (let ((uname-output | |
880 (replace-regexp-in-string | |
881 ", load average: " "] @{Load average@} [" | |
882 ;; Collapse spaces, remove | |
883 (replace-regexp-in-string | |
884 " +" " " | |
885 ;; Remove beginning and trailing whitespace | |
886 (replace-regexp-in-string | |
887 "^ +\\|[ \n]+$" "" | |
888 (shell-command-to-string "uptime")))))) | |
889 (erc-send-message | |
890 (concat "@{Uptime@} [" uname-output "]")))) | |
891 | |
892 ;; This causes ERC to connect to the Freenode network upon hitting | |
893 ;; C-c e f. Replace MYNICK with your IRC nick. | |
894 (global-set-key "\C-cef" (lambda () (interactive) | |
895 (erc :server "irc.freenode.net" :port "6667" | |
896 :nick "MYNICK"))) | |
897 | |
898 ;; This causes ERC to connect to the IRC server on your own machine (if | |
899 ;; you have one) upon hitting C-c e b. Replace MYNICK with your IRC | |
900 ;; nick. Often, people like to run bitlbee (http://bitlbee.org/) as an | |
901 ;; AIM/Jabber/MSN to IRC gateway, so that they can use ERC to chat with | |
902 ;; people on those networks. | |
903 (global-set-key "\C-ceb" (lambda () (interactive) | |
904 (erc :server "localhost" :port "6667" | |
905 :nick "MYNICK"))) | |
906 | |
907 ;; Make C-c RET (or C-c C-RET) send messages instead of RET. This has | |
908 ;; been commented out to avoid confusing new users. | |
909 ;; (define-key erc-mode-map (kbd "RET") nil) | |
910 ;; (define-key erc-mode-map (kbd "C-c RET") 'erc-send-current-line) | |
911 ;; (define-key erc-mode-map (kbd "C-c C-RET") 'erc-send-current-line) | |
912 | |
913 ;;; Options | |
914 | |
915 ;; Join the #emacs and #erc channels whenever connecting to Freenode. | |
916 (setq erc-autojoin-channels-alist '(("freenode.net" "#emacs" "#erc"))) | |
917 | |
918 ;; Interpret mIRC-style color commands in IRC chats | |
919 (setq erc-interpret-mirc-color t) | |
920 | |
921 ;; The following are commented out by default, but users of other | |
922 ;; non-Emacs IRC clients might find them useful. | |
923 ;; Kill buffers for channels after /part | |
924 ;; (setq erc-kill-buffer-on-part t) | |
925 ;; Kill buffers for private queries after quitting the server | |
926 ;; (setq erc-kill-queries-on-quit t) | |
927 ;; Kill buffers for server messages after quitting the server | |
928 ;; (setq erc-kill-server-buffer-on-quit t) | |
929 @end lisp | |
930 | |
931 @node Options, , Sample Configuration, Advanced Usage | |
932 @comment node-name, next, previous, up | |
933 @section Options | |
934 @cindex options | |
935 | |
936 @c PRE5_3: (Node) Document every ERC option (module options go in | |
937 @c previous chapter) | |
938 | |
939 This section has not yet been written. For now, the easiest way to | |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
940 check out the available options for ERC is to do |
84293 | 941 @kbd{M-x customize-group erc RET}. |
942 | |
943 | |
944 @node Getting Help and Reporting Bugs, History, Advanced Usage, Top | |
945 @comment node-name, next, previous, up | |
946 @chapter Getting Help and Reporting Bugs | |
947 @cindex help, getting | |
948 @cindex bugs, reporting | |
949 | |
950 After you have read this guide, if you still have questions about ERC, | |
951 or if you have bugs to report, there are several places you can go. | |
952 | |
953 @itemize @bullet | |
954 | |
955 @item | |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
956 @uref{http://www.emacswiki.org/cgi-bin/wiki/ERC} is the |
84293 | 957 emacswiki.org page for ERC. Anyone may add tips, hints, or bug |
958 descriptions to it. | |
959 | |
960 @item | |
961 There are several mailing lists for ERC. To subscribe, visit | |
962 @uref{http://savannah.gnu.org/mail/?group=erc}. | |
963 | |
964 The mailing lists are also available on Gmane. | |
965 (@url{http://gmane.org/}). Gmane provides additional methods for | |
966 accessing the mailing lists, adding content to them, and searching them. | |
967 | |
968 @enumerate | |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
969 @item gmane.emacs.erc.announce: Announcements |
84293 | 970 |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
971 @item gmane.emacs.erc.discuss: General discussion |
84293 | 972 |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
973 @item gmane.emacs.erc.cvs: Log messages for changes to the ERC source code |
84293 | 974 |
975 @end enumerate | |
976 | |
977 @item | |
978 You can visit the IRC Freenode channel @samp{#emacs}. Many of the | |
979 contributors are frequently around and willing to answer your | |
980 questions. | |
981 | |
982 @end itemize | |
983 | |
984 | |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
985 @node History, Copying, Getting Help and Reporting Bugs, Top |
84293 | 986 @comment node-name, next, previous, up |
987 @chapter History | |
988 @cindex history, of ERC | |
989 | |
990 ERC was originally written by Alexander L. Belikoff | |
991 @email{abel@@bfr.co.il} and Sergey Berezin | |
992 @email{sergey.berezin@@cs.cmu.edu}. They stopped development around | |
993 December 1999. Their last released version was ERC 2.0. | |
994 | |
995 P.S.: If one of the original developers of ERC reads this, we'd like to | |
996 receive additional information for this file and hear comments in | |
997 general. | |
998 | |
999 @itemize | |
1000 @item 2001 | |
1001 | |
1002 In June 2001, Mario Lang @email{mlang@@delysid.org} and Alex Schroeder | |
1003 @email{alex@@gnu.org} took over development and created a ERC Project at | |
1004 @uref{http://sourceforge.net/projects/erc}. | |
1005 | |
1006 In reaction to a mail about the new ERC development effort, Sergey | |
1007 Berezin said, ``First of all, I'm glad that my version of ERC is being | |
1008 used out there. The thing is, I do not have free time and enough | |
1009 incentive anymore to work on ERC, so I would be happy if you guys take | |
1010 over the project entirely.'' | |
1011 | |
1012 So we happily hacked away on ERC, and soon after (September 2001) | |
1013 released the next "stable" version, 2.1. | |
1014 | |
1015 Most of the development of the new ERC happened on #emacs on | |
1016 irc.openprojects.net. Over time, many people contributed code, ideas, | |
1017 bugfixes, and a lot of alpha/beta/gamma testing. | |
1018 | |
1019 See the @file{CREDITS} file for a list of contributors. | |
1020 | |
1021 @item 2003 | |
1022 | |
1023 ERC 3.0 was released. | |
1024 | |
1025 @item 2004 | |
1026 | |
1027 ERC 4.0 was released. | |
1028 | |
1029 @item 2005 | |
1030 | |
1031 ERC 5.0 was released. Michael Olson @email{mwolson@@gnu.org} became | |
1032 the release manager and eventually the maintainer. | |
1033 | |
1034 After some discussion between him and the Emacs developers, it was | |
1035 decided to include ERC in Emacs. | |
1036 | |
1037 @item 2006 | |
1038 | |
1039 ERC 5.1 was released. It was subsequently included in Emacs 22. | |
1040 | |
1041 ERC became an official GNU project, and development moved to | |
1042 @uref{http://sv.gnu.org/projects/erc}. We switched to using GNU Arch as | |
1043 our revision control system. Our mailing list address changed as well. | |
1044 | |
88015 | 1045 @item 2007 |
1046 | |
1047 We switched to using git for our version control system. | |
1048 | |
84293 | 1049 @end itemize |
1050 | |
84387
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
1051 @node Copying, GNU Free Documentation License, History, Top |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
1052 @comment node-name, next, previous, up |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
1053 @include gpl.texi |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
1054 |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
1055 @node GNU Free Documentation License, Concept Index, Copying, Top |
4ee03308c9b6
Sync ERC 5.3 (devel) from upstream
Michael Olson <mwolson@gnu.org>
parents:
84329
diff
changeset
|
1056 @comment node-name, next, previous, up |
84293 | 1057 @include doclicense.texi |
1058 | |
1059 @node Concept Index, , GNU Free Documentation License, Top | |
1060 @comment node-name, next, previous, up | |
1061 @unnumbered Index | |
1062 | |
1063 @printindex cp | |
1064 | |
1065 @bye | |
1066 | |
1067 @ignore | |
1068 arch-tag: cf9cfaff-fc12-4297-ad15-ec2493002b1e | |
1069 @end ignore |