summaryrefslogtreecommitdiff
path: root/cpp/docs
diff options
context:
space:
mode:
authorAlan Conway <aconway@apache.org>2007-10-04 15:32:45 +0000
committerAlan Conway <aconway@apache.org>2007-10-04 15:32:45 +0000
commitc848c1a4e6be50176f10170c6422c5e4d5385770 (patch)
treed8070dbbc3ac1c0744e466a5da545e4628aa9d2b /cpp/docs
parent0442198591e75c1ee00a5445d832c95c6acc45b3 (diff)
downloadqpid-python-c848c1a4e6be50176f10170c6422c5e4d5385770.tar.gz
* docs/man/qpidd.x: Explain configuration options.
* etc/qpidd.conf: Placeholder configuration file. * qpidc.spec.in: Install qpidd.conf * Makefile.am: Install qpidd.conf * src/qpid/Options.cpp, h, src/qpidd.cpp: Option formatting fixes. git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@581951 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'cpp/docs')
-rw-r--r--cpp/docs/man/qpidd.x36
1 files changed, 33 insertions, 3 deletions
diff --git a/cpp/docs/man/qpidd.x b/cpp/docs/man/qpidd.x
index 91d3c3a969..5d4ce974e1 100644
--- a/cpp/docs/man/qpidd.x
+++ b/cpp/docs/man/qpidd.x
@@ -1,16 +1,46 @@
[NAME]
+
qpidd \- the Qpid AMQP broker daemon
+[SYNOPSIS]
+
+qpidd [options]
+
[DESCRIPTION]
-Start the AMQP broker. The broker options can be specified on the command line (e.g. --worker-threads 10), in an environment variable (e.g. export QPID_WORKER_THREADS=10), or as a line in a configuration file (e.g. worker-threads=10).
+An AMQP broker daemon that stores, routes and forwards messages via
+the AMQP protocol.
+
+[OPTIONS]
+
+Options may be specified via command line, environment variable or configuration file. See FILES and ENVIRONMENT below for details.
+
+[FILES]
+.I /etc/qpidd.conf
+.RS
+Default configuration file.
+.RE
-Command line options take precedence over environment variables, which
-take precedence over the config file.
+Configuration file settings are over-ridden by command line or environment variable settings. '--config <file>' or 'export QPID_CONFIG=<file>' specifies an alternate file.
+Each line is a name=value pair. Blank lines and lines beginning with # are ignored. For example:
+ # My qpidd configuration file.
+ port=6000
+ max-connections=10
+ log.output=stdout
+ log.output=/tmp/qpidd.log
+[ENVIRONMENT]
+.I QPID_<option>
+.RS
+There is an environment variable for each option.
+.RE
+The environment variable is the option name in uppercase, prefixed with QPID_ and '.' or '-' are replaced with '_'. Environment settings are over-ridden by command line settings. For example:
+ export QPID_PORT=6000
+ export QPID_MAX_CONNECTIONS=10
+ export QPID_LOG_OUTPUT=/tmp/qpidd.log