Second part of #15224 fix: AddRows, AddColumns (dghart)

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

diff --git a/src/tiff/man/tiffcp.1 b/src/tiff/man/tiffcp.1
index ffad8ea339b6a416fc3682e505972e9052b3b86b..650556cf8c39838b4f9fb29c6101a594f8ba9130 100644 (file)
--- a/src/tiff/man/tiffcp.1
+++ b/src/tiff/man/tiffcp.1
@@ -1,4 +1,3 @@
-.\" $Id: tiffcp.1,v 1.6 2005/11/02 11:07:19 dron Exp $

 .\"
 .\" Copyright (c) 1988-1997 Sam Leffler
 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
 .\"
 .\" Copyright (c) 1988-1997 Sam Leffler
 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.


@@ -23,7 +22,7 @@
 .\" OF THIS SOFTWARE.
 .\"
 .if n .po 0
 .\" OF THIS SOFTWARE.
 .\"
 .if n .po 0

-.TH TIFFCP 1 "September 20, 2005" "libtiff"
+.TH TIFFCP 1 "February 24, 2007" "libtiff"

 .SH NAME
 tiffcp \- copy (and possibly convert) a
 .SM TIFF
 .SH NAME
 tiffcp \- copy (and possibly convert) a
 .SM TIFF


@@ -60,7 +59,7 @@ in a file, but it is explicitly intended to not alter or convert
 the image data content in any way.
 .SH OPTIONS
 .TP
 the image data content in any way.
 .SH OPTIONS
 .TP

-.B \-b image
+.BI \-b " image"

 subtract the following monochrome image from all others
 processed.  This can be used to remove a noise bias
 from a set of images.  This bias image is typically an
 subtract the following monochrome image from all others
 processed.  This can be used to remove a noise bias
 from a set of images.  This bias image is typically an


@@ -83,10 +82,12 @@ for no compression,
 for PackBits compression,
 .B lzw
 for Lempel-Ziv & Welch compression,
 for PackBits compression,
 .B lzw
 for Lempel-Ziv & Welch compression,

-.B jpeg
-for baseline JPEG compression,

 .B zip
 for Deflate compression,
 .B zip
 for Deflate compression,

+.B lzma
+for LZMA2 compression,
+.B jpeg
+for baseline JPEG compression,

 .B g3
 for CCITT Group 3 (T.4) compression,
 and
 .B g3
 for CCITT Group 3 (T.4) compression,
 and


@@ -118,20 +119,33 @@ list to the ``g3'' option; e.g.
 .B "\-c g3:2d:fill"
 to get 2D-encoded data with byte-aligned EOL codes.
 .IP
 .B "\-c g3:2d:fill"
 to get 2D-encoded data with byte-aligned EOL codes.
 .IP

-.SM LZW
+.SM LZW, Deflate
+and
+.SM LZMA2

 compression can be specified together with a 
 .I predictor
 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.
+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. A value 3 is for floating point
+predictor which you can use if the encoded data are in floating point format.
+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.
 .B "\-c lzw:2"
 for
 .SM LZW
 compression with horizontal differencing.

+.IP
+.SM Deflate
+and
+.SM LZMA2
+encoders support various compression levels (or encoder presets) set as
+character ``p'' and a preset number. ``p1'' is the fastest one with the worst
+compression ratio and ``p9'' is the slowest but with the best possible ratio;
+e.g.
+.B "\-c zip:3:p9"
+for
+.SM Deflate
+encoding with maximum compression level and floating point predictor.

 .TP
 .B \-f
 Specify the bit fill order to use in writing output data.
 .TP
 .B \-f
 Specify the bit fill order to use in writing output data.


@@ -147,6 +161,9 @@ while
 will force data to be written with the FillOrder tag set to
 .SM MSB2LSB.
 .TP
 will force data to be written with the FillOrder tag set to
 .SM MSB2LSB.
 .TP

+.B \-i
+Ignore non-fatal read errors and continue processing of the input file.
+.TP

 .B \-l
 Specify the length of a tile (in pixels).
 .I tiffcp
 .B \-l
 Specify the length of a tile (in pixels).
 .I tiffcp


@@ -185,7 +202,7 @@ is specified),
 attempts to set the rows/strip
 that no more than 8 kilobytes of data appear in a strip. If you specify
 special value
 attempts to set the rows/strip
 that no more than 8 kilobytes of data appear in a strip. If you specify
 special value

-.B -1
+.B \-1

 it will results in infinite number of the rows per strip. The entire image
 will be the one strip in that case.
 .TP
 it will results in infinite number of the rows per strip. The entire image
 will be the one strip in that case.
 .TP


@@ -194,32 +211,38 @@ Force the output file to be written with data organized in strips
 (rather than tiles).
 .TP
 .B \-t
 (rather than tiles).
 .TP
 .B \-t

