source: kde/plasma5/plasma-all.xml@ 17f2889

<?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 "http://download.kde.org/stable/plasma/&plasma5-version;">
  <!ENTITY plasma5-download-ftp  " ">
  <!ENTITY plasma5-md5sum        "See Below">
  <!ENTITY plasma5-size          "98 MB">
  <!ENTITY plasma5-buildsize     "1.2 GB (294 MB installed)">
  <!ENTITY plasma5-time          "20 SBU (using parallelism=4)">
]>

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

  <sect1info>
     <othername>$LastChangedBy: bdubbs $</othername>
     <date>$Date: 2015-09-24 16:44:04 -0500 (Thu, 24 Sep 2015) $</date>
  </sect1info>

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

  &lfs90_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"/>,-->
    <xref linkend="GConf"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="gtk3"/>,
    <xref linkend="kf5-frameworks"/>,
    <xref linkend="libpwquality"/>,
    <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="linux-pam"/>,
    <xref linkend="lm_sensors"/>,
    <xref linkend="oxygen-icons5"/>, and
    <xref linkend="pciutils"/>
  </para>

  <bridgehead renderas="sect4">Optional</bridgehead>
  <para role="optional">
    <xref linkend="glu"/>,
    <xref linkend='ibus'/>,
    <xref linkend="xorg-synaptics-driver"/>,
    <ulink url="http://distributions.freedesktop.org/wiki/AppStream">appstream-qt</ulink>, 
    <ulink url="https://www.kdevelop.org/">KDevPlatform</ulink>,
    <ulink url="http://www.catb.org/gpsd/libgps.html">libgps</ulink>,
    <ulink url="https://github.com/libhybris/libhybris">libhybris</ulink>,
    <ulink url="http://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="http://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>

  <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=http://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>65ad6be44bae48a8b95282f38a172bd5  kdecoration-5.18.0.tar.xz
352ee02e39de0bb991fde185d910dc2b  libkscreen-5.18.0.tar.xz
6cd8353bb8ee8017eb9cec1d9784354e  libksysguard-5.18.0.tar.xz
4bfa3626154af80e53fa6df31088fa5d  breeze-5.18.0.tar.xz
6f4e972f00edbcc3078646066546fd1d  breeze-gtk-5.18.0.tar.xz
44ced6d2ea583ecdf39eb12121f797ea  kscreenlocker-5.18.0.tar.xz
8ad9334b3b7cdc74a457a43fe8e3d763  oxygen-5.18.0.tar.xz
49a00ae8e8516ee9c63b1361e7e8b35a  kinfocenter-5.18.0.tar.xz
8877136028cbf810156ace05e23a0606  ksysguard-5.18.0.tar.xz
6c9e520619c2dd1cfb58b18c39a35a2a  kwin-5.18.0.tar.xz
37a8c7b47c30a6fbc96812e07e520a17  plasma-workspace-5.18.0.tar.xz
2df5eab9f574037d8ddd44595ae9740b  bluedevil-5.18.0.tar.xz
0bdcc24e5892f1ef18dacec5a7a02335  kde-gtk-config-5.18.0.tar.xz
c9aa2a00ef44caf72fc35bac425bfb11  khotkeys-5.18.0.tar.xz
bf513fd5cb621fe6188ae539af1357a0  kmenuedit-5.18.0.tar.xz
a24eb028b1942bbb6be277830c883ca4  kscreen-5.18.0.tar.xz
ff159637ce8450930120560657dc7aa4  kwallet-pam-5.18.0.tar.xz
76828427796d566b04947c01219fb538  kwayland-integration-5.18.0.tar.xz
26a01a5e99685854aa6cee4c1b5aa3ac  kwrited-5.18.0.tar.xz
75d8aef7a58acabd6cbf8e58622264e2  milou-5.18.0.tar.xz
3702c99b031856ee14facf953ab96a12  plasma-nm-5.18.0.tar.xz
af558e3b675c1dbde752b8f27d107f34  plasma-pa-5.18.0.tar.xz
dbbf224c5f626d6e93aa049f05c79824  plasma-workspace-wallpapers-5.18.0.tar.xz
64d690559f2ae9ad9724709d880e500b  polkit-kde-agent-1-5.18.0.tar.xz
2a295e35d8344c8c486d35ce31daed2e  powerdevil-5.18.0.tar.xz
f7763083a9ae5562a88725ede46019d9  plasma-desktop-5.18.0.tar.xz
fbd61128d753723f94f3e3377f1c6dbf  kdeplasma-addons-5.18.0.tar.xz
04ff88998c5a0732b9a1bb76320155ca  kgamma5-5.18.0.tar.xz
54420fb7d114b527c820018db615db80  ksshaskpass-5.18.0.tar.xz
#246b73de780bf92444ac4d6f69f50d2f  plasma-sdk-5.18.0.tar.xz
3ae3cbec00e5f354e680ae88683e92b4  sddm-kcm-5.18.0.tar.xz
01663f7d1817c976119189ccbd8fc139  user-manager-5.18.0.tar.xz
434034a0af6aa4456adef6002f9964d7  discover-5.18.0.tar.xz
#0a5db8616c37961c34b4107672f8ca1f  breeze-grub-5.18.0.tar.xz
#2483b77974bfcd0b311d10d947486b8d  breeze-plymouth-5.18.0.tar.xz
19eeb2603042ed8f13861728a42240c3  kactivitymanagerd-5.18.0.tar.xz
75ba0f7a3eb652b8aa52cdb2bb6cf449  plasma-integration-5.18.0.tar.xz
71b682f963f4c219a10c92706f7e0de0  plasma-tests-5.18.0.tar.xz
#2d10a553fa7d7ab7df3ad14ce41d4f7e  plymouth-kcm-5.18.0.tar.xz
6801ac281d11cd0b06132b8f0044b913  xdg-desktop-portal-kde-5.18.0.tar.xz
69c20946b2cfaa5d94443bf2daa5cefc  drkonqi-5.18.0.tar.xz
404bb032a9870e2182ed28bac4b62f30  plasma-vault-5.18.0.tar.xz
916bb56baee7ce272dc0076eef96c116  plasma-browser-integration-5.18.0.tar.xz
6d28a752327246b0085192d784a30164  kde-cli-tools-5.18.0.tar.xz
b89a6fcfd152fcff0c737b7994b93503  systemsettings-5.18.0.tar.xz
9a4d8193ff7a01e0fea74de69897f63a  plasma-thunderbolt-5.18.0.tar.xz
#7f67365c7aa0e385abdc3b8e5a4ed290  plasma-nano-5.18.0.tar.xz
#98a08ead926817ef803e0f0037ed7336  plasma-phone-components-5.18.0.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 plasma.desktop ]                                      ||
as_root ln -sfv $KF5_PREFIX/share/wayland-sessions/plasma.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>

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

    <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 (50 in /opt/kf5/bin) to list
           separately here.
        </seg>
        <seg>
           There are too many plasma libraries (39 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>