source: kde/add/kdegraphics.xml@ 41eec069

<?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 kdegraphics-download-http "&kde-download-http;/kdegraphics-&kde-version;.tar.bz2">
  <!ENTITY kdegraphics-download-ftp  "&kde-download-ftp;/kdegraphics-&kde-version;.tar.bz2">
  <!ENTITY kdegraphics-md5sum        "09094b5357d8cd5c49d45b5d291dcfe">
  <!ENTITY kdegraphics-size          "7.1 MB">
  <!ENTITY kdegraphics-buildsize     "115 MB (additional 37 MB for API docs)">
  <!ENTITY kdegraphics-time          "7.0 SBU (additional 0.1 SBU for API docs)">
]>

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

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

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

  <indexterm zone="kdegraphics">
    <primary sortas="a-kdegraphics">Kdegraphics</primary>
  </indexterm>

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

    <para><application>Kdegraphics</application> provides
    <application>KDE</application> programs to manage the video display and
    graphical output.  Applications include PDF, DVI, and Postscript viewers,
    an application to adjust monitor gamma correction, a 3D modeling
    application to generate POV-Ray scenes, and a scanner application.</para>

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required Patch: <ulink
        url="ftp://ftp.kde.org/pub/kde/security_patches/post-&kde-version;-kdegraphics-CAN-2005-3193.diff"/></para>
      </listitem>
    </itemizedlist>
