doc/liece.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3         "http://docbook.org/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY cvsroot-pserver ":pserver:anonymousl@cvs.m17n.org:/cvs/root">
   5 <!ENTITY liece-version "1.4.4">
   6 <!ENTITY liece-command-prefix
   7 "<keycombo moreinfo="none">
   8 <keycap moreinfo="none">C</keycap><keycap moreinfo="none">c</keycap>
   9 </keycombo>">
  10 ]>
  11
  12 <article id="index">
  13   <articleinfo>
  14     <title>Liece</title>
  15     <abstract>
  16       <para>Emacs IRC client.</para>
  17     </abstract>
  18     <author>
  19       <firstname>Daiki</firstname>
  20       <surname>Ueno</surname>
  21       <affiliation>
  22         <address format="linespecific">
  23           <email>ueno@unixuser.org</email>
  24         </address>
  25       </affiliation>
  26     </author>
  27     <date>2000/09/12</date>
  28     <releaseinfo>Version 1.4.4</releaseinfo>
  29   </articleinfo>
  30
  31   <para>
  32     This manual documents <firstterm>Liece</firstterm> &liece-version;,
  33     the Emacs IRC client.  You may find the latest information from
  34     <ulink url="http://www.unixuser.org/~ueno/liece/">
  35       <firstterm>Liece</firstterm> official home page.
  36     </ulink>
  37   </para>
  38
  39   <sect1 id="overview">
  40     <sect1info>
  41       <abstract>
  42         <para>Summary of <firstterm>Liece</firstterm> features</para>
  43       </abstract>
  44     </sect1info>
  45     <title>Overview</title>
  46
  47     <para>
  48       <firstterm>Liece</firstterm>, the Emacs IRC client,
  49       provides a user-friendly interface to access IRC servers.
  50       <footnote>
  51         Internet Relay Chat: RFC 1459, RFC 2810, RFC 2811, RFC 2812, RFC 2813.
  52       </footnote>
  53     </para>
  54     <para>Currently <firstterm>Liece</firstterm> has following features:</para>
  55     <itemizedlist>
  56       <listitem>
  57         <para>
  58           Clear user interface inspired by
  59           <ulink url="http://www.chocoa.org/">CHOCOA</ulink>
  60         </para>
  61       </listitem>
  62       <listitem><para>Lightweight operation</para></listitem>
  63       <listitem><para>Dynamic window configuration</para></listitem>
  64       <listitem><para>Collect URLs automatically</para></listitem>
  65     </itemizedlist>
  66   </sect1>
  67
  68   <sect1 id="install">
  69     <sect1info>
  70       <abstract>
  71         <para>How to install <firstterm>Liece</firstterm></para>
  72       </abstract>
  73     </sect1info>
  74     <title>Installation</title>
  75
  76     <para>
  77
  78     </para>
  79
  80     <para>
  81       The installation procedure depends on the Emacs flavor you are
  82       running.  Anyway <firstterm>Liece</firstterm> &liece-version;
  83       should work on:
  84     </para>
  85
  86     <simplelist type="vert">
  87       <member>Emacs 20.7 and up.</member>
  88       <member>XEmacs 21.1.12 and up.</member>
  89     </simplelist>
  90
  91     <sect2>
  92       <sect2info>
  93         <abstract>
  94           <para>Complicated stuff you may have to do.</para>
  95         </abstract>
  96       </sect2info>
  97       <title>Prerequisites</title>
  98       <para>
  99         <firstterm>Liece</firstterm> &liece-version; uses APEL and FLIM,
 100         you have to install them in this order.
 101         Generally <command moreinfo="none">make install</command> will do the job.
 102       </para>
 103       <segmentedlist>
 104         <segtitle>Package</segtitle>
 105         <segtitle>Author's version</segtitle>
 106         <seglistitem>
 107           <seg>
 108             <ulink url="ftp://ftp.m17n.org/pub/mule/apel/">APEL (A Portable Emacs Library)</ulink></seg>
 109           <seg>10.2 or later</seg>
 110         </seglistitem>
 111         <seglistitem>
 112           <seg>
 113             <ulink url="ftp://ftp.m17n.org/pub/mule/flim/">FLIM</ulink>
 114           </seg>
 115           <seg>1.12 or later</seg>
 116         </seglistitem>
 117       </segmentedlist>
 118     </sect2>
 119     <sect2>
 120       <title>Compilation</title>
 121       <para>
 122         In the top level directory of the <firstterm>Liece</firstterm> distribution,
 123         run the script <filename moreinfo="none">configure</filename> as follows:
 124       </para>
 125       <informalexample>
 126         <screen format="linespecific">
 127 <prompt moreinfo="none">$</prompt> ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
 128         </screen>
 129       </informalexample>
 130       <para>
 131         If you are using XEmacs and want to install to XEmacs package directory,
 132         specify <option>--enable-package</option>.
 133         If you wish to build with a specific version of Emacs,
 134         use <option>--with-emacs</option>.
 135       </para>
 136       <para>
 137         When it is done, <filename moreinfo="none">configure</filename>
 138         just creates the files:
 139       </para>
 140       <simplelist type="vert">
 141         <member>Makefile</member>
 142         <member>lisp/Makefile</member>
 143         <member>dcc/Makefile</member>
 144         <member>doc/Makefile</member>
 145         <member>etc/Makefile</member>
 146       </simplelist>
 147       <para>
 148         Then run <command moreinfo="none">make</command> to finish building
 149         <firstterm>Liece</firstterm> in the standard way.
 150         You can install the package with
 151         <command moreinfo="none">make install</command>.
 152       </para>
 153     </sect2>
 154   </sect1>
 155
 156   <sect1 id="usage">
 157     <sect1info>
 158       <abstract>
 159         <para>The various usage possibilities</para>
 160       </abstract>
 161     </sect1info>
 162     <title>Usage</title>
 163     <sect2>
 164       <sect2info>
 165         <abstract>
 166           <para>Finding an IRC server and connecting to it</para>
 167         </abstract>
 168       </sect2info>
 169       <title>Servers</title>
 170       <para>
 171         <firstterm>Liece</firstterm> comes with a list of servers
 172         held in the variable <varname>liece-server-alist</varname>.
 173       </para>
 174     </sect2>
 175     <sect2>
 176       <sect2info>
 177         <abstract>
 178           <para>Starting <firstterm>Liece</firstterm></para>
 179         </abstract>
 180       </sect2info>
 181       <title>Start <firstterm>Liece</firstterm></title>
 182       <para>
 183         If installation and configuration worked well,
 184         you can invoke <firstterm>Liece</firstterm> typing
 185         <command moreinfo="none">
 186           <keycombo moreinfo="none">
 187             <keycap moreinfo="none">M</keycap>
 188             <keycap moreinfo="none">x</keycap>
 189           </keycombo>
 190           liece
 191         </command>
 192         in Emacs.
 193       </para>
 194     </sect2>
 195     <sect2>
 196       <title>Basic Key Bindings</title>
 197       <para>
 198         Once join a channel, if you type normal text then you will see it come up
 199         in the channel with your nick before it.
 200         If anyone else was in the channel they would also see that.
 201       </para>
 202       <para>
 203         If you are familiar with IRC, you can issue commands with leading
 204         <command moreinfo="none">
 205           &liece-command-prefix;<keycap moreinfo="none">/</keycap>
 206         </command>, while there are many shortcut:
 207       </para>
 208       <variablelist>
 209         <varlistentry>
 210           <term>&liece-command-prefix;<keycap moreinfo="none">j</keycap></term>
 211           <listitem>
 212             <para>
 213               Join one or more comma separated channels with given optional keys.
 214             </para>
 215           </listitem>
 216         </varlistentry>
 217         <varlistentry>
 218           <term>&liece-command-prefix;<keycap moreinfo="none">n</keycap></term>
 219           <listitem>
 220             <para>Change your nickname.</para>
 221           </listitem>
 222         </varlistentry>
 223         <varlistentry>
 224           <term>&liece-command-prefix;<keycap moreinfo="none">q</keycap></term>
 225           <listitem>
 226             <para>
 227               Quit <firstterm>Liece</firstterm>.
 228               You can specify the comment by a prefix argument.
 229             </para>
 230           </listitem>
 231         </varlistentry>
 232         <varlistentry>
 233           <term>&liece-command-prefix;<keycap moreinfo="none">p</keycap></term>
 234           <listitem>
 235             <para>
 236               Part one or more channels.
 237               You can specify the comment by a prefix argument.
 238             </para>
 239           </listitem>
 240         </varlistentry>
 241       </variablelist>
 242     </sect2>
 243   </sect1>
 244
 245   <sect1 id="copying">
 246     <sect1info>
 247       <abstract>
 248         <para>Copyright and warranty</para>
 249       </abstract>
 250     </sect1info>
 251     <title>Copying</title>
 252     <para>
 253       This program is free software; you can redistribute it and/or modify
 254       it under the terms of the GNU General Public License as published by
 255       the Free Software Foundation; either version 2 of the License, or
 256       (at your option) any later version.
 257     </para>
 258     <para>
 259       This program is distributed in the hope that it will be useful,
 260       but WITHOUT ANY WARRANTY; without even the implied warranty of
 261       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 262       GNU General Public License for more details.
 263     </para>
 264     <para>
 265       You should have received a copy of the GNU General Public License
 266       along with this program; if not, write to the Free Software
 267       Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 268     </para>
 269   </sect1>
 270 </article>