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: mgbuild.1 16583 2008-07-29 10:20:36Z davidb $
|
---|
8 | .\"------------------------------------------------------------
|
---|
9 | .TH mgbuild 1 \*(Dt CITRI
|
---|
10 | .SH NAME
|
---|
11 | mgbuild \- build an mg system database
|
---|
12 | .SH SYNOPSIS
|
---|
13 | .B mgbuild
|
---|
14 | [
|
---|
15 | .B \-c
|
---|
16 | ]
|
---|
17 | [
|
---|
18 | .BI \-g " get"
|
---|
19 | ]
|
---|
20 | [
|
---|
21 | .BI \-s " source"
|
---|
22 | ]
|
---|
23 | [
|
---|
24 | .BI \-d " mgdata dir"
|
---|
25 | ]
|
---|
26 | .I collection-name
|
---|
27 | .SH DESCRIPTION
|
---|
28 | .B mgbuild
|
---|
29 | is a
|
---|
30 | .B csh
|
---|
31 | script that executes all the appropriate programs in the correct order
|
---|
32 | to completely build an
|
---|
33 | .BR mg (1)
|
---|
34 | system database ready for queries to be made
|
---|
35 | by
|
---|
36 | .BR mgquery.
|
---|
37 | This program makes use of the
|
---|
38 | .BR mg_get (1)
|
---|
39 | script to obtain the text of the collection.
|
---|
40 | .SH OPTIONS
|
---|
41 | Options can occur in any order, but the collection name must be last.
|
---|
42 | .TP "\w'\fIcollection-name\fP'u+2n"
|
---|
43 | .BI \-c
|
---|
44 | This specifies whether the
|
---|
45 | .I get
|
---|
46 | program is \*(lqcomplex\*(rq. If a
|
---|
47 | .I get
|
---|
48 | program is \*(lqcomplex\*(rq, then it requires initialisation and
|
---|
49 | cleanup with the
|
---|
50 | .B \-i
|
---|
51 | and
|
---|
52 | .B \-c
|
---|
53 | options.
|
---|
54 | .TP
|
---|
55 | .BI \-g " get"
|
---|
56 | This specifies the program to use for getting the source text for the
|
---|
57 | build. If no
|
---|
58 | .B \-g
|
---|
59 | option is given, the default program
|
---|
60 | .BR mg_get (1)
|
---|
61 | is used.
|
---|
62 | .TP
|
---|
63 | .BI \-s " source"
|
---|
64 | The
|
---|
65 | .B mgbuild
|
---|
66 | program consists of two parts. The first part initializes variables
|
---|
67 | to default values. The second part uses these variables to control
|
---|
68 | how the
|
---|
69 | .BR mg (1)
|
---|
70 | database is built. This option specifies a program to execute between
|
---|
71 | the first and second parts. The details of what the variables are, and
|
---|
72 | how they may be changed, are in comments in the
|
---|
73 | .B mgbuild
|
---|
74 | program.
|
---|
75 | .TP
|
---|
76 | .BI \-d " mgdata dir"
|
---|
77 | Setting this option allows one to override the MGDATA environment variable.
|
---|
78 | .TP
|
---|
79 | .I collection-name
|
---|
80 | This is the collection name, as required by the
|
---|
81 | .BR mg_get (1)
|
---|
82 | program. It serves both as a
|
---|
83 | .I case
|
---|
84 | statement selector, and as the name of a subdirectory that holds the
|
---|
85 | indexing files.
|
---|
86 | .SH ENVIRONMENT
|
---|
87 | .TP "\w'\fBMGDATA\fP'u+2n"
|
---|
88 | .SB MGDATA
|
---|
89 | If this environment variable exists, then its value is used as the
|
---|
90 | default directory where the
|
---|
91 | .BR mg (1)
|
---|
92 | collection files are. If this variable does not exist, then the
|
---|
93 | directory \*(lq\fB.\fP\*(rq is used by default. The command line
|
---|
94 | option
|
---|
95 | .BI \-d " directory"
|
---|
96 | overrides the directory in
|
---|
97 | .BR MGDATA .
|
---|
98 | .SH FILES
|
---|
99 | .TP 20
|
---|
100 | .B *.invf
|
---|
101 | Inverted file.
|
---|
102 | .TP
|
---|
103 | .B *.invf.chunk
|
---|
104 | Inverted file chunk descriptor file. When the inverted file is
|
---|
105 | created, it is written in chunks that use no more than a set amount of
|
---|
106 | memory. This file describes those chunks.
|
---|
107 | .TP
|
---|
108 | .B *.invf.chunk.trans
|
---|
109 | Word-occurrence-order to lexical-order translation file. The
|
---|
110 | .B *.invf.chunk
|
---|
111 | file is written in word-occurrence order but is required by
|
---|
112 | .B \-N2
|
---|
113 | to be in lexical order.
|
---|
114 | .TP
|
---|
115 | .B *.invf.dict
|
---|
116 | Compressed stemmed dictionary.
|
---|
117 | .TP
|
---|
118 | .B *.invf.dict.blocked
|
---|
119 | The `on-disk' stemmed dictionary.
|
---|
120 | .TP
|
---|
121 | .B *.invf.dict.hash
|
---|
122 | Data for an order-preserving perfect hash function.
|
---|
123 | .TP
|
---|
124 | .B *.invf.idx
|
---|
125 | The index into the inverted file.
|
---|
126 | .TP
|
---|
127 | .B *.weight
|
---|
128 | The exact weights file.
|
---|
129 | .TP
|
---|
130 | .B *.text
|
---|
131 | Compressed documents.
|
---|
132 | .TP
|
---|
133 | .B *.text.stats
|
---|
134 | Text statistics.
|
---|
135 | .TP
|
---|
136 | .B *.text.dict
|
---|
137 | Compressed compression dictionary.
|
---|
138 | .TP
|
---|
139 | .B *.text.idx
|
---|
140 | Index into the compressed documents.
|
---|
141 | .TP
|
---|
142 | .B *.text.idx.wgt
|
---|
143 | Interleaved index into the compressed documents and document weights.
|
---|
144 | .TP
|
---|
145 | .B *.weight.approx
|
---|
146 | Approximate document weights.
|
---|
147 | .SH "SEE ALSO"
|
---|
148 | .na
|
---|
149 | .BR mg (1),
|
---|
150 | .BR mg_compression_dict (1),
|
---|
151 | .BR mg_fast_comp_dict (1),
|
---|
152 | .BR mg_get (1),
|
---|
153 | .BR mg_invf_dict (1),
|
---|
154 | .BR mg_invf_dump (1),
|
---|
155 | .BR mg_invf_rebuild (1),
|
---|
156 | .BR mg_passes (1),
|
---|
157 | .BR mg_perf_hash_build (1),
|
---|
158 | .BR mg_text_estimate (1),
|
---|
159 | .BR mg_weights_build (1),
|
---|
160 | .BR mgbilevel (1),
|
---|
161 | .BR mgdictlist (1),
|
---|
162 | .BR mgfelics (1),
|
---|
163 | .BR mgquery (1),
|
---|
164 | .BR mgstat (1),
|
---|
165 | .BR mgtic (1),
|
---|
166 | .BR mgticbuild (1),
|
---|
167 | .BR mgticdump (1),
|
---|
168 | .BR mgticprune (1),
|
---|
169 | .BR mgticstat (1).
|
---|