]> git.saurik.com Git - wxWidgets.git/blob - src/tiff/man/tiffgt.1
No changes, just use wxRecursionGuard instead of manual boolean flag.
[wxWidgets.git] / src / tiff / man / tiffgt.1
1 .\"
2 .\" Copyright (c) 1988-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 TIFFGT 1 "September 20, 2005" "libtiff"
26 .SH NAME
27 tiffgt \- display an image stored in a
28 .SM TIFF
29 file (Silicon Graphics version)
30 .SH SYNOPSIS
31 .B tiffgt
32 [
33 .I options
34 ]
35 .I "input.tif ..."
36 .SH DESCRIPTION
37 .I tiffgt
38 displays one or more images stored using the
39 Tag Image File Format, Revision 6.0.
40 Each image is placed in a fixed size window that the
41 user must position on the display (unless configured
42 otherwise through X defaults).
43 If the display has fewer than 24 bitplanes, or if the
44 image does not warrant full color, then
45 .SM RGB
46 color values are mapped to the closest values that exist in
47 the colormap (this is done using the
48 .I rgbi
49 routine found in the graphics utility library
50 .BR \-lgutil .)
51 .PP
52 .I tiffgt
53 correctly handles files with any of the following characteristics:
54 .sp .5
55 .in +0.5i
56 .ta \w'\fIPhotometricInterpretation\fP 'u
57 .nf
58 \fIBitsPerSample\fP 1, 2, 4, 8, 16
59 \fISamplesPerPixel\fP 1, 3, 4 (the 4th sample is ignored)
60 \fIPhotometricInterpretation\fP 0 (min-is-white), 1 (min-is-black), 2 (RGB), 3 (palette), 6 (YCbCr)
61 \fIPlanarConfiguration\fP 1 (contiguous), 2 (separate)
62 \fIOrientation\fP 1 (top-left), 4 (bottom-left)
63 .fi
64 .in -0.5i
65 .sp .5
66 Data may be organized as strips or tiles and may be
67 compressed with any of the compression algorithms supported
68 by the
69 .IR libtiff (3)
70 library.
71 .PP
72 For palette images (\c
73 .IR PhotometricInterpretation =3),
74 .I tiffgt
75 inspects the colormap values and assumes either 16-bit
76 or 8-bit values according to the maximum value.
77 That is, if no colormap entry greater than 255 is found,
78 .I tiffgt
79 assumes the colormap has only 8-bit values; otherwise
80 it assumes 16-bit values.
81 This inspection is done to handle old images written by
82 previous (incorrect) versions of
83 .IR libtiff .
84 .PP
85 .I tiffgt
86 can be used to display multiple images one-at-a-time.
87 The left mouse button switches the display to the first image in the
88 .I next
89 file in the list of files specified on the command line.
90 The right mouse button switches to the first image in the
91 .I previous
92 file in the list.
93 The middle mouse button causes the first image in the first file
94 specified on the command line to be displayed.
95 In addition the following keyboard commands are recognized:
96 .TP
97 .B b
98 Use a
99 .I PhotometricInterpretation
100 of MinIsBlack in displaying the current image.
101 .TP
102 .B l
103 Use a
104 .I FillOrder
105 of lsb-to-msb in decoding the current image.
106 .TP
107 .B m
108 Use a
109 .I FillOrder
110 of msb-to-lsb in decoding the current image.
111 .TP
112 .B c
113 Use a colormap visual to display the current image.
114 .TP
115 .B r
116 Use a true color (24-bit RGB) visual to display the current image.
117 .TP
118 .B w
119 Use a
120 .I PhotometricInterpretation
121 of MinIsWhite in displaying the current image.
122 .TP
123 .B W
124 Toggle (enable/disable) display of warning messages from the
125 .SM TIFF
126 library when decoding images.
127 .TP
128 .B E
129 Toggle (enable/disable) display of error messages from the
130 .SM TIFF
131 library when decoding images.
132 .TP
133 .B z
134 Reset all parameters to their default settings (\c
135 .IR FillOrder ,
136 .IR PhotometricInterpretation ,
137 handling of warnings and errors).
138 .TP
139 .B PageUp
140 Display the previous image in the current file or the last
141 image in the previous file.
142 .TP
143 .B PageDown
144 Display the next image in the current file or the first image
145 in the next file.
146 .TP
147 .B Home
148 Display the first image in the current file.
149 .TP
150 .B End
151 Display the last image in the current file (unimplemented).
152 .SH OPTIONS
153 .TP
154 .B \-c
155 Force image display in a colormap window.
156 .TP
157 .B \-d
158 Specify an image to display by directory number.
159 By default the first image in the file is displayed.
160 Directories are numbered starting at zero.
161 .TP
162 .B \-e
163 Enable reporting of error messages from the
164 .SM TIFF
165 library.
166 By default
167 .I tiffgt
168 silently ignores images that cannot be read.
169 .TP
170 .B \-f
171 Force
172 .I tiffgt
173 to run as a foreground process.
174 By default
175 .I tiffgt
176 will place itself in the background once it has opened the
177 requested image file.
178 .TP
179 .B \-l
180 Force the presumed bit ordering to be
181 .SM LSB
182 to
183 .SM MSB.
184 .TP
185 .B \-m
186 Force the presumed bit ordering to be
187 .SM MSB
188 to
189 .SM LSB.
190 .TP
191 .B \-o
192 Specify an image to display by directory offset.
193 By default the first image in the file is displayed.
194 Directories offsets may be specified using C-style syntax;
195 i.e. a leading ``0x'' for hexadecimal and a leading ``0'' for octal.
196 .TP
197 .B \-p
198 Override the value of the
199 .I PhotometricInterpretation
200 tag; the parameter may be one of:
201 .BR miniswhite ,
202 .BR minisblack ,
203 .BR rgb ,
204 .BR palette ,
205 .BR mask ,
206 .BR separated ,
207 .BR ycbcr ,
208 and
209 .BR cielab .
210 .TP
211 .B \-r
212 Force image display in a full color window.
213 .TP
214 .B \-s
215 Stop on the first read error.
216 By default all errors in the input data are ignored and
217 .I tiffgt
218 does it's best to display as much of an image as possible.
219 .TP
220 .B \-w
221 Enable reporting of warning messages from the
222 .SM TIFF
223 library.
224 By default
225 .I tiffgt
226 ignores warning messages generated when reading an image.
227 .TP
228 .B \-v
229 Place information in the title bar describing
230 what type of window (full color or colormap) is being
231 used, the name of the input file, and the directory
232 index of the image (if non-zero).
233 By default, the window type is not shown in the title bar.
234 .SH BUGS
235 Images wider and taller than the display are silently truncated to avoid
236 crashing old versions of the window manager.
237 .SH "SEE ALSO"
238 .BR tiffdump (1),
239 .BR tiffinfo (1),
240 .BR tiffcp (1),
241 .BR libtiff (3TIFF)
242 .PP
243 Libtiff library home page:
244 .BR http://www.remotesensing.org/libtiff/