source: multimedia/libdriv/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 farstream-download-http 
           "http://freedesktop.org/software/farstream/releases/farstream/farstream-&farstream-version;.tar.gz">
  <!ENTITY farstream-download-ftp  " ">
  <!ENTITY farstream-md5sum        "5d6e561b3688d0d0c8906fec4f356df3">
  <!ENTITY farstream-size          "1.3 MB">
  <!ENTITY farstream-buildsize     "30 MB">
  <!ENTITY farstream-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      The <application>Farstream</application> package contains a 
      collection of GStreamer modules and libraries used for
      videoconferencing.
    </para>

    &lfs72_checked;

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

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gst-plugins-base"/> and
      <xref linkend="libnice"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Recommended (Runtime)</bridgehead>
    <para role="recommended">
      <xref linkend="gst-plugins-bad"/> and
      <xref linkend="gst-plugins-good"/>
    </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"/>,
      <ulink url="http://gupnp.org/">gupnp-igd</ulink>,
      <xref linkend="pygobject2"/> and
      <ulink url="http://www.valgrind.org/">Valgrind</ulink>
    </para>

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

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

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

<screen><userinput>patch -Np1 -i ../farstream-&farstream-version;-gir_fixes-1.patch &amp;&amp;
./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 Python
      bindings. Remove if you have Gst-Python and PyGObject2 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>
          libfarstream-0.1.so
        </seg>
        <seg>
          /usr/include/farstream-0.1,
          /usr/lib/farstream-0.1,
          /usr/share/farstream,
          /usr/share/gtk-doc/html/farstream-libs-0.10 and
          /usr/share/gtk-doc/html/farstream-plugins-0.1
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>