help.jsp revision 144
144N/A<%--
144N/ACDDL HEADER START
144N/A
144N/AThe contents of this file are subject to the terms of the
144N/ACommon Development and Distribution License (the "License").
144N/AYou may not use this file except in compliance with the License.
144N/A
144N/ASee LICENSE.txt included in this distribution for the specific
144N/Alanguage governing permissions and limitations under the License.
144N/A
144N/AWhen distributing Covered Code, include this CDDL HEADER in each
144N/Afile and include the License file at LICENSE.txt.
144N/AIf applicable, add the following below this CDDL HEADER, with the
144N/Afields enclosed by brackets "[]" replaced with your own identifying
144N/Ainformation: Portions Copyright [yyyy] [name of copyright owner]
144N/A
144N/ACDDL HEADER END
144N/A
144N/ACopyright 2007 Sun Microsystems, Inc. All rights reserved.
144N/AUse is subject to license terms.
144N/A
144N/A--%><%@ page import = "org.opensolaris.opengrok.configuration.RuntimeEnvironment"
144N/A session="false" errorPage="error.jsp" %><%
144N/ARuntimeEnvironment environment = RuntimeEnvironment.getInstance();
144N/Aenvironment.register);
144N/AString pageTitle = "OpenGrok Help";
144N/A%><%@ include file="httpheader.jspf" %>
66N/A<body>
144N/A <div id="page">
144N/A <div id="header"><%@ include file="pageheader.jspf" %> </div>
144N/A <div id="Masthead"></div>
144N/A <div id="bar">
144N/A <table cellpadding="0" cellspacing="0" border="0" width="100%">
144N/A <tr><td valign="top"><br /> &nbsp;</td><td align="left" valign="middle"><br/>
144N/A <form action="search" name="sbox">
144N/A <table cellpadding="2" border="0" cellspacing="0">
144N/A <tr><td align="right"> Full&nbsp;Search (q) </td><td><input class="q" name="q" size="45" value=""/></td></tr>
144N/A <tr><td align="right"> Definition (defs) </td><td><input class="q" name="defs" size="25" value=""/></td></tr>
144N/A <tr><td align="right"> Symbol (refs) </td><td><input class="q" name="refs" size="25" value=""/></td></tr>
144N/A <tr><td align="right"> File&nbsp;Path (path) </td><td><input class="q" name="path" size="25" value=""/></td></tr>
144N/A <tr><td align="right"> History (hist) </td><td><input class="q" name="hist" size="25" value=""/></td></tr>
144N/A <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>
144N/A </table>
144N/A </form>
144N/A </td></tr></table>
144N/A </div>
144N/A <div id="results"><p>
144N/A A Query is a series of clauses. A clause may be prefixed by:
144N/A <ul>
144N/A <li>a plus (+) or a minus (-) sign, indicating that the clause is required or prohibited respectively; or
144N/A <li>a term followed by a colon, indicating the field to be searched. This enables one to construct queries which search multiple fields.
144N/A </ul>
144N/A A clause may be either:
144N/A <ul>
144N/A <li> a term, indicating all the documents that contain this term; or
144N/A <li> a nested query, enclosed in parentheses (). Note that this may be used with a +/- prefix to require any of a set of terms.
144N/A </ul>
144N/A
144N/A valid FIELDs are
144N/A <pre>
144N/A full: Full text search.
144N/A defs: Only finds symbol definitions.
144N/A refs: Only finds symbols.
144N/A path: path of the source file.
144N/A hist: History log comments
144N/A </pre>
144N/A
144N/A <b>Examples</b>
144N/A <pre>
144N/A
144N/A To find where setResourceMonitors is defined
144N/A <a href="search?q=&defs=setResourceMonitors">defs:setResourceMonitors</a>
144N/A
144N/A To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/
144N/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>
144N/A
144N/A To find assignments to variable Asign
144N/A <a href="search?q=%22asign+%3D+%22">"Asign="</a>
144N/A
144N/A To find Makefiles where pstack binary is being built
144N/A <a href="search?q=pstack&path=Makefile">pstack path:Makefile</a>
144N/A
144N/A to search for phrase "Bill Joy":
144N/A <a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
144N/A
144N/A To find perl files that do not use /usr/bin/perl but something else,
144N/A <a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22">-"/usr/bin/perl" +"/bin/perl"</a>
144N/A </pre></p>
144N/A </div>
144N/A <%@include file="foot.jspf"%>