source: kde/plasma5/plasma-all.xml@ aa21336

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter 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 plasma5-download-http "https://download.kde.org/stable/plasma/&plasma5-version;">
  <!ENTITY plasma5-download-ftp  " ">
  <!ENTITY plasma5-md5sum        "See Below">
  <!ENTITY plasma5-size          "183 MB">
  <!ENTITY plasma5-buildsize     "1.5 GB (366 MB installed)">
  <!ENTITY plasma5-time          "19 SBU (using parallelism=4)">
]>

<sect1 id="plasma5-build" xreflabel="Plasma-&plasma5-version;">
  <?dbhtml filename="plasma-all.html"?>

  <sect1info>
     <date>$Date$</date>
  </sect1info>

  <title>Building Plasma 5</title>

  <indexterm zone="plasma5-build">
     <primary sortas="a-kde-plasma">KDE Plasma 5</primary>
  </indexterm>

  <para>
    KDE Plasma 5 is a collection of packages based on top of KDE Frameworks
    5 and QML. They implement the KDE Display Environment (Plasma 5).
  </para>

  &lfs111_checked;

  <para>
    The instructions below build all of the Plasma 5 packages in one
    step by using a bash script.
  </para>

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

  <bridgehead renderas="sect3">Plasma 5 Dependencies</bridgehead>

  <bridgehead renderas="sect4">Required</bridgehead>
  <para role="required">
    <!--<xref linkend="fontforge"/>,-->
    <!-- does not seem to be needed as of 5.22.4 <xref linkend="GConf"/>, -->
    <xref linkend="gtk2"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="kf5-frameworks"/>,
    <xref linkend="libpwquality"/>,
    <xref linkend="libqalculate"/>,
    <xref linkend="libxkbcommon"/>,
    <xref linkend="mesa"/> built with <xref linkend="wayland"/>,
    <xref linkend="NetworkManager"/>,
    <xref linkend="pipewire"/>,
    <xref linkend="pulseaudio"/>,
    <xref linkend="qca"/>,
    <xref linkend="sassc"/>,
    <xref linkend="taglib"/>, and
    <xref linkend="xcb-util-cursor"/>
  </para>

  <bridgehead renderas="sect4">Recommended</bridgehead>
  <para role="recommended">
    <xref linkend="fftw"/>,
    <xref linkend="gsettings-desktop-schemas"/>,
    <xref linkend="libdbusmenu-qt"/>,
    <xref linkend="libcanberra"/>,
    <xref linkend="libinput"/>,
    <xref linkend="libpcap"/>,
    <xref linkend="linux-pam"/>,
    <xref linkend="lm_sensors"/>,
    <xref linkend="oxygen-icons5"/>, and
    <xref linkend="pciutils"/>
  </para>

  <bridgehead renderas="sect4">Recommended (runtime)</bridgehead>
  <para role="recommended">
    <xref role="runtime" linkend="accountsservice"/> and
    <xref role="runtime" linkend="smartmontools"/>
  </para>

  <bridgehead renderas="sect4">Optional</bridgehead>
  <para role="optional">
    <xref linkend="glu"/>,
    <xref linkend='ibus'/>,
    <xref linkend='qtwebengine'/>,
    <xref linkend="xorg-synaptics-driver"/>,
    <ulink url="http://distributions.freedesktop.org/wiki/AppStream">appstream-qt</ulink>,
    <ulink url="https://www.kdevelop.org/">KDevPlatform</ulink>,
    <ulink url="https://gpsd.gitlab.io/gpsd/">libgps</ulink>,
    <ulink url="https://github.com/libhybris/libhybris">libhybris</ulink>,
    <ulink url="https://sourceforge.net/projects/libraw1394/">libraw1394</ulink>,
    <ulink url="https://bitbucket.org/godsme/mockcpp">mockcpp</ulink>,
    <ulink url="https://www.freedesktop.org/software/PackageKit/releases/">packagekit-qt</ulink>,
    <ulink url="http://qalculate.github.io/">Qalculate</ulink>,
    <ulink url="https://launchpad.net/qapt">Qapt</ulink>,
    <ulink url="https://github.com/osiam/osiam">SCIM</ulink>, and
    <ulink url="http://www.dest-unreach.org/socat/">socat</ulink> (for pam_kwallet)
  </para>

  <note>
    <para>
      Only two plasma packages optionally use <xref linkend="qtwebengine"/>:
      libksysguard and kdeplasma-addons. If QtWebEngine is installed later,
      only those two packages have to be rebuilt. This allows to provide
      a more complete display in the system monitor application.
    </para>
  </note>

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

  <sect2>
    <title>Downloading KDE Plasma5</title>

    <para>
      The easiest way to get the KDE Plasma5 packages is to use a single
      <command>wget</command> to fetch them all at once:
    </para>