-Force the output file to be written with data organized in tiles
-(rather than strips).
-options can be used to force the resultant image to be written
-as strips or tiles of data, respectively.
+Force the output file to be written with data organized in tiles (rather than
+strips). options can be used to force the resultant image to be written as
+strips or tiles of data, respectively.

 .TP
 .B \-w
 Specify the width of a tile (in pixels).
 .I tiffcp
 .TP
 .B \-w
 Specify the width of a tile (in pixels).
 .I tiffcp

-attempts to set the tile dimensions so
-that no more than 8 kilobytes of data appear in a tile.
+attempts to set the tile dimensions so that no more than 8 kilobytes of data
+appear in a tile.

 .I tiffcp
 .I tiffcp

-attempts to set the tile dimensions so
-that no more than 8 kilobytes of data appear in a tile.
+attempts to set the tile dimensions so that no more than 8 kilobytes of data
+appear in a tile.
+.TP
+.B \-x
+Force the output file to be written with PAGENUMBER value in sequence.

 .TP
 .TP

-.B \-,={character}
-substitute {character} for ',' in parsing image directory indices
+.BI \-,= character
+substitute
+.I character
+for `,' in parsing image directory indices

 in files.  This is necessary if filenames contain commas.
 in files.  This is necessary if filenames contain commas.

-Note that ',=' with whitespace immediately following will disable
-the special meaning of the ',' entirely.  See examples.
+Note that
+.B \-,=
+with whitespace immediately following will disable
+the special meaning of the `,' entirely.  See examples.

 .SH EXAMPLES
 The following concatenates two files and writes the result using 
 .SM LZW
 encoding:
 .RS
 .nf
 .SH EXAMPLES
 The following concatenates two files and writes the result using 
 .SM LZW
 encoding:
 .RS
 .nf

-tiffcp -c lzw a.tif b.tif result.tif
+tiffcp \-c lzw a.tif b.tif result.tif

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP


@@ -228,39 +251,48 @@ To convert a G3 1d-encoded
 to a single strip of G4-encoded data the following might be used:
 .RS
 .nf
 to a single strip of G4-encoded data the following might be used:
 .RS
 .nf

-tiffcp -c g4 -r 10000 g3.tif g4.tif
+tiffcp \-c g4 \-r 10000 g3.tif g4.tif

 .fi
 .RE
 (1000 is just a number that is larger than the number of rows in
 the source file.)
 
 .fi
 .RE
 (1000 is just a number that is larger than the number of rows in
 the source file.)
 

-To extract a selected set of images from a multi-image
-TIFF file, the file name may be immediately followed by a ',' 
-separated list of image directory indices.  The first image
-is always in directory 0.  Thus, to copy the 1st and 3rd
-images of image file "album.tif" to "result.tif":
+To extract a selected set of images from a multi-image TIFF file, the file
+name may be immediately followed by a `,' separated list of image directory
+indices.  The first image is always in directory 0.  Thus, to copy the 1st and
+3rd images of image file ``album.tif'' to ``result.tif'':

 .RS
 .nf
 tiffcp album.tif,0,2 result.tif
 .fi
 .RE
 
 .RS
 .nf
 tiffcp album.tif,0,2 result.tif
 .fi
 .RE
 

-Given file "CCD.tif" whose first image is a noise bias
+A trailing comma denotes remaining images in sequence.  The following command
+will copy all image with except the first one:
+.RS
+.nf
+tiffcp album.tif,1, result.tif
+.fi
+.RE
+
+Given file ``CCD.tif'' whose first image is a noise bias

 followed by images which include that bias,
 subtract the noise from all those images following it
 (while decompressing) with the command:
 .RS
 .nf
 followed by images which include that bias,
 subtract the noise from all those images following it
 (while decompressing) with the command:
 .RS
 .nf

-tiffcp -c none -b CCD.tif CCD.tif,1, result.tif
+tiffcp \-c none \-b CCD.tif CCD.tif,1, result.tif

 .fi
 .RE
 
 .fi
 .RE
 

-If the file above were named "CCD,X.tif", the "-,=" option would
+If the file above were named ``CCD,X.tif'', the
+.B \-,=
+option would

 be required to correctly parse this filename with image numbers,
 as follows:
 .RS
 .nf
 be required to correctly parse this filename with image numbers,
 as follows:
 .RS
 .nf

-tiffcp -c none -,=% -b CCD,X.tif CCD,X%1%.tif result.tif
+tiffcp \-c none \-,=% \-b CCD,X.tif CCD,X%1%.tif result.tif

 .SH "SEE ALSO"
 .BR pal2rgb (1),
 .BR tiffinfo (1),
 .SH "SEE ALSO"
 .BR pal2rgb (1),
 .BR tiffinfo (1),