weechat/doc/en/intro.en.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--

WeeChat documentation (english version)

Copyright (c) 2003-2009 by FlashCode <flashcode@flashtux.org>

This manual is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This manual is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

-->

<chapter id="chapIntroduction">
  <title>Introduction</title>
  
  <para>
    This chapter describes WeeChat and pre-requisites for its installation.
  </para>
  
  <section id="secDescription">
    <title>Description</title>
    
    <para>
      WeeChat (Wee Enhanced Environment for Chat) is a free chat client,
      fast and light, designed for many operating systems.
    </para>
    
    <para>
      Main features are:
      <itemizedlist>
        <listitem>
          <para>
            multi-protocols (IRC and other soon)
          </para>
        </listitem>
        <listitem>
          <para>
            multi-servers connection (with SSL, IPv6, proxy)
          </para>
        </listitem>
        <listitem>
          <para>
            many GUI: Curses (wxWidgets, Gtk and Qt under development)
          </para>
        </listitem>
        <listitem>
          <para>
            small, fast and light
          </para>
        </listitem>
        <listitem>
          <para>
            customizable and extensible with plugins and scripts
          </para>
        </listitem>
        <listitem>
          <para>
            compliant with IRC <acronym>RFC</acronym>s
            <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink>,
            <ulink url="http://www.ietf.org/rfc/rfc2810.txt">2810</ulink>,
            <ulink url="http://www.ietf.org/rfc/rfc2811.txt">2811</ulink>,
            <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> and
            <ulink url="http://www.ietf.org/rfc/rfc2813.txt">2813</ulink>
          </para>
        </listitem>
        <listitem>
          <para>
            multi-platform (GNU/Linux, *BSD, MacOS X, Windows and other)
          </para>
        </listitem>
        <listitem>
          <para>
            100% GPL, free software
          </para>
        </listitem>
      </itemizedlist>
    </para>
    
    <para>
      WeeChat homepage is here:
      <ulink url="http://weechat.flashtux.org/">
        http://weechat.flashtux.org/
      </ulink>
    </para>
    
  </section>
  
  <section id="secPreRequisites">
    <title>Pre-requisites</title>
    
    <para>
      In order to install WeeChat, you <emphasis>need</emphasis>:
      <itemizedlist>
        <listitem>
          <para>
            a running GNU/Linux system (with compiler tools for source
            package), or compatible OS (see above)
          </para>
        </listitem>
        <listitem>
          <para>
            "root" privileges (to install WeeChat in a system directory)
          </para>
        </listitem>
        <listitem>
          <para>
            according to GUI, one of the following libraries:
            <itemizedlist>
              <listitem>
                <para>
                  Curses: ncurses library
                </para>
              </listitem>
              <listitem>
                <para>
                  Gtk: <emphasis>*** GUI not developed ***</emphasis>
                </para>
              </listitem>
              <listitem>
                <para>
                  WxWidgets: <emphasis>*** GUI not developed ***</emphasis>
                </para>
              </listitem>
              <listitem>
                <para>
                  Qt: <emphasis>*** GUI not developed ***</emphasis>
                </para>
              </listitem>
            </itemizedlist>
          </para>
        </listitem>
      </itemizedlist>
    </para>
    
  </section>
</chapter>