1 \input texinfo @c -*- mode: texinfo; coding: iso-2022-jp -*-
3 @setfilename riece-en.info
4 @settitle Riece -- An IRC client for Emacsen --
7 @c @documentlanguage en
9 @dircategory GNU Emacs Lisp
11 * Riece-en: (riece-en). An IRC client for Emacsen
15 This file describes Riece.
17 Copyright (C) 2003,2004 Daiki Ueno.
19 Permission is granted to copy, distribute and/or modify this document
20 under the terms of the GNU Free Documentation License, Version 1.1 or
21 any later version published by the Free Software Foundation; with no
22 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
23 Texts. A copy of the license is included in the section entitled "GNU
24 Free Documentation License".
35 @vskip 0pt plus 1filll
36 Copyright @copyright{} 2003 Daiki Ueno.
38 Permission is granted to copy, distribute and/or modify this document
39 under the terms of the GNU Free Documentation License, Version 1.1 or
40 any later version published by the Free Software Foundation; with no
41 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
42 Texts. A copy of the license is included in the section entitled "GNU
43 Free Documentation License".
49 @node Top, Overview, (dir), (dir)
50 @top Riece user's manual
52 Riece is a program to participate in IRC (Internet Relay Chat) from Emacs.
55 * Overview:: What's Riece?
57 * Basic usage:: Let's talk with other people.
63 @node Overview, Getting started, Top, Top
66 Riece is a full rewrite of the predecessor product "Liece" (whose code
67 has been unmaintainable for a long time), while providing a user
68 interface (mostly) compatible with Liece.
70 There are noteworthy improvements as compared with Liece:
74 Several IRC servers may be used at the same time.
77 Essential features can be built upon the extension framework (called
78 "add-on") capable of dependency tracking.
81 Installation is easy. Riece doesn't depend on other packages.
84 Setup is easy. Automatically save/restore the configuration.
87 Step-by-step instructions are included.
90 Mostly compliant with the latest IRC client protocol (RFC 2812).
93 For more details, please look at the following pages:
96 @item http://www.nongnu.org/riece/
97 @item http://wiliki.designflaw.org/index.cgi?Riece&l=jp
98 @item http://www.unixuser.org/~ueno/liece/
101 @node Getting started, Basic usage, Overview, Top
102 @chapter Getting started
105 * Required Environments::
110 @node Required Environments, Installation, Getting started, Getting started
111 @section Required Environments
113 We checked this version working on the following environments.
116 @item Emacs 20.7 or later
117 @item XEmacs 21.4 or later
120 @node Installation, Startup File, Required Environments, Getting started
121 @section Installation
123 The latest version of Riece can be obtained from
124 @uref{http://wiliki.designflaw.org/riece.cgi}. After unpacking the
125 tarball, you can install with the following commands:
133 If you want to install Riece as an XEmacs package, use the following
134 commands instead of the above:
137 ./configure --with-xemacs[=xemacs-21.4.15]
142 If you do not so, it is necessery to add autoload setting to your Emacs
143 startup file (probably @file{~/.emacs}) to be able to start Riece by
144 typing @kbd{M-x riece}.
147 (autoload 'riece "riece" "Start Riece" t)
150 @node Startup File, , Installation, Getting started
151 @section Startup file
153 In this section we describe Riece's startup files.
155 If you are attempting to use Riece by way of trial, nothing needed to be
156 written in startup files. Thus you can skip this section.
158 Riece reads startup files under the directory pointed by the variable
159 @code{riece-directory} (by default, it has @file{~/.riece/} as the
160 value). There are two kinds of startup files in the directory:
163 @item riece-saved-variables-file
164 @vindex riece-saved-variables-file
165 Variables changed during the last session are automatically saved in this file.
166 (by default, it is located at @file{~/.riece/save})
167 @item riece-variables-file
168 @vindex riece-variables-file
169 Users can edit this file to configure their own settings (by default, it
170 is located at @file{~/.riece/init})
173 At startup, Riece will first read @code{riece-saved-variables-file},
174 and then @code{riece-variables-file}. That is to say, automatically
175 saved variables may be refered/modified by user configuration.
177 @node Basic usage, Index, Getting started, Top
180 To start Riece, you just type @kbd{M-x riece}. Then you will prompted
181 for the name of an IRC server. A typical IRC network may consist of
182 several IRC servers and you will need to pick up appropriate one. Most
183 of IRC networks provide a list of available servers on their Web pages:
186 @item http://irc.kyoto-u.ac.jp
187 @item http://freenode.net
190 If your nickname is taken, you will be asked to use different one. The
191 initial nickname can be set via the variable @code{riece-nickname}. By
192 default, your nickname is generated from your login name.
193 @vindex riece-nickname
195 After successfully connecting to an IRC server, you can join a channel
196 and talk with people there. To join a channel, type @kbd{C-c j}. By
197 the way there is a channel called @samp{#Riece} on IRCnet, so feel free
198 to use it for testing.
200 Now you enter a message and it will be seen by everyone else on the
201 channel. Messages from other people will appear on the top-left window.
207 * Connecting to multiple servers::
210 @node Windows, Indicators, Basic usage, Basic usage
213 By default, Riece uses 5 windows to inform user of his status:
216 +-----+-----------------+
222 +-----+-----------------+
224 | +-----------------+
228 +-----+-----------------+
231 Each window is used for different purpose:
235 "user list window" (@samp{*Users XXX*}). Users on the current
236 channel are listed in this window.
239 "channel window" (@samp{*Channel XXX*}). This window keeps
240 dialogues on the current channel.
243 "channel list window" (@samp{*Channels*}). All channels you are
244 joined are listed in this window.
247 "command window" (@samp{*Commands*}). This window is used for either
248 sending messages or issueing commands.
251 "others buffer" (@samp{*Others*}). This window displays dialogues on
252 channels except the current channel.
255 @node Indicators, Commands, Windows, Basic usage
258 Indicators are characters which indicate your status. Usually they are
259 put on the left side of the modeline like:
262 Riece: --- ueno #Liece [n]
265 In this case, @samp{---} are indicators. From left to right their
270 You are not "away". (If you marked yourself as "away", it would be
274 You are not an IRC operator. (If you entered operator mode, it would be
278 The channel window is not locked.
279 (If it was locked, it would be @samp{F}. If it was locked until next
280 send, it would be @samp{f})
283 @node Commands, Connecting to multiple servers, Indicators, Basic usage
286 The buffer used for sending messages is called "command buffer".
287 You can issue various commands from the command buffer.
289 @subsection IRC commands
292 @findex riece-command-enter-message
293 Send the current line. (@code{riece-command-enter-message})
295 @findex riece-command-enter-message-as-notice
296 Send the current line as NOTICE. (@code{riece-command-enter-message-as-notice})
298 @findex riece-command-join
299 Join a channel. (@code{riece-command-join})
301 @findex riece-command-part
302 Part from a channel. (@code{riece-command-part})
304 @findex riece-command-enter-message-to-user
305 Send the current line to particular
306 user. (@code{riece-command-enter-message-to-user})
308 @findex riece-command-quit
309 Quit from IRC. (@code{riece-command-quit})
311 @findex riece-command-change-nickname
312 Change your nickname. (@code{riece-command-change-nickname})
314 @findex riece-command-finger
315 Get information of a user. (@code{riece-command-finger})
317 @findex riece-command-kick
318 Kick a user from the current channel. (@code{riece-command-kick})
320 @findex riece-command-invite
321 Invite a user to the current channel. (@code{riece-command-invite})
323 @findex riece-command-list
324 Issue a LIST command with specified pattern. (@code{riece-command-list})
326 @findex riece-command-names
327 Issue a NAMES command with specified pattern. (@code{riece-command-names})
329 @findex riece-command-who
330 Issue a WHO command with specified pattern. (@code{riece-command-who})
332 @findex riece-command-topic
333 Set topic of the current channel. (@code{riece-command-topic})
335 @findex riece-command-change-mode
336 Change the mode of the current channel. (@code{riece-command-change-mode})
338 @findex riece-command-set-operators
339 Assign channel operator privilege to a user. If a prefix argument
340 (@kbd{C-u}) is given, remove the privilege from a
341 user. (@code{riece-command-set-operators})
343 @findex riece-command-set-speakers
344 Allow a user to speak in the current channel. If a prefix argument
345 (@kbd{C-u}) is given, disallow a user to
346 speak. (@code{riece-command-set-speakers})
348 @findex riece-version
349 Display version number of Riece. If a prefix argument (@kbd{C-u}) is
350 given, use User-Agent format.
352 @findex riece-command-raw
353 Send raw IRC command. (@code{riece-command-raw})
356 @subsection Window manipulating commands
359 @findex riece-command-configure-windows
360 Redraw windows. (@code{riece-command-configure-windows})
362 @findex riece-command-next-channel
363 Switch to the next channel in the channel
364 list. (@code{riece-command-next-channel})
366 @findex riece-command-previous-channel
367 Switch to the previous channel in the channel
368 list. (@code{riece-command-previous-channel})
370 @findex riece-command-next-channel
371 Switch to the next channel in the channel
372 list. (@code{riece-command-next-channel})
374 @findex riece-command-list-addons
375 Browse add-ons currently insinuated. (@code{riece-command-list-addons})
377 @findex riece-command-switch-to-channel-by-number
378 Switch to @var{n}th channel in the channel
379 list. (@code{riece-command-switch-to-channel-by-number})
381 @findex riece-command-switch-to-channel-by-number
382 Switch to @var{n} + 10th channel in the channel
383 list. (@code{riece-command-switch-to-channel-by-number})
385 @findex riece-command-beginning-of-buffer
386 Move point to the beginning of the buffer in the channel window.
387 (@code{riece-command-beginning-of-buffer})
389 @findex riece-command-end-of-buffer
390 Move point to the end of the buffer in the channel window.
391 (@code{riece-command-end-of-buffer})
393 @findex riece-command-scroll-up
394 Scroll text of the channel window up. (@code{riece-command-scroll-up})
396 @findex riece-command-scroll-down
397 Scroll text of the channel window down. (@code{riece-command-scroll-down})
400 @subsection Status toggle commands
403 @findex riece-command-toggle-channel-buffer-mode
404 Toggle visibility of the channel
405 window. (@code{riece-command-toggle-channel-buffer-mode})
407 @findex riece-command-toggle-channel-list-buffer-mode
408 Toggle visibility of the channel list
409 window. (@code{riece-command-toggle-channel-list-buffer-mode})
411 @findex riece-command-toggle-user-list-buffer-mode
412 Toggle visibility of the user list
413 window. (@code{riece-command-toggle-user-list-buffer-mode})
415 @findex riece-command-toggle-freeze
416 Disable scrolling of the channel window. (@code{riece-command-toggle-freeze})
418 @findex riece-command-toggle-own-freeze
419 Disable scrolling of the channel window until next
420 send. (@code{riece-command-toggle-own-freeze})
422 @findex riece-command-toggle-away
423 Mark or unmark yourself as "away". (@code{riece-command-toggle-away})
426 @node Connecting to multiple servers, , Commands, Basic usage
427 @section Connecting to multiple servers
429 One of the most important features of Riece is that users can use
430 several IRC servers at the same time.
432 The procedure to use multiple servers consists (1) connecting to the
433 foreign server and (2) joinning a channel:
437 Type @kbd{C-c O} (@code{riece-command-open-server}), and then you will
438 be asked the server name.
441 Type @kbd{C-c j} (@code{riece-command-join}) to join a channel. Here
442 the server name follows the channel name. To input a space character,
443 use @kbd{C-q}. For example, if you want to join the channel
444 @samp{#Riece} on the server @samp{irc6}, type @kbd{C-c j #Riece C-q SPC
448 If you want to send IRC command without joinning a channel, @kbd{C-c M}
449 (@code{riece-command-universal-server-name-argument}) may be useful.
451 Commands used for connection management are listed below:
455 @findex riece-command-open-server
456 Connect to the foreign server. (@code{riece-command-open-server})
458 @findex riece-command-close-server
459 Close the connection to the server. (@code{riece-command-close-server})
461 @findex riece-command-universal-server-name-argument
462 Issue a command on the specified
463 server. (@code{riece-command-universal-server-name-argument})
466 @node Index, Function Index, Basic usage, Top
470 @node Function Index, Variable Index, Index, Top
471 @chapter Function Index
474 @node Variable Index, , Function Index, Top
475 @chapter Variable Index