]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/tiff/html/man/fax2tiff.1.html
No changes, just get rid of some wxT()s in wxString unit test.
[wxWidgets.git] / src / tiff / html / man / fax2tiff.1.html
... / ...
CommitLineData
1<!-- Creator : groff version 1.18.1 -->
2<!-- CreationDate: Sat Feb 24 18:37:18 2007 -->
3<html>
4<head>
5<meta name="generator" content="groff -Thtml, see www.gnu.org">
6<meta name="Content-Style" content="text/css">
7<title>FAX2TIFF</title>
8</head>
9<body>
10
11<h1 align=center>FAX2TIFF</h1>
12<a href="#NAME">NAME</a><br>
13<a href="#SYNOPSIS">SYNOPSIS</a><br>
14<a href="#DESCRIPTION">DESCRIPTION</a><br>
15<a href="#OPTIONS">OPTIONS</a><br>
16<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
17<a href="#BUGS">BUGS</a><br>
18<a href="#SEE ALSO">SEE ALSO</a><br>
19
20<hr>
21<a name="NAME"></a>
22<h2>NAME</h2>
23<!-- INDENTATION -->
24<table width="100%" border=0 rules="none" frame="void"
25 cols="2" cellspacing="0" cellpadding="0">
26<tr valign="top" align="left">
27<td width="8%"></td>
28<td width="91%">
29<p>fax2tiff &minus; create a <small>TIFF</small> Class F fax
30file from raw fax data</p>
31</td>
32</table>
33<a name="SYNOPSIS"></a>
34<h2>SYNOPSIS</h2>
35<!-- INDENTATION -->
36<table width="100%" border=0 rules="none" frame="void"
37 cols="2" cellspacing="0" cellpadding="0">
38<tr valign="top" align="left">
39<td width="8%"></td>
40<td width="91%">
41<p><b>fax2tiff</b> [ <i>options</i> ] [ <b>&minus;o</b>
42<i>output.tif</i> ] <i>input.raw</i></p>
43</td>
44</table>
45<a name="DESCRIPTION"></a>
46<h2>DESCRIPTION</h2>
47<!-- INDENTATION -->
48<table width="100%" border=0 rules="none" frame="void"
49 cols="2" cellspacing="0" cellpadding="0">
50<tr valign="top" align="left">
51<td width="8%"></td>
52<td width="91%">
53<p><i>Fax2tiff</i> creates a <small>TIFF</small> file
54containing <small>CCITT</small> Group 3 or Group 4 encoded
55data from one or more files containing
56&lsquo;&lsquo;raw&rsquo;&rsquo; Group 3 or Group 4 encoded
57data (typically obtained directly from a fax modem). By
58default, each row of data in the resultant
59<small>TIFF</small> file is 1-dimensionally encoded and
60padded or truncated to 1728 pixels, as needed. The resultant
61image is a set of low resolution (98 lines/inch) or medium
62resolution (196 lines/inch) pages, each of which is a single
63strip of data. The generated file conforms to the
64<small>TIFF</small> Class F ( <small>FAX</small> )
65specification for storing facsimile data. This means, in
66particular, that each page of the data does <b>not</b>
67include the trailing <i>return to control</i> (
68<small>RTC</small> ) code; as required for transmission by
69the <small>CCITT</small> Group 3 specifications. The old,
70&lsquo;&lsquo;classic&rsquo;&rsquo;, format is created if
71the <b>&minus;c</b> option is used. (The Class F format can
72also be requested with the <b>&minus;f</b> option.)</p>
73<!-- INDENTATION -->
74<p>The default name of the output image is <i>fax.tif</i>;
75this can be changed with the <b>&minus;o</b> option. Each
76input file is assumed to be a separate page of facsimile
77data from the same document. The order in which input files
78are specified on the command line is the order in which the
79resultant pages appear in the output file.</p>
80</td>
81</table>
82<a name="OPTIONS"></a>
83<h2>OPTIONS</h2>
84<!-- INDENTATION -->
85<table width="100%" border=0 rules="none" frame="void"
86 cols="2" cellspacing="0" cellpadding="0">
87<tr valign="top" align="left">
88<td width="8%"></td>
89<td width="91%">
90<p>Options that affect the interpretation of input data
91are:</p>
92</td>
93</table>
94<!-- TABS -->
95<table width="100%" border=0 rules="none" frame="void"
96 cols="5" cellspacing="0" cellpadding="0">
97<tr valign="top" align="left">
98<td width="10%"></td>
99<td width="3%">
100
101<p><b>&minus;3</b></p>
102</td>
103<td width="5%"></td>
104<td width="80%">
105
106<p>Assume input data is <small>CCITT</small> Group 3
107encoded (default).</p>
108</td>
109<td width="0%">
110</td>
111<tr valign="top" align="left">
112<td width="10%"></td>
113<td width="3%">
114
115<p><b>&minus;4</b></p>
116</td>
117<td width="5%"></td>
118<td width="80%">
119
120<p>Assume input data is <small>CCITT</small> Group 4
121encoded.</p>
122</td>
123<td width="0%">
124</td>
125<tr valign="top" align="left">
126<td width="10%"></td>
127<td width="3%">
128
129<p><b>&minus;U</b></p>
130</td>
131<td width="5%"></td>
132<td width="80%">
133
134<p>Assume input data is uncompressed (Group 3 or Group
1354).</p>
136</td>
137<td width="0%">
138</td>
139<tr valign="top" align="left">
140<td width="10%"></td>
141<td width="3%">
142
143<p><b>&minus;1</b></p>
144</td>
145<td width="5%"></td>
146<td width="80%">
147
148<p>Assume input data is encoded with the 1-dimensional
149version of the <small>CCITT</small> Group 3 Huffman encoding
150algorithm (default).</p>
151</td>
152<td width="0%">
153</td>
154<tr valign="top" align="left">
155<td width="10%"></td>
156<td width="3%">
157
158<p><b>&minus;2</b></p>
159</td>
160<td width="5%"></td>
161<td width="80%">
162
163<p>Assume input data is 2-dimensional version of the
164<small>CCITT</small> Group 3 Huffman encoding algorithm.</p>
165</td>
166<td width="0%">
167</td>
168<tr valign="top" align="left">
169<td width="10%"></td>
170<td width="3%">
171
172<p><b>&minus;P</b></p>
173</td>
174<td width="5%"></td>
175<td width="80%">
176
177<p>Assume input data is <b>not</b> EOL-aligned (default).
178This option has effect with Group 3 encoded input only.</p>
179</td>
180<td width="0%">
181</td>
182<tr valign="top" align="left">
183<td width="10%"></td>
184<td width="3%">
185
186<p><b>&minus;A</b></p>
187</td>
188<td width="5%"></td>
189<td width="80%">
190
191<p>Assume input data is EOL-aligned. This option has effect
192with Group 3 encoded input only.</p>
193</td>
194<td width="0%">
195</td>
196<tr valign="top" align="left">
197<td width="10%"></td>
198<td width="3%">
199
200<p><b>&minus;M</b></p>
201</td>
202<td width="5%"></td>
203<td width="80%">
204
205<p>Treat input data as having bits filled from most
206significant bit ( <small>MSB</small> ) to most least bit (
207<small>LSB</small> ).</p>
208</td>
209<td width="0%">
210</td>
211<tr valign="top" align="left">
212<td width="10%"></td>
213<td width="3%">
214
215<p><b>&minus;L</b></p>
216</td>
217<td width="5%"></td>
218<td width="80%">
219
220<p>Treat input data as having bits filled from least
221significant bit ( <small>LSB</small> ) to most significant
222bit ( <small>MSB</small> ) (default).</p>
223</td>
224<td width="0%">
225</td>
226<tr valign="top" align="left">
227<td width="10%"></td>
228<td width="3%">
229
230<p><b>&minus;B</b></p>
231</td>
232<td width="5%"></td>
233<td width="80%">
234
235<p>Assume input data was encoded with black as 0 and white
236as 1.</p>
237</td>
238<td width="0%">
239</td>
240<tr valign="top" align="left">
241<td width="10%"></td>
242<td width="3%">
243
244<p><b>&minus;W</b></p>
245</td>
246<td width="5%"></td>
247<td width="80%">
248
249<p>Assume input data was encoded with black as 1 and white
250as 0 (default).</p>
251</td>
252<td width="0%">
253</td>
254<tr valign="top" align="left">
255<td width="10%"></td>
256<td width="3%">
257
258<p><b>&minus;R</b></p>
259</td>
260<td width="5%"></td>
261<td width="80%">
262
263<p>Specify the vertical resolution, in lines/inch, of the
264input images. By default input are assumed to have a
265vertical resolution of 196 lines/inch. If images are low
266resolution facsimile, a value of 98 lines/inch should be
267specified.</p>
268</td>
269<td width="0%">
270</td>
271<tr valign="top" align="left">
272<td width="10%"></td>
273<td width="3%">
274
275<p><b>&minus;X</b></p>
276</td>
277<td width="5%"></td>
278<td width="80%">
279
280<p>Specify the width, in pixels, of the input images. By
281default input are assumed to have a width of 1728
282pixels.</p>
283</td>
284<td width="0%">
285</td>
286</table>
287<!-- INDENTATION -->
288<table width="100%" border=0 rules="none" frame="void"
289 cols="2" cellspacing="0" cellpadding="0">
290<tr valign="top" align="left">
291<td width="8%"></td>
292<td width="91%">
293<p>Options that affect the output file format are:</p>
294</td>
295</table>
296<!-- TABS -->
297<table width="100%" border=0 rules="none" frame="void"
298 cols="5" cellspacing="0" cellpadding="0">
299<tr valign="top" align="left">
300<td width="10%"></td>
301<td width="3%">
302
303<p><b>&minus;o</b></p>
304</td>
305<td width="5%"></td>
306<td width="80%">
307
308<p>Specify the name of the output file.</p>
309</td>
310<td width="0%">
311</td>
312<tr valign="top" align="left">
313<td width="10%"></td>
314<td width="3%">
315
316<p><b>&minus;7</b></p>
317</td>
318<td width="5%"></td>
319<td width="80%">
320
321<p>Force output to be compressed with the
322<small>CCITT</small> Group 3 Huffman encoding algorithm
323(default).</p>
324</td>
325<td width="0%">
326</td>
327<tr valign="top" align="left">
328<td width="10%"></td>
329<td width="3%">
330
331<p><b>&minus;8</b></p>
332</td>
333<td width="5%"></td>
334<td width="80%">
335
336<p>Force output to be compressed with the
337<small>CCITT</small> Group 4 Huffman encoding.</p>
338</td>
339<td width="0%">
340</td>
341<tr valign="top" align="left">
342<td width="10%"></td>
343<td width="3%">
344
345<p><b>&minus;u</b></p>
346</td>
347<td width="5%"></td>
348<td width="80%">
349
350<p>Force output to be uncompressed (Group 3 or Group
3514).</p>
352</td>
353<td width="0%">
354</td>
355<tr valign="top" align="left">
356<td width="10%"></td>
357<td width="3%">
358
359<p><b>&minus;5</b></p>
360</td>
361<td width="5%"></td>
362<td width="80%">
363
364<p>Force output to be encoded with the 1-dimensional
365version of the <small>CCITT</small> Group 3 Huffman encoding
366algorithm.</p>
367</td>
368<td width="0%">
369</td>
370<tr valign="top" align="left">
371<td width="10%"></td>
372<td width="3%">
373
374<p><b>&minus;6</b></p>
375</td>
376<td width="5%"></td>
377<td width="80%">
378
379<p>Force output to be encoded with the 2-dimensional
380version of the <small>CCITT</small> Group 3 Huffman encoding
381algorithm (default).</p>
382</td>
383<td width="0%">
384</td>
385<tr valign="top" align="left">
386<td width="10%"></td>
387<td width="3%">
388
389<p><b>&minus;a</b></p>
390</td>
391<td width="5%"></td>
392<td width="80%">
393
394<p>Force the last bit of each <i>End Of Line</i> (
395<small>EOL</small> ) code to land on a byte boundary
396(default). This &lsquo;&lsquo;zero padding&rsquo;&rsquo;
397will be reflected in the contents of the
398<i>Group3Options</i> tag of the resultant
399<small>TIFF</small> file. This option has effect with Group
4003 encoded output only.</p>
401</td>
402<td width="0%">
403</td>
404<tr valign="top" align="left">
405<td width="10%"></td>
406<td width="3%">
407
408<p><b>&minus;p</b></p>
409</td>
410<td width="5%"></td>
411<td width="80%">
412
413<p>Do not EOL-align output. This option has effect with
414Group 3 encoded output only.</p>
415</td>
416<td width="0%">
417</td>
418<tr valign="top" align="left">
419<td width="10%"></td>
420<td width="3%">
421
422<p><b>&minus;c</b></p>
423</td>
424<td width="5%"></td>
425<td width="80%">
426
427<p>Generate &quot;classic&quot; Group 3 TIFF format.</p>
428</td>
429<td width="0%">
430</td>
431<tr valign="top" align="left">
432<td width="10%"></td>
433<td width="3%">
434
435<p><b>&minus;f</b></p>
436</td>
437<td width="5%"></td>
438<td width="80%">
439
440<p>Generate TIFF Class F (TIFF/F) format (default).</p>
441</td>
442<td width="0%">
443</td>
444<tr valign="top" align="left">
445<td width="10%"></td>
446<td width="3%">
447
448<p><b>&minus;m</b></p>
449</td>
450<td width="5%"></td>
451<td width="80%">
452
453<p>Force output data to have bits filled from most
454significant bit ( <small>MSB</small> ) to most least bit (
455<small>LSB</small> ).</p>
456</td>
457<td width="0%">
458</td>
459<tr valign="top" align="left">
460<td width="10%"></td>
461<td width="3%">
462
463<p><b>&minus;l</b></p>
464</td>
465<td width="5%"></td>
466<td width="80%">
467
468<p>Force output data to have bits filled from least
469significant bit ( <small>LSB</small> ) to most significant
470bit ( <small>MSB</small> ) (default).</p>
471</td>
472<td width="0%">
473</td>
474<tr valign="top" align="left">
475<td width="10%"></td>
476<td width="3%">
477
478<p><b>&minus;r</b></p>
479</td>
480<td width="5%"></td>
481<td width="80%">
482
483<p>Specify the number of rows (scanlines) in each strip of
484data written to the output file. By default (or when value
485<b>0</b> is specified), <i>tiffcp</i> attempts to set the
486rows/strip that no more than 8 kilobytes of data appear in a
487strip (with except of G3/G4 compression schemes). If you
488specify special value <b>&minus;1</b> it will results in
489infinite number of the rows per strip. The entire image will
490be the one strip in that case. This is default in case of
491G3/G4 output compression schemes.</p>
492</td>
493<td width="0%">
494</td>
495<tr valign="top" align="left">
496<td width="10%"></td>
497<td width="3%">
498
499<p><b>&minus;s</b></p>
500</td>
501<td width="5%"></td>
502<td width="80%">
503
504<p>Stretch the input image vertically by writing each input
505row of data twice to the output file.</p>
506</td>
507<td width="0%">
508</td>
509<tr valign="top" align="left">
510<td width="10%"></td>
511<td width="3%">
512
513<p><b>&minus;v</b></p>
514</td>
515<td width="5%"></td>
516<td width="80%">
517
518<p>Force <i>fax2tiff</i> to print the number of rows of
519data it retrieved from the input file.</p>
520</td>
521<td width="0%">
522</td>
523<tr valign="top" align="left">
524<td width="10%"></td>
525<td width="3%">
526
527<p><b>&minus;z</b></p>
528</td>
529<td width="5%"></td>
530<td width="80%">
531
532<p>Force output to be compressed with the LZW encoding.</p>
533</td>
534<td width="0%">
535</td>
536</table>
537<a name="DIAGNOSTICS"></a>
538<h2>DIAGNOSTICS</h2>
539<!-- INDENTATION -->
540<table width="100%" border=0 rules="none" frame="void"
541 cols="2" cellspacing="0" cellpadding="0">
542<tr valign="top" align="left">
543<td width="8%"></td>
544<td width="91%">
545<p>The following warnings and errors come from the decoding
546routines in the library.</p>
547<!-- INDENTATION -->
548<p><b>Warning, %s: Premature EOL at scanline %d (x
549%d).\n</b>. The input data had a row that was shorter than
550the expected width. The row is padded with white.</p>
551<!-- INDENTATION -->
552<p><b>%s: Premature EOF at scanline %d (x %d).\n</b>. The
553decoder ran out of data in the middle of a scanline. The
554resultant row is padded with white.</p>
555<!-- INDENTATION -->
556<p><b>%s: Bad code word at row %d, x %d\n</b>. An invalid
557Group 3 <i>code</i> was encountered while decoding the input
558file. The row number and horizontal position is given. The
559remainder of the input row is discarded, while the
560corresponding output row is padded with white.</p>
561<!-- INDENTATION -->
562<p><b>%s: Bad 2D code word at scanline %d.\n</b>. An invalid
563Group 4 or 2D Group 3 <i>code</i> was encountered while
564decoding the input file. The row number and horizontal
565position is given. The remainder of the input row is
566discarded, while the corresponding output row is padded with
567white.</p>
568</td>
569</table>
570<a name="BUGS"></a>
571<h2>BUGS</h2>
572<!-- INDENTATION -->
573<table width="100%" border=0 rules="none" frame="void"
574 cols="2" cellspacing="0" cellpadding="0">
575<tr valign="top" align="left">
576<td width="8%"></td>
577<td width="91%">
578<p>Input data are assumed to have a a &lsquo;&lsquo;top
579left&rsquo;&rsquo; orientation; it should be possible to
580override this assumption from the command line.</p>
581</td>
582</table>
583<a name="SEE ALSO"></a>
584<h2>SEE ALSO</h2>
585<!-- INDENTATION -->
586<table width="100%" border=0 rules="none" frame="void"
587 cols="2" cellspacing="0" cellpadding="0">
588<tr valign="top" align="left">
589<td width="8%"></td>
590<td width="91%">
591<p><b><small>CCITT</small> Recommendation T.4</b>
592(Standardization of Group 3 Facsimile Apparatus for Document
593Transmission).</p>
594<!-- INDENTATION -->
595<p><b>The Spirit of TIFF Class F</b>, an appendix to the
596TIFF 5.0 specification prepared by Cygnet Technologies.</p>
597<!-- INDENTATION -->
598<p><b>tiffinfo</b>(1), <b>tiffdither</b>(1),
599<b>tiffgt</b>(1), <b>libtiff</b>(3)</p>
600<!-- INDENTATION -->
601<p>Libtiff library home page:
602<b>http://www.remotesensing.org/libtiff/</b></p>
603</td>
604</table>
605<hr>
606</body>
607</html>