source: kde/core/kdelibs.xml@ 35bf1ea

<?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 kdelibs-download-http "&trinity-repo-http;/kdelibs-&trinity-version;.tar.gz">
  <!ENTITY kdelibs-download-ftp  "&trinity-repo-ftp;/kdelibs-&trinity-version;.tar.gz">
  <!ENTITY kdelibs-md5sum        "f62eefb63b4ba2141b4c576f859806dd">
  <!ENTITY kdelibs-size          "16.6 MB">
  <!ENTITY kdelibs-buildsize     "408 MB">
  <!ENTITY kdelibs-time          "5.5 SBU">
]>

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

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

  <title>Kdelibs-&trinity-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 <application>Trinity/KDE3</application> program,
    as well as internationalization files for these libraries, miscellaneous
    HTML documentation, and theme modules.</para>

    &lfs70_checked;

    <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 role="required"><xref linkend="tqtinterface"/></para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="aspell"/>,
      <xref linkend="cups"/>,
      <xref linkend="libtiff"/>,
      <ulink url="http://www.openexr.com/">OpenEXR</ulink>,
      <ulink url="http://www.ivrix.org.il/projects/spell-checker/">Hspell</ulink>, 
      <xref linkend="sudo"/>, and 
      <ulink url="http://packages.debian.org/sid/libutempter">utempter</ulink>
    </para>

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

  </sect2>

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

    <para>The <application>Trinity/KDE3</application> libraries access other programs at
    run time. One additional package that has not been mentioned already is
    <ulink url="http://packages.debian.org/unstable/source/pmount/">
    pmount</ulink>.  This enables auto-mounting of hotplugged devices at
    /media/[device_name] for any user without any fstab modification. It is
    needed to enable the full integration of <application>KDE</application>
    with <xref linkend="hal"/>.</para>

  </sect2>

  <sect2 role="installation" id="kdelibs-install"
         xreflabel="the installation of kdelibs">
    <title>Installation of Kdelibs</title>

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

<screen><userinput>MAKEDIR=/tmp/buildlibs &amp;&amp;
KDELIBS=`pwd`          &amp;&amp;
rm -rf   $MAKEDIR      &amp;&amp;
mkdir -p $MAKEDIR      &amp;&amp;
cd       $MAKEDIR      &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$TRINITY_PREFIX \
      -DCMAKE_VERBOSE_MAKEFILE=ON            \
      $KDELIBS         &amp;&amp;
unset KDELIBS MAKEDIR</userinput></screen>

    <para>Some of the optional support programs for <application>kdelibs</application>
    must be specified by the user.  The option is in the form "-DWITH_PKG=ON" and
    the following options are recognozed for 'PKG': TIFF, LIBIDN, LIBART,
    OPENEXR, UTEMPTER, ASPELL, HSPELL, and AVAHI. Other optional support 
    programs such as CUPS are automatically recognized if present.</para>

    <para>If your installation of <application>Xorg</application> is
    not in the <filename class='directory'>/usr</filename> hierarchy,
    ensure the linking commands search in the correct place:</para>
   
<screen><userinput>find -name link.txt -exec sed -i -e "s@-lX11@&amp; -L$XORG_PREFIX/lib@" {} \;</userinput></screen>

    <para>Continue with the build:</para>

<screen><userinput>make</userinput></screen>

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

      <para>The <command>make apidox</command> command generates a lot of
      errors and warnings.  In some cases it complains that Helvetica fonts are
      missing and substitutes a font that does not fit boxes properly.  You can
      add the font by downloading the <ulink
      url="ftp://ftp.tug.ctan.org/pub/tex-archive/nonfree/support/ghostscript/AFPL/GhostPCL/">
      URW Fonts </ulink> and
      unpacking them into <filename class='directory'>~/.fonts</filename>.
      <command>fc-cache</command> should also be run to update the font
      properties on your system.</para>

      <para>The documents generated are HTML and are found in <filename
      class='directory'>$TRINITY_PREFIX/share/doc/HTML/en/kdelibs-apidocs</filename>.
      </para>
    </note>

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

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

    <para><command>sed -i ... kio/kio/kdirwatch.cpp</command>: This command is
    necessary to prevent a conflict in linux headers.  The equivalent
    instructions that are deleted are now within glibc.</para>

    <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>- -sysconfdir=/etc/kde</parameter>: This option places
    configuration files in compliance with the <ulink
    url='http://www.pathname.com/fhs/pub/fhs-2.3.html#ETCHOSTSPECIFICSYSTEMCONFIGURATION'
    >Filesystem Hierarchy Standard</ulink>.  If you omit this parameter, the
    configuration files will be placed in <filename
    class='directory'>$KDE_PREFIX/etc</filename> which may be desirable if
    you have multiple versions of <application>KDE</application> installed.</para>

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

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

      <seglistitem>
        <seg>Numerous <application>KDE</application> support programs:
        artsmessage, checkXML, cupsdconf, cupsdoprint, dcop, dcopclient,
        dcopfind, dcopidl, dcopidl2cpp, dcopidlng, dcopobject, dcopquit,
        dcopref, dcopserver, dcopserver_shutdown, dcopstart, filesharelist,
        fileshareset, imagetops, kab2kabc, kaddprinterwizard, kbuildsycoca,
        kcmshell, kconf_update, kconfig_compiler, kcookiejar, kde-config,
        kde-menu, kded, kdeinit, kdeinit_shutdown, kdeinit_wrapper, kdesu_stub,
        kdontchangethehostname, kdostartupconfig, kfile, kfmexec, kgrantpty,
        khotnewstuff, kinstalltheme, kio_http_cache_cleaner, kio_uiserver,
        kioexec, kioslave, klauncher, kmailservice, kpac_dhcp_helper,
        ksendbugmail, kshell, kstartupconfig, ksvgtopng, ktelnetservice,
        ktradertest, kunittestmodrunner, kwrapper, lnusertemp,
        make_driver_db_cups, make_driver_db_lpr, makekdewidgets, meinproc,
        preparetips, and start_kdeinit</seg>
        <seg>Numerous <application>KDE</application> libraries and helper
        modules</seg>
        <seg>/etc/kde and the following subdirectories of &kde-dir;/:
        include/{dnssd, dom, kabc, kate, kdeprint, kdesu, khexedit, kio, kjs,
        kmdi, kmediaplayer, knewstuff, kparts, kresources, ksettings, kspell2,
        ktexteditor, kunittest, libkmid}, lib/kde3, and share/{applications,
        apps, autostart, config, doc, emoticons, icons, mimelnk, services} </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>are essential support programs needed by other
          <application>KDE</application> 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
          <application>KDE</application> 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.</para>

  </sect2>

</sect1>