source: general/genlib/telepathy-farstream.xml@ 8aeb474

<?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-farstream-download-http 
           "http://telepathy.freedesktop.org/releases/telepathy-farstream/telepathy-farstream-&telepathy-farstream-version;.tar.gz">
  <!ENTITY telepathy-farstream-download-ftp  " ">
  <!ENTITY telepathy-farstream-md5sum        "52d110f8a9f27bce0a6c2c07e18aee56">
  <!ENTITY telepathy-farstream-size          "644 KB">
  <!ENTITY telepathy-farstream-buildsize     "7.0 MB">
  <!ENTITY telepathy-farstream-time          "0.1 SBU">
]>

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

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

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

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

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

    <para>
      The <application>Telepathy Farstream</application> is a
      <application>Telepathy</application> client library that
      uses <application>Farstream</application> to handle Call
      channels.
    </para>

    &lfs72_checked;

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

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

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

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

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

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

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

<screen><userinput>./configure --prefix=/usr \
            --disable-python \
            --disable-static &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>
      <option>--disable-python</option>: This switch disables
      building of the <application>Python</application> bindings.
      Remove if you have optional <application>Python</application>
      bindings 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 Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libtelepathy-farstream.so and tpfarstream.so (Python Module)
        </seg>
        <seg>
          /usr/include/telepathy-1.0/telepathy-farstream and
          /usr/share/gtk-doc/html/telepathy-farstream
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>