source: xsoft/other/pidgin.xml@ c80db1b

<?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 pidgin-download-http
    "&sourceforge-repo;/pidgin/pidgin-&pidgin-version;.tar.bz2">
  <!ENTITY pidgin-download-ftp  " ">
  <!ENTITY pidgin-md5sum        "264f9ae89742b8ee168306b85d2fb51e">
  <!ENTITY pidgin-size          "9.6 MB">
  <!ENTITY pidgin-buildsize     "255 MB">
  <!ENTITY pidgin-time          "2.3 SBU">
]>

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

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

  <title>Pidgin-&pidgin-version;</title>

  <indexterm zone="pidgin">
    <primary sortas="a-Pidgin">Pidgin</primary>
  </indexterm>

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

    <para>
      <application>Pidgin</application> is a Gtk+ 2 instant messaging client
      that can connect with a wide range of networks including AIM, ICQ,
      GroupWise, MSN, Jabber, IRC, Napster, Gadu-Gadu, SILC, Zephyr and Yahoo!
    </para>

    &lfs71_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk2"/> and
      <xref linkend="perl-xml-parser"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gnutls"/> or
      <xref linkend="nss"/>
    </para>

    <para>
      SSL support is required for the MSN Messenger, Yahoo!, Novel Groupwise and
      Google Talk protocol plugins. <application>GnuTLS</application> is the
      preferred method (the Mozilla nss API is more likely to change and this
      can cause problems).
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink>,
      <xref linkend="startup-notification"/>,
      <xref linkend="intltool"/>,
      <xref linkend="GConf"/>,
      <xref linkend="dbus-glib"/>,
      <xref linkend="libidn"/>,
      <ulink url="http://silcnet.org/software/">SILC Client</ulink>,
      <ulink url="http://silcnet.org/software/">SILC Toolkit</ulink>,
      <ulink url="http://packages.debian.org/stable/source/zephyr">zephyr</ulink>,
      <xref linkend="gstreamer"/> (required for audio support),
      <xref linkend="farsight2"/> (required for video and voice support),
      <xref linkend="evolution-data-server"/>,
      <xref linkend="sqlite"/> (required for the Contact Availability Prediction
      plugin),
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="mitkrb"/> (required for Kerberos support in the Zephyr
      module),
      <xref linkend="avahi"/>, (required for the Bonjour plugin),
      <ulink url="http://meanwhile.sourceforge.net/">Meanwhile</ulink>
      (required for Sametime protocol support),
      <xref linkend="NetworkManager"/>,
      <ulink url="http://toxygen.net/libgadu/">libgadu</ulink>,
      <xref linkend="check"/> (only used during the test suite) and
      <xref linkend="tcl"/>
    </para>

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

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

    <para>
      Compile <application>Pidgin</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-meanwhile --disable-avahi  \
  --disable-nm --disable-tcl --disable-idn --disable-gstreamer \
  --disable-vv --disable-gtkspell --disable-dbus LIBS=-lX11    &amp;&amp;
make</userinput></screen>

    <para>
      If you have <xref linkend="doxygen"/> installed
      (<xref linkend="graphviz"/> can be used also) and you wish to create the
      API documentation, issue: <command>make docs</command>
    </para>

    <para>To test the results, issue: <command>make check</command>.</para>

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

<screen role="root"><userinput>make install &amp;&amp;
mkdir /usr/share/doc/pidgin-&pidgin-version; &amp;&amp;
cp README doc/gtkrc-2.0 /usr/share/doc/pidgin-&pidgin-version;</userinput></screen>

    <para>
      If you created the API documentation, install it using the following
      commands as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>mkdir /usr/share/doc/pidgin-&pidgin-version;/api &amp;&amp;
