diff options
Diffstat (limited to 'qpid/cpp/docs/man/qpidd.1')
| -rw-r--r-- | qpid/cpp/docs/man/qpidd.1 | 407 |
1 files changed, 280 insertions, 127 deletions
diff --git a/qpid/cpp/docs/man/qpidd.1 b/qpid/cpp/docs/man/qpidd.1 index d2cff454cf..f48712fad8 100644 --- a/qpid/cpp/docs/man/qpidd.1 +++ b/qpid/cpp/docs/man/qpidd.1 @@ -1,230 +1,369 @@ -.\" 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" +.\" +.\" 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. +.\" + +.TH QPIDD "1" "December 2013" "qpidd (qpid-cpp) version 0.27" "User Commands" .SH NAME qpidd \- the Qpid AMQP Message Broker Daemon + .SH SYNOPSIS qpidd [-p port] [--config config_file] [--data-dir directory] + .SH DESCRIPTION An AMQP message broker daemon that stores, routes and forwards messages using the Advanced Message Queueing Protocol (AMQP). + .SH OPTIONS The options below are built-in to qpidd. Installing add-on modules provides additional options. To see the full set of options available type "qpidd --help" Options may be specified via command line, environment variable or configuration file. See FILES and ENVIRONMENT below for details. + .PP +.SS Options + .TP -\fB\-h\fR [ \fB\-\-help\fR ] +\-h [ \-\-help ] Displays the help message .TP -\fB\-v\fR [ \fB\-\-version\fR ] +\-v [ \-\-version ] Displays version information .TP -\fB\-\-config\fR FILE +\-\-config FILE (/etc/qpid/qpidd.conf) Reads configuration from FILE -.SS "Module options:" -.TP -\fB\-\-module\-dir\fR DIR -Load all shareable modules in this +\-\-client\-config FILE (/etc/qpid/qpidc.conf) +Reads client configuration from FILE +(for cluster interconnect) + +.SS Module options +\-\-module\-dir DIR (/usr/lib64/qpid/daemon) +Load all shareable modules in this directory .TP -\fB\-\-load\-module\fR FILE -Specifies additional module(s) to be +\-\-load\-module FILE +Specifies additional module(s) to be loaded .TP -\fB\-\-no\-module\-dir\fR -Don't load modules from module +\-\-no\-module\-dir +Don't load modules from module directory -.SS "Broker Options:" -.TP -\fB\-\-data\-dir\fR DIR -Directory to contain persistent data + +.SS Broker Options +\-\-data\-dir DIR (/home/aconway/.qpidd) +Directory to contain persistent data generated by the broker .TP -\fB\-\-no\-data\-dir\fR -Don't use a data directory. No +\-\-no\-data\-dir +Don't use a data directory. No persistent configuration will be loaded or stored .TP -\fB\-p\fR [ \fB\-\-port\fR ] PORT (5672) +\-\-paging\-dir DIR +Directory in which paging files will be +created for paged queues +.TP +\-p [ \-\-port ] PORT (5672) Tells the broker to listen on PORT +\-\-interface <interface name>|<interface address> +Which network interfaces to use to +listen for incoming connections +\-\-listen\-disable <transport name> Transports to disable listening .TP -\fB\-\-worker\-threads\fR N (3) +\-\-worker\-threads N (5) Sets the broker thread pool size .TP -\fB\-\-max\-connections\fR N (500) -Sets the maximum allowed connections -.TP -\fB\-\-connection\-backlog\fR N (10) -Sets the connection backlog limit for +\-\-connection\-backlog N (10) +Sets the connection backlog limit for the server socket .TP -\fB\-m\fR [ \fB\-\-mgmt\-enable\fR ] yes|no (1) +\-m [ \-\-mgmt\-enable ] yes|no (1) Enable Management .TP -\fB\-\-mgmt\-qmf2\fR yes|no (1) -Enable broadcast of management +\-\-mgmt\-publish yes|no (1) +Enable Publish of Management Data (\&'no' +implies query\-only) +.TP +\-\-mgmt\-qmf2 yes|no (1) +Enable broadcast of management information over QMF v2 .TP -\fB\-\-mgmt\-qmf1\fR yes|no (1) -Enable broadcast of management +\-\-mgmt\-qmf1 yes|no (0) +Enable broadcast of management information over QMF v1 .TP -\fB\-\-mgmt\-pub\-interval\fR SECONDS (10) +\-\-mgmt\-pub\-interval SECONDS (10s) Management Publish Interval -.TP -\fB\-\-queue\-purge\-interval\fR SECONDS (600) -Interval between attempts to purge any +\-\-queue\-purge\-interval SECONDS (600s) +Interval between attempts to purge any expired messages from queues .TP -\fB\-\-auth\fR yes|no (1) -Enable authentication, if disabled all +\-\-auth yes|no (1) +Enable authentication, if disabled all incoming connections will be trusted .TP -\fB\-\-realm\fR REALM (QPID) -Use the given realm when performing +\-\-realm REALM (QPID) +Use the given realm when performing authentication -.TP -\fB\-\-default\-queue\-limit\fR BYTES (104857600) -Default maximum size for queues (in +\-\-default\-queue\-limit BYTES (104857600) +Default maximum size for queues (in bytes) .TP -\fB\-\-tcp\-nodelay\fR +\-\-tcp\-nodelay Set TCP_NODELAY on TCP connections .TP -\fB\-\-require\-encryption\fR -Only accept connections that are +\-\-require\-encryption +Only accept connections that are encrypted -.TP -\fB\-\-known\-hosts\-url\fR URL or '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 -.TP -\fB\-\-default\-flow\-stop\-threshold\fR PERCENT (80) -Percent of queue's maximum capacity at +\-\-known\-hosts\-url URL or \&'none' (none) +URL to send as \&'known\-hosts' to clients +(\&'none' implies empty list) +.TP +\-\-sasl\-config DIR +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. +\-\-default\-flow\-stop\-threshold PERCENT (80) +Percent of queue's maximum capacity at which flow control is activated. -.TP -\fB\-\-default\-flow\-resume\-threshold\fR PERCENT (70) -Percent of queue's maximum capacity at +\-\-default\-flow\-resume\-threshold PERCENT (70) +Percent of queue's maximum capacity at which flow control is de\-activated. -.TP -\fB\-\-default\-event\-threshold\-ratio\fR %age of limit (80) -The ratio of any specified queue limit +\-\-default\-event\-threshold\-ratio %age of limit (80) +The ratio of any specified queue limit at which an event will be raised -.SS "Logging options:" +\-\-default\-message\-group GROUP\-IDENTIFER (qpid.no\-group) +Group identifier to assign to messages +delivered to a message group queue that +do not contain an identifier. +.TP +\-\-enable\-timestamp yes|no (0) +Add current time to each received +message. +\-\-link\-maintenance\-interval SECONDS (2s) +Interval to check link health and +.TP + re\-connect +if need be +\-\-link\-heartbeat\-interval SECONDS (120s) +Heartbeat interval for a federation +link +\-\-max\-negotiate\-time MILLISECONDS (10000) +Maximum time a connection can take to +send the initial protocol negotiation +.TP +\-\-federation\-tag NAME +Override the federation tag + +.SS Logging options .TP -\fB\-t\fR [ \fB\-\-trace\fR ] +\-t [ \-\-trace ] Enables all logging .TP -\fB\-\-log\-enable\fR RULE (notice+) +\-\-log\-enable RULE (notice+) Enables logging for selected levels and -components. RULE is in the form -\&'LEVEL[+][:PATTERN]' Levels are one of: -.IP -trace debug info notice warning error -.IP +components. RULE is in the form +\&'LEVEL[+\-][:PATTERN]' +LEVEL is one of: +trace debug info notice warning error +critical +PATTERN is a logging category name, or +a namespace\-qualified function name or +name fragment. Logging category names +are: +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Model Unspecified +For example: +\&'\-\-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 +\-\-log\-disable RULE +Disables logging for selected levels +and components. RULE is in the form +\&'LEVEL[+\-][:PATTERN]' +LEVEL is one of: +trace debug info notice warning error critical +PATTERN is a logging category name, or +a namespace\-qualified function name or +name fragment. Logging category names +are: +Security Broker Management Protocol +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\-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) +\-\-log\-time yes|no (1) Include time in log messages .TP -\fB\-\-log\-level\fR yes|no (1) +\-\-log\-level yes|no (1) Include severity level in log messages .TP -\fB\-\-log\-source\fR yes|no (0) -Include source file:line in log +\-\-log\-source yes|no (0) +Include source file:line in log messages .TP -\fB\-\-log\-thread\fR yes|no (0) +\-\-log\-thread yes|no (0) Include thread ID in log messages .TP -\fB\-\-log\-function\fR yes|no (0) -Include function signature in log +\-\-log\-function yes|no (0) +Include function signature in log messages .TP -\fB\-\-log\-prefix\fR STRING -Prefix to append to all log messages -.SS "Logging sink options:" +\-\-log\-hires\-timestamp yes|no (0) +Use hi\-resolution timestamps in log +messages +.TP +\-\-log\-category yes|no (1) +Include category in log messages .TP -\fB\-\-log\-to\-stderr\fR yes|no (1) +\-\-log\-prefix STRING +Prefix to prepend to all log messages + +.SS Logging sink options +.TP +\-\-log\-to\-stderr yes|no (1) Send logging output to stderr .TP -\fB\-\-log\-to\-stdout\fR yes|no (0) +\-\-log\-to\-stdout yes|no (0) Send logging output to stdout .TP -\fB\-\-log\-to\-file\fR FILE +\-\-log\-to\-file FILE Send log output to FILE. .TP -\fB\-\-log\-to\-syslog\fR yes|no (0) +\-\-log\-to\-syslog yes|no (0) Send logging output to syslog; -customize using \fB\-\-syslog\-name\fR and -\fB\-\-syslog\-facility\fR +customize using \-\-syslog\-name and +\-\-syslog\-facility .TP -\fB\-\-syslog\-name\fR NAME (lt\-qpidd) +\-\-syslog\-name NAME (qpidd) Name to use in syslog messages -.TP -\fB\-\-syslog\-facility\fR LOG_XXX (LOG_DAEMON) +\-\-syslog\-facility LOG_XXX (LOG_DAEMON) Facility to use in syslog messages -.SS "Daemon options:" + +.SS Daemon options .TP -\fB\-d\fR [ \fB\-\-daemon\fR ] -Run as a daemon. Logs to syslog by +\-d [ \-\-daemon ] +Run as a daemon. Logs to syslog by default in this mode. .TP -\fB\-\-transport\fR TRANSPORT (tcp) -The transport for which to return the +\-\-transport TRANSPORT (tcp) +The transport for which to return the port .TP -\fB\-\-pid\-dir\fR DIR -Directory where port\-specific PID file +\-\-pid\-dir DIR (/home/aconway/.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 +\-w [ \-\-wait ] SECONDS (600) +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 +\-c [ \-\-check ] +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 ] +\-q [ \-\-quit ] Tells the daemon to shut down -.SH 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: +.TP +\-\-socket\-fd FD +File descriptor for tcp listening socket + +.SS ACL Options +.TP +\-\-acl\-file FILE +The policy file to load from, loaded from +data dir +.TP +\-\-connection\-limit\-per\-user N (0) +The maximum number of connections allowed +per user. 0 implies no limit. +.TP +\-\-max\-connections N (500) +The maximum combined number of connections +allowed. 0 implies no limit. +.TP +\-\-connection\-limit\-per\-ip N (0) +The maximum number of connections allowed +per host IP address. 0 implies no limit. +.TP +\-\-max\-queues\-per\-user N (0) +The maximum number of queues allowed per +user. 0 implies no limit. + +.SS SSL Settings +.TP +\-\-ssl\-use\-export\-policy +Use NSS export policy +.TP +\-\-ssl\-cert\-password\-file PATH +File containing password to use for +accessing certificate database +.TP +\-\-ssl\-cert\-db PATH +Path to directory containing certificate +database +.TP +\-\-ssl\-cert\-name NAME (gonzo) +Name of the certificate to use +.TP +\-\-ssl\-port PORT (5671) +Port on which to listen for SSL +connections +.TP +\-\-ssl\-require\-client\-authentication +Forces clients to authenticate in order +to establish an SSL connection +.TP +\-\-ssl\-sasl\-no\-dict +Disables SASL mechanisms that are +vulnerable to passive dictionary\-based +password attacks - export QPID_PORT=6000 - export QPID_MAX_CONNECTIONS=10 - export QPID_LOG_TO_FILE=/tmp/qpidd.log .SH FILES .I /etc/qpidd.conf .RS @@ -239,9 +378,23 @@ Each line is a name=value pair. Blank lines and lines beginning with # are ignor port=6000 max-connections=10 log-to-file=/tmp/qpidd.log + +.SH 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 + .SH AUTHOR The Apache Qpid Project, dev@qpid.apache.org -.SH "REPORTING BUGS" + +.SH REPORTING BUGS Please report bugs to users@qpid.apache.org |