source: kde/plasma/plasma-all.xml@ aeda083

<?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          "220 MB">
  <!ENTITY plasma-buildsize     "1.0 GB (444 MB installed)">
  <!ENTITY plasma-time          "14 SBU (using parallelism=8)">
]>

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

  &lfs122_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="boost"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="kf6-frameworks"/>,
    <xref linkend="kirigami-addons"/>,
    <xref linkend="libdisplay-info"/>,
    <xref linkend="libpwquality"/>,
    <xref linkend="libqalculate"/>,
    <xref linkend="libnl"/>,
    <xref linkend="libxcvt"/>,
    <xref linkend="libxkbcommon"/>,
    <xref linkend="mesa"/> built with <xref linkend="wayland"/>,
    <xref linkend="pipewire"/>,
    <xref linkend="pulseaudio-qt"/>,
    <xref linkend="qca"/>,
    <xref linkend="qcoro"/>,
    <xref linkend="sassc"/>,
    <xref linkend="taglib"/>, 
    <xref linkend="xdotool"/>, and 
    <xref linkend="xorg-evdev-driver"/>
  </para>

  <bridgehead renderas="sect4">Recommended</bridgehead>
  <para role="recommended">
    <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"/>, 
    <xref linkend="power-profiles-daemon"/>, and 
    the following Python modules: 
      <xref linkend="psutil"/>,
      <xref linkend="pygdbmi"/>,
      <xref linkend="sentry-sdk"/>, 
      <xref linkend="urllib3"/> (if they are not installed, they will be
      downloaded and installed by the drkonqi build procedure)
  </para>

  <bridgehead renderas="sect4">Recommended (runtime)</bridgehead>
  <para role="recommended">
    <xref role="runtime" linkend="accountsservice"/>,
    <xref role="runtime" linkend="breeze-icons"/>,
    <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://www.freedesktop.org/software/PackageKit/releases/">packagekit-qt</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>

  <sect2>
    <title>Downloading KDE Plasma</title>

    <para>
      The easiest way to get the KDE Plasma 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>be3516c192fcdbed07454de4b379f5db  kdecoration-6.1.4.tar.xz
