source: kde/plasma5/plasma-all.xml@ 6d8eeb9

<?xml version="1.0" encoding="UTF-8"?>
<!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 plasma-download-http "https://download.kde.org/stable/plasma/&plasma-version;">
  <!ENTITY plasma-download-ftp  " ">
  <!ENTITY plasma-md5sum        "See Below">
  <!ENTITY plasma-size          "243 MB">
  <!ENTITY plasma-buildsize     "1.7 GB (419 MB installed)">
  <!ENTITY plasma-time          "7.6 SBU (using parallelism=4)">
]>

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


  <title>Building Plasma</title>

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

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

  &lfs121_checked;

  <para>
    The instructions below build all of the Plasma 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="&plasma-download-http;"/>
      </para>
    </listitem>
    <listitem>
      <para>
        Download (FTP): <ulink url="&plasma-download-ftp;"/>
      </para>
    </listitem>
    <listitem>
      <para>
        Download MD5 sum: &plasma-md5sum;
      </para>
    </listitem>
    <listitem>
      <para>
        Download size: &plasma-size;
      </para>
    </listitem>
    <listitem>
      <para>
        Estimated disk space required: &plasma-buildsize;
      </para>
    </listitem>
    <listitem>
      <para>
        Estimated build time: &plasma-time;
      </para>
    </listitem>
  </itemizedlist>

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

  <bridgehead renderas="sect4">Required</bridgehead>
  <para role="required">
    <!--<xref linkend="gtk2"/>, Does not seem to be needed any more -->
    <xref linkend="gtk3"/>,
    <xref linkend="kf6-frameworks"/>,
    <xref linkend="libpwquality"/>,
    <xref linkend="libqalculate"/>,
    <xref linkend="libxcvt"/>,
    <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="libcanberra"/>,
    <xref linkend="libinput"/>,
    <xref linkend="libpcap"/>,
    <xref linkend="linux-pam"/>,
    <xref linkend="lm_sensors"/>,
    <xref linkend="oxygen-icons"/>, 
    <xref linkend="pciutils"/>, and
    <xref linkend="power-profiles-daemon"/> (for laptops)
  </para>

  <bridgehead renderas="sect4">Recommended (runtime)</bridgehead>
  <para role="recommended">
    <xref role="runtime" linkend="accountsservice"/>,
    <xref role="runtime" linkend="smartmontools"/>,
    <xref role="runtime" linkend="xdg-desktop-portal"/>, and
    <xref role="runtime" linkend="xwayland"/>
  </para>

  <bridgehead renderas="sect4">Optional</bridgehead>
  <para role="optional">
    <xref linkend="appstream"/> (build with -qt=true),
    <xref linkend="glu"/>,
    <xref linkend='ibus'/>,
    <xref linkend='qtwebengine'/>,
    <xref linkend="xorg-synaptics-driver"/>,
    <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://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>
      <xref linkend="qtwebengine"/> is required for aura-browser.
      It is also optional for two other packages:
      libksysguard and kdeplasma-addons. If QtWebEngine is installed later,
      only these two packages need to be rebuilt. This allows
      a more complete display in the system monitor application.
    </para>
  </note>

  <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/&plasma-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-&plasma-version;.md5 &lt;&lt; "EOF"
