Skip to content

Commit 226355f

Browse files
idodeclareidodeclare
committed
Revise block comment as block cat for --detailed
1 parent 788e650 commit 226355f

File tree

1 file changed

+120
-115
lines changed

1 file changed

+120
-115
lines changed

‎OpenGrok

Lines changed: 120 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -18,116 +18,12 @@
1818
# CDDL HEADER END
1919

2020
#
21-
# OpenGrok Wrapper (initial setup and cron job updating)
22-
#
23-
# Supported Operating Systems:
24-
# - Solaris 11 (SunOS 5.11)
25-
# - Debian (Linux)
26-
#
27-
# Supported Deployment Engines:
28-
# - Tomcat 8
29-
# - Glassfish
30-
# - Resin
31-
#
32-
# Supported Environment Variables:
33-
# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
34-
# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
35-
# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
36-
#
37-
# Supported Environment Variables for configuring the default setup:
38-
# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
39-
# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
40-
# - OPENGROK_SRC_ROOT directory with files to be indexed
41-
# - OPENGROK_DATA_ROOT directory where index and cache files are generated
42-
# - OPENGROK_CTAGS Full path to Exuberant or Universal CTags binary
43-
# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
44-
# options for CTags program (for its --options
45-
# switch), default is DATA_ROOT/etc/ctags.config
46-
# - OPENGROK_MANDOC Full path to mandoc(1) binary
47-
# - OPENGROK_LOCKING Locking mode on|off|simple|native (default off)
48-
# ("on" is an alias for "simple")
49-
# - JAVA_HOME Full Path to Java Installation Root
50-
# - JAVA Full Path to java binary (to enable 64bit JDK)
51-
# - JAVA_OPTS Java options (e.g. for JVM memory increase
52-
# or enabling server JDK)
53-
# JAVA_OPTS=-Xmx2048m is the default!
54-
# - OPENGROK_APP_SERVER Application Server ("Tomcat", "Glassfish" or "Resin")
55-
# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
56-
# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
57-
# - OPENGROK_WAR_TARGET_RESIN Resin Specific WAR Target Directory
58-
# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
59-
# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
60-
# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
61-
# (contains domains)
62-
# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
63-
# - OPENGROK_RESIN_BASE Base Directory for Resin (contains webapps)
64-
# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
65-
# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
66-
# through project, it's good to have Verbose
67-
# Mode enabled too, cost of this is one more
68-
# traversal of the project before indexing it(*)
69-
# - OPENGROK_RENAMED_FILES_HISTORY If set to "on", get full history of
70-
# renamed files for SCMs that support it (Git,
71-
# Mercurial).
72-
# The default is off.
73-
# When set to on, the indexing is slower,
74-
# especially in the presence of
75-
# lots of renamed files in the repository.
76-
# - OPENGROK_GENERATE_HISTORY Influence history cache generation
77-
# Following values are recognized:
78-
# on - enabled (default)
79-
# off - disabled for indexing and UI
80-
# dirbased - indexing enabled only for repos
81-
# which can fetch history for
82-
# directory
83-
# local - for local repos only
84-
# uionly - enabled for UI only
85-
# - OPENGROK_ENABLE_PROJECTS Enable projects (set it to true or false)
86-
# Every directory in SRC_ROOT is
87-
# considered a separate project
88-
# - OPENGROK_IGNORE_PATTERNS Set ignored patterns for indexer to skip.
89-
# OPENGROK_IGNORE_PATTERNS="-i dummy"
90-
# OPENGROK_IGNORE_PATTERNS="-i f:dummy"
91-
# OPENGROK_IGNORE_PATTERNS="-i d:dummy"
92-
# Multiple entries can be joined together:
93-
# "-i dummy -i d:tmp -i f:dummy"
94-
# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
95-
# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
96-
# (by default 3 directories from SRC_ROOT)
97-
# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
98-
# (use "none" to avoid sending it to web app)
99-
# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
100-
# (by default /source)
101-
# - FULL reindex is needed once this is used
102-
# (old already indexed files won't be refreshed)
103-
# - OPENGROK_WPREFIX Disable wildcard prefix search query
104-
# support (*)
105-
# - OPENGROK_TAG Enable parsing of revision tags into the History
106-
# view
107-
# - OPENGROK_READ_XML_CONFIGURATION file with read only configuration
108-
# - temporary workaround for bug # 327
109-
# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
110-
# default is 16MB per thread, you might try to
111-
# increase it to 256MB, but do increase JVM to
112-
# 4/8/16GB ! Lucene defaults to 8 threads.
113-
# Increase JVM memory as noted using JAVA_OPTS
114-
# - OPENGROK_PARALLELISM Default is 0, meaning that parallelism is
115-
# determined from available processors.
116-
# - OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
117-
# - OPENGROK_SUBVERSION_USERNAME name of the user that should be used for
118-
# fetching the history from subversion
119-
# - OPENGROK_SUBVERSION_PASSWORD password of the user that should be used for
120-
# fetching the history from subversion
121-
#
122-
# - OPENGROK_PROFILER Pause to await user input for profiling.
123-
#
124-
# Notes:
125-
# (*) Any Non-Empty String will enable these options
21+
# Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
22+
# Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
12623
#
12724

12825
#
129-
# Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
130-
# Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
26+
# OpenGrok Wrapper (initial setup and cron job updating)
13127
#
13228

