[trunk] FolderReorgProposal task: rename cli tools
[openjpeg.git] / doc / man / man1 / opj_decompress.1
1 '\" t
2 '\" The line above instructs most `man' programs to invoke tbl
3 '\"
4 '\" Separate paragraphs; not the same as PP which resets indent level.
5 .de SP
6 .if t .sp .5
7 .if n .sp
8 ..
9 '\"
10 '\" Replacement em-dash for nroff (default is too short).
11 .ie n .ds m " -
12 .el .ds m \(em
13 '\"
14 '\" Placeholder macro for if longer nroff arrow is needed.
15 .ds RA \(->
16 '\"
17 '\" Decimal point set slightly raised
18 .if t .ds d \v'-.15m'.\v'+.15m'
19 .if n .ds d .
20 '\"
21 '\" Enclosure macro for examples
22 .de EX
23 .SP
24 .nf
25 .ft CW
26 ..
27 .de EE
28 .ft R
29 .SP
30 .fi
31 ..
32 .TH opj_decompress 1 "Version 1.4.0" "opj_decompress" "converts jpeg2000 files"
33 .P
34 .SH NAME
35 opj_decompress - 
36 This program reads in a jpeg2000 image and converts it to another 
37 image type. It is part of the OpenJPEG library.
38 .SP
39 Valid input image extensions are
40 .B .j2k, .jp2, .j2c, .jpt
41 .SP
42 Valid output image extensions are
43 .B .bmp, .pgm, .pgx, .png, .pnm, .ppm, .raw, .tga, .tif \fR. For PNG resp. TIF it needs libpng resp. libtiff .
44 .SH SYNOPSIS
45 .P
46 .B opj_decompress -i \fRinfile.j2k \fB-o \fRoutfile.png
47 .P
48 .B opj_decompress -ImgDir \fRimages/ \fB-OutFor \fRbmp
49 .P
50 .B opj_decompress -h  \fRPrint help message and exit
51 .P
52 .R See JPWL OPTIONS for special options
53 .SH OPTIONS
54 .TP
55 .B \-\^i "name"
56 (jpeg2000 input file name)
57 .TP
58 .B \-\^l "n"
59 n is the maximum number of quality layers to decode. See LAYERS below)
60 .TP
61 .B \-\^o "name"
62 (output file name with extension)
63 .TP
64 .B \-\^r "n"
65 (n is the highest resolution level to be discarded. See REDUCTION below)
66 .TP
67 .B \-\^x "name"
68 (use name as index file and fill it)
69 .TP
70 .B \-\^ImgDir "directory_name"
71 (directory containing input files)
72 .TP
73 .B \-\^OutFor "ext"
74 (extension for output files)
75 .P
76 .SH JPWL OPTIONS
77 Options usable only if the library has been compiled with
78 .B -DUSE_JPWL
79 .TP
80 .B -W c\fR[=Nc] (Nc is the  number of expected components in the codestream; default:3)
81 .TP
82 .B -W t\fR[=Nt] (Nt is the maximum number of tiles in the codestream; default:8192)
83 .TP
84 .B -W c\fR[=Nc]\fB, t\fR[=Nt] \fR(same as above)
85 .P
86 .SH REDUCTION
87 Set the number of highest resolution levels to be discarded.
88 The image resolution is effectively divided by 2 to the power of the number of discarded levels. The reduce factor is limited by the smallest total number of decomposition levels among tiles.
89 .SH TILES
90 Set the maximum number of quality layers to decode. If there are less quality layers than the specified number, all the quality layers are decoded.
91 .P
92 '\".SH BUGS
93 .SH AUTHORS
94 Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
95 .br
96 Copyright (c) 2002-2007, Professor Benoit Macq
97 .br
98 Copyright (c) 2001-2003, David Janssens
99 .br
100 Copyright (c) 2002-2003, Yannick Verschueren
101 .br
102 Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
103 .br
104 Copyright (c) 2005, Herve Drolon, FreeImage Team
105 .br
106 Copyright (c) 2006-2007, Parvatha Elangovan
107 .P
108 .SH "SEE ALSO"
109 opj_compress(1) opj_dump(1)