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