OpenSolaris

1. Project: OpenGrok
   1. Announcements
   2. News
   3. Blogs
   4. Leaders
   5. Discussions
   6. Observers
   7. Files
   8. Documentation
      1. Story of OpenGrok
      2. Internals
      3. How to build OpenGrok from source
      4. How to install OpenGrok
   9. Tentative Roadmap

OpenSolaris Project: OpenGrok

View the leaders for this project
Project Observers

Endorsing communities

Internationalization and Localization
Tools


"A wicked fast source browser"

OpenGrok is a fast and usable source code search and cross reference engine. It helps you search, cross-reference and navigate your source tree. It can understand various program file formats and version control histories like Mercurial, Git, SCCS, RCS, CVS, Subversion, Teamware, ClearCase, Perforce and Bazaar. In other words it lets you grok (profoundly understand) the open source, hence the name OpenGrok. It is written in Java.

OpenGrok is the tool used for the OpenSolaris source browser and search.

Downloads opengrok-0.6.1.tar.gz (4.8M) - Binaries only opengrok-0.6.1-src.tar.gz (1.5M) - Source only OSOLopengrok-0.6.1.pkg (5.6M) - Solaris Package

Requirements Latest Java (At least 1.5) A servlet container like GlassFish or Tomcat (5.x or later) Exuberant Ctags Subversion 1.3.0 (or newer) if subversion support is needed Mercurial 0.9.3 (or newer) if Mercurial support is needed

Screenshots

Features

OpenGrok provides

• A fast search engine for programs, that can:
  • search for full text, definitions, symbols, path and revision history
  • limit searches to any subtree (hierarchical search)
  • incrementally update its index. i.e update only the changed files since last time it was updated
  • search query with Google like syntax (eg. path:Makefile defs:target)
  • search for files modified within a date range
  • search using wild cards like * (many characters) or ? (one character)
  • show the matching lines in search results
• A read-only web interface for version control systems like Mercurial, CVS, SVN, SCCS or TeamWare that provides:
  • history log of a file
  • diffs between any two revision in formats like udiffs, sdiffs
  • cumulative history of a given directory (putback-log) also in RSS format
• Online cross-reference with syntax high lighting, highly customizable look and feel using CSS stylesheets
• Plugins can be written for new programing language or revision control systems
• A stand alone GUI that can be used like cscope which integrates well with your favorite editor

More information on setting up OpenGrok, its usage and known issues can be found on Documentation page.
You can install the Solaris package by running pkgadd -d http://www.opensolaris.org/os/project/opengrok/files/OSOLopengrok-0.6.1.pkg

Comparison with Similar Tools

Feature	LXR	ctags	cscope	ViewVC	OpenGrok
Full text Search	Y		#		Y
Definition Search	#	Y	Y		Y
Identifier Search	Y		Y		Y
Path search	Y		Y		Y
History Search					Y
Shows matching lines		Y	Y		Y
Hierarchical Search					Y
query syntax like AND, OR, field:					Y
Incremental update					Y
Syntax highlighting-Xref	Y			#	Y
Interface for SCM				Y	Y
open source		Y	Y	Y	Y
Usable URLs	Y	-	-		Y
Individual file download		-	-	Y	Y
Changes at directory level		-	-	#	Y
Multi language support	#	Y	#	-	Y

Legend:
Y : Yes the feature is present
# : the feature may be partly present
- : not applicable

Send your ideas for improvement or contributions to OpenGrok-discuss Forum. Bugs or feature requests should be reported at http://defect.opensolaris.org.

License

OpenGrok is an open source project and is distributed under CDDL.
OpenGrok uses software libraries from Apache Software Foundation.
This product includes software developed by CollabNet (http://www.Collab.Net/).

Announcements

11 Apr 2008	OpenGrok 0.6.1 released
12 Mar 2008	OpenGrok 0.6 released
01 Nov 2007	OpenGrok category added to Bugzilla at defect.opensolaris.org
20 Aug 2007	OpenGrok 0.5 released
08 Dec 2006	Source code repository available

News

OpenGrok 0.3 Released | OSNews.com | 02/22/2006

Another release of OpenGrok, made possible due to many contributions of Trond Norbye, a new member of OpenGrok team. OpenGrok 0.3 has been released. This new version introduces support for Subversion and a new GUI. There's also an article available describing OpenGrok's internals.

Story of OpenGrok, Source Code Browser | OSNews | 12/09/2005

OpenGrok in that sense is a true enabler for source code that is open source. It lets people easily and quickly find the source code, look at it, understand the history and changes made to the source. It certainly has made my life easy when I am looking for security holes in software.

Sun releases OpenSolaris file system | ZDNet | 11/17/2005

"As part of the OpenSolaris project, the company on Tuesday also released a source code browser called OpenGrok, which is designed to help programmers search and view source code.

Blogs

trond - OpenGrok v0.7 beta is out

Sep 23, 8:54 AM

I have just released the first beta of the next version of OpenGrok, and we really need people to test it out and report bugs. You can download it from the files section on the project page at ...

chandan - To prevent auto-reply e-mails

Aug 18, 3:33 PM

To keep some of the Sun's internal processes rolling my crontab(4) has accumulated a number of scripts that are run daily. These scripts send out emails of anything from a "gentle reminder" to gory ...

Jorgen Austvik - PMD on OpenGrok

Aug 14, 3:00 PM

Hmm, I really need to come up with a new naming scheme for my blog posts. Knut Anders and Trond have been fixing FindBugs and CheckStyle warnings like crazy, and now there are just 3 FindBugs ...

Jorgen Austvik - Grokking with Style

Aug 14, 2:46 PM

I haven't had time to do much on OpenGrok lately (training for Birkebeinerrittet ), but since I am evidently the only OpenGrok developer with some style (he, he) Trond has been nagging me about ...

Jorgen Austvik - Emma in OpenGrok

Jun 5, 3:18 PM

Before I code more on OpenGrok , I need some tools. Last time I added FindBugs , and this time I add Emma, to be able to measure how well our unit tests are. Now I should be ready for some ...