source: kde/core/kdelibs.xml@ 7c27bc8

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY kdelibs-download-http "&kde-download-http;/kdelibs-&kde-version;.tar.bz2">
<!ENTITY kdelibs-download-ftp  "&kde-download-ftp;/kdelibs-&kde-version;.tar.bz2">
<!ENTITY kdelibs-md5sum        "0473fb4c6c2cd2bc0f267cfa201f3fd8">
<!ENTITY kdelibs-size          "15.6 MB">
<!ENTITY kdelibs-buildsize     "280 MB (additional 339 MB for API docs)">
<!ENTITY kdelibs-time          "20.9 SBU (additional 4.97 SBU for API docs)">
]>

<sect1 id="kdelibs" xreflabel="kdelibs-&kde-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="kdelibs.html"?>
<title><application>kdelibs</application>-&kde-version;</title>
<indexterm zone="kdelibs">
  <primary sortas="a-kdelibs">Kdelibs</primary>
</indexterm>

<sect2>
<title>Introduction to <application>kdelibs</application></title>

<para>This package includes programs and libraries that are central to the
development and execution of a <acronym>KDE</acronym> program, as well
as internationalization files for these libraries, misc
<acronym>HTML</acronym> documentation, theme modules and regression
tests.</para>

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

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Required Patch: <ulink 
url="ftp://ftp.kde.org/pub/kde/security_patches/post-3.3.2-kdelibs-htmlframes2.patch"/></para>
</listitem>
<listitem><para>Required Patch: <ulink 
url="ftp://ftp.kde.org/pub/kde/security_patches/post-3.3.2-kdelibs-kio.diff"/></para>
</listitem>
<listitem><para>Required Patch: <ulink 
url="ftp://ftp.kde.org/pub/kde/security_patches/post-3.3.2-kdelibs-kioslave.patch"/></para>
</listitem>
</itemizedlist>
</sect3>

<sect3><title><application>kdelibs</application> dependencies</title>

<sect4><title>Required</title>
<para><xref linkend="aRts"/></para>
</sect4>

<sect4><title>Recommended</title>
<para><xref linkend="libjpeg"/>, 
<xref linkend="libart_lgpl"/>, 
<xref linkend="libxml2"/>, 
<xref linkend="libxslt"/>, 
<xref linkend="pcre"/>, 
<xref linkend="fam"/>, 
<xref linkend="openssl"/> and 
<ulink url="http://www.gnu.org/software/libidn/">Libidn</ulink></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="libtiff"/>, 
<xref linkend="aspell"/>, 
<xref linkend="cups"/>, 
<xref linkend="openldap"/>, 
<xref linkend="alsa"/>, 
<xref linkend="heimdal"/> or <xref linkend="mitkrb"/>, 
<ulink url="http://www.openexr.com/">OpenEXR</ulink>, 
<ulink url="http://www.ece.uvic.ca/~mdadams/jasper/">JasPer</ulink>, 
<ulink url="http://www.graphviz.org/">GraphViz</ulink> 
and <xref linkend="doxygen"/></para>
</sect4>

</sect3>

</sect2>

<sect2>
<title>Installation of <application>kdelibs</application></title>

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

<screen><userinput><command>patch -Np0 -i ../post-3.3.2-kdelibs-htmlframes2.patch &amp;&amp;
patch -Np0 kio/kio/job.cpp ../post-3.3.2-kdelibs-kio.diff &amp;&amp;
patch -Np0 -i ../post-3.3.2-kdelibs-kioslave.patch &amp;&amp;
./configure --prefix=&kde-dir; --disable-debug \
    --disable-dependency-tracking --enable-fast-malloc=full &amp;&amp;
make</command></userinput></screen>

<note><para>If you wish to create the <acronym>API</acronym> documentation and 
you have <application>Doxygen</application> and 
<application>GraphViz</application> installed, <command>make apidox</command> 
must be done before <command>make install</command>. This applies to all 
packages which can utilize <application>Doxygen</application>.</para></note>

<para>Now, as the root user:</para>
 
<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2><title>Command explanations</title>
<para><parameter>--prefix=&kde-dir;</parameter>: This option tells the process 
to install the package in <filename class="directory">&kde-dir;</filename>.
</para>

<para><option>--disable-debug</option>: This option causes the 
package to be compiled without debugging code.</para>

<para><option>--disable-dependency-tracking</option>: This option 
speeds up one time builds.</para>

<para><parameter>--enable-fast-malloc=full</parameter>: This option tells 
<acronym>KDE</acronym> programs to use an internal memory allocation 
scheme optimized for <acronym>KDE</acronym>.</para>

<!-- <para><option>-disable-pcre</option>: Omit this switch if you have 
<application><acronym>PCRE</acronym></application> installed and you want 
improved regular expression support in the <acronym>KDE</acronym> JavaScript 
engine.</para> -->

</sect2>
 
<sect2><title>Contents</title>

<segmentedlist>
  <segtitle>Installed Programs</segtitle>
  <segtitle>Installed Libraries</segtitle>
 
  <seglistitem>
    <seg>kspell</seg>
    <seg>Numerous KDE liraries</seg>
  </seglistitem>
</segmentedlist>

<variablelist>
  <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  <?dbfo list-presentation="list"?>
 
<varlistentry id="kspell">
  <term><command>kspell</command></term>
  <listitem>
    <para>is the spelling checker used by KDE applications such as Kate, KMail, and KWord. 
          It is a GUI frontend to International ISpell and ASpell.</para>
    <indexterm zone="kdelibs kspell">
      <primary sortas="b-kspell">kspell</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="kde-libraries">
  <term><filename class='libraryfile'>KDE Libraries</filename></term>
  <listitem>
    <para>contains essential functions that are needed by KDS applications.</para>
    <indexterm zone="kdelibs kde-libraries">
      <primary sortas="c-kde-libraries">kde-libraries</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
</variablelist>

<para>The number of programs and libraries installed by
<application>kdelibs</application> prohibits an explanation of each one in this
section. Instead, see the <ulink url="http://docs.kde.org/">KDE
Documentation</ulink>.</para>

</sect2>

</sect1>