2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerCDDL HEADER START
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerThe contents of this file are subject to the terms of the
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerCommon Development and Distribution License (the "License").
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerYou may not use this file except in compliance with the License.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerSee LICENSE.txt included in this distribution for the specific
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerlanguage governing permissions and limitations under the License.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerWhen distributing Covered Code, include this CDDL HEADER in each
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerfile and include the License file at LICENSE.txt.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerIf applicable, add the following below this CDDL HEADER, with the
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerfields enclosed by brackets "[]" replaced with your own identifying
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerinformation: Portions Copyright [yyyy] [name of copyright owner]
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerCDDL HEADER END
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerCopyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerUse is subject to license terms.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerPortions Copyright 2011 Jens Elkner.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger--%><%@ page session="false" errorPage="error.jsp" import="
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerorg.opensolaris.opengrok.search.SearchEngine"
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger/* ---------------------- help.jsp start --------------------- */
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger cfg.setTitle("OpenGrok Help");
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="page">
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="whole_header">
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="header"><%@
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="Masthead"></div>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="sbar">
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="menu"><%@
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <div id="help">
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h4>Examples:</h4>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<pre class="example">
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find where setResourceMonitors is defined:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=&defs=setResourceMonitors">defs:setResourceMonitors</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?refs=sprintf&path=usr%2Fsrc%2Fcmd%2Fcmd-inet%2Fusr.sbin%2F"
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger>refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find assignments to variable foo:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=%22foo+%3D%22">"foo ="</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find Makefiles where pstack binary is being built:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=pstack&path=Makefile">pstack path:Makefile</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerto search for phrase "Bill Joy":
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find perl files that do not use /usr/bin/perl but something else:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22"
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find all strings beginning with foo use the wildcard:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=foo*">foo*</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find all files which have . c in their name (dot is a token!):
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?path=%22. c%22">". c"</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find all files which start with "ma" and then have only alphabet characters do:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?path=/ma[a-zA-Z]*/">path:/ma[a-zA-Z]*/</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerTo find all main methods in all files analyzed by C analyzer (so .c, .h, ...) do:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a href="search?q=main&type=c">main type:c</a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h4>More info:</h4>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerA <dfn>Query</dfn> is a series of clauses. A clause may be prefixed by:
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>a plus "<b>+</b>" or a minus "<b>-</b>" sign, indicating that the clause
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger is required or prohibited respectively; or</li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>a <dfn>term</dfn> followed by a colon "<b>:</b>", indicating the
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dfn>field</dfn> to be searched. This enables one to construct queries
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger which search multiple <dfn>fields</dfn>.</li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<p>A <dfn>clause</dfn> may be either:</p>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>a <dfn>term</dfn>, indicating all the documents that contain this term;
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>a <dfn>phrase</dfn> - group of words surrounded by double quotes
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <b>" "</b>, e.g. "hello dolly" </li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>a nested query, enclosed in parentheses "<b>(</b>" "<b>)</b>" (also
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger called query/field <dfn>grouping</dfn>) . Note that this may be used
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger with a +/- prefix to require any of a set of terms. </li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>boolean <dfn>operators</dfn> which allow terms to be combined through
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger logic operators. Supported are <b>AND</b>(<b>&&</b>), "<b>+</b>",
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <b>OR</b>(<b>||</b>), <b>NOT</b>(<b>!</b>) and "<b>-</b>" (Note: they
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger must be ALL CAPS).</li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<p>Regular Expression, Wildcard, Fuzzy, Proximity & Range Searches:</p>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>to perform a regular expression search use the "<b>/</b>" enclosure,
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger e.g. /[mb]an/ - will search for man or for ban;<br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger NOTE: path field search escapes "/" by default, so it only supports
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger regexps when the search string <u>starts and ends</u> with "/".<br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger More info can be found on <a href="http://lucene.apache.org/core/<%=SearchEngine.LUCENE_VERSION_HELP%>/core/org/apache/lucene/util/automaton/RegExp.html?is-external=true">Lucene regexp page</a>.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>to perform a single character wildcard search use the "<b>?</b>" symbol,
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>to perform a multiple character wildcard search use the "<b>*</b>"
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger symbol, e.g. test* or te*t</li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>you can use a * or ? symbol as the first character of a search
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger (unless not enabled using indexer option -a).</li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>to do a fuzzy search (find words similar in spelling, based on the
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Levenshtein Distance, or Edit Distance algorithm) use the tilde,
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger "<b>~</b>", e.g. rcs~ </li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>to do a proximity search use the tilde, "~", symbol at the end of a
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Phrase. For example to search for a "opengrok" and "help" within 10
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger words of each other enter: "opengrok help"~10 </li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <li>range queries allow one to match documents whose field(s) values are
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger between the lower and upper bound specified by the Range Query. Range
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Queries can be inclusive or exclusive of the upper and lower bounds.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Sorting is done lexicographically. Inclusive queries are denoted by
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger square brackets <b>[ ]</b> , exclusive by curly brackets <b>{ }</b>.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger For example: title:{Aida TO Carmen} - will find all documents between
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Aida to Carmen, exclusive of Aida and Carmen. </li>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<a id="escaping"><dfn>Escaping special characters:</dfn></a>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Opengrok supports escaping special characters that are part of the query
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger syntax. Current special characters are:<br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <b>+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ / </b><br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger To escape these character use the \ before the character. For example to
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger search for <b>(1+1):2</b> use the query: <b>\(1\+1\)\:2</b>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger NOTE on analyzers: Indexed words are made up of Alpha-Numeric and Underscore
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger characters. One letter words are usually not indexed as symbols!<br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Most other characters (including single and double quotes) are treated as
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger "spaces/whitespace" (so even if you escape them, they will not be found, since
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger most analyzers ignore them). <br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger The exceptions are: <b>@ $ % ^ & = ? . :</b> which are mostly indexed as
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger separate words.<br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger Because some of them are part of the query syntax, they must be escaped with a
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger reverse slash as noted above.<br/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger So searching for <b>\+1</b> or <b>\+ 1</b> will both find <b>+1</b> and <b>+ 1</b>.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<p>Valid <dfn>FIELDs</dfn> are</p>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<dl class="fields">
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dd>Search through all text tokens (words,strings,identifiers,numbers) in index.</dd>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dd>Only finds symbol definitions (where e.g. a variable (function, ...) is defined).</dd>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dd>Only finds symbols (e.g. methods, classes, functions, variables).</dd>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dd>path of the source file (no need to use dividers, or if, then use "/" - Windows users, "\" is an escape key in Lucene query syntax! <br/>Please don't use "\", or replace it with "/").<br/>Also note that if you want just exact path, enclose it in "", e.g. "src/mypath", otherwise dividers will be removed and you get more hits.</dd>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dd>History log comments.</dd>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <dd>Type of analyzer used to scope down to certain file types (e.g. just C sources).<br/>Current mappings: <%=SearchHelper.getFileTypeDescriptions().toString()%></dd>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger The term (phrases) can be boosted (making it more relevant) using a caret
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger <b>^</b> , e.g. help^4 opengrok - will make term help boosted
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<p>Opengrok search is powered by <a href="http://lucene.apache.org/">Lucene</a>,
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergerfor more detail on query syntax refer to <a href="http://lucene.apache.org/core/<%=SearchEngine.LUCENE_VERSION_HELP%>/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Lucene docs</a>.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h4>Intelligence Window</h4>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerKey "1" toggles <dfn>Intelligence Window</dfn>. It gives the user many helper actions on the last symbol pointed by the mouse cursor.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<img src="<%= cfg.getCssDir() %>/img/intelli-window.png"/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h5>Symbol Highlighting</h5>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerKey "2" toggles highlighting of the last symbol pointed by the mouse cursor. This functionality is also accessible via the <dfn>Intelligence Window</dfn>.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerKey "3" toggles unhighlighting all symbols. This functionality is also accessible via the <dfn>Intelligence Window</dfn>.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<img src="<%= cfg.getCssDir() %>/img/symbol-highlighting.png"/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger You can close the intelligence window either by mouse in the right upper corner or by keyboard with "Esc" key.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h5>Symbol jumping</h5>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerBy 'n' for next and 'b' for back you can jump between the symbols easily only with keyboard. When there is no symbol highlighted then the jump
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergeris made to the next symbol in the file from the current one. If you have highlighted a specific symbol then the jump is done only among the highlighted symbols.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h4>Diff jumper</h4>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerThe OpenGrok also provides an easy way how to jump through the large diffs finding the interesting pieces of code. In the diff mode you can enable diff jumper by hitting the "jumper" button.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<img src="<%= cfg.getCssDir() %>/img/diff-jumper.png"/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<h5>Mouse and keyboard navigation</h5>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian KornbergerYou can then use your mouse to intuitively navigate yourself through the diff. Also there is a convenient shortcut for moving on your keyboard,
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornbergeryou can use 'n' for next and 'b' for back to jump over to the next chunk. This is available even when the jumper window is not opened.
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger<img src="<%= cfg.getCssDir() %>/img/diff-jumping.png"/>
2a9b45dd7d8aa23908850179cde8426fbcd3ce60Julian Kornberger/* ---------------------- help.jsp end --------------------- */