source: trunk/indexers/mg/man/man1/mgstemidxlist.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.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.Id $Id: mgstemidxlist.1 3745 2003-02-20 21:20:24Z mdewsnip $
8.\"------------------------------------------------------------
9.TH mgstemidxlist 1 \*(Dt CITRI
10.SH NAME
11mgstemidxlist \- dumps the stem index file to STDOUT in ASCII format
12.SH SYNOPSIS
13.B mgstemidxlist
14[
15.B \-h
16]
17[
18.BI \-d " directory"
19]
20.B \-s 1|2|3
21.BI \-f " name"
22.SH DESCRIPTION
23.B mgstemidxlist
24is a utility program which passes through the stem index and displays
25the information. (This program was used for debugging but is included
26for completeness!) The header information is printed out, then for each
27block in the file the block header is displayed. For each word in the
28stem index, the output is formatted as:
29
30.RS
31.I number_of_references \*(lqword\*(rq
32.br
33.RS
34.I "-> number_of_cases block 3-in-4_block offset"
35.br
36.I "-> ..."
37.RE
38.RE
39.SH OPTIONS
40Options may appear in any order.
41.TP "\w'\fB\-d\fP \fIdirectory\fP'u+2n"
42.B \-h
43This displays a usage line on
44.IR stderr .
45.TP
46.B -s 1|2|3
47The stem index file with the associated stem method.
48.br
491 = casefolded and non-stemmed
50.br
512 = non-casefolded and stemmed
52.br
533 = casefolded and stemmed
54.TP
55.BI \-d " directory"
56This specifies the directory where the document collection can be found.
57.TP
58.BI \-f " name"
59This specifies the base name of the document collection.
60.SH ENVIRONMENT
61.TP "\w'\fBMGDATA\fP'u+2n"
62.SB MGDATA
63If this environment variable exists, then its value is used as the
64default directory where the
65.BR mg (1)
66collection files are. If this variable does not exist, then the
67directory \*(lq\fB.\fP\*(rq is used by default. The command line
68option
69.BI \-d " directory"
70overrides the directory in
71.BR MGDATA .
72.SH FILES
73.TP 25
74.B *.invf.dict.blocked.1
75Stem index with stem index method 1.
76.TP
77.B *.invf.dict.blocked.2
78Stem index with stem index method 2.
79.TP
80.B *.invf.dict.blocked.3
81Stem index with stem index method 3.
82.SH "SEE ALSO"
83.na
84.BR mg (1),
85.BR mg_invf_dict (1),
86.BR mg_stem_idx (1).
Note: See TracBrowser for help on using the repository browser.