Skip to content

Commit 60281ca

Browse files
Lubos KoscoLubos Kosco
authored andcommitted
improve help page, closes issue #47
1 parent e7b21c8 commit 60281ca

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

web/help.jsp

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,10 @@ A <dfn>Query</dfn> is a series of clauses. A clause may be prefixed by:</p>
7878
<p>Regular Expression, Wildcard, Fuzzy, Proximity &amp; Range Searches:</p>
7979
<ul>
8080
<li>to perform a regular expression search use the "<b>/</b>" enclosure,
81-
e.g. /[mb]an/ - will search for man or for ban;
81+
e.g. /[mb]an/ - will search for man or for ban;<br>
8282
NOTE: path field search escapes "/" by default, so it only supports
83-
regexps when the search string <u>starts and ends</u> with "/"
83+
regexps when the search string <u>starts and ends</u> with "/".<br>
84+
More info can be found on <a href="http://lucene.apache.org/core/4_3_0/core/org/apache/lucene/util/automaton/RegExp.html?is-external=true">lucene regexp page</a>.
8485
</li>
8586
<li>to perform a single character wildcard search use the "<b>?</b>" symbol,
8687
e.g. te?t</li>
@@ -148,15 +149,15 @@ the term(phrases) can be boosted (making it more relevant) using a caret
148149
<dfn><b>Examples:</b></dfn>
149150
<pre class="example">
150151

151-
To find where setResourceMonitors is defined: <a
152-
href="search?q=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
152+
To find where setResourceMonitors is defined:
153+
<a href="search?q=&amp;defs=setResourceMonitors">defs:setResourceMonitors</a>
153154

154155
To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
155156
<a href="search?refs=sprintf&amp;path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F"
156157
>refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
157158

158-
To find assignments to variable Asign:
159-
<a href="search?q=%22asign+%3D+%22">"Asign="</a>
159+
To find assignments to variable foo:
160+
<a href="search?q=%22foo+%3D%22">"foo ="</a>
160161

161162
To find Makefiles where pstack binary is being built:
162163
<a href="search?q=pstack&amp;path=Makefile">pstack path:Makefile</a>
@@ -169,15 +170,19 @@ To find perl files that do not use /usr/bin/perl but something else:
169170
>-"/usr/bin/perl" +"/bin/perl"</a>
170171

171172
To find all strings begining with foo use the wildcard:
172-
<a href="search?q=foo*">foo*</a>
173+
<a href="search?q=foo*">sefoo*</a>
173174

174175
To find all files which have . c in their name(dot is a token!):
175176
<a href="search?path=%22. c%22">". c"</a>
176177

178+
To find all files which start with "ma" and then have only alphabet characters do:
179+
<a href="search?path=/ma[a-zA-Z]*/">/ma[a-zA-Z]*/</a>
180+
177181
</pre>
178182

179183
<p>Opengrok search is powered by <a href="http://lucene.apache.org/"
180-
>lucene</a>, for more detail on query syntax refer to lucene docs.</p>
184+
>lucene</a>, for more detail on query syntax refer to <a href="http://lucene.apache.org/core/4_3_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">lucene docs</a>.<br>
185+
</p>
181186
</div>
182187
<%
183188
}

0 commit comments

Comments
 (0)