source: lxqt/desktop/lxqt-session.xml@ 737f339

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

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

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

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

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

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

    <para>
      The <application>lxqt-session</application> package contains the default
      session manager for <application>LXQt</application>.
    </para>

    &lfs81_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="liblxqt"/>,
      (<xref linkend="lxqt-kwindowsystem"/> or
       <xref linkend="kf5-frameworks"/>), and
      <xref linkend="xdg-user-dirs"/>
    </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-session"/>
    </para>
  </sect2>

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

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

<screen><userinput>sed -e '/TryExec/s@=@='$LXQT_PREFIX'/bin/@' \
    -i xsession/lxqt.desktop.in &amp;&amp;

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>
      <command>sed -e '/TryExec/s@=@='$LXQT_PREFIX'/bin/@' -i xsessions/lxqt.desktop.in</command>:
      If using a display manager, the full path of the <quote>TryExec</quote>
      directive has to be given so that the <application>LXQt</application>
      desktop appear in the sessions list.
    </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="configuration">
    <title>Configuring lxqt-session</title>

    <para>
      Window Managers other than <xref linkend="openbox"/> may be used, e.g.
      <xref linkend="xfwm4"/>. Notice that <xref linkend="icewm"/> is not a
      valid replacement. <application>Fluxbox</application> does work, although
      in this context (with <xref linkend="lxqt-config"/>) <xref
      linkend="openbox"/> is better.  The configuration file
      <filename>/etc/xdg/lxqt/windowmanagers.conf</filename> comes with several
      examples of Window Managers and the ones which are installed will appear
      in a drop down list of <command>lxqt-config-session</command>. For the
      ones not included in
      <filename>/etc/xdg/lxqt/windowmanagers.conf</filename>, you can use the
      <command>lxqt-config-session</command> "search" button, e.g. for <xref
      linkend="fluxbox"/>, navigating through the file system until you can
      choose <command>fluxbox</command>. Alternatively, if you wish the Window
      Manager of your choice to appear in the drop down list, include it in
      <filename>/etc/xdg/lxqt/windowmanagers.conf</filename>. For <xref
      linkend="fluxbox"/>, include the line
    </para>

<screen role="nodump"><userinput><literal>fluxbox/Name=Fluxbox</literal></userinput></screen>

    <para>
      and it will appear as an option in the drop down list. To change the WM,
      after selecting it, you need to restart the session.
    </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-session, lxqt-leave, lxqt-session, and startlxqt
        </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-config-session-prog">
        <term><command>lxqt-config-session</command></term>
        <listitem>
          <para>
            is a GUI configuration tool for <command>lxqt-session</command>
            settings.
          </para>
          <indexterm zone="lxqt-session lxqt-config-session-prog">
            <primary sortas="b-lxqt-config-session">lxqt-config-session</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-leave-prog">
        <term><command>lxqt-leave</command></term>
        <listitem>
          <para>
            is a graphical dialog to terminate the session.
          </para>
          <indexterm zone="lxqt-session lxqt-leave-prog">
            <primary sortas="b-lxqt-leave">lxqt-leave</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-session-prog">
        <term><command>lxqt-session</command></term>
        <listitem>
          <para>
            is a lightweight X session manager.
          </para>
          <indexterm zone="lxqt-session lxqt-session-prog">
            <primary sortas="b-lxqt-session">lxqt-session</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="startlxqt">
        <term><command>startlxqt</command></term>
        <listitem>
          <para>
            is used to start the desktop session for
            <application>LXQt</application>.
          </para>
          <indexterm zone="lxqt-session startlxqt">
            <primary sortas="b-startlxqt">startlxqt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>