source: kde5/frameworks/libdbusmenu-qt.xml@ 8e79872

<?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;
]>

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

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

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

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

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

    <para>
      The <application>libdbusmenu-qt</application> package contains a library
      that provides a Qt5 implementation of the DBusMenu protocol.
    </para>

    &lfs76_checked;

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

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

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

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

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/libdbusmenu-qt5"/>
    </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=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DCMAKE_INSTALL_LIBDIR=lib         \
      -DUSE_QT5=TRUE                     \
      -DWITH_DOC=OFF                     \
      .. &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/cmake-release.xml"/>

    <para>
      <parameter>-DCMAKE_INSTALL_LIBDIR=lib</parameter>: This switch is used
      to get libraries to install to <filename
      class="directory">$KF5_PREFIX/lib</filename> instead of <filename
      class="directory">$KF5_PREFIX/lib64</filename> on a 64 bit system.
    </para>

    <para>
      <parameter>-DUSE_QT5=TRUE</parameter>: This switch is used to ensure
      that <application>Qt5</application> version of the library is
      built even if <application>Qt4</application> is present.
    </para>

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

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libdbusmenu-qt5.so
        </seg>
        <seg>
          $KF5_PREFIX/include/dbusmenu-qt5,
          $KF5_PREFIX/lib/cmake/dbusmenu-qt5 and
          $KF5_PREFIX/share/doc/libdbusmenu-qt5-doc
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>