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

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