source: general/graphlib/libtiff.xml@ 9b37524

<?xml version="1.0" encoding="UTF-8"?>
<!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 libtiff-download-http
           "https://download.osgeo.org/libtiff/tiff-&libtiff-version;.tar.gz">
  <!ENTITY libtiff-download-ftp  " ">
  <!ENTITY libtiff-md5sum        "fc7d49a9348b890b29f91a4ecadd5b49">
  <!ENTITY libtiff-size          "3.4 MB">
  <!ENTITY libtiff-buildsize     "46 MB (with tests)">
  <!ENTITY libtiff-time          "0.2 SBU (with tests)">
]>

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


  <title>libtiff-&libtiff-version;</title>

  <indexterm zone="libtiff">
    <primary sortas="a-libtiff">libtiff</primary>
  </indexterm>

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

    <para>
      The <application>libtiff</application> package contains the TIFF
      libraries and associated utilities. The libraries are used by many
      programs for reading and writing TIFF files and the utilities are
      used for general work with TIFF files.
    </para>

    &lfs120_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/tiff-&libtiff-version;-upstream_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="freeglut"/> (required for <command>tiffgt</command>),
      <xref linkend="libjpeg"/>,
      <xref linkend="sphinx"/>,
      <xref linkend="libwebp"/>,
      <ulink url="https://www.cl.cam.ac.uk/~mgk25/jbigkit/">JBIG-KIT</ulink>, and
      <ulink url="https://www.osgeo.org/projects/lerc-limited-error-raster-compression/">LERC</ulink>
    </para>

  </sect2>

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

<!--
    <para>
      First fix several security issues identified upstream:
    </para>

<screen><userinput>patch -Np1 -i ../tiff-&libtiff-version;-upstream_fixes-1.patch</userinput></screen>
-->

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

<!-- "build" exists in the source tree -->
<screen><userinput>mkdir -p libtiff-build &amp;&amp;
cd       libtiff-build &amp;&amp;

cmake -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/libtiff-&libtiff-version; \
      -DCMAKE_INSTALL_PREFIX=/usr -G Ninja .. &amp;&amp;
ninja</userinput></screen>

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

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

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

  </sect2>

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

<!-- libtiff-4.6.0 removed most of the programs that this package
     previously installed due to lack of maintenance and security concerns. The
     only ones remaining are tiffcp, tiffdump, tiffinfo, tiffset, and tiffsplit.
     See Ticket #18550 for more details. -->

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

      <seglistitem>
        <seg>
          tiffcp,
          tiffdump,
          tiffinfo,
          tiffset, and
          tiffsplit
        </seg>
        <seg>
          libtiff.so and libtiffxx.so
        </seg>
        <seg>
          /usr/share/doc/tiff-&libtiff-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="tiffcp">
        <term><command>tiffcp</command></term>
        <listitem>
          <para>
            copies (and possibly converts) a TIFF file
          </para>
          <indexterm zone="libtiff tiffcp">
            <primary sortas="b-tiffcp">tiffcp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tiffdump">
        <term><command>tiffdump</command></term>
        <listitem>
          <para>
            prints verbatim information about TIFF files
          </para>
          <indexterm zone="libtiff tiffdump">
            <primary sortas="b-tiffdump">tiffdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tiffinfo">
        <term><command>tiffinfo</command></term>
        <listitem>
          <para>
            prints information about TIFF files
          </para>
          <indexterm zone="libtiff tiffinfo">
            <primary sortas="b-tiffinfo">tiffinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tiffset">
        <term><command>tiffset</command></term>
        <listitem>
          <para>
            sets the value of a TIFF header to a specified value
          </para>
          <indexterm zone="libtiff tiffset">
            <primary sortas="b-tiffset">tiffset</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tiffsplit">
        <term><command>tiffsplit</command></term>
        <listitem>
          <para>
            splits a multi-image TIFF into single-image TIFF files
          </para>
          <indexterm zone="libtiff tiffsplit">
            <primary sortas="b-tiffsplit">tiffsplit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtiff-lib">
        <term><filename class="libraryfile">libtiff.so</filename></term>
        <listitem>
          <para>
            contains the API functions used by the
            <application>libtiff</application> programs as well as other
            programs to read and write TIFF files
          </para>
          <indexterm zone="libtiff libtiff-lib">
            <primary sortas="c-libtiff">libtiff.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtiffxx">
        <term><filename class="libraryfile">libtiffxx.so</filename></term>
        <listitem>
          <para>
            contains the C++ API functions used
            by programs to read and write TIFF files
          </para>
          <indexterm zone="libtiff libtiffxx">
            <primary sortas="c-libtiffxx">libtiffxx.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>