glfs/kde/plasma5/plasma-all.xml
2024-03-06 10:12:21 -06:00

525 lines
19 KiB
XML

<?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 plasma5-download-http "https://download.kde.org/stable/plasma/&plasma5-version;">
<!ENTITY plasma5-download-ftp " ">
<!ENTITY plasma5-md5sum "See Below">
<!ENTITY plasma5-size "243 MB">
<!ENTITY plasma5-buildsize "1.7 GB (419 MB installed)">
<!ENTITY plasma5-time "7.6 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>
&lfs121_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="gtk2"/>, Does not seem to be needed any more -->
<xref linkend="gtk3"/>,
<xref linkend="kf6-frameworks"/>,
<xref linkend="kuserfeedback"/>,
<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="libdbusmenu-qt"/>,
<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/&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>a1361a811dc93389d0ce771d1ff82c3a kdecoration-5.27.10.tar.xz
1f491e823bc83df650d04d5d9948da45 libkscreen-5.27.10.tar.xz
571aa0c18a14ee74f3081f96f73a7f9d libksysguard-5.27.10.tar.xz
541d1b06db3b707a7a73df1526f37b44 breeze-5.27.10.tar.xz
9acdc232ea675b761e7386837f25f420 breeze-gtk-5.27.10.tar.xz
54562594af547614648cded522c3e747 layer-shell-qt-5.27.10.tar.xz
c44cfe3ba7fb03fc30b2ae305f16ed79 kscreenlocker-5.27.10.tar.xz
171949dd2dfc3b2325c959389694860a oxygen-5.27.10.tar.xz
0ef8d9f18707712fc4bcccf59138f2c7 kinfocenter-5.27.10.tar.xz
e4e4409af71c4f5a67aa35c04f6b2bc7 kwin-5.27.10.tar.xz
5c2ff5158503e983207e700ce513e929 plasma-workspace-5.27.10.tar.xz
46001c7671f7ff2f08ca0dd9c3cdbf3f plasma-disks-5.27.10.tar.xz
820566ae6effedbdd208a78e0031bf67 bluedevil-5.27.10.tar.xz
490bd81c915f332b65631b87b6eaa49d kde-gtk-config-5.27.10.tar.xz
7cade9cfce3ef14f14f55cd7a50fd7cf khotkeys-5.27.10.tar.xz
e98c999e6ee7f9bbe775d4e512368420 kmenuedit-5.27.10.tar.xz
24bc4ed3ad5587bd05591aafd758df2c kscreen-5.27.10.tar.xz
3ab1c88cf91f0fb46ae3395d57709e12 kwallet-pam-5.27.10.tar.xz
53d59d76b3dfac5f755d607798b08f85 kwayland-integration-5.27.10.tar.xz
d7a9f2999352e91d504d52ad65336d9b kwrited-5.27.10.tar.xz
8a51e19d58acebb89a919b7377d8bc83 milou-5.27.10.tar.xz
0e11c62c2a23d161b5b8cbe6e87517bc plasma-nm-5.27.10.tar.xz
02657d8fd46384f75ffe9c504f7c97b4 plasma-pa-5.27.10.tar.xz
5c1cbd459e786deb16d5615748114bfa plasma-workspace-wallpapers-5.27.10.tar.xz
17302ca60f68e13e85bc24a4ec873622 polkit-kde-agent-1-5.27.10.tar.xz
cc39dc5777614bd89ae96d38008dc7c9 powerdevil-5.27.10.tar.xz
2417bb974152d4f2274ebe3b7b524ca8 plasma-desktop-5.27.10.tar.xz
f51521902f0665349c0fa012590a1eec kgamma-5.27.10.tar.xz
e95d6813c180b078be4bf40550791e26 ksshaskpass-5.27.10.tar.xz
#8c52fad441ffe43969458ae71b6a2f26 plasma-sdk-5.27.10.tar.xz
1af573d08dd99879f27c5a2b55b02bc9 sddm-kcm-5.27.10.tar.xz
#560ac5c60112e18bb44c46eec3563d7d discover-5.27.10.tar.xz
#3af40cfe47213087d2a8c89132ff004d discover-5.27.10.1.tar.xz
#2cd0a4e1e3e89197e18f48d893c0f2d6 breeze-grub-5.27.10.tar.xz
#fe7bb4efec17206a9faceb9cfe35fbf5 breeze-plymouth-5.27.10.tar.xz
5bbb5c7a2985f8d7b8816a35d517d333 kactivitymanagerd-5.27.10.tar.xz
c1810c7d54842028fb5968097add5538 plasma-integration-5.27.10.tar.xz
#75bedf5da4b7497a18238011d12bec26 plymouth-kcm-5.27.10.tar.xz
440dd7cb1f43d7d86862a1165b48c4f2 xdg-desktop-portal-kde-5.27.10.tar.xz
657984f8356578253e1911c8d35041f6 drkonqi-5.27.10.tar.xz
912db896afe71a8283e36037b4bba79e plasma-vault-5.27.10.tar.xz
e03d33ca8a9905df3c2901cef5512a14 plasma-browser-integration-5.27.10.tar.xz
30797f3809675e61542518f9b15be2c3 kde-cli-tools-5.27.10.tar.xz
1319f82a4043456a4cb99cfcc2ba90fe systemsettings-5.27.10.tar.xz
2861104cf1e31393d9cd87701042d3aa plasma-thunderbolt-5.27.10.tar.xz
#79ffc86387c7024bd834b349fba9b79f plasma-nano-5.27.10.tar.xz
#802d5a3cd34f5ec3825c21905f0ed9db plasma-mobile-5.27.10.tar.xz
1f4875f2cf9c0d949961aa9ad6635e6f plasma-firewall-5.27.10.tar.xz
b6648b45d9824b565dda1f100e7d83a6 plasma-systemmonitor-5.27.10.tar.xz
8e46e5afde739a6361b1838f71eb182d qqc2-breeze-style-5.27.10.tar.xz
fd93592f9895c5c09f4c0db771c1710a ksystemstats-5.27.10.tar.xz
4f55bb4490751abb23046165d68e8ca7 oxygen-sounds-5.27.10.tar.xz
#6300c88c07debeb60760dede52a791ee aura-browser-5.27.10.tar.xz
00afc45528267a5e2ec11b47b8a7779b kdeplasma-addons-5.27.10.tar.xz
7f432fbb0d205d6e30714e731f91a459 kpipewire-5.27.10.tar.xz
5f37a2e3acf00a0616e13d86ed225d7f plank-player-5.27.10.tar.xz
f3a08cefe61643273a9e06cfd6b2746a plasma-bigscreen-5.27.10.tar.xz
a69142a27ab62c583fa5d4d4577427ff plasma-remotecontrollers-5.27.10.tar.xz
#16e67ca215d44ec59130214ca6e13e80 flatpak-kcm-5.27.10.tar.xz
#4ef3e1d988e5edfa8ee20f9373a82680 plasma-welcome-5.27.10.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 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>, and to allow the XDG Desktop
Portal to be detected:
</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
<!-- work around a bug in xdg-desktop-portal
-->as_root install -dvm 755 /usr/share/xdg-desktop-portal &amp;&amp;
cd /usr/share/xdg-desktop-portal/ &amp;&amp;
[ -e kde-portals.conf ] ||
as_root ln -sfv $KF5_PREFIX/share/xdg-desktop-portal/kde-portals.conf
as_root install -dvm 755 /usr/share/xdg-desktop-portal/portals &amp;&amp;
cd /usr/share/xdg-desktop-portal/portals &amp;&amp;
[ -e kde.portal ] ||
as_root ln -sfv $KF5_PREFIX/share/xdg-desktop-portal/portals/kde.portal
</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 role="nodump"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>dbus-launch --exit-with-x11 $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 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>
<!-- 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>