<screen><userinput>url=https://download.kde.org/stable/plasma/&plasma5-version;/
wget -r -nH -nd -A '*.xz' -np $url</userinput>
<literal>
The options used here are:
  -r            recurse through child directories
  -nH           disable generation of host-prefixed directories
  -nd           do not create a hierarchy of directories
  -A '*.xz'     just get the *.xz files
  -np           don't get parent directories</literal></screen>

   </sect2>

  <sect2>
    <title>Setting Package Order</title>

    <para>
      The order of building files is important due to internal dependencies.
      Create the list of files in the proper order as follows:
    </para>

<screen><userinput>cat &gt; plasma-&plasma5-version;.md5 &lt;&lt; "EOF"
<literal>d5a143b93d183e46d2d9eecb65ca32d6  kdecoration-5.24.0.tar.xz
25328009546df7703a45a51c27befc76  libkscreen-5.24.0.tar.xz
3869c4c0c3acc7fcb2a210aac6480249  libksysguard-5.24.0.tar.xz
3065e58dd9832b419e68b38921a97c24  breeze-5.24.0.tar.xz
6fad933f0ee6f852ae58d906444b9595  breeze-gtk-5.24.0.tar.xz
7eae43606459dd0a288d5c081d9a6a2a  layer-shell-qt-5.24.0.tar.xz
127f90c5e77d404949446813baf7d61a  kscreenlocker-5.24.0.tar.xz
626ae567af6b34bb3f8a0ffc18093e95  oxygen-5.24.0.tar.xz
f9a542276e05b3b4cb9fbd32c541a552  kinfocenter-5.24.0.tar.xz
cad3dc7c0b9ca2faa9f8d25b4b2d857d  kwayland-server-5.24.0.tar.xz
a401b80ab133740bb9c006cdf0eaedbf  kwin-5.24.0.tar.xz
56e20e9dd1767457613592c1edece60b  plasma-workspace-5.24.0.tar.xz
c8aa0ccd5cf5b428e16a25410f8ac33f  plasma-disks-5.24.0.tar.xz
6b7e9f27503c829924048bf65a0c4763  bluedevil-5.24.0.tar.xz
5dcd7cb3e9401942b1307ec65dcf7ea5  kde-gtk-config-5.24.0.tar.xz
5a289a97f76a416a9ac6a62dc8fe733a  khotkeys-5.24.0.tar.xz
a7485966e66b63f50eddbcbc4790832c  kmenuedit-5.24.0.tar.xz
507d12a9237fded95bbd1532e4a7b66b  kscreen-5.24.0.tar.xz
4c2f698253f260a955ed1867d1ec9007  kwallet-pam-5.24.0.tar.xz
1e5ff352ea3b039b112efe37677eff45  kwayland-integration-5.24.0.tar.xz
4f3d56f758541d046ad69e842fccac7b  kwrited-5.24.0.tar.xz
5e1d46d9bf8d0a03694903e83d070e3f  milou-5.24.0.tar.xz
b6e7be0be859d21947284e233d6e2931  plasma-nm-5.24.0.tar.xz
d99ceab1dd9986122690a4b24d50b114  plasma-pa-5.24.0.tar.xz
bad6e9079ac8ad192b8375242e5b1121  plasma-workspace-wallpapers-5.24.0.tar.xz
eacdd3ef241f27d7ae68abce49d47a45  polkit-kde-agent-1-5.24.0.tar.xz
8b1299077c31395e2f04b28d94d1ca06  powerdevil-5.24.0.tar.xz
8c07b6d13e9ed8965abb38f0c3bdfdbf  plasma-desktop-5.24.0.tar.xz
0f52913bec0b9ae5fe7c39b7eb7c0822  kdeplasma-addons-5.24.0.tar.xz
3dfd5a918fe12eaec8cf3fc291c69bfb  kgamma5-5.24.0.tar.xz
63bd9da2abdbffb38f7b89d4d1e6e52b  ksshaskpass-5.24.0.tar.xz
#e4353dc4d36d9ed54d25df4e2538ef04  plasma-sdk-5.24.0.tar.xz
9f4568cf9b1ace13f082bb38f45f0079  sddm-kcm-5.24.0.tar.xz
1759fb71e190f0fd506e98f68d1df938  discover-5.24.0.tar.xz
#89000e84cca76de236e576c922979352  breeze-grub-5.24.0.tar.xz
#5f34ae758eab4fc8343e2fad5b7afbfb  breeze-plymouth-5.24.0.tar.xz
f2485f5a857898ae47c256ae8d9b4893  kactivitymanagerd-5.24.0.tar.xz
050d04b18ce5f00fb7dfef31000d88b6  plasma-integration-5.24.0.tar.xz
1eab4ed3b88ef3a712223afc4c116a7d  plasma-tests-5.24.0.tar.xz
#8b19cc2d7929cf988a44606a3eba7644  plymouth-kcm-5.24.0.tar.xz
9aafa58faea1bd7f90776f6e63d3866a  xdg-desktop-portal-kde-5.24.0.tar.xz
fe87c0f534cbefe3955faecfe5fcfc4d  drkonqi-5.24.0.tar.xz
c6f224eb9eb6f87e0af1464d7a933d09  plasma-vault-5.24.0.tar.xz
d3c42b17d180af6ddf9821abd6f36d7e  plasma-browser-integration-5.24.0.tar.xz
a7157d0f6a12d2da890643b30bb02967  kde-cli-tools-5.24.0.tar.xz
3c7a50b0eb124cb6d1886cc89a0de5e8  systemsettings-5.24.0.tar.xz
e6346ea04baa5c25e706145777a193dc  plasma-thunderbolt-5.24.0.tar.xz
#e4daa179a4bce0f03f4988186dfe3e31  plasma-nano-5.24.0.tar.xz
#3e0e67f2a798b51025cb97a750fc1dea  plasma-phone-components-5.24.0.tar.xz
#3e0e67f2a798b51025cb97a750fc1dea  plasma-mobile-5.24.0.tar.xz
2c43882de9c657073aed4df2c01eeac4  plasma-firewall-5.24.0.tar.xz
886d89f75a6ba9324586154816a9bcef  plasma-systemmonitor-5.24.0.tar.xz
61903525c0e1585cb00e1b7c7c690145  qqc2-breeze-style-5.24.0.tar.xz
f1e7a6af9a0862cc8812426e4d040be6  ksystemstats-5.24.0.tar.xz</literal>
EOF</userinput></screen>

    <note>
      <para>
        The breeze-grub, breeze-plymouth, and plymouth-kcm packages above are
        all for customized support of <ulink
            url="https://www.freedesktop.org/wiki/Software/Plymouth/"
          >Plymouth</ulink>
        which is designed to be run within an initial ram disk during boot (see
        <xref linkend="initramfs"/>).  The plasma-sdk package is optional and
        used for software development. The plasma-nano package is used for
        embedded systems and plasma-phone-components provides phone
        functionality for Plasma.
      </para>
    </note>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Plasma5</title>

    &as_root;

    <para>
      First, start a subshell that will exit on error:
    </para>

