annotate doc/misc/erc.texi @ 94872:c5a53051fe83

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