From 88f4f04b32cf1024a9ce84db54a986950c1e7499 Mon Sep 17 00:00:00 2001 From: Aidan Skinner Date: Mon, 2 Jun 2008 18:12:47 +0000 Subject: Move to documentation directory git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/branches/forrest-site@662505 13f79535-47bb-0310-9956-ffa450edef68 --- .../content/xdocs/Qpid Java Run Scripts.html | 178 +++++++++++++++++++++ 1 file changed, 178 insertions(+) create mode 100644 documentation/content/xdocs/Qpid Java Run Scripts.html (limited to 'documentation/content/xdocs/Qpid Java Run Scripts.html') diff --git a/documentation/content/xdocs/Qpid Java Run Scripts.html b/documentation/content/xdocs/Qpid Java Run Scripts.html new file mode 100644 index 0000000000..99ee1788fd --- /dev/null +++ b/documentation/content/xdocs/Qpid Java Run Scripts.html @@ -0,0 +1,178 @@ + + + Apache Qpid : Qpid Java Run Scripts + + + + + + + + + +
+
+ + Apache Qpid : Qpid Java Run Scripts + +
+
+ This page last changed on Apr 06, 2007 by mmccorma. +
+ +

Qpid Java Broker Run Scripts

+ +

The following scripts are used to run the Qpid broker:

+ +

qpid-server
+qpid-server.bat
+qpid-run

+ +

These scripts are described in more detail below.

+ +

qpid-server

+ +

Overview

+ +

This script starts the Qpid Java Broker on Linux/Solaris/Cygwin platforms.

+ +

It is extremely simple, delegating the real work to the qpid-run script.

+ +

In fact, all it really provides is the main class to execute and passes through any command line arguments to qpid-run i.e.

+ +
+
. qpid-run org.apache.qpid.server.Main "$@"
+
+
+ +

qpid-server.bat

+ +

Overview

+ +

This script starts the Qpid Java Broker on Windows platforms. It provides a limited version of the qpid-run functionality, though is not nearly as sophisticated i.e. does not support run arguments or the full set of argument variables.

+ +

However, it does support the following features:

+ +
    +
  • validates that JAVA_HOME is set
    • +
  • validates that QPID_HOME is set
    • +
  • passes any command line arguments to the main broker class
    • +
  • supports the use of QPID_OPTS to pass through java system properties
    • +
+ + +

Note that a JIRA exists for enhancing the features this script supports http://issues.apache.org/jira/browse/QPID-168

+ +

qpid-run

+ +

Overview

+ +

The qpid-run script allows the calling program to run any given command, and provides a flexible surround supporting configurable runtime arguments for the script itself, the broker and java arguments.

+ +

Environment Variables and Defaulting

+ +

The variables noted below are used by the qpid-run script. Any default value used if not

+ +

specified is noted below.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VariableDescriptionDefault
QPID_HOMEUsed as root for installed application path. Mandatory that users set thisNone
QPID_WORKUsed as root for any working directories to which the Qpid broker writes, for
+logging and bdb etc		Current User's Homedir
AMQJ_LOGGING_LEVELLogging level for broker codeinfo
QPID_LOG_PREFIXUsed as a prefix for qpid broker log, see FAQ for more detailsNone
QPID_LOG_SUFFIXUsed as a suffix for qpid broker log, see FAQ for more detailsNone
JPDA_OPTSIf set and -run:jpda argument provided used for debugging props, see belowNone
QPID_OPTSUse to pass custom system properties, including management console connection
+info		None
JAVA_OPTSUse to pass custom Java options, for example gc options etcNone
+ +

Run Arguments

+ +

You can provide run arguments to the qpid-run script using the syntax

+ +
+
-run:argument
+
+
+ +

The table below provides details of the available arguments.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentDescription
debugPrints classpath and command before running it
jpdaAdds remote debugging info using JPDA_OPTS. Use JPDA_TRANSPORT and JPDA_ADDRESS to
+customize, JPDA_OPTS to override
external-classpathValid values are: ignore, first, last and only. See below for more info
print-classpathPrints classpath before running command
helpPrints Usage information
+ + +
+ + + + + + + +
Document generated by Confluence on Apr 22, 2008 02:47
+ + \ No newline at end of file -- cgit v1.2.1