source: lxqt/desktop/lxqt-kidletime.xml@ b60f1ce

<?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 kidletime-download-http "&kf5-download-http;/kidletime-&kf5-version;.tar.xz">
  <!ENTITY kidletime-download-ftp  " ">
  <!ENTITY kidletime-md5sum        "1bf59dbd22248f150f3b9c977af8b51f">
  <!ENTITY kidletime-size          "32 KB">
  <!ENTITY kidletime-buildsize     "3.7 MB">
  <!ENTITY kidletime-time          "0.2 SBU">
]>

<sect1 id="lxqt-kidletime" xreflabel="kidletime-&kf5-version; for lxqt">
  <?dbhtml filename="lxqt-kidletime.html"?>


  <title>kidletime-&kf5-version; for lxqt</title>

  <indexterm zone="lxqt-kidletime">
    <primary sortas="a-kidletime">kidletime</primary>
  </indexterm>

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

    <para>
      KIdleTime is used to report the idle time of users and the system. It is
      useful not only for determining the current idle time of the PC,
      but also for getting notified upon idle time events, such as custom
      timeouts or user activity.
    </para>

    &lfs121_checked;

    <important>
      <para>
        This package is extracted from the KF5 set of packages.
        If <xref linkend="kf5-frameworks"/> 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="&kidletime-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&kidletime-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &kidletime-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &kidletime-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &kidletime-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &kidletime-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="extra-cmake-modules"/>,
      <xref linkend="plasma-wayland-protocols"/>, and
      &qt5-deps;
    </para>

  </sect2>

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr        \
      -DCMAKE_INSTALL_LIBEXECDIR=libexec \
      -DKDE_INSTALL_USE_QT_SYS_PATHS=ON  \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -Wno-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>

  </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>
          libKF5IdleTime.so
        </seg>
        <seg>
          /usr/lib/plugins/kf5/org.kde.kidletime.platforms,
          /usr/lib/cmake/KF5IdleTime, and
          /usr/include/KF5/KIdleTime
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lxqt-kidletime-lib">
        <term><filename class="libraryfile">libKF5GuiAddons.so</filename></term>
        <listitem>
          <para>
            contains the KDE API for idle time reports
          </para>
          <indexterm zone="lxqt-kidletime-lib">
            <primary sortas="c-libKF5WindowSystem">libKF5GuiAddons.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>