13329
#
@@ -149,13 +45,122 @@ Usage()
14945
echo " pointed to via the OPENGROK_READ_XML_CONFIGURATION environment"
15046
echo " variable."
15147
echo ""
152-
echo " Optional environment variables:"
153-
echo " OPENGROK_CONFIGURATION - location of your configuration"
154-
echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... "
155-
echo ""
156-
echo " See the code for more information on configuration options /" \
157-
"variables"
158-
echo ""
48+
if [ "$1" != "--detailed" ]; then
49+
echo " Optional environment variables:"
50+
echo " OPENGROK_CONFIGURATION - location of your configuration"
51+
echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf \\"
52+
echo " ${0} ... "
53+
echo ""
54+
echo " Use help --detailed, or see the code for more information on"
55+
echo " configuration options and variables."
56+
else
57+
cat <<END
58+
Supported Environment Variables:
59+
- OPENGROK_CONFIGURATION User Configuration (Shell Script)
60+
- OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
61+
- OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
62+
63+
Supported Environment Variables for configuring the default setup:
64+
- OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
65+
- OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
66+
- OPENGROK_SRC_ROOT directory with files to be indexed
67+
- OPENGROK_DATA_ROOT Base Directory where index and cache files are
68+
generated
69+
- OPENGROK_CTAGS Full path to Exuberant or Universal CTags binary
70+
- OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
71+
options for CTags program (for its --options
72+
switch), default is DATA_ROOT/etc/ctags.config
73+
- OPENGROK_MANDOC Full path to mandoc(1) binary
74+
- OPENGROK_LOCKING Locking mode on|off|simple|native (default off)
75+
("on" is an alias for "simple")
76+
- JAVA_HOME Full Path to Java Installation Root
77+
- JAVA Full Path to java binary (to enable 64bit JDK)
78+
- JAVA_OPTS Java options (e.g. for JVM memory increase
79+
or enabling server JDK)
80+
JAVA_OPTS=-Xmx2048m is the default!
81+
- OPENGROK_APP_SERVER Application Server ("Tomcat", "Glassfish" or
82+
"Resin")
83+
- OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
84+
- OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
85+
- OPENGROK_WAR_TARGET_RESIN Resin Specific WAR Target Directory
86+
- OPENGROK_WAR_TARGET Fallback WAR Target Directory
87+
- OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
88+
- OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
89+
(contains domains)
90+
- OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
91+
- OPENGROK_RESIN_BASE Base Directory for Resin (contains webapps)
92+
- OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
93+
- OPENGROK_PROGRESS Shows progress in %(percentage) of working
94+
through project, it's good to have Verbose
95+
Mode enabled too, cost of this is one more
96+
traversal of the project before indexing it(*)
97+
- OPENGROK_RENAMED_FILES_HISTORY If set to "on", get full history of
98+
renamed files for SCMs that support it (Git,
99+
Mercurial).
100+
The default is off.
101+
When set to on, the indexing is slower,
102+
especially in the presence of
103+
lots of renamed files in the repository.
104+
- OPENGROK_GENERATE_HISTORY Influence history cache generation
105+
Following values are recognized:
106+
on - enabled (default)
107+
off - disabled for indexing and UI
108+
dirbased - indexing enabled only for
109+
repos which can fetch history
110+
for directory
111+
local - for local repos only
112+
uionly - enabled for UI only
113+
- OPENGROK_ENABLE_PROJECTS Enable projects (set it to true or false)
114+
Every directory in SRC_ROOT is
115+
considered a separate project
116+
- OPENGROK_IGNORE_PATTERNS Set ignored patterns for indexer to skip.
117+
OPENGROK_IGNORE_PATTERNS="-i dummy"
118+
OPENGROK_IGNORE_PATTERNS="-i f:dummy"
119+
OPENGROK_IGNORE_PATTERNS="-i d:dummy"
120+
Multiple entries can be joined together:
121+
"-i dummy -i d:tmp -i f:dummy"
122+
- OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
123+
- OPENGROK_SCAN_DEPTH how deep should scanning for repos go
124+
(by default 3 directories from SRC_ROOT)
125+
- OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
126+
(use "none" to avoid sending it to web app)
127+
- OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
128+
(by default /source)
129+
- FULL reindex is needed once this is used
130+
(old already indexed files won't be refreshed)
131+
- OPENGROK_WPREFIX Disable wildcard prefix search query
132+
support (*)
133+
- OPENGROK_TAG Enable parsing of revision tags into the History
134+
view
135+
- OPENGROK_READ_XML_CONFIGURATION file with read only configuration
136+
- temporary workaround for bug # 327
137+
- OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
138+
default is 16MB per thread, you might try to
139+
increase it to 256MB, but do increase JVM to
140+
4/8/16GB ! Lucene defaults to 8 threads.
141+
Increase JVM memory as noted using JAVA_OPTS
142+
- OPENGROK_PARALLELISM Default is 0, meaning that parallelism is
143+
determined from available processors.
144+
- OPENGROK_LOGGER_CONFIG_PATH Set path to custom logging.properties file.
145+
- OPENGROK_SUBVERSION_USERNAME name of the user that should be used for
146+
fetching the history from subversion
147+
- OPENGROK_SUBVERSION_PASSWORD password of the user that should be used for
148+
fetching the history from subversion
149+
- OPENGROK_PROFILER Pause to await user input for profiling.
150+
151+
Notes:
152+
(*) Any Non-Empty String will enable these options
153+
154+
Supported Operating Systems:
155+
- Solaris 11 (SunOS 5.11)
156+
- Debian (Linux)
157+
158+
Supported Deployment Engines:
159+
- Tomcat 8
160+
- Glassfish
161+
- Resin
162+
END
163+
fi
159164
exit 1
160165
}
161166

@@ -1111,7 +1116,7 @@ case "${1}" in
11111116

11121117
usage|help)
11131118
OpenGrokUsage $2
1114-
Usage
1119+
Usage $2
11151120
;;
11161121
*)
11171122
Usage

0 commit comments

Comments
 (0)