source: lxqt/desktop/pre-install.xml@ 0639bb6

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

<sect1 id="lxqt-pre-install" xreflabel="LXQt Pre-Install">
  <?dbhtml filename="pre-install.html"?>

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

  <title>LXQt Desktop Pre-Install Instructions</title>

  <indexterm zone="lxqt-pre-install">
    <primary sortas="g-lxqt-pre-install">LXQt Pre-Install</primary>
  </indexterm>

  <caution>
    <para>
      Due to recent changes in <command>grep</command> it is essential that
      the installing system be set to an UTF-8 locale. An example
      is <command>export LANG=en_US.UTF-8</command>, but any UTF-8 locale is
      sufficient. Failure to do this will result in a faulty installation.
    </para>
  </caution>

    <para>
      LXQt can be installed in /usr or /opt/lxqt.
    </para>

  <sect2>
    <title>Installing in /usr</title>

    <para>
      Installing in <filename class="directory">/usr</filename> creates
      a simpler setup.  Run:
    </para>

<screen><userinput>export LXQT_PREFIX=/usr</userinput></screen>

    <para>
      Either add that to your own <filename>.bash_profile</filename>
      so that it will still be set if you build the packages over a
      period of time, or else add it to the system profile as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/lxqt.sh &lt;&lt; "EOF"
<literal># Begin LXQt profile

export LXQT_PREFIX=/usr

# End LXQt profile</literal>
EOF</userinput></screen>

    <para>
      There is no other configuration needed to install LXQt in 
      <filename class="directory">/usr</filename>.
    </para>

  </sect2>

  <sect2>
    <title>Installing in /opt/lxqt</title>

    <para>
      Installing in <filename class="directory">/opt/lxqt</filename> may
      simplify upgrading to a later version of LXQt.
    </para>

    <para>
      Some variables need to be defined in your system profile, as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -vdm755 /opt/lxqt/{bin,lib,share/man}

cat &gt; /etc/profile.d/lxqt.sh &lt;&lt; "EOF"
<literal># Begin LXQt profile

export LXQT_PREFIX=/opt/lxqt

pathappend /opt/lxqt/bin           PATH
pathappend /opt/lxqt/share/man/    MANPATH
pathappend /opt/lxqt/lib/pkgconfig PKG_CONFIG_PATH
pathappend /opt/lxqt/lib/plugins   QT_PLUGIN_PATH

# End LXQt profile</literal>
EOF

cat &gt;&gt; /etc/profile.d/qt5.sh &lt;&lt; "EOF"
<literal>
# Begin Qt5 changes for LXQt

pathappend $QT5DIR/plugins         QT_PLUGIN_PATH

# End Qt5 changes for LXQt</literal>
EOF</userinput></screen>

    <para>
      Expand your <filename>/etc/ld.so.conf</filename> file:
    </para>

<screen role="root"><userinput>cat &gt;&gt; /etc/ld.so.conf &lt;&lt; "EOF"
<literal>
# Begin LXQt addition

/opt/lxqt/lib

# End LXQt addition
</literal>
EOF</userinput></screen>

    <para>
      Before starting to install the packages in the following pages, remember
      to execute:
    </para>

<screen><userinput>source /etc/profile</userinput></screen>

    <para>
      Some packages from the KDE Frameworks 5 bundle install files into D-Bus
      directories. In order to have D-Bus find those files, the easiest
      way is to create a symlink. Some packages may also install icons from
      the <quote>hicolor</quote> icon set. Since that icon set is used by many
      packages, it is a good idea to create a symlink to the one in <filename
      class="directory">/usr/share</filename> to avoid having multiple
      installations of <xref linkend="hicolor-icon-theme"/>. Run the
      following commands as the <systemitem class="username">root</systemitem>
      user:
    </para>

<screen role="root"><userinput>source /etc/profile                                       &amp;&amp;
install -v -dm755                $LXQT_PREFIX/share/icons &amp;&amp;
ln -sfv /usr/share/icons/hicolor $LXQT_PREFIX/share/icons &amp;&amp;
ln -sfv /usr/share/dbus-1        $LXQT_PREFIX/share </userinput></screen>

    <tip>
      <para>
        Sometimes, the installation paths are hardcoded into installed files.
        This is the reason why <filename class="directory">/opt/lxqt</filename>
        is used as installation prefix instead of <filename
        class="directory">/opt/lxqt-&lxqt-version;</filename>. After installing
        <application>LXQt Desktop</application>, you may rename the directory
        and create a symlink:
      </para>

