source: kde/core/kde-workspace.xml@ 2ddc3485

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

  <!ENTITY kde-workspace-download-http "&kde-download-http;&kde-version;/src/kde-workspace-&kde-version;.tar.xz">
  <!ENTITY kde-workspace-download-ftp  "&kde-download-ftp;&kde-version;/src/kde-workspace-&kde-version;.tar.xz">
  <!ENTITY kde-workspace-md5sum        "9c9efb4efffc389150f52d167746b98a">
  <!ENTITY kde-workspace-size          "13.4 MB">
  <!ENTITY kde-workspace-buildsize     "333 MB">
  <!ENTITY kde-workspace-time          "20 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Kde-workspace-&kde-version;</title>

  <indexterm zone="kde-workspace">
    <primary sortas="a-kde-workspace">kde-workspace</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Kde-workspace</title>

    <para>
      The Kde-workspace package contains components that are central to
      providing the <application>KDE</application> desktop environment. Of
      particular importance are KWin, the <application>KDE</application>
      window manager, and Plasma, which provides the workspace interface.
    </para>

    &lfs72_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/kde-workspace-&kde4-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">Kde-workspace Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kactivities"/>,
      <xref linkend="qimageblitz"/>,
      <xref linkend="xcb-util-image"/>, and
      <xref linkend="xcb-util-renderutil"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="kdepimlibs"/>,
      <xref linkend="nepomuk-core"/>,
      <xref linkend="boost"/>,
      <xref linkend="freetype2"/>,
      <xref linkend="pciutils"/>, and
      <xref linkend="consolekit"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="linux-pam"/>,
      <xref linkend="libusb"/>,
      <xref linkend="NetworkManager"/>,
      <xref linkend="lm_sensors"/>,
      <ulink url="&kde-download-http;&kde-version;/src/">PyKDE4</ulink>,
      <ulink url="http://code.google.com/p/google-gadgets-for-linux/">GoogleGadgets</ulink>,
      <ulink url="ftp://ftp.kde.org/pub/kde/stable/prison/1.0/src/">Prison</ulink>,
      <ulink url="https://ieee1394.wiki.kernel.org/index.html">libraw1394</ulink>,
      <ulink url="http://www.catb.org/gpsd/">gpsd</ulink>,
      <ulink url="http://www.xmms.org/">XMMS</ulink>,
      <ulink url="http://qalculate.sourceforge.net/">libqalculate</ulink>
      (wants <ulink url="http://www.ginac.de/CLN/">CLN</ulink>), and
      <ulink url="http://qjson.sourceforge.net/">QJson</ulink>
    </para>

    <note>
      <para>
        Kde-workspace has a run-time dependency called
        <application>Application menu for Qt</application> that allows the
        application menubar to be inserted as a single button in the titlebar.
        It can be found at 
        <ulink url="https://launchpad.net/appmenu-qt">appmenu-qt</ulink>.
      </para>
    </note>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Kde-workspace</title>

    <para>
      It is recommended to have a dedicated user and group to take
      control of the <command>kdm</command> daemon after it is
      started. Issue the following commands as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>groupadd -g 37 kdm &amp;&amp;
useradd -c "KDM Daemon Owner" -d /var/lib/kdm -g kdm \
        -u 37 -s /bin/false kdm &amp;&amp;
install -o kdm -g kdm -dm755 /var/lib/kdm</userinput></screen>

    <para>
      Install <application>Kde-workspace</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=&kde-dir; \
      -DSYSCONF_INSTALL_DIR=/etc \
      -DCMAKE_BUILD_TYPE=Release \
      -DINSTALL_PYTHON_FILES_IN_PYTHON_PREFIX=TRUE \
      .. &amp;&amp;
make</userinput></screen>

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

<screen role="root"><userinput>make install &amp;&amp;
mkdir -p /usr/share/xsessions &amp;&amp;
ln -sf &kde-dir;/share/apps/kdm/sessions/kde-plasma.desktop \
       /usr/share/xsessions/kde-plasma.desktop</userinput></screen>

  </sect2>

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

    <para>
      <parameter>-DINSTALL_PYTHON_FILES_IN_PYTHON_PREFIX=TRUE</parameter>:
      Installs the <application>KDE</application> <application>Python</application>
      objects in the standard location. This parameter can be removed and
      instead replaced with an update to the <envar>PYTHONPATH</envar>
      environment variable in the system or user's profile.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring KDE Workspace</title>

    <sect3>
      <title>Linux PAM Configuration</title>

      <para>
        If you built <application>KDE Workspace</application> with
        <application>Linux PAM</application> support, create necesary
        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" &amp;&amp;
# 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" &amp;&amp;
# 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="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>genkdmconf, kaccess, kapplymousetheme, kblankscrn.kss,
        kcheckrunning, kcminit, kcminit_startup, kdm, kdmctl,
        kdostartupconfig4, kfontinst, kfontview, kinfocenter, klipper,
        kmenuedit, krandom.kss, krandrstartup, krandrtray, krdb, krunner,
        ksmserver, ksplashqml, ksplashsimple, ksplashx, ksplashx_scale,
        kstartupconfig4, ksysguard, ksysguardd, ksystraycmd, kwin, kwin_gles,
        kwrited, oxygen-demo, oxygen-settings, oxygen-shadow-demo,
        plasma-desktop, plasma-netbook, plasma-overlay, plasma-windowed,
        solid-action-desktop-gen, solid-network, startkde and systemsettings
        </seg>
        <seg>several in &kde-dir;/lib</seg>
        <seg>several in &kde-dir;/include, &kde-dir;/lib and &kde-dir;/share
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>