From 81ac902d6dd0ca4e5413a1aa6d625a71a44fc210 Mon Sep 17 00:00:00 2001 From: Keith Wall Date: Sat, 1 Mar 2014 01:49:40 +0000 Subject: QPID-5554: [Java Broker Documentation] Add docbook chapters for environment variables, system properties and operational logging git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1573121 13f79535-47bb-0310-9956-ffa450edef68 --- .../Java-Broker-Appendix-Environment-Variables.xml | 126 +++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 qpid/doc/book/src/java-broker/Java-Broker-Appendix-Environment-Variables.xml (limited to 'qpid/doc/book/src/java-broker/Java-Broker-Appendix-Environment-Variables.xml') diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Environment-Variables.xml b/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Environment-Variables.xml new file mode 100644 index 0000000000..eea7bb6b79 --- /dev/null +++ b/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Environment-Variables.xml @@ -0,0 +1,126 @@ + + +%entities; +]> + + + + Environment Variables + The following table describes the environment variables understood by the Qpid scripts + contained within the /bin directory within the Broker distribution. + To take effect, these variables must be set within the shell (and exported - if using Unix) + before invoking the script. + + Environment variables + + + + Environment variable + Default + Purpose + + + + + QPID_HOME + + None + + + The variable used to tell the Broker its installation directory. It must be an + absolute path. This is used to determine the location of Qpid's dependency JARs and + some configuration files. + Typically the value of this variable will look similar to + c:\qpid\&windowsExtractedBrokerDirName; (Windows) or + /usr/local/qpid/&unixExtractedBrokerDirName; (Unix). The + installation prefix will differ from installation to installation. + If not set, a value for QPID_HOME is derived from the location + of the script itself. + + + + QPID_WORK + + User's home directory + + + Used as the default root directory for any data written by the Broker. This is the + default location for any message data written to persistent stores and the Broker's + log file. + For example, QPID_WORK=/var/qpidwork. + + + + QPID_OPTS + + None + + + This is the preferred mechanism for passing Java system properties to the + Broker. The value must be a list of system properties each separate by a space. + -Dname1=value1 + -Dname2=value2. + + + + + QPID_JAVA_GC + + -XX:+HeapDumpOnOutOfMemoryError -XX:+UseConcMarkSweepGC + + + This is the preferred mechanism for customising garbage collection behaviour. The + value should contain valid garbage collection options(s) for the target JVM. + Refer to the JVM's documentation for details. + + + + QPID_JAVA_MEM + + -Xmx1024m + + + This is the preferred mechanism for customising the size of the JVM's heap memory. + The value should contain valid memory option(s) for the target JVM. Oracle JVMs + understand -Xmx to specify a maximum heap size and + -Xms an initial size. + For example, QPID_JAVA_MEM=-Xmx6g would set a maximum heap size of + 6GB. + Refer to the JVM's documentation for details. + + + + JAVA_OPTS + None + + This is the preferred mechanism for passing any other JVM options. This variable is + commonly used to pass options for diagnostic purposes, for instance to turn on verbose + GC. -verbose:gc. + Refer to the JVM's documentation for details. + + + + +
+ -- cgit v1.2.1