source: kde/libdbusmenuqt.xml@ 34c29696

<?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 libdbusmenu-qt-download-http "https://launchpad.net/ubuntu/+archive/primary/+files/libdbusmenu-qt_&libdbusmenu-qt-version;.orig.tar.gz">
  <!ENTITY libdbusmenu-qt-download-ftp  " ">
  <!ENTITY libdbusmenu-qt-md5sum        "8b90312bd8654e026d814d4db986ce5e">
  <!ENTITY libdbusmenu-qt-size          "48 KB">
  <!ENTITY libdbusmenu-qt-buildsize     "4.6 MB">
  <!ENTITY libdbusmenu-qt-time          "0.4 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>libdbusmenu-qt-&libdbusmenu-qt-version;</title>

  <indexterm zone="libdbusmenu-qt">
    <primary sortas="a-libdbusmenu-qt">libdbusmenu-qt</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libdbusmenu-qt</title>

    <para>
      This library provides a <application>Qt</application> implementation
      of the DBusMenu specification that exposes menus via DBus.
    </para>

    &lfs101_checked;

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

    <bridgehead renderas="sect3">libdbusmenu-qt Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (for building the API documentation)
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of libdbusmenu-qt</title>

    <para>
      Install <application>libdbusmenu-qt</application> by running the
      following commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DWITH_DOC=OFF              \
      -Wno-dev .. &amp;&amp;
make</userinput></screen>

    <!--
    <para>
      To test the results (<xref linkend="qjson"/> must be installed),
      issue: <command>make -k check</command>. One test is known to fail.
    </para>
    -->

    <para>
      This packages does not come with a working 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>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is
      used to build without debugging symbols and apply a higher level of
      compiler optimizations.
    </para>

    <para>
      <parameter>-DWITH_DOC=OFF</parameter>: This option is set to avoid
      building the API documentation. Omit it if you have
      <application>doxygen</application> installed and want the
      documentation.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libdbusmenu-qt5.so</seg>
        <seg>/usr/lib/cmake/dbusmenu-qt5 and
             /usr/include/dbusmenu-qt5</seg>
      </seglistitem>
    </segmentedlist>
<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="a-automoc4">
        <term><command>automoc4</command></term>
        <listitem>
          <para>
            is a testing utility for libdbusmenu-qt-generated build trees.
          </para>
          <indexterm zone="a-automoc4 automoc4">
            <primary sortas="b-automoc4">automoc4</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
-->
  </sect2>

</sect1>