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

<?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 telepathy-glib-download-http 
           "http://telepathy.freedesktop.org/releases/telepathy-glib/telepathy-glib-&telepathy-glib-version;.tar.gz">
  <!ENTITY telepathy-glib-download-ftp  " ">
  <!ENTITY telepathy-glib-md5sum        "5b80faf033f91b0413907b4c380024f1">
  <!ENTITY telepathy-glib-size          "3.4 MB">
  <!ENTITY telepathy-glib-buildsize     "160 MB">
  <!ENTITY telepathy-glib-time          "2.0 SBU">
]>

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

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

  <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> package is a library for
    GLib-based Telepathy 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>

    &lfs70_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">telepathy-glib Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
      (Required if building GNOME)
    </para>

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

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of telepathy-glib</title>

    <para>Install <application>telepathy-glib</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/telepathy \
            --enable-vala-bindings \
            --disable-static &amp;&amp;
make</userinput></screen>

    <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</userinput></screen>

  </sect2>

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

    <para><parameter>--libexecdir=/usr/lib/telepathy</parameter>:
    This parameter prevents creating of
    <filename class="directory">/usr/libexec</filename>
    directory.</para>

    <para><option>--enable-vala-bindings</option>: This option builds 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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libtelepathy-glib.so
        </seg>
        <seg>
          /usr/include/telepathy-1.0/telepathy-glib,
          /usr/lib/telepathy 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>