<literal>599e79f2908879ed7f7ffda3637c54a6  kdecoration-6.0.0.tar.xz
96f956b40d929ddecb208101564aa269  libkscreen-6.0.0.tar.xz
e09b5326dea0c32c64745a0ab3bb17fd  libksysguard-6.0.0.tar.xz
6546c71b2707637fb0c8ffd90abfc981  breeze-6.0.0.tar.xz
6ec29676f896546f9fab485142fff113  breeze-gtk-6.0.0.tar.xz
5d02ead00aa69e96d71fb892aa941fa3  layer-shell-qt-6.0.0.tar.xz
c91f8689b5386ce42d8a270ba669dfc3  plasma-activities-6.0.0.tar.xz
125c3e7cf3bb32d3103bb769c584660f  libplasma-6.0.0.tar.xz
9dbfb8774a5acead43b3a0afb90a893f  kscreenlocker-6.0.0.tar.xz
b37312379616a7c2309c834005ada178  oxygen-6.0.0.tar.xz
643d13b69ffddf133f4067bd25e33034  kinfocenter-6.0.0.tar.xz
4bc12254229c9762e29f2f75d2f44e1a  kglobalacceld-6.0.0.tar.xz
97c448777e08ea7fe53aaef2cb35d17a  kwayland-6.0.0.tar.xz
b5b1a531a62ba3b778c793c63b262509  kwin-6.0.0.tar.xz
5ac7afff15ac496b580526cf5c017db7  plasma5support-6.0.0.tar.xz
d931aa7909d574c0a5b26a4d5af1f4eb  plasma-activities-stats-6.0.0.tar.xz
1ce2e4da8cf65347f6fc5099b418ecc6  kpipewire-6.0.0.tar.xz
4a155013537b80009cc1e7d1582fda33  plasma-workspace-6.0.0.tar.xz
e32c8a5eac1ac01a763bbcc70b3f6945  plasma-disks-6.0.0.tar.xz
4d18ce97c23bbf35d87b73efec71420c  bluedevil-6.0.0.tar.xz
bfc8028a6f0888965a3a555663ba893b  kde-gtk-config-6.0.0.tar.xz
83dffdc80445bbc617f0c0dcef04ca4a  kmenuedit-6.0.0.tar.xz
57acadb3a31ff06cad411269de2ea700  kscreen-6.0.0.tar.xz
7fad253ac68778bf4046b72a892ade92  kwallet-pam-6.0.0.tar.xz
115cb1253c7a903070ff76630370d97d  kwrited-6.0.0.tar.xz
90eb8b277e475f1447472ba467336547  milou-6.0.0.tar.xz
7dcf751acdb6fc66b50734948831731a  plasma-nm-6.0.0.tar.xz
ca57d6c816ae40b595bf3e3e1a2617ff  plasma-pa-6.0.0.tar.xz
f4445ecabf52a5777fa405f36c791d72  plasma-workspace-wallpapers-6.0.0.tar.xz
ae7b1d18a20699124d924b126335aaed  polkit-kde-agent-1-6.0.0.tar.xz
93aacc0af152b6d2e28a694bd211f29d  powerdevil-6.0.0.tar.xz
46d9dee5d8abfc12bd8c3ca8811327e7  plasma-desktop-6.0.0.tar.xz
2b522f3fd18ed563c9fab882b83193eb  kgamma-6.0.0.tar.xz
a832617c17070ec2dce5cf019ab7ab1c  ksshaskpass-6.0.0.tar.xz
#65ceae0e87f6b11ec924d57d764913f4  plasma-sdk-6.0.0.tar.xz
973e99f506a6fdad96a8b43d04a0b510  sddm-kcm-6.0.0.tar.xz
#a7ab65d4a36e402df4b42c91cd2a16da  discover-6.0.0.tar.xz
#bc42922097f6964252a5f56e759c3844  breeze-grub-6.0.0.tar.xz
#f399364375591938bdfb2d235f13923b  breeze-plymouth-6.0.0.tar.xz
c0248379f3df970fa19fe6d341dd00a4  kactivitymanagerd-6.0.0.tar.xz
ad6dee45c10e415a92d76745e5901842  plasma-integration-6.0.0.tar.xz
#e377ca58ca8089ce4e4c26c03e85b4f1  plymouth-kcm-6.0.0.tar.xz
b0a1e9952e09e35f90d8131faed98882  xdg-desktop-portal-kde-6.0.0.tar.xz
53864beb8ca2de75a8e4c1f52b0f4ea5  drkonqi-6.0.0.tar.xz
e6c9b78fd0022d37dc4913e3dbe5205e  plasma-vault-6.0.0.tar.xz
#a5b70716031e98843e8fa1088f2eb0bc  plasma-browser-integration-6.0.0.tar.xz
91f1b7dbde5fcd508f3eab9cdf5f0681  kde-cli-tools-6.0.0.tar.xz
876c57804ef1daadfcce81bb0d7e82a4  systemsettings-6.0.0.tar.xz
29588e3f9d64d092060890a5a438cdb6  plasma-thunderbolt-6.0.0.tar.xz
#cc307526ac2f02e7547cacea0eeccda6  plasma-nano-6.0.0.tar.xz
#5e2effe947e2edf89cce35ef5c2527f6  plasma-mobile-6.0.0.tar.xz
f791645b191b9f2e6cc9e6cf0037af00  plasma-firewall-6.0.0.tar.xz
a4d558a30b2ae93dc680010867e10abc  plasma-systemmonitor-6.0.0.tar.xz
f250350b7fa2ff6f28f88233955c5638  qqc2-breeze-style-6.0.0.tar.xz
28f4d1841cecffaf76462ba20e45c45b  ksystemstats-6.0.0.tar.xz
8aad48fd0f58f08ea197aa6d8e4dfab3  oxygen-sounds-6.0.0.tar.xz
4d7c36f9ada95960ec0619547c716f81  kdeplasma-addons-6.0.0.tar.xz
#df582e99c5288d1c0b8dcd1b34a31d08  flatpak-kcm-6.0.0.tar.xz
#eebf65971b0066c707eef50742a9c49e  plasma-welcome-6.0.0.tar.xz
8f0c51c160819c170dcc77722b6153e3  ocean-sound-theme-6.0.0.tar.xz
b8963fb1790449d4a905cf85f017d1e9  print-manager-6.0.0.tar.xz
#a05c7d650e44cd046fbc090fcbb69ae4  wacomtablet-6.0.0.tar.xz</literal>
EOF</userinput></screen>

    <note>
      <title>About Commented out Packages</title>
      <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.

        The plasma-mobile package provides phone functionality for Plasma.
        
        The aura-browser package requires <xref linkend="qtwebengine"/>.
        
        The discover package requires <xref linkend="appstream"/> to be built
        with the -Dqt=true switch. The discover-5.27.10.1 version of the 
        package is an update to the previous version.
        
        The plasma-welcome package requires the external package
          <ulink url="https://download.kde.org/stable/release-service/&kf5apps-version;/src/">
        kaccounts-integration</ulink>.
        
        The flatpack-kcm package is for managing support of flatpack applications.
      </para>
    </note>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Plasma</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=$KF6_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-&plasma-version;.md5

