source: xsoft/other/xchat.xml@ 5e63563

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY xchat-download-http "http://www.xchat.org/files/source/2.8/xchat-&xchat-version;.tar.bz2">
  <!ENTITY xchat-download-ftp  "&gentoo-ftp-repo;/xchat-&xchat-version;.tar.bz2">
  <!ENTITY xchat-md5sum        "6775c44f38e84d06c06c336b32c4a452">
  <!ENTITY xchat-size          "1.4 MB">
  <!ENTITY xchat-buildsize     "40 MB">
  <!ENTITY xchat-time          "0.4 SBU">
]>

<sect1 id="xchat" xreflabel="XChat-&xchat-version;">
  <?dbhtml filename="xchat.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>XChat-&xchat-version;</title>

  <indexterm zone="xchat">
    <primary sortas="a-XChat">XChat</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to XChat</title>

    <para><application>XChat</application> is an IRC chat program.  It allows
    you to join multiple IRC channels (chat rooms) at the same time, talk
    publicly, have private one-on-one conversations, etc.  File transfers are
    also possible.</para>

    &lfs70_checked;    
    
    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&xchat-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&xchat-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &xchat-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &xchat-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &xchat-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &xchat-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">XChat Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="pkgconfig"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="gtk2"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="dbus-glib"/>,
    <xref linkend="openssl"/>,
    <xref linkend="python2"/>,
    <xref linkend="tcl"/>,
    <xref linkend="GConf"/>, and
    <xref linkend="libsexy"/> or
    <ulink url="http://gtkspell.sourceforge.net/">GtkSpell</ulink> (not recommended)</para>

    <para>Note that using <application>libsexy</application> for spell checking
    requires <xref linkend="enchant"/> at run-time. <xref linkend="aspell"/> is
    just one of many backend spell libraries <application>Enchant</application>
    can use.</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/xchat"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of XChat</title>

    <para>Install <application>XChat</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=&gnome-etc-dir; \
            --enable-shm &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/xchat-&xchat-version; &amp;&amp;
install -v -m644    README faq.html \
                    /usr/share/doc/xchat-&xchat-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-sysconfdir.xml"/>

    <para><parameter>--enable-shm</parameter>: This parameter is used to enable
    XShm for fast tinting.</para>
    
    <para><parameter>--enable-ipv6</parameter>: Enable IPv6 support in xchat.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>xchat</seg>
        <seg>XChat binding modules</seg>
        <seg>/usr/lib/xchat and /usr/share/doc/xchat-&xchat-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="xchat-prog">
        <term><command>xchat</command></term>
        <listitem>
          <para> is a graphical Internet Relay Chat (IRC) client.</para>
          <indexterm zone="xchat xchat-prog">
            <primary sortas="b-xchat">xchat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!-- <varlistentry id="xchat-remote">
        <term><command>xchat-remote</command></term>
        <listitem>
          <para> is a program for remote access
          <application>XChat</application> using DBUS.</para>
          <indexterm zone="xchat xchat-remote">
            <primary sortas="b-xchat-remote">xchat-remote</primary>
          </indexterm>
        </listitem>
      </varlistentry> -->

    </variablelist>

  </sect2>

</sect1>