help.jsp revision 8e4e27126852837892d11016ca62f6b8f51997b8
cd348e325366620fe047edcc849e3c9424828599Peter BrayCDDL HEADER START
cd348e325366620fe047edcc849e3c9424828599Peter BrayThe contents of this file are subject to the terms of the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayCommon Development and Distribution License (the "License").
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayYou may not use this file except in compliance with the License.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BraySee LICENSE.txt included in this distribution for the specific
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Braylanguage governing permissions and limitations under the License.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayWhen distributing Covered Code, include this CDDL HEADER in each
2b024356b830395446c55f50f9f724a63612e578Lubos Koscofile and include the License file at LICENSE.txt.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayIf applicable, add the following below this CDDL HEADER, with the
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Brayfields enclosed by brackets "[]" replaced with your own identifying
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Brayinformation: Portions Copyright [yyyy] [name of copyright owner]
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayCDDL HEADER END
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayCopyright 2007 Sun Microsystems, Inc. All rights reserved.
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter BrayUse is subject to license terms.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayPortions Copyright 2011 Jens Elkner.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray--%><%@ page session="false" errorPage="error.jsp" import="
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray/* ---------------------- help.jsp start --------------------- */
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray cfg = PageConfig.get(request);
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal cfg.setTitle("OpenGrok Help");
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <div id="page">
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <div id="whole_header">
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <div id="header"><%@
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <div id="Masthead"></div>
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <div id="sbar">
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <div id="menu"><%@
c577d2f6c082eaff9af5bc997d12f3d3bcef537cPeter Bray <div id="help">
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos KoscoA <dfn>Query</dfn> is a series of clauses. A clause may be prefixed by:</p>
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <li>a plus "<b>+</b>" or a minus "<b>-</b>" sign, indicating that the clause
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal is required or prohibited respectively; or</li>
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <li>a <dfn>term</dfn> followed by a colon "<b>:</b>", indicating the
cd348e325366620fe047edcc849e3c9424828599Peter Bray <dfn>field</dfn> to be searched. This enables one to construct queries
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal which search multiple <dfn>fields</dfn>.</li>
cd348e325366620fe047edcc849e3c9424828599Peter Bray<p>A clause may be either:</p>
6c8465e3b4611cb632cba9b0572e3e3737c8c341Vladimir Kotal <li>a <dfn>term</dfn>, indicating all the documents that contain this term;
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <li>a <dfn>phrase</dfn> - group of words surrounded by double quotes
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <b>" "</b>, e.g. "hello dolly" </li>
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <li>a nested query, enclosed in parentheses "<b>(</b>" "<b>)</b>" (also
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal called query/field <dfn>grouping</dfn>) . Note that this may be used
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal with a +/- prefix to require any of a set of terms. </li>
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <li>boolean <dfn>operators</dfn> which allow terms to be combined through
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal logic operators. Supported are <b>AND</b>(<b>&&</b>), "<b>+</b>",
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <b>OR</b>(<b>||</b>), <b>NOT</b>(<b>!</b>) and "<b>-</b>" (Note: they
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal must be ALL CAPS).</li>
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal<p>Wildcard, Fuzzy, Proximity & Range Searches:</p>
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <li>to perform a single character wildcard search use the "<b>?</b>" symbol,
cd348e325366620fe047edcc849e3c9424828599Peter Bray <li>to perform a multiple character wildcard search use the "<b>*</b>"
cd348e325366620fe047edcc849e3c9424828599Peter Bray symbol, e.g. test* or te*t</li>
cd348e325366620fe047edcc849e3c9424828599Peter Bray <li>you cannot use a * or ? symbol as the first character of a search
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray (unless enabled using indexer option -a).</li>
cd348e325366620fe047edcc849e3c9424828599Peter Bray <li>to do a fuzzy search(find words similar in spelling, based on the
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Kosco Levenshtein Distance, or Edit Distance algorithm) use the tilde,
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Kosco "<b>~</b>", e.g. rcs~ </li>
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <li>to do a proximity search use the tilde, "~", symbol at the end of a
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal Phrase. For example to search for a "opengrok" and "help" within 10
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Kosco words of each other enter: "opengrok help"~10 </li>
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal <li>range queries allow one to match documents whose field(s) values are
43dac746513591adbd09bc4f417feb385f4fd87eVladimir Kotal between the lower and upper bound specified by the Range Query. Range
2cf31ec93bd5d8a2efeab511ce051da51e69aedaLubos Kosco Queries can be inclusive or exclusive of the upper and lower bounds.
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco Sorting is done lexicographically. Inclusive queries are denoted by
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray square brackets <b>[ ]</b> , exclusive by curly brackets <b>{ }</b>.
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray For example: title:{Aida TO Carmen} - will find all documents between
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray Aida to Carmen, exclusive of Aida and Carmen. </li>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<a id="escaping"><dfn>Escaping special characters:</dfn></a>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<p>Opengrok supports escaping special characters that are part of the query
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray syntax. Current special characters are:<br/>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray <b>+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ </b><br/>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayTo escape these character use the \ before the character. For example to search
cd348e325366620fe047edcc849e3c9424828599Peter Brayfor <b>(1+1):2</b> use the query: <b>\(1\+1\)\:2</b>
cd348e325366620fe047edcc849e3c9424828599Peter Bray<p>NOTE on analyzers: Indexed words are made up of Alpha-Numeric and Underscore
cd348e325366620fe047edcc849e3c9424828599Peter Braycharacters. One letter words are usually not indexed as symbols!<br/>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayMost other characters(including single and double quotes) are treated as
cd348e325366620fe047edcc849e3c9424828599Peter Bray"spaces/whitespace"(so even if you escape them, they will not be found, since
cd348e325366620fe047edcc849e3c9424828599Peter Braymost analyzers ignore them). <br/>
cd348e325366620fe047edcc849e3c9424828599Peter BrayThe exceptions are: <b>@ $ % ^ & = ? . :</b> which are mostly indexed as
cd348e325366620fe047edcc849e3c9424828599Peter Brayseparate words.<br/>
cd348e325366620fe047edcc849e3c9424828599Peter BrayBecause some of them are part of the query syntax, they must be escaped with a
cd348e325366620fe047edcc849e3c9424828599Peter Brayreverse slash as noted above.<br/>
cd348e325366620fe047edcc849e3c9424828599Peter BraySo searching for <b>\+1</b> or <b>\+ 1</b> will both find <b>+1</b> and <b>+ 1</b>.
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<p>valid <dfn>FIELDs</dfn> are</p>
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco <dl class="fields">
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<dt>full</dt>
0ca9a2c194523c517c3aafe5758e217ac88d6baaLubos Kosco<dd>Search through all text tokens(words,strings,identifiers,numbers) in index.</dd>
5762c9f28c2246777be0e9d49cb29d9c0f49146dLubos Kosco<dt>defs</dt>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<dd>Only finds symbol definitions.</dd>
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray<dt>refs</dt>
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray<dd>Only finds symbols.</dd>
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray<dt>path</dt>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<dd>path of the source file.</dd>
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray<dt>hist</dt>
b34561d2c3d92fac37dbced05ba6a8738e3d20e9Lubos Kosco<dd>History log comments.</dd>
5e6c91d7e77062129cd0b6ac8aaa546dff216419Lubos Koscothe term(phrases) can be boosted (making it more relevant) using a caret
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<b>^</b> , e.g. help^4 opengrok - will make term help boosted
cd348e325366620fe047edcc849e3c9424828599Peter Bray<dfn><b>Examples:</b></dfn>
cd348e325366620fe047edcc849e3c9424828599Peter Bray<pre class="example">
cd348e325366620fe047edcc849e3c9424828599Peter BrayTo find where setResourceMonitors is defined: <a
cd348e325366620fe047edcc849e3c9424828599Peter Brayhref="search?q=&defs=setResourceMonitors">defs:setResourceMonitors</a>
cd348e325366620fe047edcc849e3c9424828599Peter BrayTo find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<a href="search?refs=sprintf&path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F"
cd348e325366620fe047edcc849e3c9424828599Peter Bray>refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
cd348e325366620fe047edcc849e3c9424828599Peter BrayTo find assignments to variable Asign:
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<a href="search?q=%22asign+%3D+%22">"Asign="</a>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter BrayTo find Makefiles where pstack binary is being built:
cd348e325366620fe047edcc849e3c9424828599Peter Bray<a href="search?q=pstack&path=Makefile">pstack path:Makefile</a>
cd348e325366620fe047edcc849e3c9424828599Peter Brayto search for phrase "Bill Joy":
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos Kosco<a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos KoscoTo find perl files that do not use /usr/bin/perl but something else:
d7c1415de39f4b07c85828f49cd1ee7a2a19eb9eLubos Kosco<a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22"
c842732324ee4c74ede17887ad1f0dcdc4364a2cLubos KoscoTo find all strings begining with foo use the wildcard:
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray<a href="search?q=foo*">foo*</a>
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter BrayTo find all files which have . c in their name(dot is a token!):
d280c5e286f5b98be13237f52281ae5afdcf51b9Peter Bray<a href="search?path=%22. c%22">". c"</a>
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray<p>Opengrok search is powered by <a href="http://lucene.apache.org/"
d2a02e104622a26dd90fa88f4f17188f2039809fPeter Bray>lucene</a>, for more detail on query syntax refer to lucene docs.</p>
cd348e325366620fe047edcc849e3c9424828599Peter Bray/* ---------------------- help.jsp end --------------------- */
cd348e325366620fe047edcc849e3c9424828599Peter Brayinclude file="foot.jspf"