[wxWidgets.git] / src / tiff / man / tiffgt.1

.\" $Id: tiffgt.1,v 1.3 2005/11/02 11:07:19 dron Exp $
.\"
.\" Copyright (c) 1988-1997 Sam Leffler
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
.\"
.\" Permission to use, copy, modify, distribute, and sell this software and 
.\" its documentation for any purpose is hereby granted without fee, provided
.\" that (i) the above copyright notices and this permission notice appear in
.\" all copies of the software and related documentation, and (ii) the names of
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
.\" publicity relating to the software without the specific, prior written
.\" permission of Sam Leffler and Silicon Graphics.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
.\" 
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
.\" OF THIS SOFTWARE.
.\"
.if n .po 0
.TH TIFFGT 1 "September 20, 2005" "libtiff"
.SH NAME
tiffgt \- display an image stored in a
.SM TIFF
file (Silicon Graphics version)
.SH SYNOPSIS
.B tiffgt
[
.I options
]
.I "input.tif ..."
.SH DESCRIPTION
.I tiffgt
displays one or more images stored using the
Tag Image File Format, Revision 6.0.
Each image is placed in a fixed size window that the
user must position on the display (unless configured
otherwise through X defaults).
If the display has fewer than 24 bitplanes, or if the
image does not warrant full color, then
.SM RGB
color values are mapped to the closest values that exist in
the colormap (this is done using the
.I rgbi
routine found in the graphics utility library
.BR \-lgutil .)
.PP
.I tiffgt
correctly handles files with any of the following characteristics:
.sp .5
.in +0.5i
.ta \w'\fIPhotometricInterpretation\fP  'u
.nf
BitsPerSample	1, 2, 4, 8, 16
SamplesPerPixel	1, 3, 4 (the 4th sample is ignored)
PhotometricInterpretation	0 (min-is-white), 1 (min-is-black), 2 (RGB), 3 (palette), 6 (YCbCr)
PlanarConfiguration	1 (contiguous), 2 (separate)
Orientation	1 (top-left), 4 (bottom-left)
.fi
.in -0.5i
.sp .5
Data may be organized as strips or tiles and may be
compressed with any of the compression algorithms supported
by the 
.IR libtiff (3)
library.
.PP
For palette images (\c
.IR PhotometricInterpretation =3),
.I tiffgt
inspects the colormap values and assumes either 16-bit
or 8-bit values according to the maximum value.
That is, if no colormap entry greater than 255 is found,
.I tiffgt
assumes the colormap has only 8-bit values; otherwise
it assumes 16-bit values.
This inspection is done to handle old images written by
previous (incorrect) versions of
.IR libtiff .
.PP
.I tiffgt
can be used to display multiple images one-at-a-time.
The left mouse button switches the display to the first image in the
.I next
file in the list of files specified on the command line.
The right mouse button switches to the first image in the
.I previous
file in the list.
The middle mouse button causes the first image in the first file
specified on the command line to be displayed.
In addition the following keyboard commands are recognized:
.TP
.B b
Use a
.I PhotometricInterpretation
of MinIsBlack in displaying the current image.
.TP
.B l
Use a
.I FillOrder
of lsb-to-msb in decoding the current image.
.TP
.B m
Use a
.I FillOrder
of msb-to-lsb in decoding the current image.
.TP
.B c
Use a colormap visual to display the current image.
.TP
.B r
Use a true color (24-bit RGB) visual to display the current image.
.TP
.B w
Use a
.I PhotometricInterpretation
of MinIsWhite in displaying the current image.
.TP
.B W
Toggle (enable/disable) display of warning messages from the
.SM TIFF
library when decoding images.
.TP
.B E
Toggle (enable/disable) display of error messages from the
.SM TIFF
library when decoding images.
.TP
.B z
Reset all parameters to their default settings (\c
.IR FillOrder ,
.IR PhotometricInterpretation ,
handling of warnings and errors).
.TP
.B PageUp
Display the previous image in the current file or the last
image in the previous file.
.TP
.B PageDown
Display the next image in the current file or the first image
in the next file.
.TP
.B Home
Display the first image in the current file.
.TP
.B End
Display the last image in the current file (unimplemented).
.SH OPTIONS
.TP
.B \-c
Force image display in a colormap window.
.TP
.B \-d
Specify an image to display by directory number.
By default the first image in the file is displayed.
Directories are numbered starting at zero.
.TP
.B \-e
Enable reporting of error messages from the 
.SM TIFF
library.
By default
.I tiffgt
silently ignores images that cannot be read.
.TP
.B \-f
Force 
.I tiffgt
to run as a foreground process.
By default
.I tiffgt
will place itself in the background once it has opened the
requested image file.
.TP
.B \-l
Force the presumed bit ordering to be
.SM LSB
to
.SM MSB.
.TP
.B \-m
Force the presumed bit ordering to be
.SM MSB
to
.SM LSB.
.TP
.B \-o
Specify an image to display by directory offset.
By default the first image in the file is displayed.
Directories offsets may be specified using C-style syntax;
i.e. a leading ``0x'' for hexadecimal and a leading ``0'' for octal.
.TP
.B \-p
Override the value of the
.I PhotometricInterpretation
tag; the parameter may be one of:
.IR miniswhite ,
.IR minisblack ,
.IR rgb ,
.IR palette ,
.IR mask ,
.IR separated ,
.IR ycbcr ,
and
.IR cielab .
.TP
.B \-r
Force image display in a full color window.
.TP
.B \-s
Stop on the first read error.
By default all errors in the input data are ignored and 
.I tiffgt
does it's best to display as much of an image as possible.
.TP
.B \-w
Enable reporting of warning messages from the 
.SM TIFF
library.
By default
.I tiffgt
ignores warning messages generated when reading an image.
.TP
.B \-v
Place information in the title bar describing
what type of window (full color or colormap) is being
used, the name of the input file, and the directory
index of the image (if non-zero).
By default, the window type is not shown in the title bar.
.SH BUGS
Images wider and taller than the display are silently truncated to avoid
crashing old versions of the window manager.
.SH "SEE ALSO"
.BR tiffdump (1),
.BR tiffinfo (1),
.BR tiffcp (1),
.BR libtiff (3TIFF)
.PP
Libtiff library home page:
.BR http://www.remotesensing.org/libtiff/
Commit	Line	Data
8414a40c VZ	1	.\" $Id: tiffgt.1,v 1.3 2005/11/02 11:07: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	BitsPerSample 1, 2, 4, 8, 16
	60	SamplesPerPixel 1, 3, 4 (the 4th sample is ignored)
	61	PhotometricInterpretation 0 (min-is-white), 1 (min-is-black), 2 (RGB), 3 (palette), 6 (YCbCr)
	62	PlanarConfiguration 1 (contiguous), 2 (separate)
	63	Orientation 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	.IR miniswhite ,
203	.IR minisblack ,
204	.IR rgb ,
205	.IR palette ,
206	.IR mask ,
207	.IR separated ,
208	.IR ycbcr ,
209	and
210	.IR 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/