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