source: kde/core/kdelibs.xml@ 1f30212

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/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        "e5961a78b44a3005a7af6ada249e5888">
<!ENTITY kdelibs-size          "16.1 MB">
<!ENTITY kdelibs-buildsize     "239 MB (additional 339 MB for API docs)">
<!ENTITY kdelibs-time          "14.7 SBU (additional 5.0 SBU for API docs)">
]>

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

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

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

<indexterm zone="kdelibs">
  <primary sortas="a-kdelibs">Kdelibs</primary>
</indexterm>

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

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

<bridgehead renderas="sect3">Package Information</bridgehead>
<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>


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

<bridgehead renderas="sect4">Required</bridgehead>
<para><xref linkend="aRts"/></para>

<bridgehead renderas="sect4">Recommended</bridgehead>
<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>

<bridgehead renderas="sect4">Optional</bridgehead>
<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>

</sect2>

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

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

<screen><userinput>./configure --prefix=&kde-dir; --disable-debug \
    --disable-dependency-tracking --enable-fast-malloc=full &amp;&amp;
make</userinput></screen>

<note><para>If you wish to create the API 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 <systemitem class="username">root</systemitem> user:</para>
 
<screen role='root'><userinput>make install</userinput></screen>

</sect2>

<sect2 role="commands">
<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><parameter>--disable-debug</parameter>: This option causes the 
package to be compiled without debugging code.</para>

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

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

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

<segmentedlist>
  <segtitle>Installed Programs</segtitle>
  <segtitle>Installed Libraries</segtitle>
 
  <seglistitem>
    <seg>Numerous KDE support programs</seg>
    <seg>Numerous KDE libraries</seg>
  </seglistitem>
</segmentedlist>

<variablelist>
  <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  <?dbfo list-presentation="list"?>
  <?dbhtml list-presentation="table"?>
 
<varlistentry id="kdelib-programs">
  <term>KDE Support Programs</term>
  <listitem>
    <para>contain essential support programs needed by other KDE applications.</para>
    <indexterm zone="kdelibs kdelib-programs">
      <primary sortas="b-kdelib-programs">KDE Support Programs</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="kde-libraries">
  <term>KDE Libraries</term>
  <listitem>
    <para>contain essential functions that are needed by KDE 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>