To find where setResourceMonitors is defined:
defs:setResourceMonitors
To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/:
refs:sprintf path:usr/src/cmd/cmd-inet/usr.sbin
To find assignments to variable foo:
"foo ="
To find Makefiles where the pstack
binary is being built:
pstack path:Makefile
to search for phrase "Bill Joy":
"Bill Joy"
To find perl files that do not use /usr/bin/perl but something else:
-"/usr/bin/perl" +"/bin/perl"
To find all strings beginning with foo use the wildcard:
foo*
To find all files which have . c in their name (dot is a token!):
". c"
To find all files which start with "ma" and then have only alphabet characters do:
path:/ma[a-zA-Z]*/
To find all main methods in all files analyzed by C analyzer (so .c, .h, ...) do:
main type:c
+
" or a minus "-
" sign, indicating that the clause
is required or prohibited respectively; or:
", indicating the
field to be searched. This enables one to construct queries
which search multiple fields.A clause may be either:
" "
, e.g. "hello dolly" (
" ")
" (also
called query/field grouping) . Note that this may be used
with a +/- prefix to require any of a set of terms. AND
(&&
), "+
",
OR
(||
), NOT
(!
) and "-
" (Note: they
must be ALL CAPS).Regular Expression, Wildcard, Fuzzy, Proximity and Range Searches:
/
" enclosure,
e.g. /[mb]an/ - will search for man or for ban;?
" symbol,
e.g. te?t
*
"
symbol, e.g. test*
or te*t
~
", e.g. rcs~ [ ]
, exclusive by curly brackets { }
.
For example: title:{Aida TO Carmen} - will find all documents between
Aida to Carmen, exclusive of Aida and Carmen.
Opengrok supports escaping special characters that are part of the query
syntax. Current special characters are:
+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ /
To escape these character use the \ before the character. For example to
search for (1+1):2
use the query: \(1\+1\)\:2
NOTE on analyzers: Indexed words are made up of Alpha-Numeric and Underscore
characters. One letter words are usually not indexed as symbols!
Most 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).
The exceptions are: @ $ % ^ & = ? . :
which are mostly indexed as
separate words.
Because some of them are part of the query syntax, they must be escaped with a
reverse slash as noted above.
So searching for \+1
or \+ 1
will both find +1
and + 1
.
Valid FIELDs are
The term (phrases) can be boosted (making it more relevant) using a caret
^
, e.g. help^4 opengrok - will make term help boosted
Opengrok search is powered by Lucene, for more detail on query syntax refer to Lucene docs.
Key "1" toggles Intelligence Window. It gives the user many helper actions on the last symbol pointed by the mouse cursor.
Keys "2", "3", ..., "7" toggles highlighting of the last symbol pointed by the mouse cursor. This functionality is also accessible via the Intelligence Window.
Key "8" toggles un-highlighting all symbols. This functionality is also accessible via the Intelligence Window.
You can close the intelligence window either by mouse in the right upper corner or by keyboard with "Esc" key.
By '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 is 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 regardless the color of the symbol.
The 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.
You can then use your mouse to intuitively navigate yourself through the diff. Also there is a convenient shortcut for moving on your keyboard, you 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.