Home | History | Annotate | Download | only in web
      1 <%-- 
      2 CDDL HEADER START
      3 
      4 The contents of this file are subject to the terms of the
      5 Common Development and Distribution License (the "License").  
      6 You may not use this file except in compliance with the License.
      7 
      8 See LICENSE.txt included in this distribution for the specific
      9 language governing permissions and limitations under the License.
     10 
     11 When distributing Covered Code, include this CDDL HEADER in each
     12 file and include the License file at LICENSE.txt.
     13 If applicable, add the following below this CDDL HEADER, with the
     14 fields enclosed by brackets "[]" replaced with your own identifying
     15 information: Portions Copyright [yyyy] [name of copyright owner]
     16 
     17 CDDL HEADER END
     18 
     19 Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
     20 Use is subject to license terms.
     21 
     22 --%><%@ page import = "org.opensolaris.opengrok.configuration.RuntimeEnvironment"
     23              session="false" errorPage="error.jsp" %><%
     24 RuntimeEnvironment environment = RuntimeEnvironment.getInstance();
     25 environment.register();
     26 String pageTitle = "OpenGrok Help";
     27 %><%@ include file="httpheader.jspf" %>
     28 <body>
     29     <div id="page">
     30         <div id="header"><%@ include file="pageheader.jspf" %> </div>
     31         <div id="Masthead"></div>
     32         <div id="bar">
     33             <table cellpadding="0" cellspacing="0" border="0" width="100%">
     34                 <tr><td valign="top"><br /> &nbsp;</td><td align="left" valign="middle"><br/>
     35                         <form action="search" name="sbox">
     36                             <table cellpadding="2" border="0" cellspacing="0">
     37                                 <tr><td align="right"> Full&nbsp;Search (q) </td><td><input class="q" name="q" size="45" value=""/></td></tr>
     38                                 <tr><td align="right"> Definition (defs) </td><td><input class="q" name="defs" size="25" value=""/></td></tr>
     39                                 <tr><td align="right"> Symbol (refs) </td><td><input class="q" name="refs" size="25" value=""/></td></tr>
     40                                 <tr><td align="right"> File&nbsp;Path (path) </td><td><input class="q" name="path" size="25" value=""/></td></tr>
     41                                 <tr><td align="right"> History (hist) </td><td><input class="q" name="hist" size="25" value=""/></td></tr>
     42                                 <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>
     43                             </table>
     44                         </form>
     45             </td></tr></table>
     46         </div>
     47         <div id="results"><p>
     48                 A Query is a series of clauses. A clause may be prefixed by:
     49                 <ul>
     50                     <li>a plus (+) or a minus (-) sign, indicating that the clause is required or prohibited respectively; or
     51                     <li>a term followed by a colon, indicating the field to be searched. This enables one to construct queries which search multiple fields. 
     52                 </ul>
     53                 A clause may be either:
     54                 <ul>
     55                     <li> a term, indicating all the documents that contain this term; or
     56                     <li> a nested query, enclosed in parentheses (). Note that this may be used with a +/- prefix to require any of a set of terms. 
     57                 </ul>
     58                 
     59                 valid FIELDs are
     60                 <pre>
     61                     full: Full text search.
     62                     defs: Only finds symbol definitions.
     63                     refs: Only finds symbols.
     64                     path: path of the source file.
     65                     hist: History log comments
     66                 </pre>
     67                 
     68                 <b>Examples</b>
     69                 <pre>
     70                     
     71                     To find where setResourceMonitors is defined
     72                     <a href="search?q=&defs=setResourceMonitors">defs:setResourceMonitors</a>
     73                     
     74                     To find files that use sprintf in usr/src/cmd/cmd-inet/usr.sbin/
     75                     <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>
     76                     
     77                     To find assignments to variable Asign
     78                     <a href="search?q=%22asign+%3D+%22">"Asign="</a>
     79                     
     80                     To find Makefiles where pstack binary is being built
     81                     <a href="search?q=pstack&path=Makefile">pstack path:Makefile</a>
     82                     
     83                     to search for phrase "Bill Joy":
     84                     <a href="search?q=%22Bill+Joy%22">"Bill Joy"</a>
     85                     
     86                     To find perl files that do not use /usr/bin/perl but something else, 
     87                     <a href="search?q=-%22%2Fusr%2Fbin%2Fperl%22+%2B%22%2Fbin%2Fperl%22">-"/usr/bin/perl" +"/bin/perl"</a>
     88             </pre></p>
     89         </div>
     90         <%@include file="foot.jspf"%>
     91