source: general/genlib/libunique.xml@ 75f50a9

<?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 libunique-download-http "&gnome-download-http;/libunique/1.1/libunique-&libunique-version;.tar.bz2">
  <!ENTITY libunique-download-ftp  "&gnome-download-ftp;/libunique/1.1/libunique-&libunique-version;.tar.bz2">
  <!ENTITY libunique-md5sum        "f33749109768d43ef69ca7e8ffa7cfb7">
  <!ENTITY libunique-size          "328 KB">
  <!ENTITY libunique-buildsize     "6 MB">
  <!ENTITY libunique-time          "0.1 SBU">
]>

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

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

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

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

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

    <para>The <application>libunique</application> package contains a
    library for writing single instance applications.</para>

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

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

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

    <!-- Confirmed that this is not required any longer
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="gir-repository"/> (Required if
    gobject-introspection is already installed)</para>
    -->

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="dbus-glib"/></para>

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

  </sect2>

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

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

<screen><userinput>sed -i '/DG_DISABLE_DEPRECATED/d' unique/Makefile.in &amp;&amp;
./configure --prefix=/usr --disable-static &amp;&amp;
sed -i 's#  -Werror ##' unique/dbus/Makefile &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><command>sed -i '/DG_DISABLE_DEPRECATED/d' ...</command>:
    <application>Libunique</application> uses functions that are deprecated in
    the current version of <application>Glib</application>. This sed allows it
    to compile using those deprecated functions.</para>

    <para><command>sed -i 's#  -Werror ##' ...</command>: This sed disables
    treating warnings as errors in the Makefile that deals with dbus.</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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libunique-1.0.{so,a}</seg>
        <seg>/usr/{include/unique-1.0/unique,share/gtk-doc/html/unique}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libunique-1.0">
        <term><filename class='libraryfile'>libunique-1.0.{so,a}</filename></term>
        <listitem>
          <para>contains the libunique API functions for single instance support.</para>
          <indexterm zone="libunique libunique-1.0">
            <primary sortas="c-libunique-1.0">libunique-1.0.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>