source: gnome/add/gssdp.xml@ af9466b

<?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 gssdp-download-http "&gnome-download-http;/gssdp/0.12/gssdp-&gssdp-version;.tar.xz">
  <!ENTITY gssdp-download-ftp  "&gnome-download-ftp;/gssdp/0.12/gssdp-&gssdp-version;.tar.xz">
  <!ENTITY gssdp-md5sum        "b7942485e82a181eb4f08ef172576d80">
  <!ENTITY gssdp-size          "245 KB">
  <!ENTITY gssdp-buildsize     "4.8 MB">
  <!ENTITY gssdp-time          "0.1 SBU">
]>

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

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

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

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

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

    <para>The <application>gssdp</application> package provides a GObject-based API
    for handling resource discovery and announcement over SSDP (Simple Service Discovery
    Protocol).</para>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/>,
    <xref linkend="gobject-introspection"/>,
    <xref linkend="libsoup"/>, and
    <xref linkend="rarian"/></para>

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=$GNOME_PREFIX &amp;&amp;
make</userinput></screen>

    <!-- make check doesn't run any tests -->
    <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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

    <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>gssdp-device-sniffer</seg>
        <seg>libgssdp-1.0.{so,a}</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/gssdp-1.0/libgssdp,share/{gssdp,gtk-doc/html/gssdp}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gssdp-device-sniffer">
        <term><command>gssdp-device-sniffer</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="gssdp gssdp-device-sniffer">
            <primary sortas="b-gssdp-device-sniffer">gssdp-device-sniffer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgssdp-1">
        <term><filename class='libraryfile'>libgssdp-1.0.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gssdp libgssdp-1">
            <primary sortas="c-libgssdp-1">libgssdp-1.0.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>