source: general/graphlib/jasper.xml@ a8d72e7d

<?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 jasper-download-http "https://github.com/jasper-software/jasper/archive/version-&jasper-version;/jasper-&jasper-version;.tar.gz">
  <!ENTITY jasper-download-ftp  " ">
  <!ENTITY jasper-md5sum        "ba2cebfc9c1970168ed8534cfaf9f6d3">
  <!ENTITY jasper-size          "1.9 MB">
  <!ENTITY jasper-buildsize     "9.6 MB (with tests)">
  <!ENTITY jasper-time          "0.3 SBU (with tests)">
]>

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


  <title>JasPer-&jasper-version;</title>

  <indexterm zone="jasper">
    <primary sortas="a-jasper-&jasper-version;">JasPer</primary>
  </indexterm>

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

    <para>
      The <application>JasPer</application> Project is an open-source
      initiative to provide a free software-based reference implementation
      of the JPEG-2000 codec.
    </para>

    &lfs120_checked;

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

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="freeglut"/> (required for <command>jiv</command>),
      <xref linkend="doxygen"/> (needed for generating html documentation), and
      <xref linkend="texlive"/> (needed to regenerate the pdf documentation)
    </para>

  </sect2>

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

    <note>
      <para>
        The tarball <emphasis>jasper-&jasper-version;.tar.gz</emphasis> will
        extract to
        <emphasis>jasper-version-&jasper-version;</emphasis>.
      </para>
    </note>
<!--
    <para>
      First, fix a problem that happens due to cmake-3.22:
    </para>

<screen><userinput remap="pre">sed -i '/GLUT_glut_LIBRARY/s/^/#/' build/cmake/modules/JasOpenGL.cmake</userinput></screen>
-->
    <para>
      Install <application>JasPer</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir BUILD &amp;&amp;
cd    BUILD &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DCMAKE_BUILD_TYPE=Release     \
      -DCMAKE_SKIP_INSTALL_RPATH=YES \
      -DJAS_ENABLE_DOC=NO            \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/jasper-&jasper-version; \
      ..  &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue:  <command>make test</command>.
    </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>
      <parameter>-DCMAKE_SKIP_INSTALL_RPATH=YES</parameter>: This option
      removes embedded library search paths.
    </para>

    <para>
      <parameter>-DJAS_ENABLE_DOC=NO</parameter>: This option disables
      rebuilding the pdf documentation if <xref linkend="texlive"/>
      is installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>imgcmp, imginfo, jasper, and jiv</seg>
        <seg>libjasper.so</seg>
        <seg>/usr/include/jasper and /usr/share/doc/jasper-&jasper-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="imgcmp">
        <term><command>imgcmp</command></term>
        <listitem>
          <para>
            compares two images of the same geometry
          </para>
          <indexterm zone="jasper imgcmp">
            <primary sortas="b-imgcmp">imgcmp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="imginfo">
        <term><command>imginfo</command></term>
        <listitem>
          <para>
            displays information about an image
          </para>
          <indexterm zone="jasper imginfo">
            <primary sortas="b-imginfo">imginfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jasper-command">
        <term><command>jasper</command></term>
        <listitem>
          <para>
            converts images between formats (BMP, JPS, JPC, JPG, PGX, PNM, MIF,
            and RAS)
          </para>
          <indexterm zone="jasper jasper">
            <primary sortas="b-jasper">jasper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jiv">
        <term><command>jiv</command></term>
        <listitem>
          <para>
            displays images
          </para>
          <indexterm zone="jasper jiv">
            <primary sortas="b-jiv">jiv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jasper-lib">
        <term><filename class="libraryfile">libjasper.so</filename></term>
        <listitem>
          <para>
            is a library used by programs for reading and writing
            JPEG2000 format files
          </para>
          <indexterm zone="jasper jasper-lib">
            <primary sortas="c-libjasper">libjasper.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>