source: kde5/plasma/plasma-workspace.xml@ 2c6ea08

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 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;
]>

<sect1 id="plasma-workspace" xreflabel="Plasma-Workspace-&plasma-version;">
  <?dbhtml filename="plasma-workspace.html"?>

  <sect1info>
    <othername>$LastChangedBy: krejzi $</othername>
    <date>$Date: 2014-10-25 19:35:50 +0200 (Sat, 25 Oct 2014) $</date>
  </sect1info>

  <title>Plasma-Workspace-&plasma-version;</title>

  <indexterm zone="plasma-workspace">
    <primary sortas="a-Plasma-Workspace">Plasma-Workspace</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Plasma-Workspace</title>

    <para>
      The <application>Plasma-Workspace</application> package contains the
      KDE Plasma Workspace.
    </para>

    &lfs77_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&plasma-workspace-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&plasma-workspace-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &plasma-workspace-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &plasma-workspace-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &plasma-workspace-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &plasma-workspace-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Plasma-Workspace Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="baloo5"/>,
      <xref linkend="kwayland"/>,
      <xref linkend="kwin5"/>, 
      <xref linkend="libkscreen"/>, and
      <xref linkend="libksysguard"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://gpsd.berlios.de/">libgps</ulink>,
      <ulink url="http://qalculate.sourceforge.net">libqalculate</ulink>,
      <xref linkend="linux-pam"/> and
      <ulink url="http://projects.kde.org/prison/">Prison</ulink>
    </para>

    <bridgehead renderas="sect4">Runtime Dependencies</bridgehead>
    <para role="optional"> <!-- Because of circular deps -->
      <xref linkend="bluedevil5"/> (Bluetooth Applet, optional),
      <xref linkend="breeze"/>,
      <xref linkend="khelpcenter"/> (Help Viewer, required for most apps' "Help" functionality, optional), 
      <xref linkend="kinfocenter"/> (Hardware Information, optional),
      <xref linkend="kio-extras"/>,
      <xref linkend="kmenuedit"/> (Editor for Menu Entries, optional),
      <xref linkend="kmix5"/> (Volume Control Applet, optional),
      <xref linkend="ksysguard"/>,
      <xref linkend="kwrited"/>,
      <xref linkend="milou"/>,
      <xref linkend="oxygen"/>,
      <xref linkend="plasma-desktop"/>,
      <xref linkend="plasma-nm"/> (Network Management Applet, optional),
      <xref linkend="plasma-workspace-wallpapers"/> (Additional Wallpapers, optional),
      <xref linkend="polkit-kde-agent5"/> (Polkit Authentication Agent, recommended),
      <xref linkend="powerdevil"/>,
      <xref linkend="systemd"/> and
      <xref linkend="systemsettings"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/plasma-workspace"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Plasma-Workspace</title>

    <para>
      Install <application>Plasma-Workspace</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DLIB_INSTALL_DIR=lib              \
      -DBUILD_TESTING=OFF                \
      -DQML_INSTALL_DIR=&qt5-qml-dir;           \
      -DQT_PLUGIN_INSTALL_DIR=&qt5-plugins-dir; \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      Make the startup script call <command>qtpaths-qt5</command> instead of
      <command>qtpaths</command> in case <application>qtchooser</application>
      is being used by running the following command as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>sed -i "s:qtpaths:&amp;-qt5:g" $KF5_PREFIX/bin/startkde</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/cmake-release.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/kf5-libdir.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/kf5-tests.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/qt5-qml-dir.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/qt5-plugins-dir.xml"/>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Plasma-Workspace</title>

    <para>
      If <application>Linux PAM</application> was present at build time,
      create the necessary configuration file so that the Screen Locker
      can work properly by running the following command 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     include        system-auth
account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/kde</literal>
EOF</userinput></screen>

    <note>
      <para>
        The rest of this section can be skipped if <application>KDE
        Plasma 5</application> was installed in
        <filename class="directory">/usr</filename>
      </para>
    </note>

    <para>
      Create a wrapper script that will be used to start the
      <application>KDE Plasma 5</application> by running
      the following command as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cat &gt; $KF5_PREFIX/bin/startkde-wrapper &lt;&lt; "EOF"
<literal>#!/bin/sh -e

. /etc/profile.d/kf5.sh

exec $KF5_PREFIX/bin/startkde "$@"</literal>
EOF
chmod -v 755 $KF5_PREFIX/bin/startkde-wrapper</userinput></screen>

    <para>
      If you are using a display manager to log into your desktop
      (such as <xref linkend="sddm"/>), let it know about the
      <application>KDE</application> Plasma Desktop by running
      the following command as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -dm755 /usr/share/xsessions
sed -i "s:startkde:&amp;-wrapper:g" $KF5_PREFIX/share/xsessions/plasma.desktop
ln -sfv $KF5_PREFIX/share/xsessions/plasma.desktop /usr/share/xsessions/kf5-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>
          kcheckrunning, kcminit, kcminit_startup, kdostartupconfig5,
          klipper, krunner, ksmserver, ksplashqml, kstartupconfig5,
          kuiserver5, plasmashell, plasmawindowed, startkde and
          systemmonitor
        </seg>
        <seg>
          libkdeinit5_kcminit.so, libkdeinit5_kcminit_startup.so,
          libkdeinit5_klipper.so, libkdeinit5_ksmserver.so,
          libkdeinit5_kuiserver5.so, libkworkspace5.so,
          libplasma-geolocation-interface.so, libtaskmanager.so and
          libweather_ion.so
        </seg>
        <seg>
          $KF5_PREFIX/include/{KDE,kworkspace5,plasma,taskmanager},
          $KF5_PREFIX/lib/cmake/{KRunnerAppDBusInterface,KSMServerDBusInterface},
          $KF5_PREFIX/lib/cmake/{LibKWorkspace,LibTaskManager,ScreenSaverDBusInterface},
          $KF5_PREFIX/&qt5-plugins-dir;/kpackage/packagestructure,
          $KF5_PREFIX/&qt5-plugins-dir;/phonon_platform,
          $KF5_PREFIX/&qt5-plugins-dir;/plasma/{dataengine,packagestructure},
          $KF5_PREFIX/&qt5-qml-dir;/org/kde/plasma/private/{battery,digitalclock,icon},
          $KF5_PREFIX/&qt5-qml-dir;/org/kde/plasma/private/{notifications,shell},
          $KF5_PREFIX/&qt5-qml-dir;/org/kde/plasma/{wallpapers,workspace},
          $KF5_PREFIX/&qt5-qml-dir;/org/kde/private/systemtray,
          $KF5_PREFIX/share/doc/HTML/*/klipper,
          $KF5_PREFIX/share/{drkonqi,ksmserver,ksplash,kstyle},
          $KF5_PREFIX/share/plasma/kcms/screenlocker_kcm,
          $KF5_PREFIX/share/plasma/{look-and-feel,plasmoids,services},
          $KF5_PREFIX/share/plasma/{shareprovider,wallpapers} and
          $KF5_PREFIX/share/{sddm,solid,xsessions}
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>