source: kde/plasma5/plasma-all.xml@ e8af989

<?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          "124 MB">
  <!ENTITY plasma5-buildsize     "958 MB (336 MB installed)">
  <!ENTITY plasma5-time          "15 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>

  &lfs83_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="pulseaudio"/>,
    <xref linkend="python2"/>,
    <xref linkend="qca"/>,
    <xref linkend="taglib"/>, and
    <xref linkend="xcb-util-cursor"/>
  </para>

  <bridgehead renderas="sect4">Recommended</bridgehead>
  <para role="recommended">
    <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://gpsd.berlios.de">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.sourceforge.net">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>014d15755600481d8bd2125d82776510  kdecoration-5.14.4.tar.xz
6cafec0732d42a11618b0f7843b9cdb7  libkscreen-5.14.4.tar.xz
8b43076fe3d8845d7f890721a90b8210  libksysguard-5.14.4.tar.xz
4bea8ee0b3b165235ebfc2c02be6dc1c  breeze-5.14.4.tar.xz
858a3f7cbec03e40fbd3ee6bcf24ea85  breeze-gtk-5.14.4.tar.xz
f46412c02e11d53723c89a1f7505a3dd  kscreenlocker-5.14.4.tar.xz
a194273fcb39e57b694121d258188a7a  oxygen-5.14.4.tar.xz
34c5a84a8d6a135cb947b6ecd17803ee  kinfocenter-5.14.4.tar.xz
abc6602d3f0d986a07d8b00684599ca9  ksysguard-5.14.4.tar.xz
3d9ce77dd5671b514d9943c5119fca61  kwin-5.14.4.tar.xz
eaeaeaf57be7d45752ec92f0b5beda0b  plasma-workspace-5.14.4.tar.xz
fe29af65a55d434bfb5a1806f7ca61b0  bluedevil-5.14.4.tar.xz
f2bf818be2ebeca91985e01278f6d93f  kde-gtk-config-5.14.4.tar.xz
c38e8d0902ba37f5308cb7f05047072b  khotkeys-5.14.4.tar.xz
68bb90533998367a5a207132b91b0ac3  kmenuedit-5.14.4.tar.xz
2fd69bedd600e7bfa8e4cae6e2425fc9  kscreen-5.14.4.tar.xz
d548ae1d4b1850cc65093128a411304a  kwallet-pam-5.14.4.tar.xz
16d278360004a80db9c5a6baa2f7781b  kwayland-integration-5.14.4.tar.xz
9f36e858f57d24098c2ddb5987bf200e  kwrited-5.14.4.tar.xz
ea0c7fe6cf49049b9a68b9d0094634b9  milou-5.14.4.tar.xz
3e1200ad29cae12d7672902164449403  plasma-nm-5.14.4.tar.xz
bf60a089095cfeca423a2e1dfc7fc627  plasma-pa-5.14.4.tar.xz
5896ef78ebf9b4784ed1fb44c4af1d69  plasma-workspace-wallpapers-5.14.4.tar.xz
25e9a3d1745d0c11d8568074229671a3  polkit-kde-agent-1-5.14.4.tar.xz
fdb962c816db14a40c5e455c6f25523a  powerdevil-5.14.4.tar.xz
#2db6c86391fcb083a0ff079a14875821  plasma-desktop-5.14.4.tar.xz
420adc0e141435398e116e60da50d7ff  plasma-desktop-5.14.4.1.tar.xz
16c0b5f4737a9fce99018d49858cb47d  kdeplasma-addons-5.14.4.tar.xz
3c3ba960cca9349126dcafcbf702eab1  kgamma5-5.14.4.tar.xz
878b25b3c87b13030b303c7f667c450a  ksshaskpass-5.14.4.tar.xz
#305356781ac6d6fc4bd1708b4c6f756b  plasma-sdk-5.14.4.tar.xz
1a28a56b8b76b2c84c9d880f546274c4  sddm-kcm-5.14.4.tar.xz
fbd60bfb9e66c72311e233817b94e809  user-manager-5.14.4.tar.xz
e14211fc2b0d995d3cf142168056c144  discover-5.14.4.tar.xz
#86462c52fb106e9ed753822c48456c94  breeze-grub-5.14.4.tar.xz
#9a16fa97036b5de9fa0d68d6c2d6e822  breeze-plymouth-5.14.4.tar.xz
d2ef43f119c8afa91745092f649205ff  kactivitymanagerd-5.14.4.tar.xz
14289404eeff5fd571aefbe2a025dc86  plasma-integration-5.14.4.tar.xz
78aaa3b82fe3010be8ff90a44bdd7e8a  plasma-tests-5.14.4.tar.xz
13dd25e88e6fffbff6dad7ae2e49110d  plymouth-kcm-5.14.4.tar.xz
9df4568014b9f3bc91577db4205d40d4  xdg-desktop-portal-kde-5.14.4.tar.xz
633cc3750606ad94f2c8f49a0fd3a656  drkonqi-5.14.4.tar.xz
cd1c28ad7d047861634fa091cec5cd29  plasma-vault-5.14.4.tar.xz
7a1b10a5dc4b28600a9f3f13de800bd5  plasma-browser-integration-5.14.4.tar.xz
d008931a914d5748da62f6667915c7d6  kde-cli-tools-5.14.4.tar.xz
1c119822295205f625c7fcc6ea7b01bb  systemsettings-5.14.4.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.</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

       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

cd /usr/share/xsessions/
[ -e plasma.desktop ] || as_root ln -sfv $KF5_PREFIX/share/xsessions/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;&gt; /etc/pam.d/kde &lt;&lt; "EOF" 
# 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
EOF

cat &gt; /etc/pam.d/kde-np &lt;&lt; "EOF" 
# 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
EOF

cat &gt; /etc/pam.d/kscreensaver &lt;&lt; "EOF"
# Begin /etc/pam.d/kscreensaver

auth    include system-auth
account include system-account

# End /etc/pam.d/kscreensaver
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 revision="sysv"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>ck-launch-session dbus-launch --exit-with-session $KF5_PREFIX/bin/startkde</literal>
EOF

startx</userinput></screen>

<screen revision="systemd"><userinput>cat &gt; ~/.xinitrc &lt;&lt; "EOF"
<literal>dbus-launch --exit-with-session $KF5_PREFIX/bin/startkde</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>

    <note revision="sysv">
      <para>
        You may wish to drop consolekit and/or dbus-launch, e.g., just using
        startkde in ~/.xinitrc. However some capabilities such as mounting or
        umounting file systems from a file manager will not be possible, or the
        reboot option may be absent or inoperative, among other problems.
      </para>
    </note>
    <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><userinput role="root">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>