summaryrefslogtreecommitdiff
path: root/RC9/qpid/cpp/docs/man
diff options
context:
space:
mode:
Diffstat (limited to 'RC9/qpid/cpp/docs/man')
-rw-r--r--RC9/qpid/cpp/docs/man/Makefile.am47
-rw-r--r--RC9/qpid/cpp/docs/man/qpidd.x46
2 files changed, 93 insertions, 0 deletions
diff --git a/RC9/qpid/cpp/docs/man/Makefile.am b/RC9/qpid/cpp/docs/man/Makefile.am
new file mode 100644
index 0000000000..7db6b5f193
--- /dev/null
+++ b/RC9/qpid/cpp/docs/man/Makefile.am
@@ -0,0 +1,47 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+dist_man_MANS = qpidd.1
+
+man_aux = $(dist_man_MANS:.1=.x)
+EXTRA_DIST = $(man_aux)
+DISTCLEANFILES = $(dist_man_MANS)
+CLEANFILES=qpidd.1
+
+dist-hook: $(man_aux)
+
+# Depend on configure.ac to get version number changes.
+$(dist_man_MANS): $(top_srcdir)/configure.ac
+
+if HAVE_HELP2MAN
+
+SUFFIXES = .x .1
+qpidd.1: $(srcdir)/qpidd.x $(top_builddir)/src/qpidd
+.x.1:
+ @rm -f $@
+ @echo "Updating man page $@"
+ $(HELP2MAN) --no-info --include=$(srcdir)/$*.x --output=$@-t ../../src/$*
+ @chmod a-w $@-t
+ @mv $@-t $@
+else
+qpidd.1:
+ @echo "Warning: help2man not available, man page lacks options."
+ @cp $(srcdir)/qpidd.x $@
+endif
+
+
diff --git a/RC9/qpid/cpp/docs/man/qpidd.x b/RC9/qpid/cpp/docs/man/qpidd.x
new file mode 100644
index 0000000000..9f1b465701
--- /dev/null
+++ b/RC9/qpid/cpp/docs/man/qpidd.x
@@ -0,0 +1,46 @@
+[NAME]
+
+qpidd \- the Qpid AMQP Broker Daemon
+
+[SYNOPSIS]
+
+qpidd [options]
+
+[DESCRIPTION]
+
+An AMQP broker daemon that stores, routes and forwards messages using
+the Advanced Message Queueing Protocol (AMQP).
+
+[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
+
+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-to-stdout=yes
+ log-to-file=/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_TO_FILE=/tmp/qpidd.log
+
+