source: kde/add/kdeutils.xml@ ea5027b

<?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 kdeutils-download-http "&kde-download-http;/kdeutils-&kde-version;.tar.bz2">
  <!ENTITY kdeutils-download-ftp  "&kde-download-ftp;/kdeutils-&kde-version;.tar.bz2">
  <!ENTITY kdeutils-md5sum        "038f94275f42df3cae89735506ffbc0b">
  <!ENTITY kdeutils-size          "2.0 MB">
  <!ENTITY kdeutils-buildsize     "63 MB (additional 7.6 MB for API docs)">
  <!ENTITY kdeutils-time          "4.7 SBU (additional 0.1 SBU for API docs)">
]>

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

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

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

  <indexterm zone="kdeutils">
    <primary sortas="a-kdeutils">Kdeutils</primary>
  </indexterm>

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

    <para><application>Kdeutils</application> provides
    <application>KDE</application> programs for miscellaneous tasks.  Programs
    include a calculator, a note taker, a basic editor, a floppy disk manager,
    and a binary editor.</para>

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

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><ulink url="http://www.net-snmp.org/">Net-SNMP</ulink>,
    <ulink url="http://tpctl.sourceforge.net/">tpctl</ulink> (for
    Thinkpad support),
    <xref linkend="python"/>,
    <xref linkend="xmms"/>,
    <xref linkend="graphviz"/>, and
    <xref linkend="doxygen"/></para>

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

  </sect2>

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

    <para>Several programs included in <application>kdeutils</application>
    are frontends for other software, and so require these external programs
    to be present at run time. <command>kgpg</command> requires
    <xref linkend="gnupg"/> or <xref linkend="gnupg2"/>, <command>kdessh</command>
    requires <xref linkend="openssh"/>, while <command>irkick</command> requires
    <ulink url="http://www.lirc.org">LIRC</ulink>. The <command>ark</command>
    program will require appropriate utilities to handle various archives,
    including <xref linkend="zip"/>, <xref linkend="unzip"/>,
    <xref linkend="jdk"/> (for the <command>jar</command> program),
    <xref linkend="unrar"/>, <ulink url="http://www.rarlabs.com">rar</ulink>
    (binary only shareware),
    <ulink url="http://p7zip.sourceforge.net">p7zip</ulink>,
    <ulink url="http://packages.debian.org/source/unstable/zoo">zoo</ulink>, and
    <ulink url="http://packages.debian.org/source/unstable/ncompress">
    ncompress</ulink>.</para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=&kde-dir; --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>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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>ark, irkick, kcalc, kcharselect, kdessh, kdf, kedit, kfloppy,
        kgpg, khexedit, kjots, klaptop_acpi_helper, klaptop_check,
        kregexpeditor, ktimer, kwalletmanager, kwikdisk, and superkaramba</seg>
        <seg>Several kdeutils specific libraries</seg>
        <seg>Several subdirectories in $KDE_PREFIX/share</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ark">
        <term><command>ark</command></term>
        <listitem>
          <para>is an archiving tool.</para>
          <indexterm zone="kdeutils ark">
            <primary sortas="b-ark">ark</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="irkick">
        <term><command>irkick</command></term>
        <listitem>
          <para>is the infrastructure for <application>KDE</application>'s Infrared
          Remote Control functionality; <command>irkick</command> is the server
          component of that infrastructure.</para>
          <indexterm zone="kdeutils irkick">
            <primary sortas="b-irkick">irkick</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kcalc">
        <term><command>kcalc</command></term>
        <listitem>
          <para>is a scientific calculator.</para>
          <indexterm zone="kdeutils kcalc">
            <primary sortas="b-kcalc">kcalc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kcharselect">
        <term><command>kcharselect</command></term>
        <listitem>
          <para>is a character selector applet.</para>
          <indexterm zone="kdeutils kcharselect">
            <primary sortas="b-kcharselect">kcharselect</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdessh">
        <term><command>kdessh</command></term>
        <listitem>
          <para>is a graphical interface to <xref linkend="openssh"/></para>
          <indexterm zone="kdeutils kdessh">
            <primary sortas="b-kdessh">kdessh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdf">
        <term><command>kdf</command></term>
        <listitem>
          <para>is a disk usage viewer.</para>
          <indexterm zone="kdeutils kdf">
            <primary sortas="b-kdf">kdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kedit">
        <term><command>kedit</command></term>
        <listitem>
          <para>is a text editor.</para>
          <indexterm zone="kdeutils kedit">
            <primary sortas="b-kedit">kedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kfloppy">
        <term><command>kfloppy</command></term>
        <listitem>
          <para>is a floppy formatter.</para>
          <indexterm zone="kdeutils kfloppy">
            <primary sortas="b-kfloppy">kfloppy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kgpg">
        <term><command>kgpg</command></term>
        <listitem>
          <para>a simple graphical interface for <xref linkend="gnupg"/>.</para>
          <indexterm zone="kdeutils kgpg">
            <primary sortas="b-kgpg">kgpg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="khexedit">
        <term><command>khexedit</command></term>
        <listitem>
          <para>is a binary editor.</para>
          <indexterm zone="kdeutils khexedit">
            <primary sortas="b-khexedit">khexedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kjots">
        <term><command>kjots</command></term>
        <listitem>
          <para>is a note taker.</para>
          <indexterm zone="kdeutils kjots">
            <primary sortas="b-kjots">kjots</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kregexpeditor">
        <term><command>kregexpeditor</command></term>
        <listitem>
          <para>is an editor for editing regular expressions in a
          graphical style (in contrast to the ASCII syntax).</para>
          <indexterm zone="kdeutils kregexpeditor">
            <primary sortas="b-kregexpeditor">kregexpeditor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ktimer">
        <term><command>ktimer</command></term>
        <listitem>
          <para>is a task scheduler.</para>
          <indexterm zone="kdeutils ktimer">
            <primary sortas="b-ktimer">ktimer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kwalletmanager">
        <term><command>kwalletmanager</command></term>
        <listitem>
          <para>provides a secure way to manage passwords.</para>
          <indexterm zone="kdeutils kwalletmanager">
            <primary sortas="b-kwalletmanager">kwalletmanager</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="superkaramba">
        <term><command>superkaramba</command></term>
        <listitem>
          <para>is a tool to create interactive widgets on a
          <application>KDE</application> desktop.</para>
          <indexterm zone="kdeutils superkaramba">
            <primary sortas="b-superkaramba">superkaramba</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>