source: gnome/telepathy/telepathy-logger.xml@ 1840044

<?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-logger-download-http
           "http://telepathy.freedesktop.org/releases/telepathy-logger/telepathy-logger-&telepathy-logger-version;.tar.bz2">
  <!ENTITY telepathy-logger-download-ftp  " ">
  <!ENTITY telepathy-logger-md5sum        "e513eaa767344821073a0b7bb8b45217">
  <!ENTITY telepathy-logger-size          "528 KB">
  <!ENTITY telepathy-logger-buildsize     "16 MB">
  <!ENTITY telepathy-logger-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      The <application>Telepathy Logger</application> package is a headless
      observer client that logs information received by the
      <application>Telepathy</application> framework. It features pluggable
      backends to log different sorts of messages in different formats.
    </para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="sqlite"/>, and
      <xref linkend="telepathy-glib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </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-logger"/>
    </para>
  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/telepathy \
            --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>

    <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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          telepathy-logger
        </seg>
        <seg>
          libtelepathy-logger.so
        </seg>
        <seg>
          /usr/include/telepathy-logger-0.2,
          /usr/lib/telepathy,
          /usr/share/gtk-doc/html/telepathy-logger and
          /usr/share/telepathy
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="telepathy-logger-prog">
        <term><command>telepathy-logger</command></term>
        <listitem>
          <para>
            is the <application>Telepathy Logger</application> D-Bus service.
          </para>
          <indexterm zone="telepathy-logger telepathy-logger-prog">
            <primary sortas="b-telepathy-logger">telepathy-logger</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>