@@ -12,13 +12,12 @@ Copyright (c) 2006, 2018 Oracle and/or its affiliates. All rights reserved.
12
12
3 . [ Usage] ( #3-usage )
13
13
4 . [ OpenGrok install] ( #4-opengrok-install )
14
14
5 . [ OpenGrok setup] ( #5-opengrok-setup )
15
- 6 . [ Optional Command Line Interface Usage] ( #6-optional-command-line-interface-usage )
16
- 7 . [ Change web application properties or name] ( #7-change-web-application-properties-or-name )
17
- 8 . [ Information for developers] ( #8-information-for-developers )
18
- 9 . [ Tuning OpenGrok for large code bases] ( #9-tuning-opengrok-for-large-code-bases )
19
- 10 . [ Authors] ( #10-authors )
20
- 11 . [ Contact us] ( #11-contact-us )
21
- 12 . [ Demo] ( #12-demo )
15
+ 6 . [ Change web application properties or name] ( #7-change-web-application-properties-or-name )
16
+ 7 . [ Information for developers] ( #8-information-for-developers )
17
+ 8 . [ Tuning OpenGrok for large code bases] ( #9-tuning-opengrok-for-large-code-bases )
18
+ 9 . [ Authors] ( #10-authors )
19
+ 10 . [ Contact us] ( #11-contact-us )
20
+ 11 . [ Demo] ( #12-demo )
22
21
23
22
## 1. Introduction
24
23
@@ -254,7 +253,9 @@ them and index them.
254
253
255
254
It basically works like this:
256
255
257
- 1 . bootstrap initial configuration: OpenGrok bootstrap
256
+ 1 . create initial configuration:
257
+
258
+ ` OpenGrok bootstrap `
258
259
259
260
* this will create ` /var/opengrok/etc/configuration.xml ` with basic set of
260
261
properties. If more is needed use:
@@ -266,7 +267,7 @@ It basically works like this:
266
267
2. add a new project ** foo** :
267
268
268
269
```
269
- Messages -t foo -n project add
270
+ curl -d " foo" -H "Content-Type: text/plain" -X POST "${webapp_uri}/api/v1/projects"
270
271
```
271
272
272
273
* the project **foo** is now visible in the configuration however is not yet
@@ -280,8 +281,8 @@ It basically works like this:
280
281
3. index the project. It will become searchable after that.
281
282
282
283
```
283
- OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml
284
- OpenGrok indexpart /foo
284
+ OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml \
285
+ OpenGrok indexpart /foo
285
286
```
286
287
287
288
4. make the project `indexed` status of the project persistent so that if
@@ -314,9 +315,9 @@ project to this directory. The creation of the per-project directory and the
314
315
The command used in step 2 can thus look like this:
315
316
316
317
``` bash
317
- OPENGROK_LOGGER_CONFIG_PATH=/var/opengrok/myproj.logging
318
- OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml
319
- OpenGrok indexpart /myproj
318
+ OPENGROK_LOGGER_CONFIG_PATH=/var/opengrok/myproj.logging \
319
+ OPENGROK_READ_XML_CONFIGURATION=/var/opengrok/etc/configuration.xml \
320
+ OpenGrok indexpart /myproj
320
321
```
321
322
322
323
The last argument is path relative to ` SRC_ROOT ` .
@@ -344,33 +345,6 @@ configuration into a separate file and simplify future upgrades.
344
345
345
346
See ` opengrok.jar ` manual below for more details.
346
347
347
- #### 5.4.5 Custom ctags configuration
348
-
349
- To make ctags recognize additional symbols/definitions/etc. it is possible to
350
- specify configuration file with extra configuration options for ctags.
351
-
352
- This can be done by setting ` OPENGROK_CTAGS_OPTIONS_FILE ` environment variable
353
- when running the OpenGrok shell script (or directly with the ` -o ` option for
354
- ` opengrok.jar ` ). Default location for the configuration file in the OpenGrok
355
- shell script is ` etc/ctags.config ` under the OpenGrok base directory (by default
356
- the full path to the file will be ` /var/opengrok/etc/ctags.config ` ).
357
-
358
- Sample configuration file for Solaris code base is delivered in the ` doc/ `
359
- directory.
360
-
361
- ### 5.6 Introduce own mapping for an extension to analyzer
362
-
363
- OpenGrok script doesn't support this out of box, so you'd need to add it there.
364
- Usually to ` StdInvocation() ` function after line ` -jar ${OPENGROK_JAR} ` .
365
- It would look like this:
366
-
367
- ```
368
- -A cs:org.opengrok.indexer.analysis.PlainAnalyzer
369
- ```
370
-
371
- (this will map extension ` .cs ` to ` PlainAnalyzer ` )
372
- You should even be able to override OpenGroks analyzers using this option.
373
-
374
348
### 5.7 Logging
375
349
376
350
Both indexer and web app emit extensive log messages.
@@ -386,43 +360,25 @@ If not using the shell script, the path to the configuration file can be
386
360
set using the ` -Djava.util.logging.config.file=/PATH/TO/MY/logging.properties `
387
361
java parameter.
388
362
389
-
390
- ## 6. Optional Command Line Interface Usage
391
-
392
- You need to pass location of project file + the query to ` Search ` class, e.g.
393
- for fulltext search for project with above generated ` configuration.xml ` you'd
394
- do:
395
-
396
- ``` bash
397
- java -cp ./opengrok.jar org.opengrok.indexer.search.Search -R \
398
- /var/opengrok/etc/configuration.xml -f fulltext_search_string
399
- ```
400
- For quick help run:
401
-
402
- ``` bash
403
- java -cp ./opengrok.jar org.opengrok.indexer.search.Search
404
- ```
405
-
406
- ## 7. Change web application properties or name
363
+ ## 6. Change web application properties or name
407
364
408
365
See https://github.com/oracle/opengrok/wiki/Webapp-configuration
409
366
410
-
411
- ## 8. Information for developers
367
+ ## 7. Information for developers
412
368
413
369
See https://github.com/oracle/opengrok/wiki/Developer-intro and https://github.com/oracle/opengrok/wiki/Developers
414
370
415
- ## 9 . Tuning OpenGrok for large code bases
371
+ ## 8 . Tuning OpenGrok for large code bases
416
372
417
373
See https://github.com/oracle/opengrok/wiki/Tuning-for-large-code-bases
418
374
419
- ## 10 . Authors
375
+ ## 9 . Authors
420
376
421
377
The project has been originally conceived in Sun Microsystems by Chandan B.N.
422
378
423
379
For full list of contributors see https://github.com/oracle/opengrok/graphs/contributors
424
380
425
- ## 11 . Contact us
381
+ ## 10 . Contact us
426
382
427
383
Feel free to participate in discussion on the mailing lists:
428
384
@@ -432,5 +388,6 @@ Feel free to participate in discussion on the mailing lists:
432
388
433
389
To subscribe, send email to
` <mailing_list_name>[email protected] `
434
390
435
- ## 12. Demo
391
+ ## 11. Demo
392
+
436
393
Visit < http://demo.opengrok.org >
0 commit comments