summaryrefslogtreecommitdiff
path: root/doc/tools.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tools.rst')
-rw-r--r--doc/tools.rst71
1 files changed, 50 insertions, 21 deletions
diff --git a/doc/tools.rst b/doc/tools.rst
index a2b05010..df102f04 100644
--- a/doc/tools.rst
+++ b/doc/tools.rst
@@ -12,6 +12,35 @@ of these tools are useful in their own right. Many of them however
are more intended to serve as programming examples for using the
TIFF library.
+Manual pages
+------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ tools/fax2ps
+ tools/fax2tiff
+ tools/pal2rgb
+ tools/ppm2tiff
+ tools/raw2tiff
+ tools/rgb2ycbcr
+ tools/thumbnail
+ tools/tiff2bw
+ tools/tiff2pdf
+ tools/tiff2ps
+ tools/tiff2rgba
+ tools/tiffcmp
+ tools/tiffcp
+ tools/tiffcrop
+ tools/tiffdither
+ tools/tiffdump
+ tools/tiffgt
+ tools/tiffinfo
+ tools/tiffmedian
+ tools/tiffset
+ tools/tiffsplit
+
Device-dependent Programs
-------------------------
@@ -25,7 +54,7 @@ examples for writing programs to display and save TIFF images.
* - Tool
- Description
- * - `tiffgt <man/tiffgt.1.html>`_
+ * - :doc:`tools/tiffgt`
- Display the contents of one or more TIFF images using OpenGL.
The software makes extensive use of the ``TIFFRGBAImage``
facilities described elsewhere.
@@ -42,55 +71,55 @@ The remaining programs should be device-independent:
* - Tool
- Description
- * - `fax2ps <man/fax2ps.1.html>`_
+ * - :doc:`tools/fax2ps`
- Convert a Group 3- or Group 4- compressed TIFF to PostScript
that is significantly more compressed than is generated by
:program:`tiff2ps` (unless :program:`tiff2ps` writes PS Level II)
- * - `fax2tiff <man/fax2tiff.1.html>`_
+ * - :doc:`tools/fax2tiff`
- Convert raw Group 3 or Group 4 facsimile data to TIFF
- * - `pal2rgb <man/pal2rgb.1.html>`_
+ * - :doc:`tools/pal2rgb`
- Convert a Palette-style image to a full color RGB image by
applying the colormap
- * - `ppm2tiff <man/ppm2tiff.1.html>`_
+ * - :doc:`tools/ppm2tiff`
- A quick hack that converts 8-bit PPM format images to TIFF
- * - `raw2tiff <man/raw2tiff.1.html>`_
+ * - :doc:`tools/raw2tiff`
- Create a TIFF file from raw data
- * - `rgb2ycbcr <man/rgb2ycbcr.1.html>`_
+ * - :doc:`tools/rgb2ycbcr`
- Convert an RGB, grayscale, or bilevel TIFF image to a YCbCr
TIFF image; it's mainly provided for testing
- * - `thumbnail <man/thumbnail.1.html>`_
+ * - :doc:`tools/thumbnail`
- Copy a bilevel TIFF to one that includes 8-bit greyscale
"thumbnail images" for each page; it is provided as an example of
how one might use the ``SubIFD`` tag (and the library support
for it)
- * - `tiff2bw <man/tiff2bw.1.html>`_
+ * - :doc:`tools/tiff2bw`
- A simple program to convert a color image to grayscale
- * - `tiff2pdf <man/tiff2pdf.1.html>`_
+ * - :doc:`tools/tiff2pdf`
- Convert TIFF images to PDF
- * - `tiff2ps <man/tiff2ps.1.html>`_
+ * - :doc:`tools/tiff2ps`
- Convert TIFF images to PostScript
- * - `tiff2rgba <man/tiff2rgba.1.html>`_
+ * - :doc:`tools/tiff2rgba`
- Convert a TIFF image to RGBA color space
- * - `tiffcmp <man/tiffcmp.1.html>`_
+ * - :doc:`tools/tiffcmp`
- Compare the contents of two TIFF files (it does not check all
the directory information, but does check all the data)
- * - `tiffcp <man/tiffcp.1.html>`_
+ * - :doc:`tools/tiffcp`
- Copy, concatenate, and convert TIFF images (e.g. switching from
``Compression=5`` to ``Compression=1``)
- * - `tiffcrop <man/tiffcrop.1.html>`_
+ * - :doc:`tools/tiffcrop`
- Provides selection of images from within one or more multi-image
TIFF files, with orthogonal rotation, mirroring, cropping, and
extraction of multiple sections and exporting to one or more files.
@@ -100,26 +129,26 @@ The remaining programs should be device-independent:
segments to fit on multiple /pages/ (standard paper sizes), plus other
functions described in the tiffcrop man page
- * - `tiffdither <man/tiffdither.1.html>`_
+ * - :doc:`tools/tiffdither`
- Dither a b&w image into a bilevel image (suitable for use
in creating fax files)
- * - `tiffdump <man/tiffdump.1.html>`_
+ * - :doc:`tools/tiffdump`
- Display the verbatim contents of the TIFF directory in a file
(it's very useful for debugging bogus files that you may get from
someone that claims they support TIFF)
- * - `tiffinfo <man/tiffinfo.1.html>`_
+ * - :doc:`tools/tiffinfo`
- Display information about one or more TIFF files
- * - `tiffmedian <man/tiffmedian.1.html>`_
+ * - :doc:`tools/tiffmedian`
- A version of Paul Heckbert's median cut program that reads an
RGB TIFF image, and creates a TIFF palette file as a result
- * - `tiffset <man/tiffset.1.html>`_
+ * - :doc:`tools/tiffset`
- Set a field in a TIFF header
- * - `tiffsplit <man/tiffsplit.1.html>`_
+ * - :doc:`tools/tiffsplit`
- Create one or more single-image files from a (possibly)
multi-image file