source: lxqt/desktop/lxqt-runner.xml@ 31be310

<?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-runner-download-http "&lxqt-http-repo;/&lxqt-version;/lxqt-runner-&lxqt-runner-version;.tar.xz">
  <!ENTITY lxqt-runner-download-ftp  " ">
  <!ENTITY lxqt-runner-md5sum        "1775481281003297bf290471a583f22a">
  <!ENTITY lxqt-runner-size          "204 KB">
  <!ENTITY lxqt-runner-buildsize     "2.1 MB">
  <!ENTITY lxqt-runner-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      The <application>lxqt-runner</application> package provides a tool used
      to launch programs quickly by typing their names.
    </para>

    &lfs7a_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch to fix a misplaced <quote>#endif</quote>:
          <ulink url="&patch-root;/lxqt-runner-&lxqt-runner-version;-fix_endif-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="lxqt-globalkeys"/> and
      <xref linkend="menu-cache"/>
    </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), and
      <ulink url="http://muparser.beltoforion.de">muparser</ulink>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/lxqt-runner"/>
    </para>
  </sect2>

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

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

<screen><userinput>patch -p1 -i ../lxqt-runner-&lxqt-runner-version;-fix_endif-1.patch &amp;&amp;

mkdir -v build &amp;&amp;
cd       build &amp;&amp;

cmake -DCMAKE_BUILD_TYPE=Release          \
      -DRUNNER_MATH=OFF                   \
      -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>-DRUNNER_MATH=OFF</parameter>: Removes the dependency on
      <application>muparser</application>. If you want Math expression support,
      in <application>lxqt-runner</application>, install
      <application>muparser</application> and remove this switch.
    </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>

  </sect2>

  <sect2 role="use">
    <title>Using lxqt-runner</title>

    <para>
      To use <application>lxqt-runner</application>, simultaneously press the
      Alt-F2 keys.  A dialogue window appears in the top center of the screen.
      When you start typing the command, a list of possible matches appears and
      changes as you keep typing.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          lxqt-runner
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lxqt-runner-prog">
        <term><command>lxqt-runner</command></term>
        <listitem>
          <para>
            is a graphical dialogue for quickly executing a program.
          </para>
          <indexterm zone="lxqt-runner lxqt-runner-prog">
            <primary sortas="b-lxqt-runner">lxqt-runner</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>