Cross Reference: /opengrok-jel/web/help.jsp
help.jsp revision 1470
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
0N/A<%--
0N/ACDDL HEADER START
0N/A
0N/AThe contents of this file are subject to the terms of the
0N/ACommon Development and Distribution License (the "License").
0N/AYou may not use this file except in compliance with the License.
0N/A
0N/ASee LICENSE.txt included in this distribution for the specific
0N/Alanguage governing permissions and limitations under the License.
0N/A
0N/AWhen distributing Covered Code, include this CDDL HEADER in each
0N/Afile and include the License file at LICENSE.txt.
0N/AIf applicable, add the following below this CDDL HEADER, with the
0N/Afields enclosed by brackets "[]" replaced with your own identifying
0N/Ainformation: Portions Copyright [yyyy] [name of copyright owner]
0N/A
0N/ACDDL HEADER END
0N/A
0N/ACopyright 2007 Sun Microsystems, Inc. All rights reserved.
0N/AUse is subject to license terms.
0N/A
0N/APortions Copyright 2011 Jens Elkner.
0N/A
0N/A--%><%@ page session="false" errorPage="error.jsp" import="
0N/Aorg.opensolaris.opengrok.web.PageConfig"
0N/A%><%
78N/A/* ---------------------- help.jsp start --------------------- */
78N/A{
0N/A cfg = PageConfig.get(request);
0N/A cfg.setTitle("OpenGrok Help");
0N/A long lmdate = cfg.getConfig().getLastModified();
58N/A if (request.getDateHeader("If-Modified-Since") >= lmdate) {
58N/A response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
58N/A return;
0N/A }
0N/A response.setDateHeader("Last-Modified", lmdate);
0N/A String prefix = request.getContextPath() + Prefix.SEARCH_P + '?';
0N/A%><%@
58N/A
0N/Ainclude file="httpheader.jspf"
0N/A
0N/A%>
0N/A<body class="yui3-skin-sam">
0N/A <div id="page">
0N/A <div id="whole_header">
0N/A <div id="header"><%@
0N/A
0N/Ainclude file="pageheader.jspf"
0N/A
0N/A %></div>
0N/A <div id="Masthead"></div>
0N/A </div>
0N/A <div id="sbar">
0N/A <div id="menu"><%@
0N/A
0N/Ainclude file="menu.jspf"
0N/A
0N/A%>
0N/A </div>
0N/A </div>
0N/A <div id="help">
0N/A<p>
66N/AA <dfn>Query</dfn> is a series of clauses. A clause may be prefixed by:</p>
<ul>
<li>a plus "<b>+</b>" or a minus "<b>-</b>" sign, indicating that the clause
is required or prohibited respectively; or</li>
<li>a <dfn>term</dfn> followed by a colon "<b>:</b>", indicating the
<dfn>field</dfn> to be searched. This enables one to construct queries
which search multiple <dfn>fields</dfn>.</li>
</ul>
<p>A clause may be either:</p>
<ul>
<li>a <dfn>term</dfn>, indicating all the documents that contain this term;
or</li>
<li>a <dfn>phrase</dfn> - group of words surrounded by double quotes
<b>" "</b>, e.g. "hello dolly" </li>
<li>a nested query, enclosed in parentheses "<b>(</b>" "<b>)</b>" (also
called query/field <dfn>grouping</dfn>) . Note that this may be used
with a +/- prefix to require any of a set of terms. </li>
<li>boolean <dfn>operators</dfn> which allow terms to be combined through
logic operators. Supported are <b>AND</b>(<b>&amp;&amp;</b>), "<b>+</b>",
<b>OR</b>(<b>||</b>), <b>NOT</b>(<b>!</b>) and "<b>-</b>" (Note: they
must be ALL CAPS).</li>
</ul>
<p>Wildcard, Fuzzy, Proximity &amp; Range Searches:</p>
<ul>
<li>to perform a single character wildcard search use the "<b>?</b>" symbol,
e.g. te?t</li>
<li>to perform a multiple character wildcard search use the "<b>*</b>"
symbol, e.g. test* or te*t</li>
<li>you cannot use a * or ? symbol as the first character of a search
(unless enabled using indexer option -a).</li>
<li>to do a fuzzy search(find words similar in spelling, based on the
Levenshtein Distance, or Edit Distance algorithm) use the tilde,
"<b>~</b>", e.g. rcs~ </li>
<li>to do a proximity search use the tilde, "~", symbol at the end of a
Phrase. For example to search for a "opengrok" and "help" within 10
words of each other enter: "opengrok help"~10 </li>
<li>range queries allow one to match documents whose field(s) values are
between the lower and upper bound specified by the Range Query. Range
Queries can be inclusive or exclusive of the upper and lower bounds.
Sorting is done lexicographically. Inclusive queries are denoted by
square brackets <b>[ ]</b> , exclusive by curly brackets <b>{ }</b>.
For example: title:{Aida TO Carmen} - will find all documents between
Aida to Carmen, exclusive of Aida and Carmen. </li>
</ul>
<a id="escaping"><dfn>Escaping special characters:</dfn></a>
<p>Opengrok supports escaping special characters that are part of the query
syntax. Current special characters are:<br/>
<b>+ - &amp;&amp; || ! ( ) { } [ ] ^ " ~ * ? : \ </b><br/>
To escape these character use the \ before the character. For example to search
for <b>(1+1):2</b> use the query: <b>\(1\+1\)\:2</b>
</p>
<p>NOTE on analyzers: Indexed words are made up of Alpha-Numeric and Underscore
characters. One letter words are usually not indexed as symbols!<br/>
Most other characters(including single and double quotes) are treated as
"spaces/whitespace"(so even if you escape them, they will not be found, since
most analyzers ignore them). <br/>
The exceptions are: <b>@ $ % ^ &amp; = ? . :</b> which are mostly indexed as
separate words.<br/>
Because some of them are part of the query syntax, they must be escaped with a
reverse slash as noted above.<br/>
So searching for <b>\+1</b> or <b>\+ 1</b> will both find <b>+1</b> and <b>+ 1</b>.
</p>
<p>valid <dfn>FIELDs</dfn> are</p>
<dl class="hlpfields">
<dt>full</dt>
<dd>Search through all text tokens(words,strings,identifiers,numbers) in index.</dd>
<dt>defs</dt>
<dd>Only finds symbol definitions.</dd>
<dt>refs</dt>
<dd>Only finds symbols.</dd>
<dt>path</dt>
<dd>path of the source file.</dd>
<dt>hist</dt>
<dd>History log comments.</dd>
</dl>
<p>
the term(phrases) can be boosted (making it more relevant) using a caret
<b>^</b> , e.g. help^4 opengrok - will make term help boosted
</p>
<dfn><b>Examples:</b></dfn>
<pre class="hlpexample">
To find where setResourceMonitors is defined: <a
href="<%= prefix %>q=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
<a href="<%= prefix %>refs=sprintf&amp;path=usr/src/cmd/cmd-inet/usr.sbin/"
>refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
To find assignments to variable Asign:
<a href="<%= prefix %>q=%22asign=%22">"Asign="</a>
To find Makefiles where pstack binary is being built:
<a href="<%= prefix %>q=pstack&amp;path=Makefile">pstack path:Makefile</a>
to search for phrase "Bill Joy":
<a href="<%= prefix %>q=%22Bill%20Joy%22">"Bill Joy"</a>
To find perl files that do not use /usr/bin/perl but something else:
<a href="<%= prefix %>q=-%22/usr/bin/perl%22+%22/bin/perl%22"
>-"/usr/bin/perl"+"/bin/perl"</a>
To find all strings begining with foo use the wildcard:
<a href="<%= prefix %>q=foo*">foo*</a>
To find all files which have . c in their name(dot is a token!):
<a href="<%= prefix %>path=%22.%20c%22">". c"</a>
</pre>
<p>Opengrok search is powered by <a href="http://lucene.apache.org/"
>lucene</a>, for more detail on query syntax refer to lucene docs.</p>
</div>
<%
}
/* ---------------------- help.jsp end --------------------- */
%><%@
include file="foot.jspf"
%>