<screen><userinput>bash -e</userinput></screen>

    <para>
      Install all of the packages by running the following
      commands:
    </para>

<screen><userinput>while read -r line; do

    # Get the file name, ignoring comments and blank lines
    if $(echo $line | grep -E -q '^ *$|^#' ); then continue; fi
    file=$(echo $line | cut -d" " -f2)

    pkg=$(echo $file|sed 's|^.*/||')          # Remove directory
    packagedir=$(echo $pkg|sed 's|\.tar.*||') # Package directory

    tar -xf $file
    pushd $packagedir
<!--
       # Fix some build issues when generating some configuration files
       case $name in
         plasma-workspace)
           sed -i '/set.HAVE_X11/a set(X11_FOUND 1)' CMakeLists.txt
         ;;

         khotkeys)
           sed -i '/X11Extras/a set(X11_FOUND 1)' CMakeLists.txt
         ;;

         plasma-desktop)
           sed -i '/X11.h)/i set(X11_FOUND 1)' CMakeLists.txt
         ;;
       esac
-->
       mkdir build
       cd    build

       cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
             -DCMAKE_BUILD_TYPE=Release         \
             -DBUILD_TESTING=OFF                \
             -Wno-dev ..  &amp;&amp;

        make
        as_root make install
    popd

<!-- some packages end up with files owned by root in $packagedir,
     so use as_root for removing -->
    as_root rm -rf $packagedir
    as_root /sbin/ldconfig

done &lt; plasma-&plasma5-version;.md5

exit</userinput></screen>

    <para>
      If you did not set <envar>$KF5_PREFIX</envar> to
      <filename>/usr</filename>, create symlinks to allow display managers to
      find <application>Plasma</application>:
    </para>

<screen><userinput>as_root install -dvm 755 /usr/share/xsessions              &amp;&amp;
cd /usr/share/xsessions/                                   &amp;&amp;
[ -e plasma.desktop ]                                      ||
as_root ln -sfv $KF5_PREFIX/share/xsessions/plasma.desktop &amp;&amp;
as_root install -dvm 755 /usr/share/wayland-sessions       &amp;&amp;
cd /usr/share/wayland-sessions/                            &amp;&amp;
[ -e plasmawayland.desktop ]                               ||
as_root ln -sfv $KF5_PREFIX/share/wayland-sessions/plasmawayland.desktop<!--
cd $KF5_PREFIX/share/plasma/plasmoids

