0N/AOpenGrok - a wicked fast source browser
0N/A---------------------------------------
0N/AOpenGrok is a fast and usable source code search and cross reference
0N/Aengine, written in Java. It helps you search, cross-reference and navigate
0N/Ayour source tree. It can understand various program file formats and
115N/Aversion control histories like SCCS, RCS, CVS, Subversion and Mercurial.
0N/AOpenGrok is the tool used for the OpenSolaris Source Browser.
0N/A * A servlet container like Tomact (
5.x or later)
0N/A * Subversion 1.3.0 or later if SVN support is needed
115N/A * Mercurial 0.9.3 or later if Mercurial support is needed
115N/A * JFlex Ant task (If you want to build OpenGrok)
0N/ASRC_ROOT refers to the directory containing your source tree.
0N/AOpenGrok analyzes the source tree and builds a search index along with
0N/Across-referenced hypertext versions of the source files. These generated
0N/Adata files will be stored in DATA_ROOT directory.
0N/AOpenGrok setup Step.0 - Setting up the Sources.
0N/A----------------------------------------------
0N/ASource base must be available locally for OpenGrok to work efficiently. No
115N/Achanges are required to your source tree. If the code is under source control
115N/Amanagement (SCM) OpenGrok requires the checked out source tree under SRC_ROOT.
115N/AIt is possible for some SCM systems to use a remote repository (Subversion),
115N/Abut this is not recommended due to the performance penalty. CVS must have a
0N/ANote that OpenGrok ignores symbolic links.
0N/A---------------------------------------------------
0N/AUsing command line interface.
0N/A---------------------------------------------------
0N/AStep.1 - Populate DATA_ROOT Directory
0N/A=====================================
0N/Afor using in a cronjob to run regularly. Modify the variables in the script
0N/Ato point appropriate directories.
0N/Athe sources are all located in a directory SRC_ROOT and the data and
0N/Ahypertext files generated by OpenGrok are to be stored in DATA_ROOT, run
0N/A===============================================
0N/ATo configure the webapp
source.war, look into the parameters defined in
0N/A * HEADER: is the fragment of HTML that will be used to display title or
0N/A logo of your project
0N/A * SRC_ROOT: the absolute path name of the root directory of your source tree
0N/A * DATA_ROOT: absolute path of the directory where OpenGrok data
0N/AOptional Step.3 - Path Descriptions
0N/A-----------------------------------
0N/AOpenGrok uses path descriptions in various places (For eg. while showing
0N/Adirectory listings or search results) Example descriptions are in
paths.tsv 0N/Afile. You can list descriptions for directories one per line tab separated
0N/Aformat path tab description. Refer to example 4 below.
115N/ANote 1 - Changing webapp parameters:
web.xml is the deployment descriptor
0N/Afor the web application. It is in a Jar file named
source.war, you can
0N/A Then copy the war files to <i>TOMCAT</i>/webapps directory.
0N/A---------------------------------------------------
0N/AUsing Standalone Swing GUI
0N/A---------------------------------------------------
0N/Aopengrok.jar when invoked without any arguments, opens up the GUI search window.
0N/AThe interface is similar to cscope.
0N/ATo create an index, first select the browse button for "Search" drop down list.
0N/AChoose a directory to store the index (DATA_ROOT), and select the source tree
0N/A(SRC_ROOT). You may have to also select path to ctags in the Advanced Options,
0N/Aif exuberant ctags can not be found in the PATH.
0N/AClicking "Update" will create or update the search index.
0N/AThe index can be searched using the cscope like GUI, which lets you customize
0N/Ayour favorite editor to open the matching files.
13N/AMartin Englund, Sun Microsystems