| 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_stem_idx.1 3745 2003-02-20 21:20:24Z mdewsnip $
|
|---|
| 8 | .\"------------------------------------------------------------
|
|---|
| 9 | .TH mg_stem_idx 1 \*(Dt CITRI
|
|---|
| 10 | .SH NAME
|
|---|
| 11 | mg_stem_idx \- builds a stem index file
|
|---|
| 12 | .SH SYNOPSIS
|
|---|
| 13 | .B mg_stem_idx
|
|---|
| 14 | [
|
|---|
| 15 | .B \-h
|
|---|
| 16 | ]
|
|---|
| 17 | [
|
|---|
| 18 | .B \-F
|
|---|
| 19 | ]
|
|---|
| 20 | [
|
|---|
| 21 | .BI \-b " num"
|
|---|
| 22 | ]
|
|---|
| 23 | [
|
|---|
| 24 | .BI \-d " directory"
|
|---|
| 25 | ]
|
|---|
| 26 | .if n .ti +9n
|
|---|
| 27 | .B \-s 1|2|3
|
|---|
| 28 | .BI \-f " name"
|
|---|
| 29 | .SH DESCRIPTION
|
|---|
| 30 | .B mg_stem_idx
|
|---|
| 31 | generates a stem index file for a collection that is to be built with
|
|---|
| 32 | stem indexes. This program should be called three times: once for each
|
|---|
| 33 | .B -s
|
|---|
| 34 | parameter. It uses the stemmed dictionary to create the stem index which
|
|---|
| 35 | contains pointers into the stemmed dictionary.
|
|---|
| 36 | .SH OPTIONS
|
|---|
| 37 | Options may appear in any order.
|
|---|
| 38 | .TP "\w'\fB\-d\fP \fIdirectory\fP'u+2n"
|
|---|
| 39 | .B \-h
|
|---|
| 40 | This displays a usage line on
|
|---|
| 41 | .IR stderr .
|
|---|
| 42 | .TP
|
|---|
| 43 | .BI \-b " num"
|
|---|
| 44 | The dictionary is stored in blocks on disk; this option is used to set
|
|---|
| 45 | the block size. The default is 4-KB blocks.
|
|---|
| 46 | .TP
|
|---|
| 47 | .B \-F
|
|---|
| 48 | This option causes the disk blocks to be aligned on the appropriate
|
|---|
| 49 | boundaries. For example, if 4-KB blocks are used, they will be aligned
|
|---|
| 50 | in the file on 4-KB boundaries.
|
|---|
| 51 | .TP
|
|---|
| 52 | .B -s 1|2|3
|
|---|
| 53 | The stem method to apply for the stem index.
|
|---|
| 54 | .br
|
|---|
| 55 | 1 = casefolded and non-stemmed
|
|---|
| 56 | .br
|
|---|
| 57 | 2 = non-casefolded and stemmed
|
|---|
| 58 | .br
|
|---|
| 59 | 3 = casefolded and stemmed
|
|---|
| 60 | .TP
|
|---|
| 61 | .BI \-d " directory"
|
|---|
| 62 | This specifies the directory where the document collection can be found.
|
|---|
| 63 | .TP
|
|---|
| 64 | .BI \-f " name"
|
|---|
| 65 | This specifies the base name of the document collection.
|
|---|
| 66 | .SH ENVIRONMENT
|
|---|
| 67 | .TP "\w'\fBMGDATA\fP'u+2n"
|
|---|
| 68 | .SB MGDATA
|
|---|
| 69 | If this environment variable exists, then its value is used as the
|
|---|
| 70 | default directory where the
|
|---|
| 71 | .BR mg (1)
|
|---|
| 72 | collection files are. If this variable does not exist, then the
|
|---|
| 73 | directory \*(lq\fB.\fP\*(rq is used by default. The command line
|
|---|
| 74 | option
|
|---|
| 75 | .BI \-d " directory"
|
|---|
| 76 | overrides the directory in
|
|---|
| 77 | .BR MGDATA .
|
|---|
| 78 | .SH FILES
|
|---|
| 79 | .TP 25
|
|---|
| 80 | .B *.invf.dict.blocked
|
|---|
| 81 | Compressed stemmed dictionary.
|
|---|
| 82 | .TP
|
|---|
| 83 | .B *.invf.dict.blocked.1
|
|---|
| 84 | Stem index with stem index method 1.
|
|---|
| 85 | .TP
|
|---|
| 86 | .B *.invf.dict.blocked.2
|
|---|
| 87 | Stem index with stem index method 2.
|
|---|
| 88 | .TP
|
|---|
| 89 | .B *.invf.dict.blocked.3
|
|---|
| 90 | Stem index with stem index method 3.
|
|---|
| 91 | .SH "SEE ALSO"
|
|---|
| 92 | .na
|
|---|
| 93 | .BR mg (1),
|
|---|
| 94 | .BR mg_invf_dict (1),
|
|---|
| 95 | .BR mgstemidxlist (1).
|
|---|
