source: lxqt/desktop/lxqt-globalkeys.xml@ 89d6c9a

<?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 lxqt-globalkeys-download-http "&lxqt-http-repo;/&lxqt-version;/lxqt-globalkeys-&lxqt-globalkeys-version;.tar.xz">-->
  <!ENTITY lxqt-globalkeys-download-http "https://github.com/lxde/lxqt-globalkeys/releases/download/&lxqt-globalkeys-version;/lxqt-globalkeys-&lxqt-globalkeys-version;.tar.xz">
  <!ENTITY lxqt-globalkeys-download-ftp  " ">
  <!ENTITY lxqt-globalkeys-md5sum        "a3f49ade3e06e21391980cb13807cb09">
  <!ENTITY lxqt-globalkeys-size          "51 KB">
  <!ENTITY lxqt-globalkeys-buildsize     "9.3 MB">
  <!ENTITY lxqt-globalkeys-time          "0.3 SBU">
]>

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

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

  <title>lxqt-globalkeys-&lxqt-globalkeys-version;</title>

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

  <sect2 role="package">
    <title>Introduction to lxqt-globalkeys</title>

    <para>
      The <application>lxqt-globalkeys</application> package contains a daemon
      used to register global keyboard shortcuts and a key shortcut GUI editor.
    </para>

    &lfs82_checked;

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

    <bridgehead renderas="sect3">lxqt-globalkeys Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="liblxqt"/>
    </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;/lxqt-globalkeys"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of lxqt-globalkeys</title>

    <para>
      Install <application>lxqt-globalkeys</application> by running the
      following commands:
    </para>

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

cmake -DCMAKE_BUILD_TYPE=Release          \
      -DCMAKE_INSTALL_PREFIX=$LXQT_PREFIX \
      -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 Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          lxqt-config-globalkeyshortcuts and lxqt-globalkeysd
        </seg>
        <seg>
          liblxqt-globalkeys.so and liblxqt-globalkeys-ui.so
        </seg>
        <seg>
          $LXQT_PREFIX/include/lxqt-globalkeys{,-ui}
          and $LXQT_PREFIX/share/cmake/lxqt-globalkeys{,-ui}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lxqt-config-globalkeyshortcuts">
        <term><command>lxqt-config-globalkeyshortcuts</command></term>
        <listitem>
          <para>
            is a key shortcuts GUI editor.
          </para>
          <indexterm zone="lxqt-globalkeys lxqt-config-globalkeyshortcuts">
            <primary sortas="b-lxqt-config-globalkeyshortcuts">lxqt-config-globalkeyshortcuts</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-globalkeysd">
        <term><command>lxqt-globalkeysd</command></term>
        <listitem>
          <para>
            is a global key shortcuts daemon.
          </para>
          <indexterm zone="lxqt-globalkeys lxqt-globalkeysd">
            <primary sortas="b-lxqt-globalkeysd">lxqt-globalkeysd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

    </variablelist>

  </sect2>

</sect1>