source: kde/core/kdebase.xml@ 924561e

<?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 kdebase-download-http "&kde-download-http;/kdebase-&kde-version;.tar.bz2">
  <!ENTITY kdebase-download-ftp  "&kde-download-ftp;/kdebase-&kde-version;.tar.bz2">
  <!ENTITY kdebase-md5sum        "a53f589f58012e655a52220a6a151019">
  <!ENTITY kdebase-size          "23.1 MB">
  <!ENTITY kdebase-buildsize     "265 MB (additional 33 MB for API docs)">
  <!ENTITY kdebase-time          "12.8 SBU (additional 0.4 SBU for API docs)">
]>

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

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

  <title>Kdebase-&kde-version;</title>

  <indexterm zone="kdebase">
    <primary sortas="a-kdebase">Kdebase</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Kdebase</title>

    <para><application>kdebase</application> is the last mandatory package
    required for the <application>K Desktop Environment</application>. It
    provides various applications, infrastructure files and libraries.</para>

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

    <bridgehead renderas="sect3">Kdebase Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="kdelibs"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="libjpeg"/>,
    <xref linkend="libart_lgpl"/>,
    <xref linkend="libxml2"/>,
    <xref linkend="openssl"/>, and
    <xref linkend="jdk"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libusb"/>,
    <xref linkend="linux-pam"/>,
    <xref linkend="openldap"/>,
    <xref linkend="cyrus-sasl"/>,
    <xref linkend="samba3"/>,
    <xref linkend="hal"/> (must also have <xref linkend="dbus-qt3"/>,
    <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
    <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
    <ulink url="http://www.openexr.com/">OpenEXR</ulink>,
    <ulink url="http://www.linux1394.org/">libraw1394</ulink>,
    <ulink url="http://www.lm-sensors.org/">lm_sensors</ulink>
    (requires <ulink url="http://sourceforge.net/projects/linux-diag">Sysfs
    Utilities</ulink>),
    <ulink url="http://www.opensource.apple.com/darwinsource/tarballs/apsl/">mDNSResponder</ulink>,
    <xref linkend="graphviz"/>, and
    <xref linkend="doxygen"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Kdebase</title>

    <note>
      <para>You should ensure a <systemitem
      class="groupname">nogroup</systemitem> group exists on your system before
      performing the <command>configure</command> command, as
      <application>kdebase</application> installs a program
      (<filename>$KDE_PREFIX/bin/kdesud</filename>) with group ownership of
      <systemitem class="groupname">nogroup</systemitem>.</para>
    </note>

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

    <para>Install <application>kdebase</application> with:</para>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/kde-sysconfdir.xml"/>

<screen><userinput>./configure --prefix=&kde-dir; --sysconfdir=/etc/kde \
    --disable-debug --disable-dependency-tracking &amp;&amp;
make</userinput></screen>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/kde-apidocs.xml"/>

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

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

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Kdebase</title>


    <sect3><title>Configuration Information</title>

      <para>There is no real configuration necessary for this package other
      than to ensure you follow the steps outlined in the last section of
      this chapter, <xref linkend="kde-core-config"/>.</para>

    </sect3>

  </sect2>

  <sect2 id="kdebase-runtime-dependencies"
         xreflabel="KDE Base Runtime Dependencies">
    <title>Run-Time Dependencies</title>

    <para>Note that there are two additional packages you can install that
    are used at run-time for <command>konqueror</command> ioslave protocols.
    You can install the <ulink
    url="http://mtools.linux.lu/?power-to-the-parliament">Mtools</ulink>
    package to enable the <quote>floppy</quote> ioslave protocol. This will
    allow easy access to the floppy disk drives on your system. The <ulink
    url="http://packages.debian.org/stable/source/hfsplus">hfsplus</ulink>
    package can be installed to access HFS+ partitions on a Mac OS system
    using the <quote>mac</quote> ioslave.</para>

    <para>One additional package that can be used at run time is <xref
    linkend="pciutils"/>.  This enables the <application>KDE Info
    Center</application> to  use <application>lspci</application> for its "pci"
    info section.</para>

  </sect2>


  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>appletproxy, drkonqi, extensionproxy, genkdmconf, kaccess,
        kappfinder, kapplymousetheme, kasbar, kate, kblankscrn.kss,
        kbookmarkmerger, kcheckpass, kcheckrunning, kcminit, kcontrol,
        kcontroledit, kdcop, kdebugdialog, kdeeject, kdeinstallktheme,
        kdepasswd, kdeprintfax, kdesktop, kdesktop_lock, kdesu, kdesud, kdialog,
        kdm, kdm_config, kdm_greet, kdmctl, keditbookmarks, keditfiletype,
        kfind, kfmclient, kfontinst, kfontview, khc_docbookdig.pl, khc_htdig.pl,
        khc_htsearch.pl, khc_indexbuilder, khc_mansearch.pl, khelpcenter,
        khotkeys, kicker, kinfocenter, kio_media_mounthelper,
        kio_system_documenthelper, kjobviewer, klipper,
        klocaldomainurifilterhelper, kmenuedit, knetattach, kompmgr, konqueror,
        konsole, kpager, kpersonalizer, kpm, kprinter, krandom.kss, krandrtray,
        krdb, kreadconfig, krootimage, ksmserver, ksplash, ksplashsimple, kstart,
        ksysguard, ksysguardd, ksystraycmd, ktip, ktrash, kwebdesktop, kwin,
        kwin_killer_helper, kwin_rules_dialog, kwrite, kwriteconfig, kxkb,
        nspluginscan, nspluginviewer, and startkde</seg>
        <seg>Numerous KDE support libraries, helper modules, and kioslaves</seg>
        <seg>/etc/xdg/menus/applications-merged and the following subdirectories
        of &kde-dir;/: include/{kate, ksgrd, ksplash, kwin},
        lib/kconf_update_bin, share/{applnk, apps/{too many to list},
        config, config.kcfg, desktop-directories, doc/kdm, fonts,
        /mimelnk/{fonts, media, print}, services/{searchproviders,
        useragentstrings}, sounds, templates, wallpapers, and /var/lib/kdm</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="kate">
        <term><command>kate</command></term>
        <listitem>
          <para> is a programmer's text editor for <application>KDE</application>.</para>
          <indexterm zone="kdebase kate">
            <primary sortas="b-kate">kate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kcontrol">
        <term><command>kcontrol</command></term>
        <listitem>
          <para> is the <application>KDE</application> Control Center.</para>
          <indexterm zone="kdebase kcontrol">
            <primary sortas="b-kcontrol">kcontrol</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdebugdialog">
        <term><command>kdebugdialog</command></term>
        <listitem>
          <para>is a dialog box for managing diagnostic messages at runtime.</para>
          <indexterm zone="kdebase kdebugdialog">
            <primary sortas="b-kdebugdialog">kdebugdialog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdesu">
        <term><command>kdesu</command></term>
        <listitem>
          <para>is a graphical front end for the Unix
          <command>su</command> command.</para>
          <indexterm zone="kdebase kdesu">
            <primary sortas="b-kdesu">kdesu</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdm">
        <term><command>kdm</command></term>
        <listitem>
          <para>is the <application>KDE</application> display manager
          (a replacement for <command>xdm</command>).</para>
          <indexterm zone="kdebase kdm">
            <primary sortas="b-kdm">kdm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kfind">
        <term><command>kfind</command></term>
        <listitem>
          <para>is a utility to find files.</para>
          <indexterm zone="kdebase kfind">
            <primary sortas="b-kfind">kfind</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="khelpcenter">
        <term><command>khelpcenter</command></term>
        <listitem>
          <para>is the <application>KDE</application> help tool.</para>
          <indexterm zone="kdebase khelpcenter">
            <primary sortas="b-khelpcenter">khelpcenter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kicker">
        <term><command>kicker</command></term>
        <listitem>
          <para>is the <application>KDE</application> control panel.</para>
          <indexterm zone="kdebase kicker">
            <primary sortas="b-kicker">kicker</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kinfocenter">
        <term><command>kinfocenter</command></term>
        <listitem>
          <para>provides a centralized and convenient overview of your
          <application>KDE</application> and system settings.</para>
          <indexterm zone="kdebase kinfocenter">
            <primary sortas="b-kinfocenter">kinfocenter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kioslaves">
        <term>kioslaves</term>
        <listitem>
          <para>are support modules designed to be intimately familiar with a
          certain protocol, so that a standard interface (most often these are
          used by <command>konqueror</command>) can be used to get at data from
          any number of places. Examples are the http and ftp kioslaves,
          which will retrieve data from an http or ftp server respectively.</para>
          <indexterm zone="kdebase kioslaves">
            <primary sortas="c-kioslaves">kioslaves</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="klipper">
        <term><command>klipper</command></term>
        <listitem>
          <para> is a clipboard utility.</para>
          <indexterm zone="kdebase klipper">
            <primary sortas="b-klipper">klipper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kmenuedit">
        <term><command>kmenuedit</command></term>
        <listitem>
          <para>is a utility to rearrange or add items to the K-menu.</para>
          <indexterm zone="kdebase kmenuedit">
            <primary sortas="b-kmenuedit">kmenuedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="konqueror">
        <term><command>konqueror</command></term>
        <listitem>
          <para>is a filesystem and web browser.</para>
          <indexterm zone="kdebase konqueror">
            <primary sortas="b-konqueror">konqueror</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="konsole">
        <term><command>konsole</command></term>
        <listitem>
          <para>is a highly configurable <application>X</application>
          terminal emulator.</para>
          <indexterm zone="kdebase konsole">
            <primary sortas="b-konsole">konsole</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kpager">
        <term><command>kpager</command></term>
        <listitem>
          <para>provides a thumbnail view of all virtual desktops.</para>
          <indexterm zone="kdebase kpager">
            <primary sortas="b-kpager">kpager</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kprinter">
        <term><command>kprinter</command></term>
        <listitem>
          <para>is the printing module in <application>KDE</application>. It
          manages the actual printing from <application>KDE</application>
          applications. It handles print job administration and handles printer and
          print system management.</para>
          <indexterm zone="kdebase kprinter">
            <primary sortas="b-kprinter">kprinter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ksplash">
        <term><command>ksplash</command></term>
        <listitem>
          <para>is a splash screen that shows the progress of an application
          that is loading.</para>
          <indexterm zone="kdebase ksplash">
            <primary sortas="b-ksplash">ksplash</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ksysguard">
        <term><command>ksysguard</command></term>
        <listitem>
          <para>is a network enabled task manager and system monitor application,
          with the additional functionality of <command>top</command>.</para>
          <indexterm zone="kdebase ksysguard">
            <primary sortas="b-ksysguard">ksysguard</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kwrite">
        <term><command>kwrite</command></term>
        <listitem>
          <para>is a text editor for <application>KDE</application>.</para>
          <indexterm zone="kdebase kwrite">
            <primary sortas="b-kwrite">kwrite</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kxkb">
        <term><command>kxkb</command></term>
        <listitem>
          <para>is a keyboard layout switching utility based on the X11 xkb
          extension.</para>
          <indexterm zone="kdebase kxkb">
            <primary sortas="b-kxkb">kxkb</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>