source: xsoft/other/pidgin.xml@ 889c7c3f

<?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 "http://downloads.sourceforge.net/pidgin/pidgin-&pidgin-version;.tar.bz2">
  <!ENTITY pidgin-download-ftp  " ">
  <!ENTITY pidgin-md5sum        "83f44bf9c076595967f7374c50250176">
  <!ENTITY pidgin-size          "7.7 MB">
  <!ENTITY pidgin-buildsize     "172 MB (additinoal 106 MB for API documentation)">
  <!ENTITY pidgin-time          "2.5 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 an 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>

    <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="glib2"/>,
    <xref linkend="libxml2"/>, and
    <xref linkend="perl-xml-parser"/></para>

    <bridgehead renderas="sect4">Optional for SSL Support</bridgehead>
    <para role="optional"><ulink url="http://ftp.gnupg.org/gcrypt/gnutls/">GnuTLS</ulink> (requires
    <xref linkend="libgcrypt"/>) or
    <xref linkend="nss"/></para>

    <para>SSL support is required for MSN and Google Talk support and
      <application>GnuTLS</application> is the preferred method. Note that one of
    <xref linkend="firefox"/>,
    <xref linkend="thunderbird"/>,
    <xref linkend="seamonkey"/>,or
    <ulink url="http://www.mozilla.org/products/mozilla1.x/">Mozilla</ulink> can be used instead
      of NSS.</para>

    <bridgehead renderas="sect4">Optional GUI Tools</bridgehead>
    <para role="optional">
    <xref linkend="gtk2"/>
      (required to build the GUI interface),
    <ulink url="http://gtkspell.sourceforge.net/">Gtkspell</ulink>
      (for spell-check support and only used if <application>Gtk+</application> is installed),
    <xref linkend="xscreensaver"/>
      (to check for idleness and only used if <application>Gtk+</application> is installed),
    <xref linkend="startup-notification"/>
      (only used if <application>Gtk+</application> is installed), and
    <xref linkend="x-window-system"/>
      (used for session management support)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="intltool"/>,
    <xref linkend="GConf"/>,
    <xref linkend="dbus-glib"/> (requires
    <xref linkend="python"/> also),
    <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="evolution-data-server"/>
      (required for Evolution integration),
    <ulink url="http://www.sqlite.org/">SQLite</ulink>
      (required for the Contact Availability Prediction plugin),
    <xref linkend="cyrus-sasl"/>
      (required for Jabber support),
    <xref linkend="mitkrb"/>
      (required for Kerberos support in the Zephyr module),
    <ulink url="http://www.avahi.org">Avahi</ulink>
      (required for the Bonjour plugin),
    <ulink url="http://meanwhile.sourceforge.net/">Meanwhile</ulink>
      (required for Sametime protocol support),
    <ulink url="http://www.gnome.org/projects/NetworkManager/">NetworkManager</ulink>
    (<ulink url="&gnome-download-http;/NetworkManager/">download</ulink> and
      requires that <application>D-Bus</application> is installed),
    <ulink url="http://sourceforge.net/projects/check">check</ulink>
      (only used during the test suite), and
    Gadu-Gadu external libraries (cannot find a URL)</para>

    <bridgehead renderas="sect4">Optional for Programming Language Support</bridgehead>
    <para role="optional"><ulink url="http://www.mono-project.com/Main_Page">Mono</ulink>
      (experimental),
    <xref linkend="tcl"/>, and
    <xref linkend="tk"/></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 \
            --with-gconf-schema-file-dir=&gnome-etc-dir;/gconf/schemas \
            --disable-gtkui &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>. Note
    that the end result of the suite indicates an error. This error is only
    due to some locale translation issues and not the actual tests. The
    actual result of the tests are displayed about half way through the
    tests and should indicate that they passed.</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/pidgin-&pidgin-version; &amp;&amp;
install -v -m644    README* doc/*.txt 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>install -v -m755 -d /usr/share/doc/pidgin-&pidgin-version;/api &amp;&amp;
install -v -m644    doc/html/* \
                    /usr/share/doc/pidgin-&pidgin-version;/api</userinput></screen>

  </sect2>

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

    <para><parameter>--with-gconf-schema-file-dir=&gnome-etc-dir;/gconf/schemas</parameter>:
    This parameter is used so that the <application>GConf</application> schema
    files are installed into the existing database. If
    <application>GConf</application> is not installed, the parameter does not
    affect the build or installation of the package.</para>

    <para><parameter>--disable-gtkui</parameter>: This parameter is used if
    <application>GTK+</application> is not installed. The build will only
    produce the <command>finch</command> program, which is a text-based
    (<application>Ncurses</application>) only version. Remove this parameter
    if you have <application>GTK+</application> installed to build the GUI
    <command>pidgin</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 settings that
      affect the <application>Pidgin</application> application. 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 various subdirectories
        of /usr/lib.</seg>
        <seg>/usr/include/{finch,gnt,libpurple,pidgin},
        /usr/lib/{finch,gnt,pidgin,purple-2},
        /usr/share/doc/pidgin-&pidgin-version;, /usr/share/pixmaps/pidgin, and
        /usr/share/sounds/pidgin</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="finch">
        <term><command>finch</command></term>
        <listitem>
          <para>is a text-based (<application>Ncurses</application>) 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 an instant messaging client based on the
          <application>Gtk+</application> GUI toolkit.</para>
          <indexterm zone="pidgin pidgin-prog">
            <primary sortas="b-pidgin">pidgin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="purple-remote">
        <term><command>purple-remote</command></term>
        <listitem>
          <para> is a command-line interface for controlling an already running
          instance of <command>pidgin</command></para>
          <indexterm zone="pidgin purple-remote">
            <primary sortas="b-purple-remote">purple-remote</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!-- <varlistentry id="libpidgin-remote">
        <term><filename class='libraryfile'>libpidgin-remote.so</filename></term>
        <listitem>
          <para> contains functions that are used by pidgin-remote</para>
          <indexterm zone="pidgin libpidgin-remote">
            <primary sortas="c-libpidgin-remote">libpidgin-remote.so</primary>
          </indexterm>
        </listitem>
      </varlistentry> -->

    </variablelist>

  </sect2>

</sect1>