source: lxqt/desktop/lxqt-panel.xml@ 78d568a

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

  <!ENTITY lxqt-panel-download-http "https://github.com/lxqt/lxqt-panel/releases/download/&lxqt-version;/lxqt-panel-&lxqt-version;.tar.xz">
  <!ENTITY lxqt-panel-download-ftp  " ">
  <!ENTITY lxqt-panel-md5sum        "98f8b9b8f47ec0b1e7bc5eca475b7f45">
  <!ENTITY lxqt-panel-size          "600 KB">
  <!ENTITY lxqt-panel-buildsize     "55 MB">
  <!ENTITY lxqt-panel-time          "0.5 SBU (Using parallelism=4)">
]>

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


  <title>lxqt-panel-&lxqt-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>

    &lfs113_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 linkend="libdbusmenu-qt"/>,
      <xref linkend="liblxqt"/>,
      <xref linkend="lxqt-globalkeys"/>,
      <xref linkend="lxqt-menu-data"/>, 
      (<xref linkend="lxqt-solid"/> or  
       <xref role="nodep" linkend="kf5-frameworks"/>), 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>

  </sect2>

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

    <para>
      If <xref linkend="kf5"/> was not installed in /usr, help the code
      find needed headers:
    </para>

<screen role="pre"><userinput>export CXXFLAGS+="-I $KF5_PREFIX/include"
export CFLAGS+="-I $KF5_PREFIX/include"</userinput></screen>

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      ..                          &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>
      <option>-D&lt;plugin&gt;_PLUGIN=no</option>: Disable a &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>

  </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 /usr/lib/lxqt-panel
        </seg>
        <seg>
          /usr/lib/lxqt-panel, 
          /usr/share/lxqt/panel, and
          /usr/share/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>