source: x/lib/libnotify.xml@ 4f51961

<?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 libnotify-download-http "&gnome-download-http;/libnotify/0.7/libnotify-&libnotify-version;.tar.xz">
  <!ENTITY libnotify-download-ftp "&gnome-download-ftp;/libnotify/0.7/libnotify-&libnotify-version;.tar.xz">
  <!ENTITY libnotify-md5sum        "1ec80af539a176d0e5a430534e98e956">
  <!ENTITY libnotify-size          "266 KB">
  <!ENTITY libnotify-buildsize     "5.1 MB">
  <!ENTITY libnotify-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>The <application>libnotify</application> library is used to send
    desktop notifications to a notification daemon, as defined in the Desktop
    Notifications spec. These notifications can be used to inform the user about
    an event or display some form of information without getting in the user's
    way.</para>

    &lfs70_built;

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

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

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

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

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

  </sect2>

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

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

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

    <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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>notify-send</seg>
        <seg>libnotify.{so,a}</seg>
        <seg>/usr/{include/libnotify,share/gtk-doc/html/libnotify}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="notify-send">
        <term><command>notify-send</command></term>
        <listitem>
          <para>is a command to send notifications.</para>
          <indexterm zone="libnotify notify-send">
            <primary sortas="b-notify-send">notify-send</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>