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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
\
.\" 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 "G3topbm User Manual" 1 "02 July 2023" "netpbm documentation"
.SH NAME
g3topbm - convert a Group 3 fax file into a PBM image
.UN synopsis
.SH SYNOPSIS
\fBg3topbm\fP
[\fB-reversebits\fP]
[\fB-stretch\fP]
[\fB-width=\fP\fIpixels\fP | paper_size={A3|A4|A5|A6|B4}]
[\fB-stop_error\fP]
[\fB-correctlong\fP]
[\fB-kludge\fP]
[\fIg3file\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
\fBg3topbm\fP reads a Group 3 fax file with MH (Modified Huffman)
compression as input and produces a PBM image as output.
.PP
\fBg3topbm\fP tolerates various deviations from the standard,
so as to recover some of the image if there was a transmission error.
One thing it tolerates is lines of varying length. The standard requires
all the lines to be the same length; \fBg3topbm\fP makes the output
image as wide as the longest line in the input and pads the others on
the right. It warns you when it does this.
.PP
You can use the \fBstop_error\fP option to make \fBg3topbm\fP
insist on valid input.
.PP
There is no Netpbm program that understands the other G3 fax
compression methods: MR (Modified Read) and MMR (Modified Modified Read).
.PP
Note that the Group 3 fax file format does not include any kind of a
signature so that \fBg3topbm\fP might verify it's actually looking at a G3
file or that the compression method is MH. The program will interpret any
sequence of bytes you give it as if it is G3 and, while typically issuing a
lot of error messages about the file not conforming to the G3 MH format, will
produce output (unless you use
\fB-stoperror\fP). In particular, if you feed \fBg3topbm\fP an MR or MMR
file, it will not tell you of your mistake.
.PP
There are subformats of TIFF that use the Group 3 fax encodings
inside. See \fBtifftopnm\fP.
.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
\&), \fBg3topbm\fP recognizes the following
command line options:
.TP
\fB-reversebits\fP
Tells \fBg3topbm\fP to interpret bits least-significant first,
instead of the default most-significant first. Apparently some fax
modems do it one way and others do it the other way. If you get a
whole bunch of "bad code word" messages, try using this
option.
.TP
\fB-stretch\fP
This option tells \fBg3topbm\fP to stretch the image vertically by
duplicating each row. This is for the low-quality transmission mode.
.TP
\fB-width=\fP\fIpixels\fP
This option tells \fBg3topbm\fP that the image is supposed to be
\fIpixels\fP pixels wide. If any line in it is not that size, \fBg3topbm\fP
issues a warning or fails, depending on whether you specify
\fB-stop_error\fP.
.sp
You cannot specify both \fB-width\fP and \fB-paper_size\fP.
.sp
This option was new in Netpbm 10.33 (March 2006).
.TP
\fB-paper_size=\fP{\fBA3\fP,\fBA4\fP,\fBA5\fP,\fBA6\fP,\fBB4\fP}
This option tells \fBg3topbm\fP for what size paper this image is
supposed to be formatted. \fBg3topbm\fP uses the width of the paper
the same way as with the \fB-width\fP option. \fBg3topbm\fP
does not use the height of the paper for anything.
.sp
You cannot specify both \fB-width\fP and \fB-paper_size\fP.
.sp
This option was new in Netpbm 10.33 (March 2006).
.TP
\fB-stop_error\fP
This option tells \fBg3topbm\fP to fail when it finds a problem
in the input. "Fail" means it terminates with a nonzero
status code with the contents of the output file undefined.
.sp
If you don't specify this option, \fBg3topbm\fP does its best to
work around input errors and salvage as much of the image as possible
in the output image. It first tries to resynchronize to a later line
by searching for the next End Of Line marker, skipping any lines or
partial lines in between. It saves the beginning of the line in which
it encountered the problem. If the input file ends prematurely,
\fBg3topbm\fP produces output containing the lines up to where it
encountered the problem.
.sp
\fBg3topbm\fP issues warning messages when it continues in spite of
input errors.
.sp
This option was new in Netpbm 10.24 (August 2004). Before that,
\fBg3topbm\fP always failed when it encountered premature EOF and
never failed when it encountered other problems.
\fB-correctlong\fP
.sp
This option helps with certain corrupted input files. Faxes often are
corrupted because of communication line errors. A particularly annoying
corruption causes a line to be much longer than it is supposed to be. One way
that can happen is where an End of Line marker is missing, so two consecutive
lines turn into one.
.sp
Without this option, \fBg3topbm\fP faithfully renders the document as
coded, so the output PBM image simply contains that long line. This is an
especially problematic corruption because it makes the entire output image
about twice as wide as it is supposed to be. But with \fB-correctlong\fP,
\fBg3topbm\fP truncates that line so the overall effect of the input
corruption is that a line is missing rather than that the image is twice as
wide as it is supposed to be.
.sp
Specifically, with \fB-correctlong\fP, the program looks at the lengths of
all the lines (which would all be the same length in an uncorrupted G3 image)
and considers the line length that occurs the most to be the intended image
width. It truncates every line that is longer than that.
.sp
The program warns you when corruption has caused the input image to have
lines of more than one length, whether you specify \fB-correctlong\fP or not.
.sp
Note that there is no point to specifying \fB-correctlong\fP if you also
specify \fB-stop_error\fP.
.sp
This option was new in Netpbm 11.04 (September 2023).
.TP
\fB-kludge\fP
Tells \fBg3topbm\fP to ignore the first few lines of the file; sometimes
fax files have some junk at the beginning.
.UN seealso
.SH SEE ALSO
.BR "pbmtog3" (1)\c
\&,
.BR "tifftopnm" (1)\c
\&,
.BR "pbm" (1)\c
\&,
.BR "fax formats" (1)\c
\&
.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/g3topbm.html
.PP
|