for j in $(find -name \*.js); do
  as_root ln -sfv ../code/$(basename $j) $(dirname $j)/../ui/
done--></userinput></screen>

    <para revision="sysv">
      Useless systemd units have been installed in
      <filename class="directory">$KF5_PREFIX/lib</filename>. Remove
      them now (as <systemitem class="username">root</systemitem>):
    </para>

<screen role="root"
        revision="sysv"><userinput>rm -rf $KF5_PREFIX/lib/systemd</userinput></screen>

  </sect2>
<!--
    <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>ln -sfv ../code/$(basename $j) $(dirname $j)/../ui/</command>:
      Create symbolic links so qml files can find needed javascript modules.
    </para>

  </sect2>
-->
  <sect2 role="configuration">
    <title>Configuring Plasma</title>

    <sect3>
      <title>Linux PAM Configuration</title>

      <para>
        If you built Plasma with the recommended <application>Linux
        PAM</application> support, create necessary configuration files by
        running the following commands as the <systemitem
        class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>cat &gt; /etc/pam.d/kde &lt;&lt; "EOF"
<literal># Begin /etc/pam.d/kde

auth     requisite      pam_nologin.so
auth     required       pam_env.so

auth     required       pam_succeed_if.so uid &gt;= 1000 quiet
auth     include        system-auth

account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/kde</literal>
EOF

cat &gt; /etc/pam.d/kde-np &lt;&lt; "EOF"
<literal># Begin /etc/pam.d/kde-np

auth     requisite      pam_nologin.so
auth     required       pam_env.so

auth     required       pam_succeed_if.so uid &gt;= 1000 quiet
auth     required       pam_permit.so

account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/kde-np</literal>
EOF

cat &gt; /etc/pam.d/kscreensaver &lt;&lt; "EOF"
<literal># Begin /etc/pam.d/kscreensaver

auth    include system-auth
account include system-account

# End /etc/pam.d/kscreensaver</literal>
EOF</userinput></screen>
    </sect3>
  </sect2>

  <sect2 role="starting">
    <title>Starting Plasma5</title>

    <para revision="sysv">
      You can start <application>Plasma5</application> from runlevel 3, using
      <xref linkend="xinit"/>, or from runlevel 5, using a Display Manager,
      such as <xref linkend="lightdm"/>.
    </para>

    <para revision="systemd">
      You can start <application>Plasma5</application> from a TTY, using
      <xref linkend="xinit"/><!--, or from a graphical display manager, such as
      <xref linkend="sddm"/>-->.
    </para>

    <para>
      To start <application>Plasma 5</application> using <xref linkend="xinit"/>,
      run the following commands:
    </para>

<screen><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>dbus-launch --exit-with-session $KF5_PREFIX/bin/startplasma-x11</literal>
EOF

startx</userinput></screen>

    <para>
      The X session starts on the first unused virtual terminal, normally vt7.
      You can switch to another vt<emphasis>n</emphasis> simultaneously
      pressing the keys Ctrl-Alt-F<emphasis>n</emphasis>
      (<emphasis>n</emphasis>=1, 2, ...).  To switch back to the X session,
      normally started at vt7, use Ctrl-Alt-F7. The vt where the command
      <command>startx</command> was executed will display many messages,
      including X starting messages, applications automatically started with
      the session, and eventually, some warning and error messages. You may
      prefer to redirect those messages to a log file, which not only will keep
      the initial vt uncluttered, but can also be used for debugging purposes. This
      can be done starting X with:
    </para>

    <screen><userinput>startx &amp;&gt; ~/x-session-errors</userinput></screen>

    <para>
      When shutting down or rebooting, the shutdown messages appear on the vt
      where X was running. If you wish to see those messages, simultaneously
      press keys Alt-F7 (assuming that X was running on vt7).
    </para>
<!-- Now the entry is "plasma (X11)" for Xorg, so I guess this is
     not needed anymore:
    <para>
      If you intend to start <application>Plasma</application> using a
    display manager such as <xref linkend="lightdm"/>, there will be two entries
    for <application>Plasma</application>, one for use with
    <application>Xorg</application>, and another for
    <application>Wayland</application>. Modify the
    <application>Xorg</application> entry with the following command, as the
    <systemitem class="username">root</systemitem> user, so that you can
    differentiate between the two:</para>

<screen role="root"><userinput>sed '/^Name=/s/Plasma/Plasma on Xorg/' -i /usr/share/xsessions/plasma.desktop</userinput></screen>
-->

  </sect2>

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

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

      <seglistitem>
        <seg>
           There are too many plasma programs (63 in /opt/kf5/bin) to list
           separately here.
        </seg>
        <seg>
           There are too many plasma libraries (40 in /opt/kf5/lib) to list
           separately here.
        </seg>
        <seg>
           There are too many plasma directories (over 1000 in /opt/kf5) to
           list separately here.
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>