]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/tiff/man/tiff2pdf.1
wxMessageBox off the main thread lost result code.
[wxWidgets.git] / src / tiff / man / tiff2pdf.1
... / ...
CommitLineData
1.\"
2.\" Copyright (c) 2003 Ross Finlayson
3.\"
4.\" Permission to use, copy, modify, distribute, and sell this software and
5.\" its documentation for any purpose is hereby granted without fee, provided
6.\" that (i) the above copyright notices and this permission notice appear in
7.\" all copies of the software and related documentation, and (ii) the name of
8.\" Ross Finlayson may not be used in any advertising or
9.\" publicity relating to the software without the specific, prior written
10.\" permission of Ross Finlayson.
11.\"
12.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
13.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
14.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
15.\"
16.\" IN NO EVENT SHALL ROSS FINLAYSON BE LIABLE FOR
17.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
18.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
19.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
20.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
21.\" OF THIS SOFTWARE.
22.\"
23.\" Process this file with
24.\" groff -man -Tascii tiff2pdf.1
25.\"
26.TH TIFF2PDF 1 "April 20, 2006" "libtiff"
27.SH NAME
28tiff2pdf \- convert a TIFF image to a PDF document
29.SH SYNOPSIS
30.B tiff2pdf
31[
32.I options
33]
34.I input.tiff
35.SH DESCRIPTION
36.I tiff2pdf
37opens a TIFF image and writes a PDF document to standard output.
38.PP
39The program converts one TIFF file to one PDF file, including multiple page
40TIFF files, tiled TIFF files, black and white. grayscale, and color TIFF
41files that contain data of TIFF photometric interpretations of bilevel,
42grayscale, RGB, YCbCr, CMYK separation, and ICC L*a*b* as supported by
43.I libtiff
44and PDF.
45.PP
46If you have multiple TIFF files to convert into one PDF file then use
47.I tiffcp
48or other program to concatenate the files into a multiple page TIFF file.
49If the input TIFF file is of huge dimensions (greater than 10000 pixels height
50or width) convert the input image to a tiled TIFF if it is not already.
51.PP
52The standard output is standard output. Set the output file name with the
53.BI \-o " output.pdf"
54option.
55.PP
56All black and white files are compressed into a single strip CCITT G4 Fax
57compressed PDF, unless tiled, where tiled black and white images are
58compressed into tiled CCITT G4 Fax compressed PDF,
59.I libtiff
60CCITT support is assumed.
61.PP
62Color and grayscale data can be compressed using either JPEG compression,
63ITU-T T.81, or Zip/Deflate LZ77 compression. Set the compression type using
64the
65.B \-j
66or
67.B \-z
68options. JPEG compression support
69requires that
70.I libtiff
71be configured with JPEG support, and Zip/Deflate compression support requires
72that
73.I libtiff
74be configured with Zip support, in tiffconf.h. Use only one or the other of
75.B \-j
76and
77.B \-z.
78.PP
79If the input TIFF contains single strip CCITT G4 Fax compressed information,
80then that is written to the PDF file without transcoding, unless the options
81of no compression and no passthrough are set,
82.B \-d
83and
84.B \-n.
85.PP
86If the input TIFF contains JPEG or single strip Zip/Deflate compressed
87information, and they are configured, then that is written to the PDF file
88without transcoding, unless the options of no compression and no passthrough
89are set.
90.PP
91The default page size upon which the TIFF image is placed is determined by
92the resolution and extent of the image data. Default values for the TIFF
93image resolution can be set using the
94.B \-x
95and
96.B \-y
97options. The page size can be set using the
98.B \-p
99option for paper size, or
100.B \-w
101and
102.B \-l
103for paper width and length, then each page of the TIFF image is centered on
104its page. The distance unit for default resolution and page width and
105length can be set by the
106.B \-u
107option, the default unit is inch.
108.PP
109Various items of the output document information can be set with the
110.BR \-e ,
111.BR \-c ,
112.BR \-a ,
113.BR \-t ,
114.BR \-s ,
115and
116.B \-k
117options. Setting the argument of the option to "" for these
118tags causes the relevant document information field to be not written. Some
119of the document information values otherwise get their information from the
120input TIFF image, the software, author, document name, and image description.
121.PP
122The Portable Document Format (PDF) specification is copyrighted by Adobe
123Systems, Incorporated.
124.SH OPTIONS
125.TP
126.BI \-o " output-file"
127Set the output to go to file.
128.I output-file
129.TP
130.B \-j
131Compress with JPEG (requires
132.I libjpeg
133configured with
134.IR libtiff ).
135.TP
136.B \-z
137Compress with Zip/Deflate (requires
138.I zlib
139configured with
140.IR libtiff ).
141.TP
142.BI \-q " quality"
143Set the compression quality, 1-100 for JPEG.
144.TP
145.B \-n
146Do not allow data to be converted without uncompressing, no compressed
147data passthrough.
148.TP
149.BI \-b
150Set PDF ``Interpolate'' user preference.
151.TP
152.B \-d
153Do not compress (decompress).
154.TP
155.B \-i
156Invert colors.
157.TP
158.BI \-p " paper-size"
159Set paper size, e.g.,
160.BR letter ,
161.BR legal ,
162.BR A4 .
163.TP
164.B \-F
165Cause the tiff to fill the PDF page.
166.TP
167.BR \-u " [" i | m ]
168Set distance unit,
169.B i
170for inch,
171.B m
172for centimeter.
173.TP
174.BI \-w " width"
175Set width in units.
176.TP
177.BI \-l " length"
178Set length in units.
179.TP
180.BI \-x " xres"
181Set x/width resolution default.
182.TP
183.BI \-y " yres"
184Set y/length resolution default.
185.TP
186.BR \-r " [" d | o ]
187Set
188.B d
189for resolution default for images without resolution,
190.B o
191for resolution override for all images.
192.TP
193.BI \-f
194Set PDF ``Fit Window'' user preference.
195.TP
196.BI \-e " YYYYMMDDHHMMSS"
197Set document information date, overrides image or current date/time default,
198.I YYYYMMDDHHMMSS.
199.TP
200.BI \-c " creator"
201Set document information creator, overrides image software default.
202.TP
203.BI \-a " author"
204Set document information author, overrides image artist default.
205.TP
206.BI \-t " title"
207Set document information title, overrides image document name default.
208.TP
209.BI \-s " subject"
210Set document information subject, overrides image image description default.
211.TP
212.BI \-k " keywords"
213Set document information keywords.
214.TP
215.B \-h
216List usage reminder to stderr and exit.
217.SH EXAMPLES
218.TP
219The following example would generate the file output.pdf from input.tiff.
220.RS
221.nf
222tiff2pdf \-o output.pdf input.tiff
223.fi
224.RE
225.PP
226The following example would generate PDF output from input.tiff and write it
227to standard output.
228.RS
229.nf
230tiff2pdf input.tiff
231.fi
232.RE
233.PP
234The following example would generate the file output.pdf from input.tiff,
235putting the image pages on a letter sized page, compressing the output
236with JPEG, with JPEG quality 75, setting the title to ``Document'', and setting
237the ``Fit Window'' option.
238.RS
239.nf
240tiff2pdf \-p letter \-j \-q 75 \-t "Document" \-f \-o output.pdf input.tiff
241.fi
242.RE
243.SH BUGS
244Please report bugs via the web interface at
245.IP
246\%http://bugzilla.remotesensing.org/enter_bug.cgi?product=libtiff
247.SH "SEE ALSO"
248.BR libtiff (3),
249.BR tiffcp (1),
250.BR tiff2ps (1)
251.PP
252Libtiff library home page:
253.BR http://www.remotesensing.org/libtiff/