source: archive/openjpeg.xml@ acb648f

<?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 openjpeg-download-http "&sourceforge-dl;/openjpeg.mirror/openjpeg-&openjpeg-version;.tar.gz">
  <!ENTITY openjpeg-download-ftp  " ">
  <!ENTITY openjpeg-md5sum        "c41772c30fb1c272358b3707233134a1">
  <!ENTITY openjpeg-size          "1.4 MB">
  <!ENTITY openjpeg-buildsize     "16 MB">
  <!ENTITY openjpeg-time          "0.2 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>OpenJPEG-&openjpeg-version;</title>

  <indexterm zone="openjpeg">
    <primary sortas="a-openjpeg">OpenJPEG</primary>
  </indexterm>

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

    <para><application>OpenJPEG</application> is an open-source implementation
    of the JPEG-2000 standard. OpenJPEG fully respects the JPEG-2000 specifications
    and can compress/decompress lossless 16-bit images.</para>

    &lfs82_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&openjpeg-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&openjpeg-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &openjpeg-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &openjpeg-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &openjpeg-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &openjpeg-time;</para>
      </listitem>
    </itemizedlist>
<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/openjpeg-&openjpeg-version;-security_fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">OpenJPEG Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="lcms2"/>,
    <xref linkend="libpng"/>,
    <xref linkend="libtiff"/> and
    <xref linkend="doxygen"/> (to build the API documentation)
    </para>

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

  </sect2>

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

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

<screen><userinput>autoreconf -f -i &amp;&amp;
./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a testsuite.</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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

  <!--
  <sect2 role="configuration">
    <title>Configuring OpenJPEG</title>

    <sect3>
      <title>Configuration Information</title>

    </sect3>

  </sect2>
  -->

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

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

      <seglistitem>
        <seg>image_to_j2k, j2k_dump and j2k_to_image</seg>
        <seg>libopenjpeg.so</seg>
        <seg>/usr/include/openjpeg-1.5 and /usr/share/doc/openjpeg-1.5</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="image_to_j2k">
        <term><command>image_to_j2k</command></term>
        <listitem>
          <para>converts various image formats to the jpeg2000 format.</para>
          <indexterm zone="openjpeg image_to_j2k">
            <primary sortas="b-image_to_j2k">image_to_j2k</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="j2k_dump">
        <term><command>j2k_dump</command></term>
        <listitem>
          <para>reads in a jpeg2000 image and dumps the contents to stdout.</para>
          <indexterm zone="openjpeg j2k_dump">
            <primary sortas="b-j2k_dump">j2k_dump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="j2k_to_image">
        <term><command>j2k_to_image</command></term>
        <listitem>
          <para>converts jpeg2000 images to other image types.</para>
          <indexterm zone="openjpeg j2k_to_image">
            <primary sortas="b-j2k_to_image">j2k_to_image</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>