source: trunk/indexers/mg/man/man1/xmg.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.8 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: xmg.1 3745 2003-02-20 21:20:24Z mdewsnip $
8.\"------------------------------------------------------------
9.TH xmg 1 \*(Dt CITRI
10.SH NAME
11xmg \- An X interface to mgquery
12.SH SYNOPSIS
13.B xmg
14[
15.I collection-name
16]
17.SH DESCRIPTION
18.B xmg
19is an X interface to the
20.BR mg (1)
21information retrieval system.
22.PP
23Type a query in the ``Query'' box. The escape key clears the query text.
24.PP
25The first line or so of each matching document is listed.
26.PP
27Click on any line to show the complete document.
28.PP
29Shift-click to show the document in a new window.
30.PP
31Press
32.I Next
33and
34.I Previous
35to cycle through the list of documents (shift works here too).
36.PP
37If you change the query, existing windows continue to refer to the
38original query.
39.PP
40You can select either Boolean or ranked queries:
41.RS
42.TP "\w'\fIBoolean queries:\fP'u+2n"
43.I "Boolean queries:"
44use ``&'' for AND, ``|'' for OR, ``!'' for NOT, and parentheses for
45grouping.
46.TP
47.I "Ranked queries:"
48Documents are listed in order of relevance. A weight is shown
49alongside each. Weights are normalized to 100 for the most relevant
50document. Choose
51.I "Approximate Ranking"
52for greater retrieval speed.
53.RE
54.PP
55In document windows (other than the main window):
56.RS
57.br
58Typing `n' = next document;
59.br
60Typing `N' = next document in new window;
61.br
62Typing `p' = previous document;
63.br
64Typing `P' = previous document in new window;
65.br
66Typing `q' = close window.
67.RE
68.SH ENVIRONMENT
69.TP "\w'\fBMGDATA\fP'u+2n"
70.SB MGDATA
71If this environment variable exists, then its value is used as the
72default directory where the
73.BR mg (1)
74collection files are. If this variable does not exist, then the
75directory \*(lq\fB.\fP\*(rq is used by default. The command line
76option
77.BI \-d " directory"
78overrides the directory in
79.BR MGDATA .
80.TP
81.SB Xdefaults
82To override the default font options, use RESOURCE_MANAGER properties
83like the following in your
84.I .Xdefaults
85file:
86.IP
87.RS
88.nf
89.I "xmg.textfont: fixed"
90.I "xmg.buttonfont: fixed"
91.fi
92.RE
93.IP
94To override the default query type of ranked, use
95.IP
96.RS
97.I "xmg.querytype: boolean"
98.RE
99.IP
100To override the default collection name (the first one listed by
101.BR ls (1)
102from your MGDATA environment variable), use
103.IP
104.RS
105.I "xmg.collection: mail93"
106.RE
107.SH "SEE ALSO"
108.na
109.BR ls (1),
110.BR mg (1),
111.BR mg_compression_dict (1),
112.BR mg_fast_comp_dict (1),
113.BR mg_get (1),
114.BR mg_invf_dict (1),
115.BR mg_invf_dump (1),
116.BR mg_invf_rebuild (1),
117.BR mg_passes (1),
118.BR mg_perf_hash_build (1),
119.BR mg_text_estimate (1),
120.BR mg_weights_build (1),
121.BR mgbilevel (1),
122.BR mgbuild (1),
123.BR mgdictlist (1),
124.BR mgfelics (1),
125.BR mgquery (1),
126.BR mgtic (1),
127.BR mgticbuild (1),
128.BR mgticdump (1),
129.BR mgticprune (1),
130.BR mgticstat (1).
Note: See TracBrowser for help on using the repository browser.