source: lxqt/desktop/liblxqt.xml@ 50cb265e

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

<!-- As of August 2017, downloads.lxqt.org is down. Use github archives
     instead, but keep the old link in case the host become available again.
     According to lxqt devs, they are working on it...
  <!ENTITY liblxqt-download-http "&lxqt-http-repo;/&lxqt-version;/liblxqt-&liblxqt-version;.tar.xz">-->
  <!ENTITY liblxqt-download-http "https://github.com/lxde/liblxqt/releases/download/&liblxqt-version;/liblxqt-&liblxqt-version;.tar.xz">
  <!ENTITY liblxqt-download-ftp  " ">
  <!ENTITY liblxqt-md5sum        "65abc1f9dd25a4244e12f9126ea22397">
  <!ENTITY liblxqt-size          "50 KB">
  <!ENTITY liblxqt-buildsize     "5.0 MB">
  <!ENTITY liblxqt-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      The <application>liblxqt</application> is the core utility library for all
      <application>LXQt</application> components.
    </para>

    &lfs81_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libqtxdg"/> and
      (<xref linkend="lxqt-kwindowsystem"/> or
      <xref role="nodep" linkend="kf5-frameworks"/>)
<!-- role="nodep" implies jhalfs users won't depend on the whole kf5
     stack. If they have installed kf5, it is easy to remove the
     lxqt-kwindowsystem script. -->
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="git"/> (to download translation files) or
      <xref linkend="lxqt-l10n"/> (to add localization files)
    </para>

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

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
      -DCMAKE_BUILD_TYPE=Release          \
      -DPULL_TRANSLATIONS=no              \
      ..                                  &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>

    <para>
      <parameter>-DPULL_TRANSLATIONS=no</parameter>: Removes the need for
      <xref linkend="git"/>, which would otherwise be requested to download
      the translation files.
    </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>
          liblxqt.so
        </seg>
        <seg>
          $LXQT_PREFIX/include/lxqt and $LXQT_PREFIX/share/cmake/lxqt
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>