From 3dfe835be7ad47747ebc2154b882fc2a0d7b0c9e Mon Sep 17 00:00:00 2001 From: Robert Gemmell Date: Mon, 20 May 2013 00:57:24 +0000 Subject: QPID-4685: additional documentation updates following broker configuration model changes git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1484370 13f79535-47bb-0310-9956-ffa450edef68 --- .../java-broker/Java-Broker-Getting-Started.xml | 75 ++++++++++++---------- 1 file changed, 42 insertions(+), 33 deletions(-) (limited to 'qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml') diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml b/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml index e90dadd126..c982984a82 100644 --- a/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml +++ b/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml @@ -26,18 +26,21 @@ Getting Started - - This section describes how to start the Java Broker for the first time. - The Broker configuration details and configuration command line arguments are described in . - - -
- Starting/Stopping the Broker - To start the Broker, use the qpid-server script (UNIX) or qpid-server.bat (Windows) - provided within distribution. + +
+ Introduction + + This section describes how to start and stop the Java Broker, and outlines the various command line options. + + + For additional details about the broker configuration store and related command line arguments see + . + The broker is fully configurable via its Web Management Console, for details of this see + . +
- Starting/Stopping on Windows + Starting/Stopping the broker on Windows Firstly change to the installation directory used during the installation and ensure that the QPID_WORK environment variable is set. Now use the qpid-server.bat to start the server @@ -59,11 +62,11 @@ [Broker] BRK-1004 : Qpid Broker Ready 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 or use the Shutdown MBean made from the + To stop the Broker, use Control-C or use the Shutdown MBean from the + JMX management plugin.
- Starting/Stopping on Unix + Starting/Stopping the broker on Unix Firstly change to the installation directory used during the installation and ensure that the QPID_WORK environment variable is set. Now use the qpid-server script to start the server: @@ -87,7 +90,7 @@ 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, use kill -TERM <pid>, or - the Shutdown MBean from + the Shutdown MBean from the JMX management plugin.
Log file @@ -99,65 +102,71 @@
Using the command line - 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 + The Java Broker understands a number of command line options which may be used to customise the configuration. + + For additional details about the broker configuration and related command line arguments see + . + The broker is fully configurable via its Web Management Console, for details of this see + . + + To see usage information for all command line options, use the option ] [-h] [-icp ] [-l ] [-mm] [-mmhttp ] [-mmjmx ] [-mmpass ] [-mmqv] [-mmrmi ] [-os] [-sp ] [-st ] [-v] [-w ] - -cic create a copy of the initial config + -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 + -h, Print this message --help - -icp set the location of initial JSON config + -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 + -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 + -mm Start broker in management mode, + --management-mode disabling the AMQP ports - -mmhttp override http management port in + -mmhttp Override http management port in --management-mode-http-port management mode - -mmjmx override jmx connector port in + -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 + -mmqv Make virtualhosts stay in the quiesced --management-mode-quiesce-virtualhosts state during management mode. - -mmrmi override jmx rmi registry port in + -mmrmi Override jmx rmi registry port in --management-mode-rmi-registry-port management mode - -os overwrite the broker configuration store + -os Overwrite the broker configuration store --overwrite-store with the current initial configuration - -prop,--config-property set a configuration property to use when - resolving variables in the broker + -prop Set a configuration property to use when + --config-property resolving variables in the broker configuration store, with format 'name=value' - -sp use given configuration store location + -sp Use given configuration store location --store-path - -st use given broker configuration store type + -st Use given broker configuration store type --store-type - -v print the version information and exit + -v Print the version information and exit --version - -w monitor the log file configuration file + -w Monitor the log file configuration file --logwatch for changes. Units are seconds. Zero means do not check for changes. ]]> -- cgit v1.2.1