source: networking/netlibs/libnice.xml@ 394ea4d3

<?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 libnice-download-http
  "http://nice.freedesktop.org/releases/libnice-&libnice-version;.tar.gz">
  <!ENTITY libnice-download-ftp  " ">
  <!ENTITY libnice-md5sum        "0906c3523eb78cb3caad170cc75af4b0">
  <!ENTITY libnice-size          "650 KB">
  <!ENTITY libnice-buildsize     "12 MB">
  <!ENTITY libnice-time          "0.1 SBU">
]>

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

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

  <title>libnice-&libnice-version;</title>

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

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

    <para>The <application>libnice</application> package is an implementation of
    the IETF's draft Interactice Connectivity Establishment standard (ICE). It
    provides <application>GLib</application>-based library,
    <application>libnice</application> and <application>GStreamer</application>
    elements.</para>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gstreamer"/> and
    <xref linkend="gtk-doc"/></para>

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

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

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

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

    <para><option> --disable-static</option>: This switch prevents the static
    libraries being installed.</para>

    <para><option>--with-gstreamer</option>: This option enables GStreamer
    functionality.</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>stunbdc and stund</seg>
        <seg>libgstnice.so and libnice.so</seg>
        <seg>/usr/include/nice, /usr/include/stun and
        /usr/share/gtk-doc/html/libnice</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="stunbdc">
        <term><command>stunbdc</command></term>
        <listitem>
          <para>performs Session Traversal for NAT (STUN) Binding
          Discovery.</para>
          <indexterm zone="libnice stunbdc">
            <primary sortas="b-stunbdc">stunbdc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="stund">
        <term><command>stund</command></term>
        <listitem>
          <para>is a Session Traversal for NAT (STUN) daemon.</para>
          <indexterm zone="libnice stund">
            <primary sortas="b-stund">stund</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgstnice">
        <term><filename class="libraryfile">libgstnice.so</filename></term>
        <listitem>
          <para>is the <application>gstreamer</application> module.</para>
          <indexterm zone="libnice libgstnice">
            <primary sortas="c-libgstnice">libgstnice.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnice-lib">
        <term><filename class="libraryfile">libnice.so</filename></term>
        <listitem>
          <para>contains the <application>libnice</application> API
          functions.</para>
          <indexterm zone="libnice libnice-lib">
            <primary sortas="c-libnice">libnice.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>