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