source: tags/greenstone-3_01-distribution/mgpp/text/mgpp_invf_dict.1@ 10896

Last change on this file since 10896 was 10896, checked in by (none), 18 years ago

This commit was manufactured by cvs2svn to create tag
'greenstone-3_01-distribution'.

  • Property svn:keywords set to Author Date Id Revision
File size: 2.0 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.\"------------------------------------------------------------
8.TH mgpp_invf_dict 1 \*(Dt CITRI
9.SH NAME
10mgpp_invf_dict \- build an `on-disk' stemmed dictionary
11.SH SYNOPSIS
12.B mgpp_invf_dict
13[
14.B \-h
15]
16[
17.BI \-b " entries-per-block"
18]
19.if n .ti +13n
20[
21.BI \-d " directory"
22]
23.BI \-f " name"
24.SH DESCRIPTION
25.B mgpp_invf_dict
26builds an `on-disk' stemmed dictionary from the
27compressed stemmed dictionary that can be used during querying.
28Each entry in the dictionary contains the disk
29pointer to the associated inverted file entry, and various other pieces
30of information about the stemmed word. The dictionary is blocked with
31each block containing the same number of entries (not the same size).
32.SH OPTIONS
33Options may appear in any order.
34.TP "\w'\fB\-d\fP \fIdirectoryyyyyyyy\fP'u+2n"
35.B \-h
36This displays a usage line on
37.IR stderr .
38.TP
39.BI \-b " entries-per-block"
40The dictionary is stored in blocks on disk; this option is used to
41specify the number of entries per block. The default is 16.
42.TP
43.BI \-d " directory"
44This specifies the directory where the document collection can be found.
45.TP
46.BI \-f " name"
47This specifies the base name of the document collection.
48.SH ENVIRONMENT
49.TP "\w'\fBMGDATA\fP'u+2n"
50.SB MGDATA
51If this environment variable exists, then its value is used as the
52default directory where the mgpp
53collection files are. If this variable does not exist, then the
54directory \*(lq\fB.\fP\*(rq is used by default. The command line
55option
56.BI \-d " directory"
57overrides the directory in
58.BR MGDATA .
59.SH FILES
60.TP 20
61.B *.invf
62Inverted file.
63.TP
64.B *.invf.dict
65Compressed stemmed dictionary.
66.TP
67.B *.invf.dict.blocked
68The `on-disk' stemmed dictionary.
69.TP
70.B *.invf.idx
71The index into the inverted file.
72.SH "SEE ALSO"
73.na
74.BR mgpp_compression_dict (1),
75.BR mgpp_fast_comp_dict (1),
76.BR mgpp_passes (1),
77.BR mgpp_perf_hash_build (1),
78.BR mgpp_stem_idx (1),
79.BR mgpp_weights_build (1)
Note: See TracBrowser for help on using the repository browser.