source: kde/plasma5/plasma-all.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 3 days ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 17.4 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY plasma5-download-http "https://download.kde.org/stable/plasma/&plasma5-version;">
8 <!ENTITY plasma5-download-ftp " ">
9 <!ENTITY plasma5-md5sum "See Below">
10 <!ENTITY plasma5-size "154 MB">
11 <!ENTITY plasma5-buildsize "1.5 GB (370 MB installed)">
12 <!ENTITY plasma5-time "17 SBU (using parallelism=4)">
13]>
14
15<sect1 id="plasma5-build" xreflabel="Plasma-&plasma5-version;">
16 <?dbhtml filename="plasma-all.html"?>
17
18
19 <title>Building Plasma 5</title>
20
21 <indexterm zone="plasma5-build">
22 <primary sortas="a-kde-plasma">KDE Plasma 5</primary>
23 </indexterm>
24
25 <para>
26 KDE Plasma 5 is a collection of packages based on top of KDE Frameworks
27 5 and QML. They implement the KDE Display Environment (Plasma 5).
28 </para>
29
30 &lfs112_checked;
31
32 <para>
33 The instructions below build all of the Plasma 5 packages in one
34 step by using a bash script.
35 </para>
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&plasma5-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&plasma5-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &plasma5-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &plasma5-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &plasma5-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &plasma5-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">Plasma 5 Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required">
75 <!--<xref linkend="fontforge"/>,-->
76 <!-- does not seem to be needed as of 5.22.4 <xref linkend="GConf"/>, -->
77 <xref linkend="gtk2"/>,
78 <xref linkend="gtk3"/>,
79 <xref linkend="kf5-frameworks"/>,
80 <xref linkend="libpwquality"/>,
81 <xref linkend="libqalculate"/>,
82 <xref linkend="libxkbcommon"/>,
83 <xref linkend="mesa"/> built with <xref linkend="wayland"/>,
84 <xref linkend="NetworkManager"/>,
85 <xref linkend="pipewire"/>,
86 <xref linkend="pulseaudio"/>,
87 <xref linkend="qca"/>,
88 <xref linkend="sassc"/>,
89 <xref linkend="taglib"/>, and
90 <xref linkend="xcb-util-cursor"/>
91 </para>
92
93 <bridgehead renderas="sect4">Recommended</bridgehead>
94 <para role="recommended">
95 <xref linkend="fftw"/>,
96 <xref linkend="gsettings-desktop-schemas"/>,
97 <xref linkend="libdbusmenu-qt"/>,
98 <xref linkend="libcanberra"/>,
99 <xref linkend="libinput"/>,
100 <xref linkend="libpcap"/>,
101 <xref linkend="linux-pam"/>,
102 <xref linkend="lm_sensors"/>,
103 <xref linkend="oxygen-icons5"/>, and
104 <xref linkend="pciutils"/>
105 </para>
106
107 <bridgehead renderas="sect4">Recommended (runtime)</bridgehead>
108 <para role="recommended">
109 <xref role="runtime" linkend="accountsservice"/>,
110 <xref role="runtime" linkend="smartmontools"/>, and
111 <xref role="runtime" linkend="xwayland"/>
112 </para>
113
114 <bridgehead renderas="sect4">Optional</bridgehead>
115 <para role="optional">
116 <xref linkend="glu"/>,
117 <xref linkend='ibus'/>,
118 <xref linkend='qtwebengine'/>,
119 <xref linkend="xorg-synaptics-driver"/>,
120 <ulink url="http://distributions.freedesktop.org/wiki/AppStream">appstream-qt</ulink>,
121 <ulink url="https://www.kdevelop.org/">KDevPlatform</ulink>,
122 <ulink url="https://gpsd.gitlab.io/gpsd/">libgps</ulink>,
123 <ulink url="https://github.com/libhybris/libhybris">libhybris</ulink>,
124 <ulink url="https://sourceforge.net/projects/libraw1394/">libraw1394</ulink>,
125 <ulink url="https://bitbucket.org/godsme/mockcpp">mockcpp</ulink>,
126 <ulink url="https://www.freedesktop.org/software/PackageKit/releases/">packagekit-qt</ulink>,
127 <ulink url="http://qalculate.github.io/">Qalculate</ulink>,
128 <ulink url="https://launchpad.net/qapt">Qapt</ulink>,
129 <ulink url="https://github.com/osiam/osiam">SCIM</ulink>, and
130 <ulink url="http://www.dest-unreach.org/socat/">socat</ulink> (for pam_kwallet)
131 </para>
132
133 <note>
134 <para>
135 Only two plasma packages optionally use <xref linkend="qtwebengine"/>:
136 libksysguard and kdeplasma-addons. If QtWebEngine is installed later,
137 only those two packages have to be rebuilt. This allows to provide
138 a more complete display in the system monitor application.
139 </para>
140 </note>
141
142 <para condition="html" role="usernotes">User Notes:
143 <ulink url="&blfs-wiki;/kf5"/></para>
144
145 <sect2>
146 <title>Downloading KDE Plasma5</title>
147
148 <para>
149 The easiest way to get the KDE Plasma5 packages is to use a single
150 <command>wget</command> to fetch them all at once:
151 </para>
152
153<screen><userinput>url=https://download.kde.org/stable/plasma/&plasma5-version;/
154wget -r -nH -nd -A '*.xz' -np $url</userinput>
155<literal>
156The options used here are:
157 -r recurse through child directories
158 -nH disable generation of host-prefixed directories
159 -nd do not create a hierarchy of directories
160 -A '*.xz' just get the *.xz files
161 -np don't get parent directories</literal></screen>
162
163 </sect2>
164
165 <sect2>
166 <title>Setting Package Order</title>
167
168 <para>
169 The order of building files is important due to internal dependencies.
170 Create the list of files in the proper order as follows:
171 </para>
172
173<screen><userinput>cat &gt; plasma-&plasma5-version;.md5 &lt;&lt; "EOF"
174<literal>cc886e068156be2e3a38dd581ef5c7cd kdecoration-5.25.4.tar.xz
175dc335301006b1007714dc2af028856ef libkscreen-5.25.4.tar.xz
17638101d3a8fee3a6eef04370e29da3538 libksysguard-5.25.4.tar.xz
17799b6204e0e782232de0caae00d8b08f9 breeze-5.25.4.tar.xz
1789cff677a443097f0cd6ff997d75cd8d3 breeze-gtk-5.25.4.tar.xz
17963f91c68af6cf236931455e3f2f7db8d layer-shell-qt-5.25.4.tar.xz
180f0390e8aa342f3b6f78383ffbd8e6245 kscreenlocker-5.25.4.tar.xz
181173c0ff83e4677bd3d493882616f4821 oxygen-5.25.4.tar.xz
1820eba490f93429cbae3274f5c80e8e4a4 kinfocenter-5.25.4.tar.xz
1838c07df3083286b7fbf2fee061a9b8556 kwin-5.25.4.tar.xz
1844322408dc35f32cfa25cde675ca4f950 plasma-workspace-5.25.4.tar.xz
185847f15762403af3355dd9f8d313e3160 plasma-disks-5.25.4.tar.xz
186a6c95ad969503a0c4f7fa61b457405c1 bluedevil-5.25.4.tar.xz
1876b6cf6c6faa28d7593e3065befe8cf8d kde-gtk-config-5.25.4.tar.xz
188943b40a2a7e3738618ddb070233fe6f4 khotkeys-5.25.4.tar.xz
18909c80647ed861aa94672fcb5d13fe382 kmenuedit-5.25.4.tar.xz
1908671c090d885302d9553cecee3b87d65 kscreen-5.25.4.tar.xz
191f0df854ad5288a369c3d38a393ad796c kwallet-pam-5.25.4.tar.xz
192b686e387222177d70f14652d03225fd9 kwayland-integration-5.25.4.tar.xz
1937ad4e4512e2c03e351930e83dd2d5c9b kwrited-5.25.4.tar.xz
1947db4206e533f247b878241158f946552 milou-5.25.4.tar.xz
1953e7cab69babe28ccafb1eb0df0c18757 plasma-nm-5.25.4.tar.xz
1969813c33efcc84eb15d792aad2c096127 plasma-pa-5.25.4.tar.xz
19754f0171cb296021b80437d2b5c5821e5 plasma-workspace-wallpapers-5.25.4.tar.xz
198b29230b6615e1d4318e37d92940dd35b polkit-kde-agent-1-5.25.4.tar.xz
199207ef7369a9dbe242bb4be12856c9950 powerdevil-5.25.4.tar.xz
20058f128569154007f74dd74b8fb1ce976 plasma-desktop-5.25.4.tar.xz
2012218d15c9644268c8a001993ac2b75a3 kdeplasma-addons-5.25.4.tar.xz
20278407d2ec45a8efbd94be4be4e458ec6 kgamma5-5.25.4.tar.xz
20312f157a44265e888238e44567c49ffdd ksshaskpass-5.25.4.tar.xz
204#8f34f405bd2e81866f484c8fb2b3e4bf plasma-sdk-5.25.4.tar.xz
2055cf6a96fac52af822c28a5b414dfb05e sddm-kcm-5.25.4.tar.xz
206e5d1e81e741fcb94c6d3b7f0a460f0f2 discover-5.25.4.tar.xz
207#7317d218fb9bcbd3bb52dcc2d0b45497 breeze-grub-5.25.4.tar.xz
208#891882622ea5f8fc9e42aec7c349708a breeze-plymouth-5.25.4.tar.xz
209f8c1e906f17ce513113af47dadbf0222 kactivitymanagerd-5.25.4.tar.xz
2104cbd66be9bfac48ff222c787652a0e1f plasma-integration-5.25.4.tar.xz
211ae0cc94583a0b6bd977a15b0ffba57d2 plasma-tests-5.25.4.tar.xz
212#43096cf164e17176cc381d804823bac2 plymouth-kcm-5.25.4.tar.xz
21353d0980ca27e7233ca24bae9eceb4e57 xdg-desktop-portal-kde-5.25.4.tar.xz
21423b19b8d694ec98bc3e049cd628e8413 drkonqi-5.25.4.tar.xz
2155a466c0da69b52836ddbf5524ddb14b9 plasma-vault-5.25.4.tar.xz
21671c02fb4b8f3953a8548978b6309f7c8 plasma-browser-integration-5.25.4.tar.xz
2175e0063ee3e50a7a336d80d17ed3c6651 kde-cli-tools-5.25.4.tar.xz
218d0dcc4214861fc05328d5df46fe618f5 systemsettings-5.25.4.tar.xz
2193a786aae80fa31643ace5b3c62e70254 plasma-thunderbolt-5.25.4.tar.xz
220#74e38cc52ac71d74f0bce96ac6c2e288 plasma-nano-5.25.4.tar.xz
221#86db281d990e794a0890b9b7933995fa plasma-mobile-5.25.4.tar.xz
222e08c0ad74f68666713c5891f73b6432b plasma-firewall-5.25.4.tar.xz
223030f1d0236b31407745300858f4f6db5 plasma-systemmonitor-5.25.4.tar.xz
224005283e828b3ed1d1a9006dea23fd647 qqc2-breeze-style-5.25.4.tar.xz
2255a8ef1866697cf5a660a59213d2f38e7 ksystemstats-5.25.4.tar.xz
226ab1fd9c2a595b09925fc2f9ddfe18406 oxygen-sounds-5.25.4.tar.xz</literal>
227EOF</userinput></screen>
228
229 <note>
230 <para>
231 The breeze-grub, breeze-plymouth, and plymouth-kcm packages above are
232 all for customized support of <ulink
233 url="https://www.freedesktop.org/wiki/Software/Plymouth/"
234 >Plymouth</ulink>
235 which is designed to be run within an initial ram disk during boot (see
236 <xref linkend="initramfs"/>). The plasma-sdk package is optional and
237 used for software development. The plasma-nano package is used for
238 embedded systems and plasma-phone-components provides phone
239 functionality for Plasma.
240 </para>
241 </note>
242
243 </sect2>
244
245 <sect2 role="installation">
246 <title>Installation of Plasma5</title>
247
248 &as_root;
249
250 <para>
251 First, start a subshell that will exit on error:
252 </para>
253
254<screen><userinput>bash -e</userinput></screen>
255
256 <para>
257 Install all of the packages by running the following
258 commands:
259 </para>
260
261<screen><userinput>while read -r line; do
262
263 # Get the file name, ignoring comments and blank lines
264 if $(echo $line | grep -E -q '^ *$|^#' ); then continue; fi
265 file=$(echo $line | cut -d" " -f2)
266
267 pkg=$(echo $file|sed 's|^.*/||') # Remove directory
268 packagedir=$(echo $pkg|sed 's|\.tar.*||') # Package directory
269
270 tar -xf $file
271 pushd $packagedir
272<!--
273 # Fix some build issues when generating some configuration files
274 case $name in
275 plasma-workspace)
276 sed -i '/set.HAVE_X11/a set(X11_FOUND 1)' CMakeLists.txt
277 ;;
278
279 khotkeys)
280 sed -i '/X11Extras/a set(X11_FOUND 1)' CMakeLists.txt
281 ;;
282
283 plasma-desktop)
284 sed -i '/X11.h)/i set(X11_FOUND 1)' CMakeLists.txt
285 ;;
286 esac
287-->
288 mkdir build
289 cd build
290
291 cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
292 -DCMAKE_BUILD_TYPE=Release \
293 -DBUILD_TESTING=OFF \
294 -Wno-dev .. &amp;&amp;
295
296 make
297 as_root make install
298 popd
299
300<!-- some packages end up with files owned by root in $packagedir,
301 so use as_root for removing -->
302 as_root rm -rf $packagedir
303 as_root /sbin/ldconfig
304
305done &lt; plasma-&plasma5-version;.md5
306
307exit</userinput></screen>
308
309 <para>
310 If you did not set <envar>$KF5_PREFIX</envar> to
311 <filename>/usr</filename>, create symlinks to allow display managers to
312 find <application>Plasma</application>:
313 </para>
314
315<screen><userinput>as_root install -dvm 755 /usr/share/xsessions &amp;&amp;
316cd /usr/share/xsessions/ &amp;&amp;
317[ -e plasma.desktop ] ||
318as_root ln -sfv $KF5_PREFIX/share/xsessions/plasma.desktop &amp;&amp;
319as_root install -dvm 755 /usr/share/wayland-sessions &amp;&amp;
320cd /usr/share/wayland-sessions/ &amp;&amp;
321[ -e plasmawayland.desktop ] ||
322as_root ln -sfv $KF5_PREFIX/share/wayland-sessions/plasmawayland.desktop<!--
323cd $KF5_PREFIX/share/plasma/plasmoids
324
325for j in $(find -name \*.js); do
326 as_root ln -sfv ../code/$(basename $j) $(dirname $j)/../ui/
327done--></userinput></screen>
328
329 <para revision="sysv">
330 Useless systemd units have been installed in
331 <filename class="directory">$KF5_PREFIX/lib</filename>. Remove
332 them now (as <systemitem class="username">root</systemitem>):
333 </para>
334
335<screen role="root"
336 revision="sysv"><userinput>rm -rf $KF5_PREFIX/lib/systemd</userinput></screen>
337
338 </sect2>
339<!--
340 <sect2 role="commands">
341 <title>Command Explanations</title>
342
343 <para>
344 <command>ln -sfv ../code/$(basename $j) $(dirname $j)/../ui/</command>:
345 Create symbolic links so qml files can find needed javascript modules.
346 </para>
347
348 </sect2>
349-->
350 <sect2 role="configuration">
351 <title>Configuring Plasma</title>
352
353 <sect3>
354 <title>Linux PAM Configuration</title>
355
356 <para>
357 If you built Plasma with the recommended <application>Linux
358 PAM</application> support, create necessary configuration files by
359 running the following commands as the <systemitem
360 class="username">root</systemitem> user:
361 </para>
362
363<screen role="root"><userinput>cat &gt; /etc/pam.d/kde &lt;&lt; "EOF"
364<literal># Begin /etc/pam.d/kde
365
366auth requisite pam_nologin.so
367auth required pam_env.so
368
369auth required pam_succeed_if.so uid &gt;= 1000 quiet
370auth include system-auth
371
372account include system-account
373password include system-password
374session include system-session
375
376# End /etc/pam.d/kde</literal>
377EOF
378
379cat &gt; /etc/pam.d/kde-np &lt;&lt; "EOF"
380<literal># Begin /etc/pam.d/kde-np
381
382auth requisite pam_nologin.so
383auth required pam_env.so
384
385auth required pam_succeed_if.so uid &gt;= 1000 quiet
386auth required pam_permit.so
387
388account include system-account
389password include system-password
390session include system-session
391
392# End /etc/pam.d/kde-np</literal>
393EOF
394
395cat &gt; /etc/pam.d/kscreensaver &lt;&lt; "EOF"
396<literal># Begin /etc/pam.d/kscreensaver
397
398auth include system-auth
399account include system-account
400
401# End /etc/pam.d/kscreensaver</literal>
402EOF</userinput></screen>
403 </sect3>
404 </sect2>
405
406 <sect2 role="starting">
407 <title>Starting Plasma5</title>
408
409 <para revision="sysv">
410 You can start <application>Plasma5</application> from runlevel 3, using
411 <xref linkend="xinit"/>, or from runlevel 5, using a Display Manager,
412 such as <xref linkend="lightdm"/>.
413 </para>
414
415 <para revision="systemd">
416 You can start <application>Plasma5</application> from a TTY, using
417 <xref linkend="xinit"/><!--, or from a graphical display manager, such as
418 <xref linkend="sddm"/>-->.
419 </para>
420
421 <para>
422 To start <application>Plasma 5</application> using <xref linkend="xinit"/>,
423 run the following commands:
424 </para>
425
426<screen><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
427<literal>dbus-launch --exit-with-session $KF5_PREFIX/bin/startplasma-x11</literal>
428EOF
429
430startx</userinput></screen>
431
432 <para>
433 The X session starts on the first unused virtual terminal, normally vt7.
434 You can switch to another vt<emphasis>n</emphasis> simultaneously
435 pressing the keys Ctrl-Alt-F<emphasis>n</emphasis>
436 (<emphasis>n</emphasis>=1, 2, ...). To switch back to the X session,
437 normally started at vt7, use Ctrl-Alt-F7. The vt where the command
438 <command>startx</command> was executed will display many messages,
439 including X starting messages, applications automatically started with
440 the session, and eventually, some warning and error messages. You may
441 prefer to redirect those messages to a log file, which not only will keep
442 the initial vt uncluttered, but can also be used for debugging purposes. This
443 can be done starting X with:
444 </para>
445
446 <screen><userinput>startx &amp;&gt; ~/x-session-errors</userinput></screen>
447
448 <para>
449 When shutting down or rebooting, the shutdown messages appear on the vt
450 where X was running. If you wish to see those messages, simultaneously
451 press keys Alt-F7 (assuming that X was running on vt7).
452 </para>
453<!-- Now the entry is "plasma (X11)" for Xorg, so I guess this is
454 not needed anymore:
455 <para>
456 If you intend to start <application>Plasma</application> using a
457 display manager such as <xref linkend="lightdm"/>, there will be two entries
458 for <application>Plasma</application>, one for use with
459 <application>Xorg</application>, and another for
460 <application>Wayland</application>. Modify the
461 <application>Xorg</application> entry with the following command, as the
462 <systemitem class="username">root</systemitem> user, so that you can
463 differentiate between the two:</para>
464
465<screen role="root"><userinput>sed '/^Name=/s/Plasma/Plasma on Xorg/' -i /usr/share/xsessions/plasma.desktop</userinput></screen>
466-->
467
468 </sect2>
469
470 <sect2 role="content">
471 <title>Contents</title>
472
473 <segmentedlist>
474 <segtitle>Installed Programs</segtitle>
475 <segtitle>Installed Libraries</segtitle>
476 <segtitle>Installed Directories</segtitle>
477
478 <seglistitem>
479 <seg>
480 There are too many plasma programs (63 in /opt/kf5/bin) to list
481 separately here.
482 </seg>
483 <seg>
484 There are too many plasma libraries (40 in /opt/kf5/lib) to list
485 separately here.
486 </seg>
487 <seg>
488 There are too many plasma directories (over 1000 in /opt/kf5) to
489 list separately here.
490 </seg>
491 </seglistitem>
492 </segmentedlist>
493
494 </sect2>
495
496</sect1>
Note: See TracBrowser for help on using the repository browser.