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 user interface
68 compatible with Liece.
70 For now it does not have rich functions as an IRC client, but there are
71 noteworthy improvements as compared with Liece:
74 @item Several IRC servers may be used at the same time.
75 @item Essential features can be built upon the extension framework (called "add-on") capable of dependency tracking.
76 @item Installation is easy. Riece doesn't depend on other packages.
77 @item Setup is easy. Automatically save/restore the configuration.
78 @item Step-by-step instructions (currently written in Japanese) are included.
79 @item Mostly compliant with the latest IRC client protocol (RFC 2812).
82 For more details, please look at the following pages:
85 @item http://www.nongnu.org/riece/
86 @item http://wiliki.designflaw.org/index.cgi?Riece&l=jp
87 @item http://www.unixuser.org/~ueno/liece/
90 @node Getting started, Basic usage, Overview, Top
91 @chapter Getting started
94 * Required Environments::
99 @node Required Environments, Installation, Getting started, Getting started
100 @section Required Environments
102 We have checked this version working on the following environments.
105 @item Emacs 20.7 or later
106 @item XEmacs 21.4 or later
109 @node Installation, Startup File, Required Environments, Getting started
110 @section Installation
112 The latest version of Riece can be obtained from
113 @uref{http://wiliki.designflaw.org/riece.cgi}. After unpacking the
114 tarball, you can install with the following commands:
122 If you want to install Riece as an XEmacs package, use the following
123 commands instead of the above:
126 ./configure --with-xemacs[=xemacs-21.4.15]
131 If you do not so, it is necessery to add autoload setting to your Emacs
132 startup file to be able to start Riece by typing @kbd{M-x riece}.
135 (autoload 'riece "riece" "Start Riece" t)
138 @node Startup File, , Installation, Getting started
139 @section Startup file
141 In this section, we describe Riece's startup files.
143 If you are attempting to use Riece by way of trial, nothing needed to be
144 written in startup files. Thus you can skip this section.
146 Riece reads startup files under the directory pointed by the variable
147 @code{riece-directory} (by default, it has @file{~/.riece/} as the
148 value). There are two kinds of startup files in the directory:
151 @item riece-saved-variables-file
152 @vindex riece-saved-variables-file
153 Variables changed during the last session are automatically saved in this file.
154 (by default, it is located at @file{~/.riece/save})
155 @item riece-variables-file
156 @vindex riece-variables-file
157 Users can edit this file to configure their own settings (by default, it
158 is located at @file{~/.riece/init})
161 At startup, Riece will first read @code{riece-saved-variables-file} ,
162 and then @code{riece-variables-file}. That is to say, automatically
163 saved variables may be refered/modified by user configuration.
165 @node Basic usage, Index, Getting started, Top
168 To start Riece, type @kbd{M-x riece}. Then you need to select an IRC
169 server to connect. Typical IRC network consists of several IRC servers
170 and you can pick up appropriate one. Most of them provide a list of
171 available servers on their Web pages:
174 @item http://irc.kyoto-u.ac.jp
175 @item http://freenode.net
178 If your nickname is taken, you will be asked to use different one. The
179 initial nickname can be set via the variable @code{riece-nickname}. By
180 default, your nickname is generated from your login name.
181 @vindex riece-nickname
183 After successfully connecting to an IRC server, you can join a channel
184 and talk with people in there. To join a channel, type @kbd{C-c j}.
185 There is the channel @samp{#Riece} on IRCnet, so feel free to use it for
188 Now you can send the current line by simply hitting Enter key. Messages
189 from other people will appear on the top-left window.
195 * Connecting to multiple servers::
198 @node Windows, Indicators, Basic usage, Basic usage
201 By default, Riece uses 5 window to inform user of his status:
204 +-----+-----------------+
210 +-----+-----------------+
212 | +-----------------+
216 +-----+-----------------+
219 Each window is used for different purpose:
223 "user list window" (@samp{*Users XXX*}). Users on the current
224 channel are listed in this window.
227 "channel window" (@samp{*Channel XXX*}). This window keeps
228 dialogues on the current channel.
231 "channel list window" (@samp{*Channels*}). All channels you are
232 joined are listed in this window.
235 "command window" (@samp{*Commands*}). This window is used for either
236 sending messages or issueing commands.
239 "others buffer" (@samp{*Others*}). This window displays dialogues on
240 channels except the current channel.
243 @node Indicators, Commands, Windows, Basic usage
246 Indicators are characters which indicate your status. Usually they are
247 put on the left side of the modeline like:
250 Riece: --- ueno #Liece [n]
253 In this case, @samp{---} are indicators. From left to right their
258 You are not "away". (If you marked yourself as "away", it would be
262 You are not an IRC operator. (If you entered operator mode, it would be
266 The channel window is not locked.
267 (If it was locked, it would be @samp{F}. If it was locked until next
268 send, it would be @samp{f})
271 @node Commands, Connecting to multiple servers, Indicators, Basic usage
274 The buffer used for sending messages is called "command buffer".
275 You can issue various commands from the command buffer.
277 @subsection IRC commands
280 @findex riece-command-enter-message
281 Send the current line. (@code{riece-command-enter-message})
283 @findex riece-command-enter-message-as-notice
284 Send the current line as NOTICE. (@code{riece-command-enter-message-as-notice})
286 @findex riece-command-join
287 Join a channel. (@code{riece-command-join})
289 @findex riece-command-part
290 Part from a channel. (@code{riece-command-part})
292 @findex riece-command-enter-message-to-user
293 Send the current line to particular
294 user. (@code{riece-command-enter-message-to-user})
296 @findex riece-command-quit
297 Quit from IRC. (@code{riece-command-quit})
299 @findex riece-command-change-nickname
300 Change your nickname. (@code{riece-command-change-nickname})
302 @findex riece-command-finger
303 Get information of a user. (@code{riece-command-finger})
305 @findex riece-command-kick
306 Kick a user from the current channel. (@code{riece-command-kick})
308 @findex riece-command-invite
309 Invite a user to the current channel. (@code{riece-command-invite})
311 @findex riece-command-list
312 Issue a LIST command with specified pattern. (@code{riece-command-list})
314 @findex riece-command-names
315 Issue a NAMES command with specified pattern. (@code{riece-command-names})
317 @findex riece-command-who
318 Issue a WHO command with specified pattern. (@code{riece-command-who})
320 @findex riece-command-topic
321 Set topic of the current channel. (@code{riece-command-topic})
323 @findex riece-command-change-mode
324 Change the mode of the current channel. (@code{riece-command-change-mode})
326 @findex riece-command-set-operators
327 Assign channel operator privilege to a user. If a prefix argument
328 (@kbd{C-u}) is given, remove the privilege from a
329 user. (@code{riece-command-set-operators})
331 @findex riece-command-set-speakers
332 Allow a user to speak in the current channel. If a prefix argument
333 (@kbd{C-u}) is given, disallow a user to
334 speak. (@code{riece-command-set-speakers})
336 @findex riece-version
337 Display version number of Riece. If a prefix argument (@kbd{C-u}) is
338 given, use User-Agent format.
340 @findex riece-command-raw
341 Send raw IRC command. (@code{riece-command-raw})
344 @subsection Window manipulating commands
347 @findex riece-command-configure-windows
348 Redraw windows. (@code{riece-command-configure-windows})
350 @findex riece-command-next-channel
351 Switch to the next channel in the channel
352 list. (@code{riece-command-next-channel})
354 @findex riece-command-previous-channel
355 Switch to the previous channel in the channel
356 list. (@code{riece-command-previous-channel})
358 @findex riece-command-next-channel
359 Switch to the next channel in the channel
360 list. (@code{riece-command-next-channel})
362 @findex riece-command-list-addons
363 Browse add-ons currently insinuated. (@code{riece-command-list-addons})
365 @findex riece-command-switch-to-channel-by-number
366 Switch to @var{n}th channel in the channel
367 list. (@code{riece-command-switch-to-channel-by-number})
369 @findex riece-command-switch-to-channel-by-number
370 Switch to @var{n} + 10th channel in the channel
371 list. (@code{riece-command-switch-to-channel-by-number})
373 @findex riece-command-beginning-of-buffer
374 Move point to the beginning of the buffer in the channel window.
375 (@code{riece-command-beginning-of-buffer})
377 @findex riece-command-end-of-buffer
378 Move point to the end of the buffer in the channel window.
379 (@code{riece-command-end-of-buffer})
381 @findex riece-command-scroll-up
382 Scroll text of the channel window up. (@code{riece-command-scroll-up})
384 @findex riece-command-scroll-down
385 Scroll text of the channel window down. (@code{riece-command-scroll-down})
388 @subsection Status toggle commands
391 @findex riece-command-toggle-channel-buffer-mode
392 Toggle visibility of the channel
393 window. (@code{riece-command-toggle-channel-buffer-mode})
395 @findex riece-command-toggle-channel-list-buffer-mode
396 Toggle visibility of the channel list
397 window. (@code{riece-command-toggle-channel-list-buffer-mode})
399 @findex riece-command-toggle-user-list-buffer-mode
400 Toggle visibility of the user list
401 window. (@code{riece-command-toggle-user-list-buffer-mode})
403 @findex riece-command-toggle-freeze
404 Disable scrolling of the channel window. (@code{riece-command-toggle-freeze})
406 @findex riece-command-toggle-own-freeze
407 Disable scrolling of the channel window until next
408 send. (@code{riece-command-toggle-own-freeze})
410 @findex riece-command-toggle-away
411 Mark or unmark yourself as "away". (@code{riece-command-toggle-away})
414 @node Connecting to multiple servers, , Commands, Basic usage
415 @section Connecting to multiple servers
417 One of the most important features of Riece is that users can use
418 several IRC servers at the same time.
420 The procedure to use multiple servers consists (1) connecting to the
421 foreign server and (2) joinning a channel:
425 Type @kbd{C-c O} (@code{riece-command-open-server}), and then you will
426 be asked the server name.
429 Type @kbd{C-c j} (@code{riece-command-join}) to join a channel. Here
430 the server name follows the channel name. To input a space character,
431 use @kbd{C-q}. For example, if you want to join the channel
432 @samp{#Riece} on the server @samp{irc6}, type @kbd{C-c j #Riece C-q SPC
436 If you want to send IRC command without joinning a channel, @kbd{C-c M}
437 (@code{riece-command-universal-server-name-argument}) may be useful.
439 Commands used for connection management are listed below:
443 @findex riece-command-open-server
444 Connect to the foreign server. (@code{riece-command-open-server})
446 @findex riece-command-close-server
447 Close the connection to the server. (@code{riece-command-close-server})
449 @findex riece-command-universal-server-name-argument
450 Issue a command on the specified
451 server. (@code{riece-command-universal-server-name-argument})
454 @node Index, Function Index, Basic usage, Top
458 @node Function Index, Variable Index, Index, Top
459 @chapter Function Index
462 @node Variable Index, , Function Index, Top
463 @chapter Variable Index