source: lxqt/desktop/lxqt-panel.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-panel-download-http "&lxqt-http-repo;/&lxqt-version;/lxqt-panel-&lxqt-panel-version;.tar.xz">-->
  <!ENTITY lxqt-panel-download-http "https://github.com/lxde/lxqt-panel/releases/download/&lxqt-panel-version;/lxqt-panel-&lxqt-panel-version;.tar.xz">
  <!ENTITY lxqt-panel-download-ftp  " ">
  <!ENTITY lxqt-panel-md5sum        "58bf215ddfb9727d8c494618c58064e5">
  <!ENTITY lxqt-panel-size          "265 KB">
  <!ENTITY lxqt-panel-buildsize     "24 MB">
  <!ENTITY lxqt-panel-time          "1.3 SBU">
]>

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

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

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

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

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

    <para>
      The <application>lxqt-panel</application> package contains a
      lightweight X11 desktop panel.
    </para>

    &lfs82_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref role="nodep" linkend="kf5-frameworks"/> or 
<!-- role="nodep" implies that jhalfs users will not depend on the whole
     kf5 stack. If they have built kf5, it is easy to remove the
     lxqt-kguiaddons and lxqt-solid scripts.-->
      (<xref linkend="lxqt-kguiaddons"/> and 
       <xref linkend="lxqt-solid"/>) (keyboard indicator plugin),     
      <xref linkend="lxqt-globalkeys"/>,
      <xref linkend="libdbusmenu-qt"/>,
      <xref linkend="liblxqt"/>,
      <xref linkend="lxmenu-data"/>, and
      <xref linkend="menu-cache"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/> or
      <xref linkend="pulseaudio"/> (volume plugin; see Command Explanations below
         if not present),
      <xref linkend="libstatgrab"/> (network monitor and CPU load plugins),
      <xref linkend="libsysstat"/> (CPU and network monitor plugins),
      <xref linkend="libxkbcommon"/> (keyboard indicator plugin), and
      <xref linkend="lm_sensors"/> (sensors plugin)
    </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-panel"/>
    </para>
  </sect2>

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

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

<screen><userinput>sed -e 's:&lt;KF5/KWindowSystem/:&lt;:'               \
    -i plugin-taskbar/lxqttaskgroup.{h,cpp}     &amp;&amp;

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>
      <command>sed ... plugin-taskbar/lxqttaskgroup.{h,cpp}</command>: 
      Removes a hard coded directory from an include file and allows
      the system to find it when the KDE Framework dependencies are not
      installed in <envar>$LXQT_PREFIX</envar>.
    </para>

    <para>
      <parameter>-DPULL_TRANSLATIONS=no</parameter>: Removes the need for
      <xref linkend="git"/>, which would otherwise be requested to download
      the translation files.
    </para>

    <para>
      <option>-D&lt;plugin&gt;_PLUGIN=no</option>: Disable &lt;plugin&gt;,
      where &lt;plugin&gt; may be CLOCK, COLORPICKER, CPULOAD, DIRECTORYMENU,
      DESKTOPSWITCH, KBINDICATOR, MAINMENU, MOUNT, QUICKLAUNCH, SENSORS,
      SHOWDESKTOP, NETWORKMONITOR, SYSSTAT, TASKBAR, STATUSNOTIFIER, TRAY,
      VOLUME, WORLDCLOCK, or SPACER,
    </para>

    <para>
      <option>-DVOLUME_USE_&lt;backend&gt;=no</option>: Disable support
      for &lt;backend&gt; in volume plugin, where backend is ALSA or PULSEAUDIO.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          lxqt-panel
        </seg>
        <seg>
          several plugins under $LXQT_PREFIX/lib/lxqt-panel
        </seg>
        <seg>
          /etc/xdg/lxqt,
          $LXQT_PREFIX/share/lxqt/lxqt-panel and
          $LXQT_PREFIX/lib/lxqt-panel
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lxqt-panel-prog">
        <term><command>lxqt-panel</command></term>
        <listitem>
          <para>
            is a lightweight <application>Qt5</application> based
            panel for the <application>LXQt</application> Desktop.
          </para>
          <indexterm zone="lxqt-panel lxqt-panel-prog">
            <primary sortas="b-lxqt-panel">lxqt-panel</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>