Home | History | Annotate | Download | only in index
      1 <?xml version="1.0" encoding="UTF-8"?>
      2 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN">
      3 <?Pub Inc>
      4 <refentry id="opengrok-1">
      5 <refmeta>
      6 <refentrytitle>opengrok</refentrytitle>
      7 <manvolnum>1</manvolnum>
      8 ___INSERT_DATE___
      9 </refmeta>
     10 <refnamediv>
     11 <refname>opengrok</refname>
     12 <refpurpose>a wicked fast source browser</refpurpose>
     13 </refnamediv>
     14 <refsynopsisdiv>
     15 <cmdsynopsis>
     16 <command>opengrok
     17 ___INSERT_USAGE___
     18 </command>
     19 </cmdsynopsis>
     20 </refsynopsisdiv>
     21 
     22 <refsect1><title>DESCRIPTION</title>
     23 <para>
     24 OpenGrok is a fast and usable source code search and cross reference
     25 engine written in pure Java. It helps you search, cross-referenece
     26 and navigate your source tree. It can understand various program file
     27 formats and version control histories.
     28 </para>
     29 </refsect1>
     30 
     31 <refsect1><title>OPTIONS</title>
     32 <variablelist termlength="medium">
     33 ___INSERT_OPTIONS___
     34 </variablelist>
     35 </refsect1>
     36 
     37 <refsect1><title>FILE FORMATS</title>
     38 <para>
     39 OpenGrok can grok various program file formats like C, C++, Shell
     40 Scripts like ksh, sh, Perl, Java, Java Class files, JAR files, ELF
     41 files, troff man pages, file archives like Zip, Gzip, BZip2, Tar 
     42 and meta language files like XML, SGML or HTML.
     43 </para>
     44 <para>
     45 OpenGrok supports various source control systems like Mercurial, CVS,
     46 Subversion, TeamWare, SCCS and Bazaar.
     47 </para>
     48 </refsect1>
     49 
     50 <refsect1><title>EXAMPLE</title>
     51 <example>
     52 <title>Indexing files in /usr/include and storing the output data to 
     53 /var/tmp/opengrok_data.</title>
     54 <screen>$ <userinput>opengrok.jar -s /usr/include -d /var/tmp/opengrok_data</userinput>
     55 </screen>
     56 </example>
     57 
     58 </refsect1>
     59 
     60 <refsect1><title>EXIT STATUS</title>
     61 <variablelist termlength="medium">
     62 <varlistentry><term>0</term><listitem><para>command executed successfully</para></listitem></varlistentry>
     63 <varlistentry><term>1</term><listitem><para>error in executing the command</para></listitem></varlistentry>
     64 </variablelist>
     65 </refsect1>
     66 </refentry>
     67