1opengrok(1) opengrok(1)
2
6 opengrok - a wicked fast source browser
7
9 opengrok q v e c /path/to/ctags R /path/to/configuration W
10 /path/to/configuration U host:port P p /path/to/default/project Q
11 on/off n H h /path/to/repository D j class u url r on/off L path l
12 on/off O on/off a on/off w webapp-context i pattern A ext:analyzer m
13 number S z number s /path/to/source/root d /path/to/data/root T number
14 ? V .if (0>(1872/2)) .nr x (1872/5)
15
17 OpenGrok is a fast and usable source code search and cross reference
18 engine written in pure Java. It helps you search, cross-referenece and
19 navigate your source tree. It can understand various program file for‐
20 mats and version control histories.
21
23 q Run as quietly as possible
24 v Print progress information as we go along
26 e Economical - consumes less disk space. It does not generate hy‐
28 per text cross reference files offline, but will do so on demand
29 - which could be sightly slow.
30 c Path to Exuberant Ctags from http://ctags.sf.net by default
32 takes the Exuberant Ctags in PATH.
33 R Read configuration from the specified file
35 W Write the current configuration to the specified file (so that
37 the web application can use the same configuration
38 U Send the current configuration to the specified address (This is
40 most likely the web-app configured with ConfigAddress)
41 P Generate a project for each of the top-level directories in
43 source root
44 p This is the path to the project that should be selected by de‐
46 fault in the web application(when no other project set either in
47 cookie or in parameter). You should strip off the source root.
48 Q Turn on/off quick context scan. By default only the first 32k of
50 a file is scanned, and a '[..all..]' link is inserted if the
51 file is bigger. Activating this may slow the server down (Note:
52 this is setting only affects the web application)
53 n Do not generate indexes, but process all other command line op‐
55 tions
56 H Generate history cache for all external repositories
58 h Generate history cache for the specified repos (absolute path
60 from source root)
61 D Store history cache in a database (needs the JDBC driver in the
63 classpath, typically derbyclient.jar or derby.jar)
64 j Name of the JDBC driver class used by the history cache. Can use
66 one of the shorthands "client" (org.apache.derby.jdbc.Client‐
67 Driver) or "embedded" (org.apache.derby.jdbc.EmbeddedDriver).
68 Default: "client"
69 u URL to the database that contains the history cache. Default: If
71 -j specifies "embedded", "jdbc:derby:$DATA_ROOT/cachedb;cre‐
72 ate=true"; otherwise, "jdbc:derby://localhost/cachedb;cre‐
73 ate=true"
74 r Turn on/off support for remote SCM systems
76 L Path to the subdirectory in the web-application containing the
78 requested stylesheet. The following factory-defaults exist: "de‐
79 fault", "offwhite" and "polished"
80 l Turn on/off locking of the Lucene database during index genera‐
82 tion
83 O Turn on/off the optimization of the index database as part of
85 the indexing step
86 a Allow or disallow leading wildcards in a search
88 w Context of webapp. Default is /source. If you specify a differ‐
90 ent name, make sure to rename source.war to that name.
91 i Ignore the named files or directories (supports wildcards, exam‐
93 ple: -i *.so -i *.dll)
94 A Files with the named extension should be analyzed with the spec‐
96 ified class
97 m The maximum words to index in a file
99 S Search for "external" source repositories and add them
101 z depth of scanning for repositories in directory structure rela‐
103 tive to source root
104 s The root directory of the source tree
106 d The directory where OpenGrok stores the generated data
108 T The number of threads to use for index generation. By default
110 the number of threads will be set to the number of available
111 CPUs
112 ? Help
114 V Print version and quit
116
118 OpenGrok can grok various program file formats like C, C++, Shell
119 Scripts like ksh, sh, Perl, Java, Java Class files, JAR files, ELF
120 files, troff man pages, file archives like Zip, Gzip, BZip2, Tar and
121 meta language files like XML, SGML or HTML.
122 OpenGrok supports various source control systems like Mercurial, CVS,
124 Subversion, TeamWare, SCCS and Bazaar.
125
127 Indexing files in /usr/include and storing the output data to
128 /var/tmp/opengrok_data.
129 $ opengrok.jar -s /usr/include -d /var/tmp/opengrok_data
131 .fi
132
134 0 command executed successfully
135 1 error in executing the command
137 May 31, 2010 opengrok(1)