source: gsdl/trunk/trunk/mg/man/man1/mgtic.1@ 16583

Last change on this file since 16583 was 16583, checked in by davidb, 16 years ago

Undoing change commited in r16582

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 3.1 KB
Line 
1.\"------------------------------------------------------------
2.\" Id - set Rv,revision, and Dt, Date using rcs-Id tag.
3.de Id
4.ds Rv \\$3
5.ds Dt \\$4
6..
7.Id $Id: mgtic.1 16583 2008-07-29 10:20:36Z davidb $
8.\"------------------------------------------------------------
9.TH mgtic 1 \*(Dt CITRI
10.SH NAME
11mgtic \- textual image compression.
12.SH SYNOPSIS
13.B mgtic
14.B \-e
15[
16.B \-L
17]
18[
19.B \-Q
20]
21[
22.B \-X
23]
24.I libraryfile
25.I infile
26.if n .ti +9n
27[
28.I \>compressed\-outfile
29]
30.nf
31or
32.fi
33.B mgtic
34.B \-d
35[
36.B \-L
37]
38[
39.BI \-X " libraryfile"
40]
41.I compressed-infile
42.if n .ti +9n
43[
44.I \>outfile
45]
46.SH DESCRIPTION
47This is the main routine in the
48.B mgtic
49system.
50.B mgtic
51is used to
52processes a series of files, and by using the
53.I libraryfile
54produced by
55.BR mgticbuild (1),
56compresses input files with respect to the marks contained in the
57library. On the CCITT test faxes, lossless mode achieved around 20:1
58compression, and lossy, around 40:1 compression. On more textual
59images, the amount of compression is determined by the resolution of
60the original file, and the amount of noise in the image. By default,
61.B mgtic
62will reconstruct a lossy version of the image. This
63can be changed to lossless by using the
64.B \-L
65option.
66.SH OPTIONS
67Options may appear in any order, but must come before the input
68filenames.
69.TP "\w'\fB\-X\fP \fI[libraryfile]\fP'u+2n"
70.B \-h
71This displays a usage line on
72.IR stderr .
73.TP
74.B \-e
75Encode
76.I infile
77with respect to the library.
78.TP
79.B \-d
80Decodes
81.IR compressed-infile
82with respect to the library.
83.TP
84.B \-l
85This specifies lossy mode, and is the default mode for (de)compression.
86Do not generate the residue. If used in encoding mode, does not store
87the residue in the output. If used in decoding mode, the residue (if
88it exists) is ignored.
89.TP
90.B \-L
91Use lossless mode for (de)compression, which generates the residue.
92If used in encoding mode, this stores the residue in the compressed
93output. If used in decoding mode (assuming the residue is present),
94this allows the original file to be recovered exactly.
95.TP
96.BI \-R\ filename
97Stores the residue as an external file
98.I filename
99which could possibly be stored on another medium. During
100decompression, if the residue file specified does not relate to the
101compressed file, the resulting decompressed image will be a mess.
102Note that only the width and height of the residue image is checked.
103.TP
104.BI \-Q
105Uses a quicker form of compression. This option decreases the time
106spent looking for a good match during encoding. On average this
107option decreases compression ratios, but increases compression speed.
108.TP
109.BI \-X " [libraryfile]"
110Use an external library file, instead of (de)compressing the library
111within the normal stream. When decoding, the
112.B \-X
113option must be followed by the
114.IR libraryfile .
115.SH "SEE ALSO"
116.na
117.BR mg (1),
118.BR mg_compression_dict (1),
119.BR mg_fast_comp_dict (1),
120.BR mg_get (1),
121.BR mg_invf_dict (1),
122.BR mg_invf_dump (1),
123.BR mg_invf_rebuild (1),
124.BR mg_passes (1),
125.BR mg_perf_hash_build (1),
126.BR mg_text_estimate (1),
127.BR mg_weights_build (1),
128.BR mgbilevel (1),
129.BR mgbuild (1),
130.BR mgdictlist (1),
131.BR mgfelics (1),
132.BR mgquery (1),
133.BR mgstat (1),
134.BR mgticbuild (1),
135.BR mgticdump (1),
136.BR mgticprune (1),
137.BR mgticstat (1).
Note: See TracBrowser for help on using the repository browser.