source: gnome/add/gupnp.xml@ 383811b9

<?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 gupnp-download-http "&gnome-download-http;/gupnp/0.18/gupnp-&gupnp-version;.tar.xz">
  <!ENTITY gupnp-download-ftp  "&gnome-download-ftp;/gupnp/0.18/gupnp-&gupnp-version;.tar.xz">
  <!ENTITY gupnp-md5sum        "cfee1920c67a1a11312599c1fadd4a67">
  <!ENTITY gupnp-size          "329 KB">
  <!ENTITY gupnp-buildsize     "11 MB">
  <!ENTITY gupnp-time          "0.2 SBU">
]>

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

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

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

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

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

    <para><application>GUPnP</application> is an elegant, object-oriented open source
    framework for creating UPnP devices and control points, written in C using GObject
    and libsoup.</para>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/>,
    <xref linkend="gssdp"/>, and
    <!-- these two are pulled in by gssdp
    <xref linkend="libsoup"/>,
    <xref linkend="libxml2"/>, and -->
    <xref linkend="shared-mime-info"/></para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="NetworkManager"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=$GNOME_PREFIX \
            --with-context-manager=linux &amp;&amp;
make</userinput></screen>

    <para>This package does not have a testsuite.</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>--with-context-manager=linux</parameter>: This parameter
    ensures the package uses the linux backend for creating and destroying
    context objects when network interfaces go up/down.</para>

    <para><option>--with-context-manager=network-manager</option>: Use this
    alternative if you have installed <application>NetworkManager</application> and
    wish to use it for the backend.</para>

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

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gupnp-binding-tool</seg>
        <seg>libgupnp-1.0.{so,a}</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/gupnp-1.0/libgupnp,share/gtk-doc/html/gupnp}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gupnp-binding-tool">
        <term><command>gupnp-binding-tool</command></term>
        <listitem>
          <para>creates C convenience wrappers for UPnP services.</para>
          <indexterm zone="gupnp gupnp-binding-tool">
            <primary sortas="b-gupnp-binding-tool">gupnp-binding-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgupnp-1">
        <term><filename class='libraryfile'>libgupnp-1.0.{so,a}</filename></term>
        <listitem>
          <para>GObject-based library for UPnP.</para>
          <indexterm zone="gupnp libgupnp-1">
            <primary sortas="c-libgupnp-1">libgupnp-1.0.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>