source: general/genutils/imagemagick.xml@ 4ca94e5c

<?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 imagemagick-patch-version "3">
  <!ENTITY imagemagick-download-http "http://www.imagemagick.org/download/ImageMagick-&imagemagick-version;-&imagemagick-patch-version;.tar.bz2">
  <!ENTITY imagemagick-download-ftp  "ftp://ftp.imagemagick.net/pub/ImageMagick/ImageMagick-&imagemagick-version;-&imagemagick-patch-version;.tar.bz2">
  <!ENTITY imagemagick-md5sum        "39222a764f5649f16ff0c934aef8d85a">
  <!ENTITY imagemagick-size          "4.6 MB">
  <!ENTITY imagemagick-buildsize     "142 MB">
  <!ENTITY imagemagick-time          "2.8 SBU (Additional 1.1 SBU for the test suite)">
]>

<sect1 id="imagemagick"
xreflabel="ImageMagick-&imagemagick-version;-&imagemagick-patch-version;">
  <?dbhtml filename="imagemagick.html"?>

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

  <title>ImageMagick-&imagemagick-version;-&imagemagick-patch-version;</title>

  <indexterm zone="imagemagick">
    <primary sortas="a-ImageMagick">ImageMagick</primary>
  </indexterm>

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

    <para><application>ImageMagick</application> is a collection of tools and
    libraries to read, write, and manipulate an image in various image formats.
    Image processing operations are available from the command line. Bindings
    to various programming languages are also available.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para>X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>)</para>

    <bridgehead renderas="sect4">Optional (Install Based on the Required
    Format Support and Tools)</bridgehead>
    <para><xref linkend="lcms"/>,
    <xref linkend="espgs"/> or <xref linkend="gs"/>,
    <xref linkend="libpng"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="freetype2"/>,
    <xref linkend="libtiff"/>,
    <xref linkend="libxml2"/>,
    <xref linkend="mozilla"/>,
    <xref linkend="tex"/>,
    <xref linkend="gimp"/>,
    <xref linkend="sane"/>,
    <xref linkend="wget"/>,
    <xref linkend="enscript"/>,
    <xref linkend="libexif"/>,
    <ulink url="http://www.graphviz.org/">GraphViz</ulink>,
    <ulink url="http://www.i3a.org/i_flashpix.html">FlashPIX</ulink> (or
    <ulink url="ftp://ftp.imagemagick.org/pub/ImageMagick/delegates/libfpx-1.2.0.9.tar.gz">
    FlashPIX library</ulink>),
    <ulink url="http://www.ece.uvic.ca/~mdadams/jasper/">Jasper</ulink>,
    <ulink url="http://www.cl.cam.ac.uk/~mgk25/jbigkit/">JBIG-KIT</ulink>,
    <ulink url="http://wvware.sourceforge.net/">libwmf</ulink>,
    <ulink url="http://autotrace.sourceforge.net/">AutoTrace</ulink>,
    <ulink url="http://www.agocg.ac.uk/train/cgm/ralcgm.htm">RALCGM</ulink>,
    <ulink url="http://www.cybercom.net/~dcoffin/dcraw/">DCRaw</ulink>,
    <ulink url="http://www.xfig.org/">Transfig</ulink>,
    <ulink url="http://www.gnuplot.info/">Gnuplot</ulink>,
    <ulink url="http://www.gnu.org/software/hp2xx/">hp2xx</ulink>,
    <ulink url="http://user.it.uu.se/~jan/html2ps.html">html2ps</ulink>,
    <ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink>,
    <ulink url="http://www.mpeg.org/MSSG/">MPEG-2 Video Codec</ulink>,
    <ulink url="http://www.povray.org/">POV-Ray</ulink>,
    <ulink url="http://www.cs.utah.edu/gdc/projects/urt/">Utah Raster Toolkit</ulink>
    (or <ulink
    url="http://www.funet.fi/pub/graphics/packages/Utah-Raster-Toolkit/rel3/urt-3.1b.mlg.tar.gz">
    source</ulink>),
    <ulink url="http://txt2html.sourceforge.net/">txt2html</ulink>,
    <ulink url="http://radsite.lbl.gov/radiance/HOME.html">Radiance</ulink>,
    <ulink url="http://corefonts.sourceforge.net/">corefonts</ulink>,
    <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink> and
    <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>

  </sect2>

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

    <para>Install <application>Imagemagick</application> by running the following
    commands:</para>