-->

    <bridgehead renderas="sect3">Kdegraphics 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"/>,
    <xref linkend="libxml2"/>, and
    <xref linkend="libart_lgpl"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libtiff"/>,
    <ulink url="http://ftp.gnome.org/pub/gnome/sources/imlib/1.9/">Imlib</ulink>
    (not recommended: obsolete, abandoned upstream,
    <ulink url="http://bugs.debian.org/448360">buggy</ulink>,
    needed only for the
    <command>kuickshow</command> image viewer, to which
    <command>kview</command> is a better alternative),
    <xref linkend="lcms"/>,
    <xref linkend="poppler"/>
    (<filename class='libraryfile'>libpoppler-qt.so</filename> must have
    been built),
    <xref linkend="sane"/>,
    <!-- There is an internal copy of Xpdf and there are *no* hooks to any
         outside version. Commenting this out for now
    <xref linkend="xpdf"/>, -->
    <xref linkend="tetex"/>,
    <xref linkend="fribidi"/>,
    <ulink url="http://www.gphoto.org/">libgphoto2</ulink>,
    <ulink url="http://www.sfr-fresh.com/linux/misc/t1lib">t1lib</ulink>,
    <ulink url="http://www.openexr.com/">OpenEXR</ulink>,
    <ulink url="http://packages.debian.org/unstable/source/libpaper">libpaper</ulink>,
    <ulink url="http://www.rerecognition.com/">KADMOS</ulink> (a commercial
    OCR engine),
    <xref linkend="graphviz"/>, and
    <xref linkend="doxygen"/></para>

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

  </sect2>

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

    <para>The <command>kooka</command> utility is a scanning and OCR program.
    In order for <command>kooka</command> to utilize the OCR capabilities, you
    must install an OCR engine. <command>kooka</command> provides full OCR
    support using the <ulink url="http://www.rerecognition.com/">KADMOS</ulink>
    and <ulink url="http://sourceforge.net/projects/jocr">GOCR</ulink> engines
    and partial support using the <ulink
    url="https://savannah.gnu.org/projects/ocrad/">Ocrad</ulink> engine.</para>

    <para>The <command>kghostview</command> program requires a ghostscript
    interpreter from <xref linkend="gs"/><!-- or <xref linkend="espgs"/> --> to
    process PS or PDF files.</para>

    <para>The <command>kpovmodeler</command> program requires
    <ulink url="http://www.povray.org/">POV-Ray</ulink> to render 3D scenes.</para>

  </sect2>

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

    <para>Install <application>kdegraphics</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>kcolorchooser, kcoloredit, kdvi, kfax, kfaxview, kghostview,
        kiconedit, kolourpaint, kooka, kpdf, kpovmodeler, kruler, ksnapshot,
        kuickshow, kview, kviewshell, mrmlsearch, printnodetest, svgdisplay,
        and xf86gammacfg</seg>
        <seg>kio_kamera and several other kdegraphics specific libraries and
        support modules</seg>
        <seg>The following subdirectories in &kde-dir;: include/{svg,
        kviewshell, libtext2path-0.1}, share/applnk/Graphics, share/apps/{too
        many to list}, and share/config/magic</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="kcolorchooser">
        <term><command>kcolorchooser</command></term>
        <listitem>
          <para>is a color chooser for a given pallette.</para>
          <indexterm zone="kdegraphics kcolorchooser">
            <primary sortas="b-kcolorchooser">kcolorchooser</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kcoloredit">
        <term><command>kcoloredit</command></term>
        <listitem>
          <para>is a color pallette editor.</para>
          <indexterm zone="kdegraphics kcoloredit">
            <primary sortas="b-kcoloredit">kcoloredit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kdvi">
        <term><command>kdvi</command></term>
        <listitem>
          <para>is a DVI viewer.</para>
          <indexterm zone="kdegraphics kdvi">
            <primary sortas="b-kdvi">kdvi</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kfax">
        <term><command>kfax</command></term>
        <listitem>
          <para>is a FAX viewer.</para>
          <indexterm zone="kdegraphics kfax">
            <primary sortas="b-kfax">kfax</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kfaxview">
        <term><command>kfaxview</command></term>
        <listitem>
          <para>is a FAX previewer used with
          <command>kviewshell</command>.</para>
          <indexterm zone="kdegraphics kfaxview">
            <primary sortas="b-kfaxview">kfaxview</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kghostview">
        <term><command>kghostview</command></term>
        <listitem>
          <para>is a PS/PDF viewer.</para>
          <indexterm zone="kdegraphics kghostview">
            <primary sortas="b-kghostview">kghostview</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kiconedit">
        <term><command>kiconedit</command></term>
        <listitem>
          <para>is an icon editor.</para>
          <indexterm zone="kdegraphics kiconedit">
            <primary sortas="b-kiconedit">kiconedit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kolourpaint">
        <term><command>kolourpaint</command></term>
        <listitem>
          <para>is a paint program.</para>
          <indexterm zone="kdegraphics kolourpaint">
            <primary sortas="b-kolourpaint">kolourpaint</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kooka">
        <term><command>kooka</command></term>
        <listitem>
          <para>is a raster image scan program.</para>
          <indexterm zone="kdegraphics kooka">
            <primary sortas="b-kooka">kooka</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kpdf">
        <term><command>kpdf</command></term>
        <listitem>
          <para>is a PDF viewer.</para>
          <indexterm zone="kdegraphics kpdf">
            <primary sortas="b-kpdf">kpdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kpovmodeler">
        <term><command>kpovmodeler</command></term>
        <listitem>
          <para>is a graphical 3D modeler, which can generate scenes for
          <ulink url="http://www.povray.org/">POV-Ray</ulink>.</para>
          <indexterm zone="kdegraphics kpovmodeler">
            <primary sortas="b-kpovmodeler">kpovmodeler</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kruler">
        <term><command>kruler</command></term>
        <listitem>
          <para>is a screen ruler.</para>
          <indexterm zone="kdegraphics kruler">
            <primary sortas="b-kruler">kruler</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ksnapshot">
        <term><command>ksnapshot</command></term>
        <listitem>
          <para> is a screen capture program.</para>
          <indexterm zone="kdegraphics ksnapshot">
            <primary sortas="b-ksnapshot">ksnapshot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kuickshow">
        <term><command>kuickshow</command></term>
        <listitem>
          <para>is an image viewer.</para>
          <indexterm zone="kdegraphics kuickshow">
            <primary sortas="b-kuickshow">kuickshow</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kview">
        <term><command>kview</command></term>
        <listitem>
          <para>is another image viewer.</para>
          <indexterm zone="kdegraphics kview">
            <primary sortas="b-kview">kview</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kviewshell">
        <term><command>kviewshell</command></term>
        <listitem>
          <para>is a generic framework for the KDE viewer
          applications.</para>
          <indexterm zone="kdegraphics kviewshell">
            <primary sortas="b-kviewshell">kviewshell</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xf86gammacfg">
        <term><command>xf86gammacfg</command></term>
        <listitem>
          <para>is a simple tool for monitor gamma correction.</para>
          <indexterm zone="kdegraphics xf86gammacfg">
            <primary sortas="b-xf86gammacfg">xf86gammacfg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kio_kamera">
        <term><command>kio_kamera</command></term>
        <listitem>
          <para>is an ioslave that allows you to view and download images from a
          digital camera using the <userinput>kamera:/</userinput> URL in
          <command>konqueror</command>.</para>
          <indexterm zone="kdegraphics kio_kamera">
            <primary sortas="c-kio_kamera">kio_kamera</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>