From fc756bf58dd5e4b636df8972c052715765e60155 Mon Sep 17 00:00:00 2001 From: Robert Gemmell Date: Mon, 22 Apr 2013 12:25:15 +0000 Subject: QPID-4685: update documentation for CLI options git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1470475 13f79535-47bb-0310-9956-ffa450edef68 --- .../java-broker/Java-Broker-Getting-Started.xml | 93 +++++++++++++--------- .../src/java-broker/Java-Broker-Installation.xml | 4 +- .../src/java-broker/Java-Broker-Miscellaneous.xml | 2 +- 3 files changed, 58 insertions(+), 41 deletions(-) (limited to 'doc') diff --git a/doc/book/src/java-broker/Java-Broker-Getting-Started.xml b/doc/book/src/java-broker/Java-Broker-Getting-Started.xml index 630c27ce89..061d574362 100644 --- a/doc/book/src/java-broker/Java-Broker-Getting-Started.xml +++ b/doc/book/src/java-broker/Java-Broker-Getting-Started.xml @@ -82,7 +82,7 @@ The BRK-1004 message confirms that the Broker is ready for work. The MNG-1002 and BRK-1002 confirm the ports to which the Broker is listening (for HTTP/JMX management and AMQP respectively). To stop the Broker, use Control-C from the controlling shell, use the - bin/qpid.stop script, or use kill -TERM <pid> or + bin/qpid.stop script, use kill -TERM <pid>, or the Shutdown MBean from
@@ -98,43 +98,60 @@ The Java Broker understands a number of command line options which may be used to override the configuration. To see usage information for all command line options, use the option - ] [-c ] [--exclude-0-10 ] [--exclude-0-8 ] [--exclude-0-9 ] [--exclude-0-9-1 - ] [--exclude-1-0 ] [-h] [--include-0-10 ] [--include-0-8 ] [--include-0-9 ] [--include-0-9-1 - ] [--include-1-0 ] [--jmxconnectorport ] [-l ] [-m ] [-p ] [-s ] [-v] [-w ] - -b,--bind
bind to the specified address. Overrides any value in the config file - -c,--config use given configuration file - --exclude-0-10 when listening on the specified port do not accept AMQP0-10 connections. The - specified port must be one specified on the command line - --exclude-0-8 when listening on the specified port do not accept AMQP0-8 connections. The - specified port must be one specified on the command line - --exclude-0-9 when listening on the specified port do not accept AMQP0-9 connections. The - specified port must be one specified on the command line - --exclude-0-9-1 when listening on the specified port do not accept AMQP0-9-1 connections. The - specified port must be one specified on the command line - --exclude-1-0 when listening on the specified port do not accept AMQP1-0 connections. The - specified port must be one specified on the command line - -h,--help print this message - --include-0-10 accept AMQP0-10 connections on this port, overriding configuration to the contrary. - The specified port must be one specified on the command line - --include-0-8 accept AMQP0-8 connections on this port, overriding configuration to the contrary. - The specified port must be one specified on the command line - --include-0-9 accept AMQP0-9 connections on this port, overriding configuration to the contrary. - The specified port must be one specified on the command line - --include-0-9-1 accept AMQP0-9-1 connections on this port, overriding configuration to the contrary. - The specified port must be one specified on the command line - --include-1-0 accept AMQP1-0 connections on this port, overriding configuration to the contrary. - The specified port must be one specified on the command line - --jmxconnectorport listen on the specified management (connector server) port. Overrides any - value in the config file - -l,--logconfig use the specified log4j xml configuration file. By default looks for a file named - etc/log4j.xml in the same directory as the configuration file - -m,--jmxregistryport listen on the specified management (registry server) port. Overrides any - value in the config file - -p,--port listen on the specified port. Overrides any value in the config file - -s,--sslport SSL port. Overrides any value in the config file - -v,--version print the version information and exit - -w,--logwatch monitor the log file configuration file for changes. Units are seconds. Zero means - do not check for changes.]]> + ] [-h] [-icp ] [-l ] [-mm] [-mmhttp ] + [-mmjmx ] [-mmpass ] [-mmqv] [-mmrmi ] [-os] + [-sp ] [-st ] [-v] [-w ] + -cic create a copy of the initial config + --create-initial-config file, either to an optionally specified + file path, or as initial-config.json + in the current directory + + -h, print this message + --help + + -icp set the location of initial JSON config + --initial-config-path to use when creating/overwriting a + broker configuration store + + -l use the specified log4j xml configuration + --logconfig file. By default looks for a file named + etc/log4j.xml in the same directory as + the configuration file + + -mm start broker in management mode, + disabling the AMQP ports + + -mmhttp override http management port in + --management-mode-http-port management mode + + -mmjmx override jmx connector port in + --management-mode-jmx-connector-port management mode + + -mmpass Set the password for the management + --management-mode-password mode user mm_admin + + -mmqv make virtualhosts stay in the quiesced + --management-mode-quiesce-virtualhosts state during management mode. + + -mmrmi override jmx rmi registry port in + --management-mode-rmi-registry-port management mode + + -os overwrite the broker configuration store + --overwrite-store with the current initial configuration + + -sp use given configuration store location + --store-path + + -st use given broker configuration store type + --store-type + + -v print the version information and exit + --version + + -w monitor the log file configuration file + --logwatch for changes. Units are seconds. Zero + means do not check for changes. +]]>
diff --git a/doc/book/src/java-broker/Java-Broker-Installation.xml b/doc/book/src/java-broker/Java-Broker-Installation.xml index 218e39f578..7b41c01541 100644 --- a/doc/book/src/java-broker/Java-Broker-Installation.xml +++ b/doc/book/src/java-broker/Java-Broker-Installation.xml @@ -126,13 +126,13 @@ file and is used for the storage of persistent messages. The work directory can be set on the command-line (for the lifetime of the command interpreter), but you will normally want to set the environment variable permanently via the Advanced System Settings in the Control Panel. - set QPID_WORK=S:\qpidwork + set QPID_WORK=C:\qpidwork If the directory referred to by QPID_WORK does not exist, the Java Broker will attempt to create it on start-up.
Optional Dependencies - The broker has an optional message store implementations backed by Oracle BDB JE. If you wish to use these + The broker has optional message store implementations backed by Oracle BDB JE. If you wish to use these stores you will need to provide the optional Oracle BDB JE dependency. For more details, see
diff --git a/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml b/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml index 007d6cde5b..4b3bdeb15b 100644 --- a/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml +++ b/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml @@ -54,7 +54,7 @@ Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02, mixed mode)]]>
- Verify JVM on Windows + Verify JVM on Unix Firstly confirm that the JAVA_HOME environment variable is set correctly by typing the following at the command prompt: -- cgit v1.2.1