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