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

.\" $Id: tiff2pdf.1,v 1.4 2005/11/02 11:07:19 dron Exp $
.\" 
.\"  Copyright (c) 2003 Ross Finlayson
.\" 
.\"  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 name of
.\"  Ross Finlayson may not be used in any advertising or
.\"  publicity relating to the software without the specific, prior written
.\"  permission of Ross Finlayson.
.\"  
.\"  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 ROSS FINLAYSON 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.
.\" 
.\" Process this file with
.\" groff -man -Tascii tiff2pdf.1
.\"
.TH TIFF2PDF 1 "November 2, 2005" "libtiff"
.SH NAME
tiff2pdf - convert a TIFF image to a PDF document
.SH SYNOPSIS
.B tiff2pdf [
.I options 
.B ] 
.I input.tiff
.SH DESCRIPTION
.B tiff2pdf
opens a TIFF image and writes a PDF document to standard output.
.PP
The program converts one TIFF file to one PDF file, including multiple page 
TIFF files, tiled TIFF files, black and white. grayscale, and color TIFF 
files that contain data of TIFF photometric interpretations of bilevel, 
grayscale, RGB, YCbCr, CMYK separation, and ICC L*a*b* as supported by 
.I libtiff 
and PDF.
.PP
If you have multiple TIFF files to convert into one PDF file then use 
.I tiffcp 
or other program to concatenate the files into a multiple page TIFF file.  
If the input TIFF file is of huge dimensions (greater than 10000 pixels height
or width) convert the input image to a tiled TIFF if it is not already.
.PP
The standard output is standard output.  Set the output file name with the 
.BI -o output.pdf
option.
.PP
All black and white files are compressed into a single strip CCITT G4 Fax
compressed PDF, unless tiled, where tiled black and white images are
compressed into tiled CCITT G4 Fax compressed PDF, 
.I libtiff 
CCITT support is assumed.
.PP
Color and grayscale data can be compressed using either JPEG compression,
ITU-T T.81, or Zip/Deflate LZ77 compression.  Set the compression type using
the 
.B \-j
or
.B \-z
options.  JPEG compression support 
requires that 
.I libtiff 
be configured with JPEG support, and Zip/Deflate compression support requires
that 
.I libtiff 
be configured with Zip support, in tiffconf.h.  Use only one or the other of 
.B \-j
and
.B \-z.
.PP
If the input TIFF contains single strip CCITT G4 Fax compressed information, 
then that is written to the PDF file without transcoding, unless the options 
of no compression and no passthrough are set, 
.B \-d
and
.B \-n.
.PP
If the input TIFF contains JPEG or single strip Zip/Deflate compressed 
information, and they are configured, then that is written to the PDF file 
without transcoding, unless the options of no compression and no passthrough 
are set.
.PP
The default page size upon which the TIFF image is placed is determined by 
the resolution and extent of the image data.  Default values for the TIFF 
image resolution can be set using the
.B \-x
and
.B \-y
options.  The page size can be set using the
.B \-p
option for paper size, or
.B \-w
and
.B \-l
for paper width and length, then each page of the TIFF image is centered on
its page.  The distance unit for default resolution and page width and
length can be set by the
.B \-u
option, the default unit is inch.
.PP
Various items of the output document information can be set with the
.B \-e,
.B \-c, 
.B \-a,
.B \-t,
.B \-s,
and
.B \-k
options.  Setting the argument of the option to "" for these 
tags causes the relevant document information field to be not written.  Some 
of the document information values otherwise get their information from the 
input TIFF image, the software, author, document name, and image description.
.PP
The Portable Document Format (PDF) specification is copyrighted by Adobe 
Systems, Incorporated.
.SH OPTIONS
.TP
.BI \-o output-file
Set the output to go to file 
.I output-file
.TP
.B \-j  
Compress with JPEG (requires libjpeg configured with libtiff).
.TP
.B \-z  
Compress with Zip/Deflate (requires zlib configured with libtiff).
.TP
.BI \-q quality
Set the compression quality, 1-100 for JPEG.
.TP
.B \-n
Do not allow data to be converted without uncompressing, no compressed
data passthrough.
.TP
.BI \-b
Set PDF "Interpolate" user preference.
.TP
.B \-d  
Do not compress (decompress).
.TP
.B \-i  
Invert colors.
.TP
.BI \-p paper-size
Set paper size, eg "letter", "legal", "A4".
.TP
.BI \-u [i|m]
Set distance unit,
.I i
for inch, 
.I m
for centimeter.
.TP
.BI \-w width
Set width in units.
.TP
.BI \-l length
Set length in units.
.TP
.BI \-x xres
Set x/width resolution default.
.TP
.BI \-y yres
Set y/length resolution default.
.TP
.BI \-r [d|o]
Set
.I d
for resolution default for images without resolution, 
.I o for resolution override for all images.
.TP
.BI \-f
Set PDF "Fit Window" user preference.
.TP
.BI \-e YYYYMMDDHHMMSS
Set document information date, overrides image or current date/time default,
.I YYYYMMDDHHMMSS.
.TP
.BI \-c creator
Set document information creator, overrides image software default.
.TP
.BI \-a author
Set document information author, overrides image artist default
.TP
.BI \-t title
Set document information title, overrides image document name default
.TP
.BI \-s subject
Set document information subject, overrides image image description default
.TP
.BI \-k keywords
Set document information keywords.
.TP
.B \-h  
List usage reminder to stderr and exit.
.TP
.SH EXAMPLES
.TP
The following example would generate the file output.pdf from input.tiff.
.PP
.RS
.NF
tiff2pdf -o output.pdf input.tiff
.FI
.RE
.PP
The following example would generate PDF output from input.tiff and write it 
to standard output.
.PP
.RS
.NF
tiff2pdf input.tiff
.FI
.RE
.PP
The following example would generate the file output.pdf from input.tiff, 
putting the image pages on a letter sized page, compressing the output 
with JPEG, with JPEG quality 75, setting the title to "Document", and setting 
the "Fit Window" option.
.PP
.RS
.NF
tiff2pdf -p letter -j -q 75 -t "Document" -f -o output.pdf input.tiff
.FI
.RE
.SH BUGS
Please report bugs via the web interface at 
.IP
\%http://bugzilla.remotesensing.org/enter_bug.cgi?product=libtiff
.SH "SEE ALSO"
.BR libtiff (3) ,
.BR tiffcp (1) , 
.BR tiff2ps (1)
.PP
Libtiff library home page:
.BR http://www.remotesensing.org/libtiff/
Commit	Line	Data
8414a40c VZ	1	.\" $Id: tiff2pdf.1,v 1.4 2005/11/02 11:07:19 dron Exp $
	2	.\"
	3	.\" Copyright (c) 2003 Ross Finlayson
	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 name of
	9	.\" Ross Finlayson may not be used in any advertising or
	10	.\" publicity relating to the software without the specific, prior written
	11	.\" permission of Ross Finlayson.
	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 ROSS FINLAYSON 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	.\" Process this file with
	25	.\" groff -man -Tascii tiff2pdf.1
	26	.\"
	27	.TH TIFF2PDF 1 "November 2, 2005" "libtiff"
	28	.SH NAME
	29	tiff2pdf - convert a TIFF image to a PDF document
	30	.SH SYNOPSIS
	31	.B tiff2pdf [
	32	.I options
	33	.B ]
	34	.I input.tiff
	35	.SH DESCRIPTION
	36	.B tiff2pdf
	37	opens a TIFF image and writes a PDF document to standard output.
	38	.PP
	39	The program converts one TIFF file to one PDF file, including multiple page
	40	TIFF files, tiled TIFF files, black and white. grayscale, and color TIFF
	41	files that contain data of TIFF photometric interpretations of bilevel,
	42	grayscale, RGB, YCbCr, CMYK separation, and ICC Lab* as supported by
	43	.I libtiff
	44	and PDF.
	45	.PP
	46	If you have multiple TIFF files to convert into one PDF file then use
	47	.I tiffcp
	48	or other program to concatenate the files into a multiple page TIFF file.
	49	If the input TIFF file is of huge dimensions (greater than 10000 pixels height
	50	or width) convert the input image to a tiled TIFF if it is not already.
	51	.PP
	52	The standard output is standard output. Set the output file name with the
	53	.BI -o output.pdf
	54	option.
	55	.PP
	56	All black and white files are compressed into a single strip CCITT G4 Fax
	57	compressed PDF, unless tiled, where tiled black and white images are
	58	compressed into tiled CCITT G4 Fax compressed PDF,
	59	.I libtiff
	60	CCITT support is assumed.
	61	.PP
	62	Color and grayscale data can be compressed using either JPEG compression,
	63	ITU-T T.81, or Zip/Deflate LZ77 compression. Set the compression type using
	64	the
