source: lxqt/desktop/lxqt-layer-shell.xml@ 18958f2e

<?xml version="1.0" encoding="UTF-8"?>
<!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 layer-shell-download-http "http://download.kde.org/stable/plasma/&plasma-version;/layer-shell-qt-&plasma-version;.tar.xz">
  <!ENTITY layer-shell-download-ftp  " ">
  <!ENTITY layer-shell-md5sum        "c1206b4c182b3a01614d0a6ade96e76c">
  <!ENTITY layer-shell-size          "24 KB">
  <!ENTITY layer-shell-buildsize     "4.9 MB">
  <!ENTITY layer-shell-time          "0.2 SBU (using parallelism=4)">
]>

<sect1 id="layer-shell-qt" xreflabel="layer-shell-qt-&plasma-version; for lxqt">
  <?dbhtml filename="lxqt-layer-shell-qt.html"?>

  <title>layer-shell-qt-&plasma-version; for lxqt</title>

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

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

    <para>
      This component is meant for applications to be able to easily 
      use clients based on a "wtl-layer-shell" protocol. Clients can use 
      this interface to assign the surface_layer role to
      wl_surfaces. Such surfaces are assigned to a "layer" of the output and
      rendered with a defined z-depth respective to each other.
    </para>

    &lfs121_checked;

    <important>
      <para>
        This package is extracted from the plasma set of packages.
        If <xref linkend="plasma-build"/> is built, do <emphasis
        role="bold">NOT</emphasis> also build this package as presented
        here.
      </para>
    </important>

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

    <bridgehead renderas="sect3">layer-shell-qt Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="extra-cmake-modules"/> and
      <xref linkend="qt6"/> 
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of layer-shell</title>

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

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

cmake -D CMAKE_INSTALL_PREFIX=/usr \
      -D CMAKE_BUILD_TYPE=Release  \
      -W no-dev ..                 &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>
<!--
    <para revision="sysv">
      Next, remove a systemd unit which serves no purpose on a SysV system as
      the &root; user:
    </para>

<screen role="root" revision="sysv"><userinput>rm -v /usr/lib/systemd/user/plasma-kscreen.service</userinput></screen>
-->
  </sect2>
<!--
  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DCMAKE_INSTALL_LIBEXECDIR=libexec</parameter>: This overrides
      the default in extra-cmake-modules, which is <filename
      class="directory">/usr/lib/libexec</filename> and is not FHS compliant.
    </para>

    <para>
      <parameter>-DKDE_INSTALL_USE_QT_SYS_PATHS=ON</parameter>: This forces
      installation of Qt plugins in the same directory as <xref linkend="qt5"/>
      itself. Otherwise they get installed into <filename
      class="directory">/usr/mkspecs</filename>, which is not FHS compliant.
    </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>
          libLayerShellQtInterface.so
        </seg>
        <seg>
          /usr/lib/qml/org/kde/layershell,
          /usr/include/LayerShellQt, and
          /usr/lib/wayland-shell-integration
        </seg>
      </seglistitem>
    </segmentedlist>
<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="layer-shell-kscreen-doctor">
        <term><command>kscreen-doctor</command></term>
        <listitem>
          <para>
            allows modifying the screen setup from the command line
          </para>
          <indexterm zone="layer-shell-qt lxqt-layer-shell-kscreen-doctor">
            <primary sortas="b-kscreen-doctor">kscreen-doctor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-layer-shell-lib">
        <term><filename class="libraryfile">libKF6Screen.so</filename></term>
        <listitem>
          <para>
            contains the KDE Screen Management library
          </para>
          <indexterm zone="lxqt-layer-shell-lib">
            <primary sortas="c-libKF6Screen">libKF6Screen.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

        <varlistentry id="lxqt-layer-shell-dpms-lib">
        <term><filename class="libraryfile">libKF6ScreenDpms.so</filename></term>
        <listitem>
          <para>
            contains API functions for handling DPMS
          </para>
          <indexterm zone="lxqt-layer-shell-dpms-lib">
            <primary sortas="c-libKF6ScreenDpms">libKF6ScreenDpms.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
-->
  </sect2>

</sect1>