Linux Certif

Toute la documentation sur la certification Linux LPI

opengrok

NAME

opengrok - a wicked fast source browser

SYNOPSIS

opengrok q v e c /path/to/ctags R /path/to/configuration W /path/to/configuration U host:port P p /path/to/default/project Q on/off n H h /path/to/repository D j class u url r on/off L path l on/off O on/off a on/off w webapp-context i pattern A ext:analyzer m number S z number s /path/to/source/root d /path/to/data/root T number ? V .if (>(/2)) .nr x (/5)

DESCRIPTION

OpenGrok is a fast and usable source code search and cross reference engine written in pure Java. It helps you search, cross-referenece and navigate your source tree. It can understand various program file formats and version control histories.

OPTIONS

q

Run as quietly as possible

v

Print progress information as we go along

e

Economical - consumes less disk space. It does not generate hyper text cross reference files offline, but will do so on demand - which could be sightly slow.

c

Path to Exuberant Ctags from http://ctags.sf.net by default takes the Exuberant Ctags in PATH.

R

Read configuration from the specified file

W

Write the current configuration to the specified file (so that the web application can use the same configuration

U

Send the current configuration to the specified address (This is most likely the web-app configured with ConfigAddress)

P

Generate a project for each of the top-level directories in source root

p

This is the path to the project that should be selected by default in the web application(when no other project set either in cookie or in parameter). You should strip off the source root.

Q

Turn on/off quick context scan. By default only the first 32k of a file is scanned, and a '[..all..]' link is inserted if the file is bigger. Activating this may slow the server down (Note: this is setting only affects the web application)

n

Do not generate indexes, but process all other command line options

H

Generate history cache for all external repositories

h

Generate history cache for the specified repos (absolute path from source root)

D

Store history cache in a database (needs the JDBC driver in the classpath, typically derbyclient.jar or derby.jar)

j

Name of the JDBC driver class used by the history cache. Can use one of the shorthands "client" (org.apache.derby.jdbc.ClientDriver) or "embedded" (org.apache.derby.jdbc.EmbeddedDriver). Default: "client"

u

URL to the database that contains the history cache. Default: If -j specifies "embedded", "jdbc:derby:$DATA_ROOT/cachedb;create=true"; otherwise, "jdbc:derby://localhost/cachedb;create=true"

r

Turn on/off support for remote SCM systems

L

Path to the subdirectory in the web-application containing the requested stylesheet. The following factory-defaults exist: "default", "offwhite" and "polished"

l

Turn on/off locking of the Lucene database during index generation

O

Turn on/off the optimization of the index database as part of the indexing step

a

Allow or disallow leading wildcards in a search

w

Context of webapp. Default is /source. If you specify a different name, make sure to rename source.war to that name.

i

Ignore the named files or directories (supports wildcards, example: -i *.so -i *.dll)

A

Files with the named extension should be analyzed with the specified class

m

The maximum words to index in a file

S

Search for "external" source repositories and add them

z

depth of scanning for repositories in directory structure relative to source root

s

The root directory of the source tree

d

The directory where OpenGrok stores the generated data

T

The number of threads to use for index generation. By default the number of threads will be set to the number of available CPUs

?

Help

V

Print version and quit

FILE FORMATS

OpenGrok can grok various program file formats like C, C++, Shell Scripts like ksh, sh, Perl, Java, Java Class files, JAR files, ELF files, troff man pages, file archives like Zip, Gzip, BZip2, Tar and meta language files like XML, SGML or HTML.

OpenGrok supports various source control systems like Mercurial, CVS, Subversion, TeamWare, SCCS and Bazaar.

EXAMPLE

Indexing files in /usr/include and storing the output data to /var/tmp/opengrok_data.

 $ opengrok.jar -s /usr/include -d /var/tmp/opengrok_data
 .fi
 

 

EXIT STATUS

0

command executed successfully

1

error in executing the command