source: kde/plasma5/plasma-all.xml@ 75b1a338

<?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          "209 MB">
  <!ENTITY plasma5-buildsize     "1.5 GB (416 MB installed)">
  <!ENTITY plasma5-time          "19 SBU (using parallelism=4)">
]>

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


  <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>

  &lfs112_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="kuserfeedback"/>,
    <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"/>,
    <xref role="runtime" linkend="smartmontools"/>, and
    <xref role="runtime" linkend="xwayland"/>
  </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="https://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="https://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>a01dbbcce3ba3940153316d1c37d4744  kdecoration-5.26.4.tar.xz
d1e815e30f077922fbcad8a5ae4ae551  libkscreen-5.26.4.tar.xz
7723718f4ae45ef8d7afb6f698754500  libksysguard-5.26.4.tar.xz
a9a1aa3091af394ea4f0da49cf71fa55  breeze-5.26.4.tar.xz
6d3af0af59e7570c195e16326eb78a95  breeze-gtk-5.26.4.tar.xz
625e99eab5af4ec21336f748e67b67b7  layer-shell-qt-5.26.4.tar.xz
a8162421975df33c2a28f679b03b03aa  kscreenlocker-5.26.4.tar.xz
c7d87706957fdcad8967348a718cc1c9  oxygen-5.26.4.tar.xz
3dbf318d057cd9a012d2a37a3d45c3d5  kinfocenter-5.26.4.tar.xz
a2f23971599845b291c12c2701d7aa4e  kwin-5.26.4.tar.xz
39302f811e359033e664a6461b6fdbe4  plasma-workspace-5.26.4.1.tar.xz
3f1e7dfe3bfb45bab458c3867d92cd9f  plasma-disks-5.26.4.tar.xz
d9fb627fc4272e7753af952b522d4416  bluedevil-5.26.4.tar.xz
54e61050bbadae9d40321843834660e8  kde-gtk-config-5.26.4.tar.xz
52d5f2ed12284c8f31c6e6c7c1a18271  khotkeys-5.26.4.tar.xz
0d8060c1680c91a85129732a25f67623  kmenuedit-5.26.4.tar.xz
68bea6c5219ed6b83eb588b4f09254f6  kscreen-5.26.4.tar.xz
325ecd912133aec98d72cbb9371b5e9b  kwallet-pam-5.26.4.tar.xz
72255cb11155888a1f02dbc44346faf6  kwayland-integration-5.26.4.tar.xz
b6ba8694011f3f764ff3a4a2de27c446  kwrited-5.26.4.tar.xz
ba3f3b6cc47ae3092f4e70742300d181  milou-5.26.4.tar.xz
9b0fa4a7b7285c0eaaecc8f2cf4991b5  plasma-nm-5.26.4.tar.xz
9b83ac853e5851eb01918ae66e4bc238  plasma-pa-5.26.4.tar.xz
f4386c8910593425386b4d53f495a590  plasma-workspace-wallpapers-5.26.4.tar.xz
ca6f21554bc89320ad04d19fc56b749b  polkit-kde-agent-1-5.26.4.tar.xz
cc2dbf3bd907d7a347b53420f51b73c6  powerdevil-5.26.4.tar.xz
a7480b2f3dcb241597f881b820cea82f  plasma-desktop-5.26.4.tar.xz
c381c5cd5bbcfcf7f5b5012862e575c5  kgamma5-5.26.4.tar.xz
a0a20325af1c3a9690228f0da5d22efb  ksshaskpass-5.26.4.tar.xz
#90a1d60dfcae3b683246e3b04ccf3b36  plasma-sdk-5.26.4.tar.xz
1ab9b3119be9f170c82d28f83652d139  sddm-kcm-5.26.4.tar.xz
42bdb4436c5e5f02f6a6893b43d57029  discover-5.26.4.tar.xz
#9bf877b70af210d2b40833d00c6baae8  breeze-grub-5.26.4.tar.xz
#7977cbb93436e0cb41ac7c043a79d14e  breeze-plymouth-5.26.4.tar.xz
d102a43c139a928d6ccb83a0b4fb2f61  kactivitymanagerd-5.26.4.tar.xz
d7999e1f9ca9b7da32387227f890e7ed  plasma-integration-5.26.4.tar.xz
64277d588a7b2ab1bf9295268fac4fce  plasma-tests-5.26.4.tar.xz
#8824f8fe6c6547ba053c77980db5fc19  plymouth-kcm-5.26.4.tar.xz
2ca28e5e76a04ced2a151ada42df421f  xdg-desktop-portal-kde-5.26.4.tar.xz
d7d81abab1f75c4f75286b7541e3c724  drkonqi-5.26.4.tar.xz
a5d6dcfbcacb34429e3125a4dc3d20fa  plasma-vault-5.26.4.tar.xz
c554a96073816fdadd5ce27c8cc290da  plasma-browser-integration-5.26.4.tar.xz
ef012068159708971289387b948bbb9f  kde-cli-tools-5.26.4.tar.xz
3abcf237a6ba20f1e2ec4f9462780932  systemsettings-5.26.4.tar.xz
d6406865e7e722f503d118d283a9cb13  plasma-thunderbolt-5.26.4.tar.xz
#e459caedeccd6bd7ce7ec01130b9ef96  plasma-nano-5.26.4.tar.xz
#710b5a5517a0856e991a45b0e33b5048  plasma-mobile-5.26.4.tar.xz
46363a107539755e2d6707a199860dc5  plasma-firewall-5.26.4.tar.xz
a7614d882e4ea34682fbba713434ee94  plasma-systemmonitor-5.26.4.tar.xz
3d3c6f2086318a9a5bc584161b1a09b7  qqc2-breeze-style-5.26.4.tar.xz
9c5c6ced9cffaab52bdeed33fc5d053f  ksystemstats-5.26.4.tar.xz
dc694109774211bc57efa9030838245f  oxygen-sounds-5.26.4.tar.xz
b924e1a5efa106aafa87a25e1a3775b9  aura-browser-5.26.4.tar.xz
5d6fd4a97a939df024509371daca9fa2  kdeplasma-addons-5.26.4.tar.xz
b3a40dc5c74a53889fd6b3204bf91124  kpipewire-5.26.4.tar.xz
6d235cd46a3f9ecd313e0d0cc66f194c  plank-player-5.26.4.tar.xz
7dd0e56273b92752c7d0a2fc49144058  plasma-bigscreen-5.26.4.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>