exit</userinput></screen>

    <para>
      If you did not set <envar>$KF6_PREFIX</envar> to
      <filename>/usr</filename>, create symlinks to allow display managers to
      find <application>Plasma</application>, and to allow the XDG Desktop
      Portal to be detected. As the &root; user:
    </para>

<screen><userinput># Setup xsessions (X11 sessions)
install -dvm 755 /usr/share/xsessions
cd /usr/share/xsessions

[ -e plasma.desktop ] ||
ln -sfv $KF6_PREFIX/share/xsessions/plasmax11.desktop 

# Setup wayland-sessions 
install -dvm 755 /usr/share/wayland-sessions
cd /usr/share/wayland-sessions

[ -e plasmawayland.desktop ] ||
ln -sfv $KF6_PREFIX/share/wayland-sessions/plasma.desktop
<!-- work around a bug in xdg-desktop-portal-->
# Setup xdg-desktop-portal
install -dvm 755 /usr/share/xdg-desktop-portal
cd /usr/share/xdg-desktop-portal 

[ -e kde-portals.conf ] ||
ln -sfv $KF6_PREFIX/share/xdg-desktop-portal/kde-portals.conf

# Setup kde partal
install -dvm 755 /usr/share/xdg-desktop-portal/portals
cd /usr/share/xdg-desktop-portal/portals

[ -e kde.portal ] ||
ln -sfv $KF6_PREFIX/share/xdg-desktop-portal/portals/kde.portal</userinput></screen>

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

<screen role="root"
        revision="sysv"><userinput>rm -rf $KF6_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 Plasma</title>

    <para revision="sysv">
      You can start <application>Plasma</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>Plasma</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</application> using <xref linkend="xinit"/>,
      run the following commands:
    </para>

<screen role="nodump"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>dbus-launch --exit-with-x11 $KF6_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 role="nodump"><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>
<!-- Start plasma wayland with 

/opt/kf6/lib/libexec/plasma-dbus-run-session-if-needed /opt/kf6/bin/startplasma-wayland

Investigate why it's in /opt/kf6/lib/libexec and not just in /opt/kf6/libexec


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 (over 50 in /opt/kf6/bin) to list
           separately here.
        </seg>
        <seg>
           There are too many plasma libraries (over 250 in /opt/kf6/lib) to list
           separately here.
        </seg>
        <seg>
           There are too many plasma directories (over 2700 in /opt/kf6) to
           list separately here.
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>