help.jsp revision 849
144N/ASee LICENSE.txt included in this distribution for the specific
144N/Afile and include the License file at LICENSE.txt.
1186N/A--%><%@ page import = "org.opensolaris.opengrok.configuration.RuntimeEnvironment"
1186N/ARuntimeEnvironment environment = RuntimeEnvironment.getInstance();
1186N/A%><%@ include file="httpheader.jspf" %>
1281N/A <div id="header"><%@ include file="pageheader.jspf" %> </div>
1186N/A <tr><td align="right"> Full Search (q) </td><td><input class="q" name="q" size="45" value=""/></td></tr>
1186N/A <tr><td align="right"> Definition (defs) </td><td><input class="q" name="defs" size="25" value=""/></td></tr>
1186N/A <tr><td align="right"> Symbol (refs) </td><td><input class="q" name="refs" size="25" value=""/></td></tr>
1186N/A <tr><td align="right"> File Path (path) </td><td><input class="q" name="path" size="25" value=""/></td></tr>
1186N/A <tr><td align="right"> History (hist) </td><td><input class="q" name="hist" size="25" value=""/></td></tr>
1364N/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>
1281N/A <li>a plus "<b>+</b>" or a minus "<b>-</b>" sign, indicating that the clause is required or prohibited respectively; or</li>
1281N/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>
1186N/A <li> a <u>phrase</u> - group of words surrounded by double quotes <b>" "</b>, e.g. "hello dolly" </li>
1186N/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>
1281N/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>
1186N/A <li> to perform a single character wildcard search use the "<b>?</b>" symbol, e.g. te?t</li>
1186N/A <li> to perform a multiple character wildcard search use the "<b>*</b>" symbol, e.g. test* or te*t</li>
1281N/A <li> you cannot use a * or ? symbol as the first character of a search (unless enabled using indexer option -a).</li>
1281N/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>
1281N/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>
1281N/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>
1186N/A <p>Opengrok supports escaping special characters that are part of the query syntax. The current list special characters are:<br/>
1281N/A To escape these character use the \ before the character. For example to search for (1+1):2 use the query: \(1\+1\)\:2</p>
1186N/A 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
1281N/A To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/
1281N/A <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>
1281N/A To find perl files that do not use /usr/bin/perl but something else,
1186N/A <a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22">-"/usr/bin/perl" +"/bin/perl"</a>
1281N/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>