src/tiff/man/TIFFPrintDirectory.3tiff

   1 .\"
   2 .\" Copyright (c) 1991-1997 Sam Leffler
   3 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and
   6 .\" its documentation for any purpose is hereby granted without fee, provided
   7 .\" that (i) the above copyright notices and this permission notice appear in
   8 .\" all copies of the software and related documentation, and (ii) the names of
   9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  10 .\" publicity relating to the software without the specific, prior written
  11 .\" permission of Sam Leffler and Silicon Graphics.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  16 .\"
  17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22 .\" OF THIS SOFTWARE.
  23 .\"
  24 .if n .po 0
  25 .TH TIFFPrintDirectory 3TIFF "December 12, 1991" "libtiff"
  26 .SH NAME
  27 TIFFPrintDirectory \- print a description of a
  28 .SM TIFF
  29 directory
  30 .SH SYNOPSIS
  31 .B "#include <tiffio.h>"
  32 .sp
  33 .BI "void TIFFPrintDirectory(TIFF *" tif ", FILE *" fd ", long " flags ")"
  34 .SH DESCRIPTION
  35 .I TIFFPrintDirectory
  36 prints a description of the current directory in the specified
  37 .SM TIFF
  38 file to the standard I/O output stream
  39 .IR fd .
  40 The
  41 .I flags
  42 parameter is used to control the
  43 .I "level of detail"
  44 of the printed information; it is a bit-or of the flags defined in
  45 .BR tiffio.h :
  46 .sp .5
  47 .nf
  48 .ta \w'#define 'u +\w'TIFFPRINT_JPEGDCTABLES  'u +\w'0x200   'u
  49 #define TIFFPRINT_NONE  0x0     /* no extra info */
  50 #define TIFFPRINT_STRIPS        0x1     /* strips/tiles info */
  51 #define TIFFPRINT_CURVES        0x2     /* color/gray response curves */
  52 #define TIFFPRINT_COLORMAP      0x4     /* colormap */
  53 #define TIFFPRINT_JPEGQTABLES   0x100   /* JPEG Q matrices */
  54 #define TIFFPRINT_JPEGACTABLES  0x200   /* JPEG AC tables */
  55 #define TIFFPRINT_JPEGDCTABLES  0x200   /* JPEG DC tables */
  56 .fi
  57 .SH NOTES
  58 In C++ the
  59 .I flags
  60 parameter defaults to 0.
  61 .SH "RETURN VALUES"
  62 None.
  63 .SH DIAGNOSTICS
  64 None.
  65 .SH "SEE ALSO"
  66 .IR libtiff (3TIFF),
  67 .IR TIFFOpen (3TIFF),
  68 .IR TIFFReadDirectory (3TIFF),
  69 .IR TIFFSetDirectory (3TIFF)