source: kde/plasma5/plasma-all.xml@ 1c3fc6f0

<?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          "130 MB">
  <!ENTITY plasma5-buildsize     "572 MB (357 MB installed)">
  <!ENTITY plasma5-time          "14 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>

  &lfs101_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"/>,-->
    <xref linkend="GConf"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="kf5-frameworks"/>,
    <xref linkend="libpwquality"/>,
    <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="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="smartmontools"/>
  </para>

  <bridgehead renderas="sect4">Optional</bridgehead>
  <para role="optional">
    <xref linkend="glu"/>,
    <xref linkend='ibus'/>,
    <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>

  <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>6704f5b7e08ddef06aaae2329c83edd0  kdecoration-5.21.1.tar.xz
6b7cc3ccf7881ea0d0bde07ead95860c  libkscreen-5.21.1.tar.xz
ad1b34a1fa173c92d279941333e15d04  libksysguard-5.21.1.tar.xz
672efd2a00cae728c602aee8dcbe6d34  breeze-5.21.1.tar.xz
cd2968bedf5a2f81df05921fb27d3c4d  breeze-gtk-5.21.1.tar.xz
2607a8599c0923e824a5d9a8661fe11d  kscreenlocker-5.21.1.tar.xz
2b0542f736741808cf08ea08f60b3b70  oxygen-5.21.1.tar.xz
a7254b02d4e52f406840090ad6cd1a04  kinfocenter-5.21.1.tar.xz
efa5758ce2ee0f8fd70f188198187f6a  ksysguard-5.21.1.tar.xz
bee63f7adde88fda32313b479050cc91  kwayland-server-5.21.1.tar.xz
56647c9a9a14c447013d734321dfeb28  kwin-5.21.1.tar.xz
a6d561c5183168449de63840888ec120  plasma-workspace-5.21.1.tar.xz
f94222d6d0237978e4a00d68abcf45b7  plasma-disks-5.21.1.tar.xz
582c0bc22874a5dd28f82c765b2562e8  bluedevil-5.21.1.tar.xz
1140e976e5cc8e157c0fb7d15058a07b  kde-gtk-config-5.21.1.tar.xz
85c2366ba57798df2cd2c4a006fa6430  khotkeys-5.21.1.tar.xz
b6ea73b30e16f05923840c79146d0280  kmenuedit-5.21.1.tar.xz
1dfd0ddec58bd28d93a09dea672dcb70  kscreen-5.21.1.tar.xz
cefd31bcc087e54faa00a619c762ba63  kwallet-pam-5.21.1.tar.xz
4faee9fba32bb4c4f69b98b23e3d5950  kwayland-integration-5.21.1.tar.xz
25867c8239bea61976bd3f5ab8af9e9f  kwrited-5.21.1.tar.xz
45bf96a93445d1ab3c9a63d8b40d8974  milou-5.21.1.tar.xz
09f1f2668113c01d327b9873ed4f80a6  plasma-nm-5.21.1.tar.xz
a8d0daf6e671c125e7f09e4b67f9f158  plasma-pa-5.21.1.tar.xz
0bc819955f9c5bc483d2b443b765d544  plasma-workspace-wallpapers-5.21.1.tar.xz
b9d5703a6e291e3ba4d8f967b83beb94  polkit-kde-agent-1-5.21.1.tar.xz
77758cb82a129155c4db2a0a4d14d993  powerdevil-5.21.1.tar.xz
31070b325b1673aec305b1d13fe7fc08  plasma-desktop-5.21.1.tar.xz
749d00234c2bc6991af0c0cd5bc36e96  kdeplasma-addons-5.21.1.tar.xz
94e3eb05ee7c06e25587dd6c198fcc7c  kgamma5-5.21.1.tar.xz
61cac749eec698ffaa4d54eaaf251565  ksshaskpass-5.21.1.tar.xz
#3f54255d7515f08615f7905329771ea6  plasma-sdk-5.21.1.tar.xz
c675d299cc468021ce31267a69589373  sddm-kcm-5.21.1.tar.xz
3311f6e733d26aa0a7803351cba7c0c5  discover-5.21.1.tar.xz
#9d4627fe5e15c972d1bd5902653eb15c  breeze-grub-5.21.1.tar.xz
#006bd972f30dbf79f5d8cc6702816361  breeze-plymouth-5.21.1.tar.xz
c30bbee8eed6943cb40144bcd70e9a55  kactivitymanagerd-5.21.1.tar.xz
8db9a652a9c40be8f092efda2d6a8463  plasma-integration-5.21.1.tar.xz
95d1ff516afb540c2a94297e6f816bb7  plasma-tests-5.21.1.tar.xz
#b536cd7d2274c552b740fbfce9920a9f  plymouth-kcm-5.21.1.tar.xz
dfe793c51a0654a38a80404fbda4de57  xdg-desktop-portal-kde-5.21.1.tar.xz
3a3de5e9e4caa35e95c009d2aa21cf04  drkonqi-5.21.1.tar.xz
b4295f7d395e547f7936b76717e2d4cd  plasma-vault-5.21.1.tar.xz
caf1b7d83ec0c75c315fce35f4fcc1b4  plasma-browser-integration-5.21.1.tar.xz
a19f5e8158322e91d08e93ccedc11feb  kde-cli-tools-5.21.1.tar.xz
3a626e27e0cf792142ad5269efe95ed9  systemsettings-5.21.1.tar.xz
5d7d94423d252301cf236db930d21357  plasma-thunderbolt-5.21.1.tar.xz
#b31c66f7c84c0d3177d116b3db06cd9e  plasma-nano-5.21.1.tar.xz
#e2a71cf0145b1f546bd4e1a483cd3017  plasma-phone-components-5.21.1.tar.xz
eee25dec70bffac0dc0858d6a53f829e  plasma-firewall-5.21.1.tar.xz
de0b75f307c6674971079abd1c3e0d6e  plasma-systemmonitor-5.21.1.tar.xz
ee1d2b217efbc83d16218d4370bd6098  qqc2-breeze-style-5.21.1.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>