<screen><userinput>sed -i -e 's/\$(LIBLTDL) \$/\$/' Makefile.in &amp;&amp;
./configure --prefix=/usr --with-modules &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

    <sect3>
      <title>Additional Configure Options</title>

      <para>There are additional switches that can be passed to
      <application>ImageMagick</application> to customize the installation to
      your needs. Check out the <application>ImageMagick</application>
      installation instructions at <ulink
      url="http://www.imagemagick.org/script/advanced-unix-installation.html"/>.</para>

    </sect3>

  </sect2>

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

    <para><command>sed -i -e 's/\$(LIBLTDL) \$/\$/' Makefile.in</command>: The
    package will build and install a different version of the
    <application>Libtool</application> library in
    <filename class='directory'>/usr/lib</filename>. This command forces the
    package to link to the installed version of
    <filename class='libraryfile'>libltdl</filename>, and not replace it.</para>

    <para><parameter>--with-modules</parameter>: Enables support for dynamically
    loadable modules.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>animate, compare, composite, conjure, convert, display,
        identify, import, Magick-config, Magick++-config, mogrify,
        montage, and Wand-config</seg>
        <seg>libMagick.[so,a], libMagick++.[so,a], libWand.[so,a],
        the PerlMagick.so Perl module, and numerous plugin modules</seg>
        <seg>/usr/include/magick, /usr/include/wand,
        /usr/lib/ImageMagick-&imagemagick-version;,
        /usr/lib/perl5/site_perl/5.8.5/i686-linux/auto/Image/Magick, and
        /usr/share/ImageMagick-&imagemagick-version;</seg>
      </seglistitem>
    </segmentedlist>

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

    <varlistentry id="animate">
      <term><command>animate</command></term>
      <listitem>
        <para>animates a sequence of images.</para>
        <indexterm zone="imagemagick animate">
          <primary sortas="b-animate">animate</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="compare">
      <term><command>compare</command></term>
      <listitem>
        <para>compares an image to a reconstructed image.</para>
        <indexterm zone="imagemagick compare">
          <primary sortas="b-compare">compare</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="composite">
      <term><command>composite</command></term>
      <listitem>
        <para>composites various images into the given base image.</para>
        <indexterm zone="imagemagick composite">
          <primary sortas="b-composite">composite</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="conjure">
      <term><command>conjure</command></term>
      <listitem>
        <para>processes a MSL script to create an image.</para>
        <indexterm zone="imagemagick conjure">
          <primary sortas="b-conjure">conjure</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="convert">
      <term><command>convert</command></term>
      <listitem>
        <para>converts image(s) from one format to another.</para>
        <indexterm zone="imagemagick convert">
          <primary sortas="b-convert">convert</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="display">
      <term><command>display</command></term>
      <listitem>
        <para>displays an image.</para>
        <indexterm zone="imagemagick display">
          <primary sortas="b-display">display</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="identify">
      <term><command>identify</command></term>
      <listitem>
        <para>describes the format and characteristics of an image file.</para>
        <indexterm zone="imagemagick identify">
          <primary sortas="b-identify">identify</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="import">
      <term><command>import</command></term>
      <listitem>
        <para>captures an X window.</para>
        <indexterm zone="imagemagick import">
          <primary sortas="b-import">import</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="magick-config">
      <term><command>Magick-config</command> and
      <command>Magick++-config</command></term>
      <listitem>
        <para>show information about the installed versions of
        <application>ImageMagick</application> and Magick++.</para>
        <indexterm zone="imagemagick magick-config">
          <primary sortas="b-Magick-config">Magick-config</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="mogrify">
      <term><command>mogrify</command></term>
      <listitem>
        <para>transforms an image.</para>
        <indexterm zone="imagemagick mogrify">
          <primary sortas="b-mogrify">mogrify</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="montage">
      <term><command>montage</command></term>
      <listitem>
        <para>composites various images into a new image.</para>
        <indexterm zone="imagemagick montage">
          <primary sortas="b-montage">montage</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="wand-config">
      <term><command>Wand-config</command></term>
      <listitem>
        <para>shows the options required to use the Wand library.</para>
        <indexterm zone="imagemagick wand-config">
          <primary sortas="b-Wand-config">Wand-config</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    <varlistentry id="perlmagick">
      <term><filename class='libraryfile'>Image::Magick</filename></term>
      <listitem>
        <para>allows the reading, manipulation and writing of a large number of
        image file formats using the <application>ImageMagick</application>
        library. Run <command>make</command> in the
        <filename class='directory'>PerlMagick/demo</filename> directory of
        the package source tree to see a nice demo of the module's
        capabilities.</para>
        <indexterm zone="imagemagick perlmagick">
          <primary sortas="g-Image-Magick">Image::Magick</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    </variablelist>

  </sect2>

</sect1>