dfd2bd982b5ab4daa5a3545e54cf9cb3  libkscreen-6.1.4.tar.xz
c05c1623be161c149a61ac3db0ce5382  libksysguard-6.1.4.tar.xz
7035691a6f63b28f389d76002afc3da8  breeze-6.1.4.tar.xz
9d82aff77358f55069020a408987c111  breeze-gtk-6.1.4.tar.xz
2e3a5220acf76e2c0edf9701978e802b  layer-shell-qt-6.1.4.tar.xz
250385889199481e81b979bd0dd51669  plasma-activities-6.1.4.tar.xz
d6686b711c1e52c0de7c75b66c9dc6e3  libplasma-6.1.4.tar.xz
98101a610670cfae5779bc9940d8561f  kscreenlocker-6.1.4.tar.xz
ca7bf1418903745c65dcbf7583299ceb  kinfocenter-6.1.4.tar.xz
4c4b58890f3bf7bf1b1d99e89f9271a8  kglobalacceld-6.1.4.tar.xz
d297f096ac9492262b8274a024618bd3  kwayland-6.1.4.tar.xz
2d4516080f370a6cf40351266277b010  kwin-6.1.4.tar.xz
131d3250d9124c8f21751f5e5255a7d6  plasma5support-6.1.4.tar.xz
fc8fe31088cad9f1a904554956df708b  plasma-activities-stats-6.1.4.tar.xz
85a3ff80ec16299dc8aa12190ce2bc24  kpipewire-6.1.4.tar.xz
575c902a134bb24214f76c500460df39  plasma-workspace-6.1.4.tar.xz
d000e0ee0f0e530c9dc64ab9252bc17a  plasma-disks-6.1.4.tar.xz
180136a6b20736c359b999cbd3509afc  bluedevil-6.1.4.tar.xz
3f065b337807c2a37d27a90bbcf1d8d1  kde-gtk-config-6.1.4.tar.xz
bcfa7f92df7c2f1a6c7718a12f81734c  kmenuedit-6.1.4.tar.xz
08590284bc4613804563db94a68c7cd2  kscreen-6.1.4.tar.xz
801318aea037e3d64f0aa7c9ca4fef8b  kwallet-pam-6.1.4.tar.xz
aa6bc381778b4e10c9798c3abeeb5692  kwrited-6.1.4.tar.xz
9c4f88ca9936252f62705f27687af764  milou-6.1.4.tar.xz
cbeb7b6b0094e9ec19af07ea458c8eb3  plasma-nm-6.1.4.tar.xz
aa32529c005706d2253333c93faa45de  plasma-pa-6.1.4.tar.xz
4c7484c0d5e4352372d32a340656abec  plasma-workspace-wallpapers-6.1.4.tar.xz
f904e90a9db900551d228f20dac06a45  polkit-kde-agent-1-6.1.4.tar.xz
312fe34839a8d0861cc676766a4317e4  powerdevil-6.1.4.tar.xz
adc8dad07c1157e79aed7476025b6925  plasma-desktop-6.1.4.tar.xz
cfbc61347436b9ff7ff43b7130d7955a  kgamma-6.1.4.tar.xz
41d6254b23061c4b4067b0d2db150cbf  ksshaskpass-6.1.4.tar.xz
#7bf7fd0d3a4a381148885cd058872212  plasma-sdk-6.1.4.tar.xz
ce1bbaf7df576f6ddccd1adda545657a  sddm-kcm-6.1.4.tar.xz
#5482b86089286d9b0153f09752d57574  discover-6.1.4.tar.xz
#d33ef85fb879f3073f1f26f1695e72f3  breeze-grub-6.1.4.tar.xz
#42bb6940246062b24ee80ac6e3b40e2d  breeze-plymouth-6.1.4.tar.xz
e458fddb447b0c76e8e49bb772b423a9  kactivitymanagerd-6.1.4.tar.xz
e0b3c21962456a5f9f79a739c477c22c  plasma-integration-6.1.4.tar.xz
#bebea20d8972e4052690877455aea645  plymouth-kcm-6.1.4.tar.xz
6bf11a27e32cc81e689867ddf59080c6  xdg-desktop-portal-kde-6.1.4.tar.xz
96d1d51407b85d22f01e6438e8e492cb  drkonqi-6.1.4.tar.xz
34627cfef9b00bc58bc853790e978dfd  plasma-vault-6.1.4.tar.xz
#d7984e9a5d3c4ac7a6e36b656cc16f3a  plasma-browser-integration-6.1.4.tar.xz
626f7f2e373085f948d0809413b0d49f  kde-cli-tools-6.1.4.tar.xz
5ba8376be2db662750ef48f582f22352  systemsettings-6.1.4.tar.xz
db8923a9b87e95dd5ec82a20da4ae95b  plasma-thunderbolt-6.1.4.tar.xz
#0106b72c6a46c966d31b7a4afdb456b3  plasma-mobile-6.1.4.tar.xz
#8a7de2aa288ae50190fcd86a7d72cbcb  plasma-nano-6.1.4.tar.xz
3bc5c58b1d06e4f4f1667799219ae887  plasma-firewall-6.1.4.tar.xz
bf76a58afb8def0a0d07ea65429154fc  plasma-systemmonitor-6.1.4.tar.xz
e6e3a3bc681b7044b5219ed6417f0310  qqc2-breeze-style-6.1.4.tar.xz
d3096345a478a821fa16620dadf95fb4  ksystemstats-6.1.4.tar.xz
03a717ac104f6f44ab9dffafdc37710b  oxygen-sounds-6.1.4.tar.xz
a2f8684825ee231fefad28589f321ce7  kdeplasma-addons-6.1.4.tar.xz
#4691fcec4a83314e82c8d1b64bf23c8e  flatpak-kcm-6.1.4.tar.xz
8175024493047e4e98cd12f4d52bc24b  plasma-welcome-6.1.4.tar.xz
8431d1bf294e2ba3cacd9c455678d118  ocean-sound-theme-6.1.4.tar.xz
ed8102ad60b2c8ae9ce12dcaf1ff3cd5  print-manager-6.1.4.tar.xz
#523c82bcf113168b2113612d7b20e544  wacomtablet-6.1.4.tar.xz
#ebb06249b835ea73743c9cf6e91df4df  kwayland-integration-6.1.4.tar.xz
#87332ae4b1c87a6921651ae9211a7e86  krdp-6.1.4.tar.xz
7ca2419cbdb9e4e9b2822b930ac5ec18  oxygen-6.1.4.tar.xz</literal>
EOF</userinput></screen>

    <note>
      <title>About Commented Out Packages</title>
      <para>
        In the above list, several files are commented out with a hash (#) character.

        <itemizedlist spacing="compact">
          <listitem>
            <para>
              The plasma-sdk package is optional and used for software development.
            </para>
          </listitem>
          <listitem>
            <para>
              The discover package requires <xref linkend="appstream"/> to be built
              with the -D qt=true switch.
            </para>
          </listitem>
          <listitem>
            <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"/>).
            </para>
          </listitem>
          <listitem>
            <para>
              The plasma-browser-integration and krdp-6.1.4.tar.xz packages are
              only used by plasma-meta which is not installed by BLFS.
            </para>
          </listitem>
          <listitem>
            <para>
              The plasma-nano package is used for embedded systems.
            </para>
          </listitem>
          <listitem>
            <para>
              The plasma-mobile package provides phone functionality for Plasma.
            </para>
          </listitem>
          <listitem>
            <para>
              The flatpak-kcm package is for managing support of flatpak applications.
            </para>
          </listitem>
          <listitem>
            <para>
              The wacomtablet and kwayland-integration applications require
              plasma5 support.
            </para>
          </listitem>
        </itemizedlist>
      </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 -D CMAKE_INSTALL_PREFIX=$KF6_PREFIX \
             -D CMAKE_INSTALL_LIBEXECDIR=libexec \
             -D CMAKE_BUILD_TYPE=Release         \
             -D BUILD_QT5=OFF                    \
             -D BUILD_TESTING=OFF                \
             -W no-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 portal
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>