glfs/multimedia/libdriv/telepathy-farsight.xml

<?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-farsight-download-http "http://telepathy.freedesktop.org/releases/telepathy-farsight/telepathy-farsight-&telepathy-farsight-version;.tar.gz">
  <!ENTITY telepathy-farsight-download-ftp  " ">
  <!ENTITY telepathy-farsight-md5sum        "2862c3c07d150485b22b2614391c36e2">
  <!ENTITY telepathy-farsight-size          "558 KB">
  <!ENTITY telepathy-farsight-buildsize     "6 MB">
  <!ENTITY telepathy-farsight-time          "0.1 SBU">
]>

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

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

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

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

  <sect2 role="package">
    <title>Introduction to telepathy-farsight</title>

    <para>The <application>telepathy-farsight</application> package contains a
    Telepathy client that uses <application>Farsight</application> and
    <application>GStreamer</application> to handle media streaming channels.
    It's used as a background process by other Telepathy clients, rather than
    presenting any user interface of its own.</para>

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

    <bridgehead renderas="sect3">telepathy-farsight Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><ulink
    url="http://gstreamer.freedesktop.org/modules/gst-python.html">GStreamer
    Python Bindings</ulink>,
    <xref linkend="gtk-doc"/>, and
    <xref linkend="pygtk"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --disable-python &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</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>--disable-python</parameter>: This parameter disables the
    <application>Python</application> bindings from being built.</para>

    <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-farsight.{so,a} and tpfarsight.{so,a}</seg>
        <seg>/usr/{include/telepathy-1.0/telepathy-farsight,
        share/gtk-doc/html/telepathy-farsight}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libtelepathy-farsight">
        <term><filename class='libraryfile'>libtelepathy-farsight.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>telepathy-farsight</application> API
          functions.</para>
          <indexterm zone="telepathy-farsight libtelepathy-farsight">
            <primary sortas="c-libtelepathy-farsight">libtelepathy-farsight.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tpfarsight">
        <term><filename class='libraryfile'>tpfarsight.{so,a}</filename></term>
        <listitem>
          <para>is a <application>Python</application> module.</para>
          <indexterm zone="telepathy-farsight tpfarsight">
            <primary sortas="c-tpfarsight">tpfarsight.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>