source: trunk/indexers/mg/man/man1/mg_perf_hash_build.1@ 3745

Last change on this file since 3745 was 3745, checked in by mdewsnip, 21 years ago

Addition of MG package for search and retrieval

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 2.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: mg_perf_hash_build.1 3745 2003-02-20 21:20:24Z mdewsnip $
8.\"------------------------------------------------------------
9.TH mg_perf_hash_build 1 \*(Dt CITRI
10.SH NAME
11mg_perf_hash_build \- generate an order-preserving hash function for the stemmed dictionary
12.SH SYNOPSIS
13.B mg_perf_hash_build
14[
15.B \-h
16]
17[
18.BI \-r " rndseed"
19]
20[
21.BI \-d " directory"
22]
23.if n .ti +9n
24.BI \-f " name"
25.SH DESCRIPTION
26.B mg_perf_hash_build
27generates an order-preserving hashing function from the compressed
28stemmed dictionary and writes it out to disk.
29.BR mg_passes (1)
30will make use of the hash function when it builds the inverted file.
31.SH OPTIONS
32Options may appear in any order.
33.TP "\w'\fB\-d\fP \fIdirectory\fP'u+2n"
34.B \-h
35This displays a usage line on
36.IR stderr .
37.TP
38.BI \-r " rndseed"
39This specifies the random seed to be used in the generation of the
40hash function; it must be an integer. If this is not specified, the
41current time will be used as the random seed.
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
53.BR mg (1)
54collection files are. If this variable does not exist, then the
55directory \*(lq\fB.\fP\*(rq is used by default. The command line
56option
57.BI \-d " directory"
58overrides the directory in
59.BR MGDATA .
60.SH FILES
61.TP 20
62.B *.invf.dict
63Stemmed dictionary.
64.TP
65.B *.invf.dict.hash
66Data for a order-preserving perfect hash function.
67.SH "SEE ALSO"
68.na
69.BR mg (1),
70.BR mg_compression_dict (1),
71.BR mg_fast_comp_dict (1),
72.BR mg_get (1),
73.BR mg_invf_dict (1),
74.BR mg_invf_dump (1),
75.BR mg_invf_rebuild (1),
76.BR mg_passes (1),
77.BR mg_text_estimate (1),
78.BR mg_weights_build (1),
79.BR mgbilevel (1),
80.BR mgbuild (1),
81.BR mgdictlist (1),
82.BR mgfelics (1),
83.BR mgquery (1),
84.BR mgstat (1),
85.BR mgtic (1),
86.BR mgticbuild (1),
87.BR mgticdump (1),
88.BR mgticprune (1),
89.BR mgticstat (1).
Note: See TracBrowser for help on using the repository browser.