X-Git-Url: http://git.chise.org/gitweb/?p=elisp%2Friece.git;a=blobdiff_plain;f=doc%2Friece-en.texi;h=695154cd15f6b9358640afca51fce4f6c4871659;hp=6cf1bd20a4e65033b0de63f243c3ff573af5ca51;hb=d464dd4cda287ad1d4722ddf565b60ebefdc3471;hpb=268e6aeaded94cf18195d72f9a8198ab9d5bc3dc diff --git a/doc/riece-en.texi b/doc/riece-en.texi index 6cf1bd2..695154c 100644 --- a/doc/riece-en.texi +++ b/doc/riece-en.texi @@ -1,9 +1,9 @@ -\input texinfo @c -*- mode: texinfo; coding: iso-2022-jp -*- +\input texinfo @c -*- mode: texinfo -*- @c %**start of header @setfilename riece-en.info @settitle Riece -- An IRC client for Emacsen -- @c %**end of header -@set VERSION 1.0.4 +@set VERSION 3.1.1 @c @documentlanguage en @dircategory GNU Emacs Lisp @@ -14,7 +14,7 @@ @ifinfo This file describes Riece. -Copyright (C) 2003,2004 Daiki Ueno. +Copyright (C) 2003,2004,2005 Daiki Ueno. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or @@ -33,7 +33,7 @@ Free Documentation License". @page @vskip 0pt plus 1filll -Copyright @copyright{} 2003 Daiki Ueno. +Copyright @copyright{} 2003,2004,2005 Daiki Ueno. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or @@ -49,12 +49,14 @@ Free Documentation License". @node Top, Overview, (dir), (dir) @top Riece user's manual -Riece is a program to participate in IRC (Internet Relay Chat) from Emacs. +This manual documents Riece version @value{VERSION}. In addition to this +manual, you may find useful information about Riece from Riece's official +home page @uref{http://www.nongnu.org/riece/}. @menu -* Overview:: What's Riece? -* Getting started:: -* Basic usage:: Let's talk with other people. +* Overview:: Read me first. +* Getting started:: Let's talk with other people. +* Basic usage:: * Index:: * Function Index:: * Variable Index:: @@ -63,113 +65,102 @@ Riece is a program to participate in IRC (Internet Relay Chat) from Emacs. @node Overview, Getting started, Top, Top @chapter Overview -Riece is an IRC (Internet Relay Chat) client for Emacs and is a full -rewrite of the predecessor product "Liece" (whose code has been -unmaintainable for a long time), while providing user interface -compatible with Liece. +Riece is a user interface for IRC (Internet Relay Chat). You should +spell it with the first letter capitalized and pronounce it as /ri:s/. -For now it does not have rich functions as an IRC client, but there are -noteworthy points as compared with Liece: +The features of Riece are as follows: @itemize @bullet -@item Several IRC servers may be used at the same time. -@item Essential features can be built upon the extension framework (called "add-on") capable of dependency tracking. -@item Installation is easy. Riece doesn't depend on other packages. -@item Setup is easy. Automatically save/restore the configuration. -@item Step-by-step instructions (currently written in Japanese) are included. -@item Mostly compliant with the latest IRC client protocol (RFC 2812). -@end itemize +@item +Several IRC servers may be used at the same time. + +@item +Many features built upon the extension mechanism called add-on. +Currently 30 such add-ons are available. -For more details, please look at the following pages: +@item +Installation is easy. Riece doesn't depend on other packages. -@itemize @bullet -@item http://www.nongnu.org/riece/ -@item http://wiliki.designflaw.org/index.cgi?Riece&l=jp -@item http://www.unixuser.org/~ueno/liece/ +@item +Setup is easy. Automatically save/restore the configuration. + +@item +Step-by-step instructions are included. + +@item +Mostly compliant with the latest IRC client protocol (RFC 2812). @end itemize @node Getting started, Basic usage, Overview, Top @chapter Getting started -@menu -* Required Environments:: -* Installation:: -* Startup File:: -@end menu - -@node Required Environments, Installation, Getting started, Getting started -@section Required Environments +To start Riece, follow the instruction below: -We have checked this version working on the following environments. +@enumerate +@item +@kbd{M-x load-library riece} -@itemize @bullet -@item Emacs 20.7 or later -@item XEmacs 21.4 or later -@end itemize +@item +@kbd{M-x riece} +@end enumerate -@node Installation, Startup File, Required Environments, Getting started -@section Installation +In case that @samp{Cannot open load file: riece} is signalled in (1), +you should probably have an installation problem. If you installed +Riece from source tarball, please read README again. If you are +trying to use a package distribution, check out the documentation. -The latest version of Riece can be obtained from -@uref{http://wiliki.designflaw.org/riece.cgi}. After unpacking the -tarball, you can install with the following commands: +Once Riece started successfully, you will be asked the name of the IRC +server to connect. IRC servers publicly available are taken from the +Web pages of IRC networks: -@example -./configure -make -make install -@end example +@itemize @bullet +@item http://irc.kyoto-u.ac.jp +@item http://freenode.net +@end itemize -If you want to install Riece as an XEmacs package, use the following -commands instead of the above: +You may see the following message: @example -./configure --with-xemacs[=xemacs-21.4.15] -make package -make install-package +Nickname "ueno" already in use. Choose a new one: @end example -If you do not so, it is necessery to add autoload setting to your Emacs -startup file to be able to start Riece by typing @kbd{M-x riece}. - -@lisp -(autoload 'riece "riece" "Start Riece" t) -@end lisp - -@node Startup File, , Installation, Getting started -@section Startup file - -In this section, we describe Riece's startup files. +In IRC, users are identified by @emph{nicknames}. If the nickname you +selected has already used by another person, you must select the new one. -If you are attempting to use Riece by way of trial, nothing needed to be -written in startup files. Thus you can skip this section. +In IRC, users join the @emph{channels} to start multi user +conversation. To join a channel, type @kbd{C-c j}. On IRCnet, there +is a channel named @samp{#Riece} where you can do some tests to get +experienced with Riece. -Riece reads startup files under the directory pointed by the variable -@code{riece-directory} (by default, it has @file{~/.riece/} as the -value). There are two kinds of startup files in the directory: +After you joined a channel, the layout of windows are changed to the +following: -@table @code -@item riece-saved-variables-file -@vindex riece-saved-variables-file -Variables changed during the last session are automatically saved in this file. -(by default, it is located at @file{~/.riece/save}) -@item riece-variables-file -@vindex riece-variables-file -Users can edit this file to configure their own settings (by default, it -is located at @file{~/.riece/init}) -@end table +@example ++-----+-----------------+ +| | | +| | | +| (1) | (2) | +| | | +| | | ++-----+-----------------+ +| | (4) | +| +-----------------+ +| (3) | | +| | (5) | +| | | ++-----+-----------------+ +@end example -At startup, Riece will first read @code{riece-saved-variables-file} , -and then @code{riece-variables-file}. That is to say, automatically -saved variables may be refered/modified by user configuration. +You can send messages by entering messages in (4). Messages from +other persons are shown in (2). @node Basic usage, Index, Getting started, Top @chapter Basic usage -To start Riece, type @kbd{M-x riece}. Then you need to select an IRC -server to connect. Typical IRC network consists of several IRC servers -and you can pick up appropriate one. Most of them provide a list of -available servers on their Web pages: +To start Riece, you just type @kbd{M-x riece}. Then you will prompted +for the name of an IRC server. A typical IRC network may consist of +several IRC servers and you will need to pick up appropriate one. Most +of IRC networks provide a list of available servers on their Web pages: @itemize @bullet @item http://irc.kyoto-u.ac.jp @@ -182,12 +173,12 @@ default, your nickname is generated from your login name. @vindex riece-nickname After successfully connecting to an IRC server, you can join a channel -and talk with people in there. To join a channel, type @kbd{C-c j}. -There is the channel @samp{#Riece} on IRCnet, so feel free to use it for -testing. +and talk with people there. To join a channel, type @kbd{C-c j}. By +the way there is a channel called @samp{#Riece} on IRCnet, so feel free +to use it for testing. -Now you can send the current line by simply hitting Enter key. Messages -from other people will appear on the top-left window. +Now you enter a message and it will be seen by everyone else on the +channel. Messages from other people will appear on the top-left window. @menu * Windows:: @@ -199,7 +190,7 @@ from other people will appear on the top-left window. @node Windows, Indicators, Basic usage, Basic usage @section Windows -By default, Riece uses 5 window to inform user of his status: +By default, Riece uses 5 windows to inform user of his status: @example +-----+-----------------+ @@ -248,7 +239,7 @@ Indicators are characters which indicate your status. Usually they are put on the left side of the modeline like: @example -Riece: --- ueno #Liece [n] +Riece: --- ueno #Riece [n] @end example In this case, @samp{---} are indicators. From left to right their