source: lxqt/desktop/libqtxdg.xml@ 990dbf0

<?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 libqtxdg-download-http "https://github.com/lxqt/libqtxdg/releases/download/&libqtxdg-version;/libqtxdg-&libqtxdg-version;.tar.xz">
  <!ENTITY libqtxdg-download-ftp  " ">
  <!ENTITY libqtxdg-md5sum        "1dfe393914a1e29c3b0d684bff8189f4">
  <!ENTITY libqtxdg-size          "72 KB">
  <!ENTITY libqtxdg-buildsize     "6.3 MB">
  <!ENTITY libqtxdg-time          "0.3 SBU">
]>

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


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

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

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

    <para>
      The <application>libqtxdg</application> is a Qt implementation of the
      freedesktop.org xdg specifications.
    </para>

    &lfs120_checked;

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

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

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

    <bridgehead renderas="sect4">Optional (runtime)</bridgehead>
    <para role="optional">
      <xref role="runtime" linkend="gtk3"/>
          (for <command>gtk-update-icon-cache</command>)
    </para>

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

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      ..       &amp;&amp;

make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

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

    <para>
      <option>-DBUILD_TESTS=ON</option>: Use this option if you wish to build
      tests. If you pass this option, you can run the tests by executing:
      <command>make test</command>.
    </para>

    <para>
      <option>-DBUILD_DEV_UTILS=ON</option>: Use this switch if you wish to
      build and install the development utilities.
    </para>

  </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>
          libQt5Xdg.so and libQt5XdgIconLoader.so
        </seg>
        <seg>
          /usr/include/{qt5xdg,qt5xdgiconloader} and
          /usr/share/cmake/{qt5xdg,qt5xdgiconloader}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libQt5Xdg-lib">
        <term><filename class="libraryfile">libQt5Xdg.so</filename></term>
        <listitem>
          <para>
            contains the <application>libQt5Xdg</application> API functions
          </para>
          <indexterm zone="libqtxdg libQt5Xdg-lib">
            <primary sortas="c-libQt5Xdg">libQt5Xdg.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libQt5XdgIconLoader-lib">
        <term><filename class="libraryfile">libQt5XdgIconLoader.so</filename></term>
        <listitem>
          <para>
            contains the <application>libQt5XdgIconLoader</application> API functions
          </para>
          <indexterm zone="libqtxdg libQt5XdgIconLoader-lib">
            <primary sortas="c-libQt5XdgIconLoader">libQt5XdgIconLoader.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>