summaryrefslogtreecommitdiff
path: root/qpid/cpp/docs
diff options
context:
space:
mode:
authorKim van der Riet <kpvdr@apache.org>2013-08-21 14:38:12 +0000
committerKim van der Riet <kpvdr@apache.org>2013-08-21 14:38:12 +0000
commit7cfb37d4117ed1726795cd5e30f5a11ea1a555c9 (patch)
tree80c33eaa7e3aca8c497525844dbe6996d095a65c /qpid/cpp/docs
parentce77e05f958a3ebbf8510d79de88a86e58eb6f26 (diff)
downloadqpid-python-7cfb37d4117ed1726795cd5e30f5a11ea1a555c9.tar.gz
QPID-4984: WIP - compiles, but not functional.
git-svn-id: https://svn.apache.org/repos/asf/qpid/branches/linearstore@1516176 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp/docs')
-rw-r--r--qpid/cpp/docs/man/qpidd.1186
1 files changed, 147 insertions, 39 deletions
diff --git a/qpid/cpp/docs/man/qpidd.1 b/qpid/cpp/docs/man/qpidd.1
index d2cff454cf..fd40413337 100644
--- a/qpid/cpp/docs/man/qpidd.1
+++ b/qpid/cpp/docs/man/qpidd.1
@@ -1,5 +1,5 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.38.2.
-.TH QPIDD "1" "March 2011" "qpidd (qpidc) version 0.11" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.41.2.
+.TH QPIDD "1" "August 2013" "qpidd (qpidc) version 0.23" "User Commands"
.SH NAME
qpidd \- the Qpid AMQP Message Broker Daemon
@@ -24,11 +24,15 @@ Displays the help message
\fB\-v\fR [ \fB\-\-version\fR ]
Displays version information
.TP
-\fB\-\-config\fR FILE
+\fB\-\-config\fR FILE (\fI/usr/local/etc/qpidd.conf\fP)
Reads configuration from FILE
+.TP
+\fB\-\-client\-config\fR FILE (\fI/usr/local/etc/qpid/qpidc.conf\fP)
+Reads client configuration from FILE
+(for cluster interconnect)
.SS "Module options:"
.TP
-\fB\-\-module\-dir\fR DIR
+\fB\-\-module\-dir\fR DIR (\fI/usr/local/lib/qpid/daemon\fP)
Load all shareable modules in this
directory
.TP
@@ -41,7 +45,7 @@ Don't load modules from module
directory
.SS "Broker Options:"
.TP
-\fB\-\-data\-dir\fR DIR
+\fB\-\-data\-dir\fR DIR (/home/kpvdr/.qpidd)
Directory to contain persistent data
generated by the broker
.TP
@@ -53,11 +57,15 @@ or stored
\fB\-p\fR [ \fB\-\-port\fR ] PORT (5672)
Tells the broker to listen on PORT
.TP
-\fB\-\-worker\-threads\fR N (3)
-Sets the broker thread pool size
+\fB\-\-interface\fR <interface name>|<interface address>
+Which network interfaces to use to
+listen for incoming connections
.TP
-\fB\-\-max\-connections\fR N (500)
-Sets the maximum allowed connections
+\fB\-\-listen\-disable\fR <transport name>
+Transports to disable listening
+.TP
+\fB\-\-worker\-threads\fR N (5)
+Sets the broker thread pool size
.TP
\fB\-\-connection\-backlog\fR N (10)
Sets the connection backlog limit for
@@ -66,6 +74,10 @@ the server socket
\fB\-m\fR [ \fB\-\-mgmt\-enable\fR ] yes|no (1)
Enable Management
.TP
+\fB\-\-mgmt\-publish\fR yes|no (1)
+Enable Publish of Management Data ('no'
+implies query\-only)
+.TP
\fB\-\-mgmt\-qmf2\fR yes|no (1)
Enable broadcast of management
information over QMF v2
@@ -74,14 +86,14 @@ information over QMF v2
Enable broadcast of management
information over QMF v1
.TP
-\fB\-\-mgmt\-pub\-interval\fR SECONDS (10)
+\fB\-\-mgmt\-pub\-interval\fR SECONDS (10s)
Management Publish Interval
.TP
-\fB\-\-queue\-purge\-interval\fR SECONDS (600)
+\fB\-\-queue\-purge\-interval\fR SECONDS (600s)
Interval between attempts to purge any
expired messages from queues
.TP
-\fB\-\-auth\fR yes|no (1)
+\fB\-\-auth\fR yes|no (0)
Enable authentication, if disabled all
incoming connections will be trusted
.TP
@@ -100,21 +112,16 @@ Set TCP_NODELAY on TCP connections
Only accept connections that are
encrypted
.TP
-\fB\-\-known\-hosts\-url\fR URL or 'none'
+\fB\-\-known\-hosts\-url\fR URL or 'none' (none)
URL to send as 'known\-hosts' to clients
('none' implies empty list)
.TP
\fB\-\-sasl\-config\fR DIR
-gets sasl config info from nonstandard
-location
-.TP
-\fB\-\-max\-session\-rate\fR MESSAGES/S (0)
-Sets the maximum message rate per
-session (0=unlimited)
-.TP
-\fB\-\-async\-queue\-events\fR yes|no (0)
-Set Queue Events async, used for
-services like replication
+Allows SASL config path, if supported
+by platform, to be overridden. For
+default location on Linux, see Cyrus
+SASL documentation. There is no SASL
+config dir on Windows.
.TP
\fB\-\-default\-flow\-stop\-threshold\fR PERCENT (80)
Percent of queue's maximum capacity at
@@ -127,6 +134,30 @@ which flow control is de\-activated.
\fB\-\-default\-event\-threshold\-ratio\fR %age of limit (80)
The ratio of any specified queue limit
at which an event will be raised
+.TP
+\fB\-\-default\-message\-group\fR GROUP\-IDENTIFER (qpid.no\-group)
+Group identifier to assign to messages
+delivered to a message group queue that
+do not contain an identifier.
+.TP
+\fB\-\-enable\-timestamp\fR yes|no (0)
+Add current time to each received
+message.
+.TP
+\fB\-\-link\-maintenance\-interval\fR SECONDS (2s)
+Interval to check link health and
+re\-connect if need be
+.TP
+\fB\-\-link\-heartbeat\-interval\fR SECONDS (120s)
+Heartbeat interval for a federation
+link
+.TP
+\fB\-\-max\-negotiate\-time\fR MILLISECONDS (10000)
+Maximum time a connection can take to
+send the initial protocol negotiation
+.TP
+\fB\-\-federation\-tag\fR NAME
+Override the federation tag
.SS "Logging options:"
.TP
\fB\-t\fR [ \fB\-\-trace\fR ]
@@ -135,16 +166,62 @@ Enables all logging
\fB\-\-log\-enable\fR RULE (notice+)
Enables logging for selected levels and
components. RULE is in the form
-\&'LEVEL[+][:PATTERN]' Levels are one of:
+\&'LEVEL[+\-][:PATTERN]'
+LEVEL is one of:
.IP
trace debug info notice warning error
.IP
critical
+PATTERN is a logging category name, or
+a namespace\-qualified function name or
+name fragment. Logging category names
+are:
+.IP
+Security Broker Management Protocol
+.IP
+System HA Messaging Store Network Test
+Client Model Unspecified
For example:
-\&'\-\-log\-enable warning+' logs all
-warning, error and critical messages.
-\&'\-\-log\-enable debug:framing' logs debug
-messages from the framing namespace.
+\&'\-\-log\-enable warning+'
+logs all warning, error and critical
+messages.
+\&'\-\-log\-enable trace+:Broker'
+logs all category 'Broker' messages.
+\&'\-\-log\-enable debug:framing'
+logs debug messages from all functions
+with 'framing' in the namespace or
+function name.
+This option can be used multiple times
+.TP
+\fB\-\-log\-disable\fR RULE
+Disables logging for selected levels
+and components. RULE is in the form
+\&'LEVEL[+\-][:PATTERN]'
+LEVEL is one of:
+.IP
+trace debug info notice warning error
+.IP
+critical
+PATTERN is a logging category name, or
+a namespace\-qualified function name or
+name fragment. Logging category names
+are:
+.IP
+Security Broker Management Protocol
+.IP
+System HA Messaging Store Network Test
+Client Model Unspecified
+For example:
+\&'\-\-log\-disable warning\-'
+disables logging all warning, notice,
+info, debug, and trace messages.
+\&'\-\-log\-disable trace:Broker'
+disables all category 'Broker' trace
+messages.
+\&'\-\-log\-disable debug\-:qmf::'
+disables logging debug and trace
+messages from all functions with
+\&'qmf::' in the namespace.
This option can be used multiple times
.TP
\fB\-\-log\-time\fR yes|no (1)
@@ -164,8 +241,15 @@ Include thread ID in log messages
Include function signature in log
messages
.TP
+\fB\-\-log\-hires\-timestamp\fR yes|no (0)
+Use hi\-resolution timestamps in log
+messages
+.TP
+\fB\-\-log\-category\fR yes|no (1)
+Include category in log messages
+.TP
\fB\-\-log\-prefix\fR STRING
-Prefix to append to all log messages
+Prefix to prepend to all log messages
.SS "Logging sink options:"
.TP
\fB\-\-log\-to\-stderr\fR yes|no (1)
@@ -197,23 +281,47 @@ default in this mode.
The transport for which to return the
port
.TP
-\fB\-\-pid\-dir\fR DIR
-Directory where port\-specific PID file
-is stored
+\fB\-\-pid\-dir\fR DIR (/home/kpvdr/.qpidd)
+Directory where port\-specific PID file is
+stored
.TP
\fB\-w\fR [ \fB\-\-wait\fR ] SECONDS (600)
-Sets the maximum wait time to
-initialize the daemon. If the daemon
-fails to initialize, prints an error
-and returns 1
+Sets the maximum wait time to initialize
+or shutdown the daemon. If the daemon
+fails to initialize/shutdown, prints an
+error and returns 1
.TP
\fB\-c\fR [ \fB\-\-check\fR ]
-Prints the daemon's process ID to
-stdout and returns 0 if the daemon is
-running, otherwise returns 1
+Prints the daemon's process ID to stdout
+and returns 0 if the daemon is running,
+otherwise returns 1
.TP
\fB\-q\fR [ \fB\-\-quit\fR ]
Tells the daemon to shut down
+.TP
+\fB\-\-socket\-fd\fR FD
+File descriptor for tcp listening socket
+.SS "ACL Options:"
+.TP
+\fB\-\-acl\-file\fR FILE
+The policy file to load from, loaded from
+data dir
+.TP
+\fB\-\-connection\-limit\-per\-user\fR N (0)
+The maximum number of connections allowed
+per user. 0 implies no limit.
+.TP
+\fB\-\-max\-connections\fR N (500)
+The maximum combined number of connections
+allowed. 0 implies no limit.
+.TP
+\fB\-\-connection\-limit\-per\-ip\fR N (0)
+The maximum number of connections allowed
+per host IP address. 0 implies no limit.
+.TP
+\fB\-\-max\-queues\-per\-user\fR N (0)
+The maximum number of queues allowed per
+user. 0 implies no limit.
.SH ENVIRONMENT
.I QPID_<option>
.RS