help.jsp revision 1120
70N/ASee LICENSE.txt included in this distribution for the specific
70N/Afile and include the License file at LICENSE.txt.
70N/A--%><%@ page import = "org.opensolaris.opengrok.configuration.RuntimeEnvironment"
70N/ARuntimeEnvironment environment = RuntimeEnvironment.getInstance();
70N/A%><%@ include file="httpheader.jspf" %>
70N/A <div id="header"><%@ include file="pageheader.jspf" %> </div>
231N/A <tr><td align="right"> Full Search (q) </td><td><input class="q" name="q" size="45" value=""/></td></tr>
98N/A <tr><td align="right"> Definition (defs) </td><td><input class="q" name="defs" size="25" value=""/></td></tr>
290N/A <tr><td align="right"> Symbol (refs) </td><td><input class="q" name="refs" size="25" value=""/></td></tr>
210N/A <tr><td align="right"> File Path (path) </td><td><input class="q" name="path" size="25" value=""/></td></tr>
128N/A <tr><td align="right"> History (hist) </td><td><input class="q" name="hist" size="25" value=""/></td></tr>
70N/A <tr><td></td><td> <input class="submit" type="submit" value=" Search "/> | <input class="submit" onclick="document.sbox.q.value='';document.sbox.defs.value='';document.sbox.refs.value='';document.sbox.path.value='';document.sbox.hist.value='';" type="button" value=" Clear "/></td></tr>
70N/A <li>a plus "<b>+</b>" or a minus "<b>-</b>" sign, indicating that the clause is required or prohibited respectively; or</li>
262N/A <li>a <u>term</u> followed by a colon "<b>:</b>", indicating the <u>field</u> to be searched. This enables one to construct queries which search multiple <u>fields</u>.</li>
280N/A <li> a <u>phrase</u> - group of words surrounded by double quotes <b>" "</b>, e.g. "hello dolly" </li>
70N/A <li> a nested query, enclosed in parentheses "<b>(</b>" "<b>)</b>" (also called query/field <u>grouping</u>) . Note that this may be used with a +/- prefix to require any of a set of terms. </li>
70N/A <li> boolean <u>operators</u> which allow terms to be combined through logic operators. Supported are <b>AND</b>(<b>&&</b>), "<b>+</b>", <b>OR</b>(<b>||</b>), <b>NOT</b>(<b>!</b>) and "<b>-</b>" (Note: they must be ALL CAPS).</li>
156N/A <li> to perform a multiple character wildcard search use the "<b>*</b>" symbol, e.g. test* or te*t</li>
156N/A <li> you cannot use a * or ? symbol as the first character of a search (unless enabled using indexer option -a).</li>
98N/A <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>
70N/A <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>
70N/A <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>
70N/A <p>Opengrok supports escaping special characters that are part of the query syntax. Current special characters are:<br/>
70N/A 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>
70N/A <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>
70N/AMost 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>
70N/AThe exceptions are: <b>@ $ % ^ & = ? . :</b> which are mostly indexed as separate words.<br>
70N/ABecause some of them are part of the query syntax, they must be escaped with a reverse slash as noted above.<br>
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
To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
<a href="search?refs=sprintf&path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F">refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
To find perl files that do not use /usr/bin/perl but something else:
<a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22">-"/usr/bin/perl" +"/bin/perl"</a>
<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>
<%@include file="foot.jspf"%>