source: xsoft/other/hexchat.xml@ 0d93d243

<?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;

  <!-- For the next version, remove the -repack -->
  <!ENTITY hexchat-download-http "https://dl.hexchat.net/hexchat/hexchat-&hexchat-version;.tar.xz">
  <!ENTITY hexchat-download-ftp  " ">
  <!ENTITY hexchat-md5sum        "9f04c48f011b646b91d03c5776fce776">
  <!ENTITY hexchat-size          "1.2 MB">
  <!ENTITY hexchat-buildsize     "21 MB">
  <!ENTITY hexchat-time          "0.1 SBU (using parallelism=4)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>HexChat-&hexchat-version;</title>

  <indexterm zone="hexchat">
    <primary sortas="a-HexChat">HexChat</primary>
  </indexterm>

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

    <para>
      <application>HexChat</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>

    &lfs110a_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Optional patch:
          <ulink url="&patch-root;/hexchat-&hexchat-version;-add_libera_chat-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>,
      <xref linkend="glib2"/>, and
      <xref linkend="libnotify"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gtk2"/> and
      <xref linkend="libcanberra"/>
      <!--<xref linkend="lua"/> -->
      <!-- Lua plugin support is currently broken and causes Hexchat to crash
           upon startup.
           FIXME: Check upstream in a few days.-->
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="dbus-glib"/>,
      <xref linkend="iso-codes"/>,
 <!-- <xref linkend="libcanberra"/>, -->
      <xref linkend="libnotify"/>,
      <xref linkend="pciutils"/>,
      <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
      <ulink url="http://luajit.org/">luajit</ulink>,
      if python is enabled
      <ulink url="https://cffi.readthedocs.io/en/latest/">cffi</ulink> and
      <ulink url="https://github.com/eliben/pycparser">pycparser</ulink>.
    </para>

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

  </sect2>

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

<!-- Since 2.16.0 its not longer required, even when python is enabled
    <para>
      First, fix the python plugin:
    </para>
-->
<!-- Since 2.16.0 its added and default:
<screen><userinput remap="pre">sed -i "s/(python_opt/&amp; + '-embed'/" plugins/python/meson.build</userinput></screen>

    <para>
      Next, apply an optional patch to have the "libera.chat" network
      preconfigured in the client:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../hexchat-&hexchat-version;-add_libera_chat-1.patch</userinput></screen>
-->
    <para>
      Install <application>HexChat</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr         \
      --buildtype=release   \
      -Dwith-libproxy=false \
      -Dwith-lua=false      \
      -Dwith-python=false   \
      ..                    &amp;&amp;
ninja</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>ninja install</userinput></screen>

  </sect2>

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

    <!--
    <para>
      <parameter>-Dwith-lua=lua</parameter>: By default, this package
      will look for luajit. Use the normal lua instead.
    </para>
    -->

    <para>
      <parameter>-Dwith-lua=false</parameter>: By default, this package will
      look for luajit. However, the Lua plugin support is currently broken
      and will cause the application to crash on startup.
    </para>

    <para>
      <parameter>-Dwith-python=false</parameter>: If the Python interface
      should be enabled, remove this switch or set it to <literal>true</literal>.
      When enabling Python, two additional modules (cffi and pycparser)
      needs to be installed prior to installation of <application>Hexchat</application>.
    </para>

    <para>
      <option>-Dwith-libcanberra=false</option>: Use this switch if you have
      libcanberra not installed.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>hexchat</seg>
        <seg>None</seg>
        <seg>/usr/lib/hexchat</seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>