help.jsp revision c0550b01024b910b8c1468811c0ea663b10b1372
4778ff543a041ac356d6e661cc9b66c3fafa2092Adam MooreCDDL HEADER START
4778ff543a041ac356d6e661cc9b66c3fafa2092Adam MooreThe contents of this file are subject to the terms of the
2c5ce90c334a2d0f18474e85c93b424b6ec9daaaAdam MooreCommon Development and Distribution License (the "License").
4778ff543a041ac356d6e661cc9b66c3fafa2092Adam MooreYou may not use this file except in compliance with the License.
dbe7d1d8fcb85b219fa0d9ab081b7724c651e63dAdam MooreSee LICENSE.txt included in this distribution for the specific
dbe7d1d8fcb85b219fa0d9ab081b7724c651e63dAdam Moorelanguage governing permissions and limitations under the License.
e125e48e3547df3d96d6f2b0e1cf71c9a12a86b5Adam MooreWhen distributing Covered Code, include this CDDL HEADER in each
e125e48e3547df3d96d6f2b0e1cf71c9a12a86b5Adam Moorefile and include the License file at LICENSE.txt.
e125e48e3547df3d96d6f2b0e1cf71c9a12a86b5Adam MooreIf applicable, add the following below this CDDL HEADER, with the
dbe7d1d8fcb85b219fa0d9ab081b7724c651e63dAdam Moorefields enclosed by brackets "[]" replaced with your own identifying
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Mooreinformation: Portions Copyright [yyyy] [name of copyright owner]
0670af1110de6616e0c87818a4ddbd048bc07b97Adam MooreCDDL HEADER END
0670af1110de6616e0c87818a4ddbd048bc07b97Adam MooreCopyright 2007 Sun Microsystems, Inc. All rights reserved.
0670af1110de6616e0c87818a4ddbd048bc07b97Adam MooreUse is subject to license terms.
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore--%><%@ page import = "org.opensolaris.opengrok.configuration.RuntimeEnvironment"
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore session="false" errorPage="error.jsp" %><%
0670af1110de6616e0c87818a4ddbd048bc07b97Adam MooreRuntimeEnvironment environment = RuntimeEnvironment.getInstance();
0670af1110de6616e0c87818a4ddbd048bc07b97Adam MooreString pageTitle = "OpenGrok Help";
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore%><%@ include file="httpheader.jspf" %>
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <div id="page">
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <div id="header"><%@ include file="pageheader.jspf" %> </div>
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <div id="Masthead"></div>
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore <div id="bar">
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <table cellpadding="0" cellspacing="0" border="0" width="100%">
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <tr><td valign="top"><br /> </td><td align="left" valign="middle"><br/>
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <form action="search" name="sbox">
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore <table cellpadding="2" border="0" cellspacing="0">
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <tr><td align="right"> Full Search (q) </td><td><input class="q" name="q" size="45" value=""/></td></tr>
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <tr><td align="right"> Definition (defs) </td><td><input class="q" name="defs" size="25" value=""/></td></tr>
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <tr><td align="right"> Symbol (refs) </td><td><input class="q" name="refs" size="25" value=""/></td></tr>
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore <tr><td align="right"> File Path (path) </td><td><input class="q" name="path" size="25" value=""/></td></tr>
0670af1110de6616e0c87818a4ddbd048bc07b97Adam Moore <tr><td align="right"> History (hist) </td><td><input class="q" name="hist" size="25" value=""/></td></tr>
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore <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>
918b08f9832633dcbf580984b649169aff501b36Adam Moore </td></tr></table>
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore <div id="results"><p>
701dfa296d4afcfc9da4c68aaa58369782ca12f4Adam Moore A Query is a series of clauses. A clause may be prefixed by:
dbe7d1d8fcb85b219fa0d9ab081b7724c651e63dAdam Moore <li>a plus (+) or a minus (-) sign, indicating that the clause is required or prohibited respectively; or
dbe7d1d8fcb85b219fa0d9ab081b7724c651e63dAdam Moore <li>a term followed by a colon, indicating the field to be searched. This enables one to construct queries which search multiple fields.
7fe7b305509bbc3a3b6fc04bc7f03ed345ed8daaAdam Moore A clause may be either:
6e1414a3787add08f9e6457d3d872d980d614862Adam Moore <li> a term, indicating all the documents that contain this term; or
6e1414a3787add08f9e6457d3d872d980d614862Adam Moore <li> a nested query, enclosed in parentheses (). Note that this may be used with a +/- prefix to require any of a set of terms.
57fe6dcf945efb6f89119a961654a9b0914ddc5cAdam Moore valid FIELDs are
57fe6dcf945efb6f89119a961654a9b0914ddc5cAdam Moore full: Full text search.
b701c311ef82111da645c974b7f65d58152447f3Adam Moore defs: Only finds symbol definitions.
b701c311ef82111da645c974b7f65d58152447f3Adam Moore refs: Only finds symbols.
57fe6dcf945efb6f89119a961654a9b0914ddc5cAdam Moore path: path of the source file.
38ace6487b8176bc771d6e0277f49015f794aa01Adam Moore hist: History log comments
f2af787d8d8c17b679458bd58b44846f12b94904Adam Moore <b>Examples</b>
4ab997398bc9c730d9fc720cd639263c2f1ac747Adam Moore To find where setResourceMonitors is defined
57fe6dcf945efb6f89119a961654a9b0914ddc5cAdam Moore <a href="search?q=&defs=setResourceMonitors">defs:setResourceMonitors</a>
3ee2f740318e77d0a50957420f1786683531f69eAdam Moore To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/
dcdf332ac871e588177e21c7cbd0045657826f84Adam Moore <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>
bf84ae48e272b3ddc103e8da28cc9ed7f30a9ba2Adam Moore To find assignments to variable Asign
ba2701ee03e94104edf19911ee0989f8cee11088Adam Moore <a href="search?q=%22asign+%3D+%22">"Asign="</a>
dcdf332ac871e588177e21c7cbd0045657826f84Adam Moore To find Makefiles where pstack binary is being built
de71a413e00aaae25fca939ce99c1c4b02869168Adam Moore <a href="search?q=pstack&path=Makefile">pstack path:Makefile</a>
1633e9a9ce15929556db15d1004e56656550d562Adam Moore to search for phrase "Bill Joy":
bf84ae48e272b3ddc103e8da28cc9ed7f30a9ba2Adam Moore <a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
b701c311ef82111da645c974b7f65d58152447f3Adam Moore To find perl files that do not use /usr/bin/perl but something else,
bf84ae48e272b3ddc103e8da28cc9ed7f30a9ba2Adam Moore <a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22">-"/usr/bin/perl" +"/bin/perl"</a>
dcdf332ac871e588177e21c7cbd0045657826f84Adam Moore <%@include file="foot.jspf"%>