opengrok.xml revision 260
260N/A<?xml version="1.0" encoding="UTF-8"?>
260N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN">
260N/A<?Pub Inc>
260N/A<refentry id="opengrok-1">
260N/A<refmeta>
260N/A<refentrytitle>opengrok</refentrytitle>
260N/A<manvolnum>1</manvolnum>
260N/A___INSERT_DATE___
260N/A</refmeta>
260N/A<refnamediv>
260N/A<refname>opengrok</refname>
260N/A<refpurpose>a wicked fast source browser</refpurpose>
260N/A</refnamediv>
260N/A<refsynopsisdiv>
260N/A<cmdsynopsis>
260N/A<command>opengrok
260N/A___INSERT_USAGE___
260N/A</command>
260N/A</cmdsynopsis>
260N/A</refsynopsisdiv>
260N/A
260N/A<refsect1><title>DESCRIPTION</title>
260N/A<para>
260N/AOpenGrok is a fast and usable source code search and cross reference
260N/Aengine written in pure Java. It helps you search, cross-referenece
260N/Aand navigate your source tree. It can understand various program file
260N/Aformats and version control histories.
260N/A</para>
260N/A</refsect1>
260N/A
260N/A<refsect1><title>OPTIONS</title>
260N/A<variablelist termlength="medium">
260N/A___INSERT_OPTIONS___
260N/A</variablelist>
260N/A</refsect1>
260N/A
260N/A<refsect1><title>FILE FORMATS</title>
260N/A<para>
260N/AOpenGrok can grok various program file formats like C, C++, Shell
260N/AScripts like ksh, sh, Perl, Java, Java Class files, JAR files, ELF
260N/Afiles, troff man pages, file archives like Zip, Gzip, BZip2, Tar
260N/Aand meta language files like XML, SGML or HTML.
260N/A</para>
260N/A<para>
260N/AOpenGrok supports various source control systems like Mercurial, CVS,
260N/ASubversion, TeamWare, SCCS and Bazaar.
260N/A</para>
260N/A</refsect1>
260N/A
260N/A<refsect1><title>EXAMPLE</title>
260N/A<example>
260N/A<title>Indexing files in /usr/include and storing the output data to
260N/A/var/tmp/opengrok_data.</title>
260N/A<screen>$ <userinput>opengrok.jar -s /usr/include -d /var/tmp/opengrok_data</userinput>
260N/A</screen>
260N/A</example>
260N/A
260N/A</refsect1>
260N/A
260N/A<refsect1><title>EXIT STATUS</title>
260N/A<variablelist termlength="medium">
260N/A<varlistentry><term>0</term><listitem><para>command executed successfully</para></listitem></varlistentry>
260N/A<varlistentry><term>1</term><listitem><para>error in executing the command</para></listitem></varlistentry>
260N/A</variablelist>
260N/A</refsect1>
260N/A</refentry>