cp doc/html/* /usr/share/doc/pidgin-&pidgin-version;/api</userinput></screen>
  </sect2>

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

    <para>
      <option>--disable-meanwhile</option>: Remove this option if you've
      installed <ulink url="http://meanwhile.sourceforge.net/">Meanwhile</ulink>
    </para>

    <para>
      <option>--disable-avahi</option>: Remove this option if you've
    installed <xref linkend="avahi"/>.</para>

    <para>
      <option>--disable-nm</option>: Remove this option if you've installed
      <xref linkend="NetworkManager"/>.
    </para>

    <para>
      <option>--disable-tcl</option>: Remove this option if you've installed
      <xref linkend="tcl"/>.
    </para>

    <para>
      <option>--disable-idn</option>: Remove this option if you've installed
      <xref linkend="libidn"/>.
    </para>

    <para>
      <option>--disable-gstreamer</option>: Sounds. Remove this option if you've
      installed <xref linkend="gstreamer"/>.
    </para>

    <para>
      <option>--disable-vv</option>: Video and voice. Remove this option if
      you've installed <xref linkend="farsight2"/>.
    </para>

    <para>
      <option>--disable-gtkspell</option>: Spellchecking. Remove this option if
      you've installed
      <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink>.
    </para>

    <para>
      <option>--disable-dbus</option>: Remove this option if you've installed
      <xref linkend="dbus"/>.
    </para>

    <para>
      <parameter>LIBS=-lX11</parameter>: This parameter needs to be passed to
      configure to avoid a link time error with recent versions of binutils.
    </para>

    <para>
      <option>--disable-gtkui</option>: Use this option if you've not installed
      <xref linkend="gtk2"/> and you just want the
      <application>Ncurses</application> based <command>finch</command>
      program.
    </para>
  </sect2>

  <sect2 role="configuration">
    <title>Configuring Pidgin</title>

    <sect3 id="pidgin-config">
      <title>Config Files</title>
      <para><filename>~/.purple/*</filename> and
      <filename>~/.gtkrc-02</filename></para>

      <indexterm zone="pidgin pidgin-config">
        <primary sortas="e-AA-purple-star">~/.purple/*</primary>
      </indexterm>

      <indexterm zone="pidgin pidgin-config">
        <primary sortas="e-AA-gtkrc-02">~/.gtkrc-02</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>

      <para>
        Most configuration can be accomplished by using the various preference
        settings inside the programs. Additionally, you can create a
        <filename>~/.gtkrc-02</filename> file which can store gtk+-2 theme
        settings that affect <application>Pidgin</application> and other Gtk+ 2
        applications. Note that an example <filename>gtkrc-02</filename> file
        was installed during the package installation and can be used as a
        starting point or reference.
      </para>
    </sect3>
  </sect2>

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

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

      <seglistitem>
        <seg>
          finch,
          pidgin,
          purple-client-example,
          purple-remote,
          purple-send,
          purple-send-async and
          purple-url-handler
        </seg>
        <seg>
          libgnt.so,
          libpurple.so and
          libpurple-client.so along with numerous plugin and support modules
          located in /usr/lib/finch, /usr/lib/gnt, /usr/lib/pidgin and
          /usr/lib/purple-2
        </seg>
        <seg>
          /usr/include/finch,
          /usr/include/gnt,
          /usr/include/libpurple,
          /usr/include/pidgin,
          /usr/lib/finch,
          /usr/lib/gnt,
          /usr/lib/pidgin,
          /usr/lib/purple-2,
          /usr/share/doc/pidgin-&pidgin-version;,
          /usr/share/pixmaps/pidgin,
          /usr/share/purple and
          /usr/share/sounds/purple
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="pidgin-prog">
        <term><command>pidgin</command></term>
        <listitem>
          <para>is a Gtk+-2 instant messaging client</para>
          <indexterm zone="pidgin pidgin-prog">
            <primary sortas="b-pidgin">pidgin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="finch">
        <term><command>finch</command></term>
        <listitem>
          <para>is a text-based instant messaging client</para>
          <indexterm zone="pidgin finch">
            <primary sortas="b-finch">finch</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>