src/tiff/man/TIFFPrintDirectory.3tiff

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