65	.B \-j
66	or
67	.B \-z
68	options. JPEG compression support
69	requires that
70	.I libtiff
71	be configured with JPEG support, and Zip/Deflate compression support requires
72	that
73	.I libtiff
74	be configured with Zip support, in tiffconf.h. Use only one or the other of
75	.B \-j
76	and
77	.B \-z.
78	.PP
79	If the input TIFF contains single strip CCITT G4 Fax compressed information,
80	then that is written to the PDF file without transcoding, unless the options
81	of no compression and no passthrough are set,
82	.B \-d
83	and
84	.B \-n.
85	.PP
86	If the input TIFF contains JPEG or single strip Zip/Deflate compressed
87	information, and they are configured, then that is written to the PDF file
88	without transcoding, unless the options of no compression and no passthrough
89	are set.
90	.PP
91	The default page size upon which the TIFF image is placed is determined by
92	the resolution and extent of the image data. Default values for the TIFF
93	image resolution can be set using the
94	.B \-x
95	and
96	.B \-y
97	options. The page size can be set using the
98	.B \-p
99	option for paper size, or
100	.B \-w
101	and
102	.B \-l
103	for paper width and length, then each page of the TIFF image is centered on
104	its page. The distance unit for default resolution and page width and
105	length can be set by the
106	.B \-u
107	option, the default unit is inch.
108	.PP
109	Various items of the output document information can be set with the
110	.B \-e,
111	.B \-c,
112	.B \-a,
113	.B \-t,
114	.B \-s,
115	and
116	.B \-k
117	options. Setting the argument of the option to "" for these
118	tags causes the relevant document information field to be not written. Some
119	of the document information values otherwise get their information from the
120	input TIFF image, the software, author, document name, and image description.
121	.PP
122	The Portable Document Format (PDF) specification is copyrighted by Adobe
123	Systems, Incorporated.
124	.SH OPTIONS
125	.TP
126	.BI \-o output-file
127	Set the output to go to file
128	.I output-file
129	.TP
130	.B \-j
131	Compress with JPEG (requires libjpeg configured with libtiff).
132	.TP
133	.B \-z
134	Compress with Zip/Deflate (requires zlib configured with libtiff).
135	.TP
136	.BI \-q quality
137	Set the compression quality, 1-100 for JPEG.
138	.TP
139	.B \-n
140	Do not allow data to be converted without uncompressing, no compressed
141	data passthrough.
142	.TP
143	.BI \-b
144	Set PDF "Interpolate" user preference.
145	.TP
146	.B \-d
147	Do not compress (decompress).
148	.TP
149	.B \-i
150	Invert colors.
151	.TP
152	.BI \-p paper-size
153	Set paper size, eg "letter", "legal", "A4".
154	.TP
155	.BI \-u [i\|m]
156	Set distance unit,
157	.I i
158	for inch,
159	.I m
160	for centimeter.
161	.TP
162	.BI \-w width
163	Set width in units.
164	.TP
165	.BI \-l length
166	Set length in units.
167	.TP
168	.BI \-x xres
169	Set x/width resolution default.
170	.TP
171	.BI \-y yres
172	Set y/length resolution default.
173	.TP
174	.BI \-r [d\|o]
175	Set
176	.I d
177	for resolution default for images without resolution,
178	.I o for resolution override for all images.
179	.TP
180	.BI \-f
181	Set PDF "Fit Window" user preference.
182	.TP
183	.BI \-e YYYYMMDDHHMMSS
184	Set document information date, overrides image or current date/time default,
185	.I YYYYMMDDHHMMSS.
186	.TP
187	.BI \-c creator
188	Set document information creator, overrides image software default.
189	.TP
190	.BI \-a author
191	Set document information author, overrides image artist default
192	.TP
193	.BI \-t title
194	Set document information title, overrides image document name default
195	.TP
196	.BI \-s subject
197	Set document information subject, overrides image image description default
198	.TP
199	.BI \-k keywords
200	Set document information keywords.
201	.TP
202	.B \-h
203	List usage reminder to stderr and exit.
204	.TP
205	.SH EXAMPLES
206	.TP
207	The following example would generate the file output.pdf from input.tiff.
208	.PP
209	.RS
210	.NF
211	tiff2pdf -o output.pdf input.tiff
212	.FI
213	.RE
214	.PP
215	The following example would generate PDF output from input.tiff and write it
216	to standard output.
217	.PP
218	.RS
219	.NF
220	tiff2pdf input.tiff
221	.FI
222	.RE
223	.PP
224	The following example would generate the file output.pdf from input.tiff,
225	putting the image pages on a letter sized page, compressing the output
226	with JPEG, with JPEG quality 75, setting the title to "Document", and setting
227	the "Fit Window" option.
228	.PP
229	.RS
230	.NF
231	tiff2pdf -p letter -j -q 75 -t "Document" -f -o output.pdf input.tiff
232	.FI
233	.RE
234	.SH BUGS
235	Please report bugs via the web interface at
236	.IP
237	\%http://bugzilla.remotesensing.org/enter_bug.cgi?product=libtiff
238	.SH "SEE ALSO"
239	.BR libtiff (3) ,
240	.BR tiffcp (1) ,
241	.BR tiff2ps (1)
242	.PP
243	Libtiff library home page:
244	.BR http://www.remotesensing.org/libtiff/