source: archive/farsight2.xml@ 48b59802

<?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 farsight2-download-http "http://farsight.freedesktop.org/releases/farsight2/farsight2-&farsight2-version;.tar.gz">
  <!ENTITY farsight2-download-ftp  " ">
  <!ENTITY farsight2-md5sum        "7756d910687dd2abd455fd68e83f125c">
  <!ENTITY farsight2-size          "1.1 MB">
  <!ENTITY farsight2-buildsize     "40 MB">
  <!ENTITY farsight2-time          "0.4 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>Farsight2-&farsight2-version;</title>

  <indexterm zone="farsight2">
    <primary sortas="a-Farsight2">Farsight2</primary>
  </indexterm>

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

    <para>The <application>Farsight2</application> package is a collection of
    GStreamer modules and libraries for videoconferencing.</para>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gst-plugins-base"/>,
    <xref linkend="libnice"/>, and
    <xref linkend="python2"/></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"/>,
    <xref linkend="gupnp"/>,
    <xref linkend="pygobject2"/>, and
    <ulink url="http://www.valgrind.org/">Valgrind</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --disable-python &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>--disable-python</parameter>: This parameter disables the
    <application>Python</application> bindings from being built. Omit it if
    you have installed the optional python module dependencies.</para>

    <para><option>--enable-static=no</option>: This switch prevents the static
    libraries being installed.</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>libfsfunnel.{so,a},libfsmsnconference.{so,a},
        libfsrawconference.{so,a},libfsrtcpfilter.{so,a},libfsrtpconference.{so,a},
        libfsvideoanyrate.{so,a},libgstfarsight-0.10.{so,a},
        libmulticast-transmitter.{so,a},libnice-transmitter.{so,a},
        librawudp-transmitter.{so,a}, and libshm-transmitter.{so,a}</seg>
        <seg>/usr/{include/gstreamer-0.10/gst/farsight,lib/farsight2-0.0,
        share/{farsight2/0.0/fsrtpconference,gtk-doc/html/{farsight2-libs-0.10,
        farsight2-plugins-0.10}}}</seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>