.\"------------------------------------------------------------
.\" Id - set Rv,revision, and Dt, Date using rcs-Id tag.
.de Id
.ds Rv \\$3
.ds Dt \\$4
..
.Id $Id: mg_stem_idx.1 3745 2003-02-20 21:20:24Z mdewsnip $
.\"------------------------------------------------------------
.TH mg_stem_idx 1 \*(Dt CITRI
.SH NAME
mg_stem_idx \- builds a stem index file
.SH SYNOPSIS
.B mg_stem_idx
[
.B \-h
]
[
.B \-F
]
[
.BI \-b " num"
]
[
.BI \-d " directory"
]
.if n .ti +9n
.B \-s 1|2|3
.BI \-f " name"
.SH DESCRIPTION
.B mg_stem_idx
generates a stem index file for a collection that is to be built with
stem indexes.  This program should be called three times: once for each
.B -s
parameter.  It uses the stemmed dictionary to create the stem index which
contains pointers into the stemmed dictionary.
.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
.B -s 1|2|3
The stem method to apply for the stem index.
.br
1 = casefolded and non-stemmed
.br
2 = non-casefolded and stemmed
.br
3 = casefolded and stemmed
.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 25
.B *.invf.dict.blocked
Compressed stemmed dictionary.
.TP
.B *.invf.dict.blocked.1
Stem index with stem index method 1.
.TP
.B *.invf.dict.blocked.2
Stem index with stem index method 2.
.TP
.B *.invf.dict.blocked.3
Stem index with stem index method 3.
.SH "SEE ALSO"
.na
.BR mg (1),
.BR mg_invf_dict (1),
.BR mgstemidxlist (1).