source: general/genlib/telepathy-glib.xml@ ff822d5

<?xml version="1.0" encoding="UTF-8"?>
<!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 telepathy-glib-download-http
           "https://telepathy.freedesktop.org/releases/telepathy-glib/telepathy-glib-&telepathy-glib-version;.tar.gz">
  <!ENTITY telepathy-glib-download-ftp  " ">
  <!ENTITY telepathy-glib-md5sum        "a3a75657e9389381b44fee1680f770a7">
  <!ENTITY telepathy-glib-size          "3.7 MB">
  <!ENTITY telepathy-glib-buildsize     "256 MB">
  <!ENTITY telepathy-glib-time          "1.2 SBU">
]>

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


  <title>telepathy-glib-&telepathy-glib-version;</title>

  <indexterm zone="telepathy-glib">
    <primary sortas="a-telepathy-glib">telepathy-glib</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Telepathy GLib</title>

    <para>
      The <application>Telepathy GLib</application> contains a library used by
      <application>GLib</application> based <application>Telepathy</application>
      components. Telepathy is a <application>D-Bus</application> framework for
      unifying real time communication, including instant messaging, voice calls
      and video calls. It abstracts differences between protocols to provide a
      unified interface for applications.
    </para>

    &lfs121_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/telepathy-glib-&telepathy-glib-version;-consolidated_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->

    <bridgehead renderas="sect3">Telepathy GLib Dependencies</bridgehead>

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


    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      &gobject-introspection;, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Telepathy Glib</title>

<!--
    <para>
      First, apply a patch to fix several bugs discovered after
      release:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../telepathy-glib-&telepathy-glib-version;-consolidated_fixes-1.patch</userinput></screen>
-->

    <para>
      First, fix building this package with gcc-14:
    </para>

<screen><userinput remap="pre">sed -i '1794 s/tp_value_array_free/(GDestroyNotify) tp_value_array_free/' telepathy-glib/protocol.c</userinput></screen>

    <para>
      If you intend to run the tests, one of them defaults to invoking
      <filename>/usr/bin/python</filename> and fails if it is absent, causing
      the second batch of tests to not run - unlike the other tests which can be
      overridden from the environment. Fix it with the following command:
    </para>
    <!-- Still needed with 0.24.2 -->

<screen><userinput>sed -i 's%/usr/bin/python%&amp;3%' tests/all-errors-documented.py</userinput></screen>

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

<screen><userinput>PYTHON=/usr/bin/python3 ./configure --prefix=/usr          \
                                    --enable-vala-bindings \
                                    --disable-static       &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
      <!--Four tests are known to fail: <emphasis>test-account</emphasis>,
      <emphasis>test-cm</emphasis>, <emphasis>test-contact-lists</emphasis>, and
      <emphasis>test-contact-list-client</emphasis>.-->
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--enable-vala-bindings</parameter>: This switch
      enables building of the Vala bindings. Remove if you don't
      have <xref linkend="vala"/> installed.
    </para>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libtelepathy-glib.so
        </seg>
        <seg>
          /usr/include/telepathy-1.0 and
          /usr/share/gtk-doc/html/telepathy-glib
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libtelepathy-glib">
        <term><filename class="libraryfile">libtelepathy-glib.so</filename></term>
        <listitem>
          <para>
            contains the <application>Telepathy GLib</application> API functions
          </para>
          <indexterm zone="telepathy-glib libtelepathy-glib">
            <primary sortas="c-libtelepathy-glib">libtelepathy-glib.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>