source: xsoft/other/pidgin.xml@ 60530f7

<?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-dl;/pidgin/pidgin-&pidgin-version;.tar.bz2">
  <!ENTITY pidgin-download-ftp  " ">
  <!ENTITY pidgin-md5sum        "bba0fd38ee1d8b9b725c4dbdc33e58e7">
  <!ENTITY pidgin-size          "8.3 MB">
  <!ENTITY pidgin-buildsize     "297 MB (with tests and docs)">
  <!ENTITY pidgin-time          "0.6 SBU (using parallelism=4; with tests and docs)">
]>

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

  <sect1info>
    <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 Bonjour, ICQ,
      GroupWise, Jabber/XMPP, IRC, Gadu-Gadu, SILC, SIMPLE, and Zephyr.
    </para>

    &lfs110a_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"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libgcrypt"/>,
      <xref linkend="gstreamer10"/> (required for audio support), and
      <xref linkend="gnutls"/> or
      <xref role="nodep" 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">
      <xref linkend="avahi"/> (required for the Bonjour plugin),
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="dbus"/>,
      <xref linkend="doxygen"/>,
      <xref linkend="evolution-data-server"/>,
      <xref linkend="GConf"/>,
      <xref linkend="graphviz"/>,
      <xref linkend="libidn"/> (required, if you wish to run the test suite),
      <xref linkend="libnsl"/>,
      <xref linkend="NetworkManager"/>,
      <xref linkend="sqlite"/> (required for the Contact Availability Prediction
      plugin),
      <xref linkend="startup-notification"/>,
      <!-- <xref linkend="tcl"/>, -->
      <xref linkend="tk"/>,
      <ulink url="http://www.freedesktop.org/wiki/Software/Farstream">
      Farstream (Version 0.1)</ulink>
      (required for video and voice support),
      <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink>,
      <ulink url="http://libgadu.net/">libgadu</ulink>,
      <ulink url="http://meanwhile.sourceforge.net/">Meanwhile</ulink>
      (required for Sametime protocol support),
      <ulink url="https://www.mono-project.com/">Mono</ulink>,
      <ulink url="http://silcnet.org/client.html">SILC Client</ulink>,
      <ulink url="http://silcnet.org/client.html">SILC Toolkit</ulink>,
      <ulink url="http://packages.debian.org/stable/source/zephyr">Zephyr</ulink>, and
      <xref linkend="mitkrb"/> (required for Kerberos support in the Zephyr
      module)
    </para>

    <bridgehead renderas="sect4">Optional (runtime)</bridgehead>
    <para role="optional">
      <xref role="runtime" linkend="xdg-utils"/>
    </para>

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

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

    <para>
      If you wish to run the test suite, make sure that <xref
      linkend="libidn"/> is installed and remove the switch
      <quote>--disable-idn</quote>. Compile <application>Pidgin</application>
      by running the following commands:
    </para>

<!-- - -with-gstreamer=1.0 is removed and gstreamer support is disabled
     because of a build problem when both this and - -disable-vv are present.
     See https://hastebin.com/utiwijizad.rb for more details, and check again
     at the next version (2.14.1 or 3.0 - whichever is next). -->

<screen><userinput>./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --disable-gstreamer  \
            --disable-avahi      \
            --disable-gtkspell   \
            --disable-meanwhile  \
            --disable-idn        \
            --disable-nm         \
            --disable-vv         &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:
    </para>

<screen remap="doc"><userinput>make docs</userinput></screen>

    <para>
      Remember the remarks before <command>configure</command>. 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 -pv /usr/share/doc/pidgin-&pidgin-version; &amp;&amp;
cp -v 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"
        remap="doc"><userinput>mkdir -pv /usr/share/doc/pidgin-&pidgin-version;/api &amp;&amp;
cp -v doc/html/* /usr/share/doc/pidgin-&pidgin-version;/api</userinput></screen>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/update-icons-and-desktop.xml"/>

  </sect2>

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

<!--
    <para>
      <parameter>- -with-gstreamer=1.0</parameter>: Remove this switch
      and add <option>- -disable-gstreamer</option>
      if you've not installed <xref linkend="gstreamer10"/>.
    </para>
-->
    <para>
      <parameter>--disable-gstreamer</parameter>: This switch disables gstreamer
      support because there are problems with the build when Voice/Video support
      is disabled, and gstreamer is enabled.
      <!-- The problems exist within gst_device_monitor. See
           https://hastebin.com/utiwijizad.rb for more details.
           FIXME: Check this at the next release of pidgin, or if we ever add
           Farstream. -->
    </para>

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

    <para>
      <parameter>--disable-gtkspell</parameter>: Remove this
      switch if you've installed
      <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink> and wish
      to enable spellchecking support.
    </para>

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

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

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

    <para>
      <parameter>--disable-vv</parameter>: Remove this
      switch if you've installed
      <ulink url="http://www.freedesktop.org/wiki/Software/Farstream">
      Farstream (Version 0.1)</ulink> and wish to enable voice and video
      communication support. You should also remove the --disable-gstreamer
      flag.
    </para>
<!--
    <para>
      <parameter>- -disable-tcl</parameter>: Remove this switch if you've
      installed <xref linkend="tcl"/>.
    </para>
i-->
    <para>
      <option>--enable-cyrus-sasl</option>: Use this switch if you've installed
      <xref linkend="cyrus-sasl"/> and wish to build
      <application>Pidgin</application> with SASL support.
    </para>

    <para>
      <option>--disable-gnutls</option>: Use this switch if you've got both
      <xref linkend="gnutls"/> and <xref linkend="nss"/> installed, but want
      to use <xref linkend="nss"/> for the SSL support.
    </para>

  </sect2>

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

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

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

      <indexterm zone="pidgin pidgin-config">
        <primary sortas="e-AA.gtkrc-20">~/.gtkrc-2.0</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-2.0</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-2.0</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
        </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"?>

 <!-- Seems to be removed with 2.14.0
      <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>
-->
      <varlistentry id="pidgin-prog">
        <term><command>pidgin</command></term>
        <listitem>
          <para>
            is a <application>GTK+</application> 2 instant messaging client
          </para>
          <indexterm zone="pidgin pidgin-prog">
            <primary sortas="b-pidgin">pidgin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="purple-client-example">
        <term><command>purple-client-example</command></term>
        <listitem>
          <para>
            is an example that demonstrates how to use the libpurple-client
            library to communicate with purple
          </para>
          <indexterm zone="pidgin purple-client-example">
            <primary sortas="b-purple-client-example">purple-client-example</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="purple-remote">
        <term><command>purple-remote</command></term>
        <listitem>
          <para>
            sends remote commands to Pidgin/Finch
          </para>
          <indexterm zone="pidgin purple-remote">
            <primary sortas="b-purple-remote">purple-remote</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="purple-send">
        <term><command>purple-send</command></term>
        <listitem>
          <para>
            calls purple API functions using DBus and prints the return value
          </para>
          <indexterm zone="pidgin purple-send">
            <primary sortas="b-purple-send">purple-send</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="purple-send-async">
        <term><command>purple-send-async</command></term>
        <listitem>
          <para>
            calls purple API functions using DBus. As opposed to
            <command>purple-send</command>, it does not print the return value
          </para>
          <indexterm zone="pidgin purple-send-async">
            <primary sortas="b-purple-send-async">purple-send-async</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="purple-url-handler">
        <term><command>purple-url-handler</command></term>
        <listitem>
          <para>
            is a python script to handle URLs with purple
          </para>
          <indexterm zone="pidgin purple-url-handler">
            <primary sortas="b-purple-url-handler">purple-url-handler</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>