help.html revision bb191b4db2657326cea4ebb7a8d0508b6ab84929
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
<head>
<link rel="icon" href="img/icon.png" type="image/png"/>
<link rel="stylesheet" type="text/css" href="style.css"/>
<link rel="stylesheet" type="text/css" href="print.css" media="print"/>
<link rel="alternate stylesheet" type="text/css" media="all" title="Paper White" href="print.css"/>
<title>OpenGrok Help</title>
</head>
<body>
<div id="page">
<div id="header"> <!-- CONFIG: Header -->
<div id="MastheadLogo"> <h1> OpenGrok </h1> </div>
</div>
<div id="Masthead"></div>
<div id="bar">
<table cellpadding="0" cellspacing="0" border="0" width="100%">
<tr><td valign="top"><br /> &nbsp;</td><td align="left" valign="middle"><br/>
<form action="search" name="sbox">
<table cellpadding="2" border="0" cellspacing="0">
<tr><td align="right"> Full&nbsp;Search (q) </td><td><input class="q" name="q" size="45" value=""/></td></tr>
<tr><td align="right"> Definition (defs) </td><td><input class="q" name="defs" size="25" value=""/></td></tr>
<tr><td align="right"> Symbol (refs) </td><td><input class="q" name="refs" size="25" value=""/></td></tr>
<tr><td align="right"> File&nbsp;Path (path) </td><td><input class="q" name="path" size="25" value=""/></td></tr>
<tr><td align="right"> History (hist) </td><td><input class="q" name="hist" size="25" value=""/></td></tr>
<tr><td></td><td> &nbsp; <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>
</table>
</form>
</td></tr></table>
</div>
<div id="results"><p>
A Query is a series of clauses. A clause may be prefixed by:
<ul>
<li>a plus (+) or a minus (-) sign, indicating that the clause is required or prohibited respectively; or
<li>a term followed by a colon, indicating the field to be searched. This enables one to construct queries which search multiple fields.
</ul>
A clause may be either:
<ul>
<li> a term, indicating all the documents that contain this term; or
<li> a nested query, enclosed in parentheses (). Note that this may be used with a +/- prefix to require any of a set of terms.
</ul>
valid FIELDs are
<pre>
full: Full text search.
defs: Only finds symbol definitions.
refs: Only finds symbols.
path: path of the source file.
hist: History log comments
</pre>
<b>Examples</b>
<pre>
To find where setResourceMonitors is defined
<a href="search?q=&defs=setResourceMonitors">defs:setResourceMonitors</a>
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 assignments to variable Asign
<a href="search?q=%22asign+%3D+%22">"Asign="</a>
To find Makefiles where pstack binary is being built
<a href="search?q=pstack&path=Makefile">pstack path:Makefile</a>
to search for phrase "Bill Joy":
<a href="search?q=%22Bill+Joy%22">"Bill Joy"</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>
</pre></p>
</div>
<div id="Footer">
<p class="Center">
<!-- CONFIG: Footer -->
</p>
</div>
</div>
</body>
</html>