source: x/lib/startup-notification.xml@ d1857f3

<?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 startup-notification-download-http "https://www.freedesktop.org/software/startup-notification/releases/startup-notification-&startup-notification-version;.tar.gz">
  <!ENTITY startup-notification-download-ftp  " ">
  <!ENTITY startup-notification-md5sum        "2cd77326d4dcaed9a5a23a1232fb38e9">
  <!ENTITY startup-notification-size          "347 KB">
  <!ENTITY startup-notification-buildsize     "4 MB">
  <!ENTITY startup-notification-time          "less than 0.1 SBU">
]>

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


  <title>startup-notification-&startup-notification-version;</title>

  <indexterm zone="startup-notification">
    <primary sortas="a-startup-notification">startup-notification</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to startup-notification</title>

    <para>
      The <application>startup-notification</application> package
      contains <filename class="libraryfile">startup-notification</filename>
      libraries. These are useful for building a consistent manner to notify
      the user through the cursor that the application is loading.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">startup-notification Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg7-lib"/> and
      <xref linkend="xcb-util"/>
    </para>


  </sect2>

  <sect2 role="installation">
    <title>Installation of startup-notification</title>

    <para>
      Install <application>startup-notification</application> by running the
      following commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-static &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 &amp;&amp;
install -v -m644 -D doc/startup-notification.txt \
    /usr/share/doc/startup-notification-&startup-notification-version;/startup-notification.txt</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.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>libstartup-notification-1.so</seg>
        <seg>/usr/include/startup-notification-1.0 and
        /usr/share/doc/startup-notification-&startup-notification-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libstartup-notification-1">
        <term><filename class="libraryfile">libstartup-notification-1.so</filename></term>
        <listitem>
          <para>
            provides the functions to assist applications in communicating
            with the cursor system to provide feedback to the user that the
            application is loading
          </para>
          <indexterm zone="startup-notification libstartup-notification-1">
            <primary sortas="c-libstartup-notification-1">libstartup-notification-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>