summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/jbigtopnm.1
blob: bf39f569be84dedfaa54e754fcf9dbcd282509cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Jbigtopnm User Manual" 1 "28 July 2020" "netpbm documentation"

.SH NAME
jbigtopnm - JBIG to PNM image file converter

.UN synopsis
.SH SYNOPSIS

\fBjbigtopnm\fP
[\fB-xmax\fP]
[\fB-ymax\fP]
[\fB-binary\fP]
[\fB-diagnose\fP]
[\fB-plane\fP]
[\fIinput-file\fP [\fIoutput-file\fP]]
.PP
Minimum unique abbreviation of option is acceptable.  You may use double
hyphens instead of single hyphen to denote options.  You may use white
space in place of the equals sign to separate an option name from its value.


.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBjbigtopnm\fP reads a JBIG bi-level image entity (BIE) from a
file or standard input, decompresses it, and outputs a PBM or PGM
file.  If the input has one plane, or you choose just one plane of it,
the output is PBM.  Otherwise, the output is PGM.
.PP
JBIG is a highly effective lossless compression algorithm for
bi-level images (one bit per pixel), which is particularly suitable
for scanned document pages.
.PP
A JBIG encoded image can be stored in several resolutions in one or
several BIEs. All resolution layers except the lowest one are stored
efficiently as differences to the next lower resolution layer.  You
can use options \fB-x\fP and \fB-y\fP to stop the decompression at a
specified maximal output image size.  The input file can consist of
several concatenated BIEs which contain different increasing
resolution layers of the same image.

.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBjbigtopnm\fP recognizes the following
command line options:
.PP
Before Netpbm 10.85 (December 2018), only single-character single-hyphen
abbreviations of the options are accepted.



.TP
\fB-xmax\fP \fInumber\fP
Decode only up to the largest resolution layer which is still not
more than \fInumber\fP pixels wide.  If no such resolution layer
exists, then use the smallest one available.

.TP
\fB-ymax\fP\fI number\fP
Decode only up to the largest resolution layer which is still not
more than \fInumber\fP pixels high.  If no such resolution layer
exists, then use the smallest one available.  You can also use options
\fB-x\fP and \fB-y\fP together which selects the largest layer that
satisfies both limits.

.TP
\fB-binary\fP
Use binary values instead of Gray code words in order to decode
pixel values from multiple bitplanes.  This option has effect only if
the input has more than one bitplane and you don't select just one of
those bitplanes.  Note that the decoder has to be used in the same
mode as the encoder and cannot determine from the BIE, whether Gray or
binary code words were used by the encoder.

.TP
\fB-diagnose\fP
Diagnose a BIE.  With this option, \fBjbigtopnm\fP only prints a
summary of the header information found in the input file and then
exits.

.TP
\fB-plane\fP\fI number\fP
If the input contains multiple bitplanes, then extract only the
specified single plane as a PBM file.  The first plane has number 0.



.UN standards
.SH STANDARDS
.PP
This program implements the JBIG image coding algorithm as
specified in ISO/IEC 11544:1993 and ITU-T T.82(1993).

.UN author
.SH AUTHOR


.PP
\fBjbigtopnm\fP is based on the JBIG library by Markus Kuhn, part
of his 
.UR http://www.cl.cam.ac.uk/~mgk25/jbigkit/
\fBJBIG-KIT\fP package
.UE
\&.  The \fBjbgtopbm\fP program is part of the
\fBJBIG-KIT\fP package.
.PP
\fBjbigtopnm\fP is part of the Netpbm package of graphics tools.

.UN seealso
.SH SEE ALSO
.BR "pnm" (1)\c
\&,
.BR "pnmtojbig" (1)\c
\&

.UN license
.SH LICENSE
.PP
There was at one time concern about the need for patent licenses to
use \fBjbigtopnm\fP, but any relevant patents expired by 2012.
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/jbigtopnm.html
.PP