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

.\"
.\" 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 TIFFSV 1 "September 20, 2005" "libtiff"
.SH NAME
tiffsv \- save an image from the framebuffer in a
.SM TIFF
file (Silicon Graphics version)
.SH SYNOPSIS
.B tiffsv
[
.I options
]
.I output.tif
[
.I "x1 x2 y1 y2"
]
.SH DESCRIPTION
.I tiffsv
saves all or part of the framebuffer in a file using the
Tag Image File Format, Revision 6.0.
By default, the image is saved with data samples packed (\c
.IR PlanarConfiguration =1),
compressed with the Lempel-Ziv & Welch algorithm (\c
.IR Compression =5),
and with each strip no more than 8 kilobytes.
These characteristics can be overridden, or explicitly specified
with the options described below.
.SH OPTIONS
.TP
.B \-b
Save the image as a greyscale image
as if it were processed by 
.IR tiff2bw (1).
This option is included for compatibility with the standard
.IR scrsave (6D)
program.
.TP
.B \-c
Specify the compression to use for data written to the output file:
.B none 
for no compression,
.B packbits
for PackBits compression,
.B jpeg
for baseline JPEG compression,
.B zip
for Deflate compression,
and
.B lzw
for Lempel-Ziv & Welch compression (default).
.IP
.SM LZW
compression can be specified together with a 
.I predictor
value.
A predictor value of 2 causes
each scanline of the output image to undergo horizontal
differencing before it is encoded; a value
of 1 forces each scanline to be encoded without differencing.
LZW-specific options are specified by appending a ``:''-separated
list to the ``lzw'' option; e.g.
.B "\-c lzw:2"
for
.SM LZW
compression with horizontal differencing.
.TP
.B \-p
Specify the planar configuration to use in writing image data.
By default,
.I tiffsv
will create a new file with the data samples packed contiguously.
Specifying
.B "\-p contig"
will force data to be written with multi-sample data packed
together, while
.B "\-p separate"
will force samples to be written in separate planes.
.TP
.B \-r
Specify the number of rows (scanlines) in each strip of data
written to the output file.
By default,
.I tiffsv
attempts to set the rows/strip
that no more than 8 kilobytes of data appear in a strip.
.SH NOTE
Except for the use of
.SM TIFF,
this program is equivalent to the standard
.I scrsave
program.
This means, for example, that you can use it in conjunction with
the standard
.IR icut
program simply by creating a link called
.IR scrsave ,
or by creating a shell script called
.I scrsave
that invokes
.I tiffgt
with the appropriate options.
.SH BUGS
If data are saved compressed and in separate planes, then the
rows in each strip is silently set to one to avoid limitations
in the
.BR libtiff (3TIFF)
library.
.SH "SEE ALSO"
.BR scrsave (6D)
.BR pal2rgb (1),
.BR tiffdump (1),
.BR tiffgt (1),
.BR tiffinfo (1),
.BR tiffcp (1),
.BR tiffmedian (1),
.BR libtiff (3TIFF)
.PP
Libtiff library home page:
.BR http://www.remotesensing.org/libtiff/
Commit	Line	Data
8414a40c VZ	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 TIFFSV 1 "September 20, 2005" "libtiff"
	26	.SH NAME
	27	tiffsv \- save an image from the framebuffer in a
	28	.SM TIFF
	29	file (Silicon Graphics version)
	30	.SH SYNOPSIS
	31	.B tiffsv
	32	[
	33	.I options
	34	]
	35	.I output.tif
	36	[
	37	.I "x1 x2 y1 y2"
	38	]
	39	.SH DESCRIPTION
	40	.I tiffsv
	41	saves all or part of the framebuffer in a file using the
	42	Tag Image File Format, Revision 6.0.
	43	By default, the image is saved with data samples packed (\c
	44	.IR PlanarConfiguration =1),
	45	compressed with the Lempel-Ziv & Welch algorithm (\c
	46	.IR Compression =5),
	47	and with each strip no more than 8 kilobytes.
	48	These characteristics can be overridden, or explicitly specified
	49	with the options described below.
	50	.SH OPTIONS
	51	.TP
	52	.B \-b
	53	Save the image as a greyscale image
	54	as if it were processed by
	55	.IR tiff2bw (1).
	56	This option is included for compatibility with the standard
	57	.IR scrsave (6D)
	58	program.
	59	.TP
	60	.B \-c
	61	Specify the compression to use for data written to the output file:
	62	.B none
	63	for no compression,
	64	.B packbits
65	for PackBits compression,
66	.B jpeg
67	for baseline JPEG compression,
68	.B zip
69	for Deflate compression,
70	and
71	.B lzw
72	for Lempel-Ziv & Welch compression (default).
73	.IP
74	.SM LZW
75	compression can be specified together with a
76	.I predictor
77	value.
78	A predictor value of 2 causes
79	each scanline of the output image to undergo horizontal
80	differencing before it is encoded; a value
81	of 1 forces each scanline to be encoded without differencing.
82	LZW-specific options are specified by appending a ``:''-separated
83	list to the ``lzw'' option; e.g.
84	.B "\-c lzw:2"
85	for
86	.SM LZW
87	compression with horizontal differencing.
88	.TP
89	.B \-p
90	Specify the planar configuration to use in writing image data.
91	By default,
92	.I tiffsv
93	will create a new file with the data samples packed contiguously.
94	Specifying
95	.B "\-p contig"
96	will force data to be written with multi-sample data packed
97	together, while
98	.B "\-p separate"
99	will force samples to be written in separate planes.
100	.TP
101	.B \-r
102	Specify the number of rows (scanlines) in each strip of data
103	written to the output file.
104	By default,
105	.I tiffsv
106	attempts to set the rows/strip
107	that no more than 8 kilobytes of data appear in a strip.
108	.SH NOTE
109	Except for the use of
110	.SM TIFF,
111	this program is equivalent to the standard
112	.I scrsave
113	program.
114	This means, for example, that you can use it in conjunction with
115	the standard
116	.IR icut
117	program simply by creating a link called
118	.IR scrsave ,
119	or by creating a shell script called
120	.I scrsave
121	that invokes
122	.I tiffgt
123	with the appropriate options.
124	.SH BUGS
125	If data are saved compressed and in separate planes, then the
126	rows in each strip is silently set to one to avoid limitations
127	in the
128	.BR libtiff (3TIFF)
129	library.
130	.SH "SEE ALSO"
131	.BR scrsave (6D)
132	.BR pal2rgb (1),
133	.BR tiffdump (1),
134	.BR tiffgt (1),
135	.BR tiffinfo (1),
136	.BR tiffcp (1),
137	.BR tiffmedian (1),
138	.BR libtiff (3TIFF)
139	.PP
140	Libtiff library home page:
141	.BR http://www.remotesensing.org/libtiff/