<screen role="root"><userinput>mv /opt/lxqt{,-&lxqt-version;}
ln -sfv lxqt-&lxqt-version; /opt/lxqt</userinput></screen>

      <para>
        Later on, you may want to install other versions of <application>LXQt
        Desktop</application>. To do that, just remove the symlink and use
        <filename class="directory">/opt/lxqt</filename> as the prefix again.
        Which version of <application>LXQt Desktop</application> you use
        depends only on where the symlink points. No other reconfiguration will
        be needed.
      </para>
    </tip>

  </sect2>

  <sect2>
    <title>Notes about building LXQt dependencies</title>

    <para>
      <application>LXQt</application> obviously needs <xref linkend="qt5"/>,
      but not all Qt5 modules and dependencies are necessary. Since the aim
      of <application>LXQt</application> is to be light weight, it may be
      interesting to cut down the Qt5 overhead, and to build only parts of it.
      To build Qt and LXQT dependencies, the proposed order is the following:
    </para>

    <procedure>
      <step>
        <para>
          Build <xref linkend="linux-pam"/>, <xref linkend="shadow"/>,
          and <xref linkend="sudo"/>, with their dependencies
        </para>
      </step>

      <step>
        <para>
          Build the whole <xref linkend="x-window-system"/> chapter, with
          Wayland support, and replacing twm vith <xref linkend="openbox"/>
          (and its required dependencies). Some Xorg applications and fonts
          may be omitted, but with a negligible impact on build time and size
        </para>
      </step>

      <step>
        <para>
          Build <xref linkend="gtk2"/> and its required and recommended
          dependencies. GTK+2 is needed for <xref linkend="libfm"/>, and
          brings the <command>gtk-update-icon-cache</command> executable,
          which is needed by libqtxdg
        </para>
      </step>

      <step>
        <para>
          Build required Qt dependencies, and some of the recommended or
          optional dependencies, namely:
          <xref linkend="dbus"/>,
          <xref linkend="alsa-lib"/>,
          <xref linkend="pulseaudio"/>, and
          <xref linkend="libxkbcommon"/>
        </para>
      </step>

      <step>
        <para>
          Build the required parts of <xref linkend="qt5"/>. To skip all
          modules but the four needed for LXQt, do:
        </para>
<screen role="nodump"><userinput>ls -Fd qt* | grep / | sed 's/^/-skip /;s/qt//;s@/@@' > tempconf
sed -i '/base/d;/tools/d;/x11extras/d;/svg/d' tempconf
# if you plan to build SDDM, add:
sed -i '/declarative/d'
./configure &lt;book flags&gt; $(cat tempconf)</userinput></screen>
        <para>
          The time needed to complete the Qt installation is thus reduced to
          around 6 SBU
        </para>
      </step>

      <step>
        <para>
          Build miscellaneous dependencies (with their required ones):
          <xref linkend="libstatgrab"/>,
          <xref linkend="polkit"/>,
          <phrase revision="sysv">
            <xref linkend="consolekit"/>,
            <xref linkend="pm-utils"/>,
          </phrase>
          <xref linkend="lm_sensors"/>,
          <xref linkend="upower"/>, and
          <xref linkend="libfm"/>. If <xref linkend="cmake"/> has not been
          built during the preceding steps, build it now
        </para>
      </step>

      <step>
        <para>
          Build KDE frameworks dependencies:
          <xref linkend="extra-cmake-modules"/>,
          <xref linkend="libdbusmenu-qt"/>, and
          <xref linkend="polkit-qt"/>
        </para>
      </step>

      <step>
        <para>
          Finally, build some desktop utilities:
          <xref linkend="xdg-utils"/> (needs only xmlto),
          <xref linkend="xdg-user-dirs"/>,
          <xref linkend="oxygen-icons5"/> or other sets of icons
        </para>
      </step>
    </procedure>

  </sect2>

</sect1>