.\"------------------------------------------------------------
.\" Id - set Rv,revision, and Dt, Date using rcs-Id tag.
.de Id
.ds Rv \\$3
.ds Dt \\$4
..
.Id $Id: mg_invf_dict.1 3745 2003-02-20 21:20:24Z mdewsnip $
.\"------------------------------------------------------------
.TH mg_invf_dict 1 \*(Dt CITRI
.SH NAME
mg_invf_dict \- build an `on-disk' stemmed dictionary
.SH SYNOPSIS
.B mg_invf_dict
[
.B \-h
]
[
.B \-F
]
[
.BI \-b " num"
]
[
.BI \-d " directory"
]
.if n .ti +9n
.BI \-f " name"
.SH DESCRIPTION
.B mg_invf_dict
builds an `on-disk' stemmed dictionary from the
compressed stemmed dictionary that the
.BR mgquery (1)
program can access.  Each entry in the dictionary contains the disk
pointer to the associated inverted file entry, and various other pieces
of information about the stemmed word.
.SH OPTIONS
Options may appear in any order.
.TP "\w'\fB\-d\fP \fIdirectory\fP'u+2n"
.B \-h
This displays a usage line on
.IR stderr .
.TP
.BI \-b " num"
The dictionary is stored in blocks on disk; this option is used to set
the block size.  The default is 4-KB blocks.
.TP
.B \-F
This option causes the disk blocks to be aligned on the appropriate
boundaries.  For example, if 4-KB blocks are used, they will be aligned
in the file on 4-KB boundaries.
.TP
.BI \-d " directory"
This specifies the directory where the document collection can be found.
.TP
.BI \-f " name"
This specifies the base name of the document collection.
.SH ENVIRONMENT
.TP "\w'\fBMGDATA\fP'u+2n"
.SB MGDATA
If this environment variable exists, then its value is used as the
default directory where the
.BR mg (1)
collection files are.  If this variable does not exist, then the
directory \*(lq\fB.\fP\*(rq is used by default.  The command line
option
.BI \-d " directory"
overrides the directory in
.BR MGDATA .
.SH FILES
.TP 20
.B *.invf
Inverted file.
.TP
.B *.invf.dict.build
Compressed stemmed dictionary.
.TP
.B *.invf.dict
The `on-disk' stemmed dictionary.
.TP
.B *.invf.idx
The index into the inverted file.
.SH "SEE ALSO"
.na
.BR mg (1),
.BR mg_compression_dict (1),
.BR mg_fast_comp_dict (1),
.BR mg_get (1),
.BR mg_invf_dump (1),
.BR mg_invf_rebuild (1),
.BR mg_passes (1),
.BR mg_perf_hash_build (1),
.BR mg_text_estimate (1),
.BR mg_weights_build (1),
.BR mgbilevel (1),
.BR mgbuild (1),
.BR mgdictlist (1),
.BR mgfelics (1),
.BR mgquery (1),
.BR mgstat (1),
.BR mgtic (1),
.BR mgticbuild (1),
.BR mgticdump (1),
.BR mgticprune (1),
.BR mgticstat (1).