QPID-3168: fix queue flow control --help text

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1085065 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 157 insertions, 202 deletions

diff --git a/qpid/cpp/docs/man/qpidd.1 b/qpid/cpp/docs/man/qpidd.1
index 48b73b3823..d2cff454cf 100644
--- a/qpid/cpp/docs/man/qpidd.1
+++ b/qpid/cpp/docs/man/qpidd.1
@@ -1,261 +1,230 @@
+.\" 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"
 .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
-\-h [ \-\-help ]
-Displays the
-help message
+\fB\-h\fR [ \fB\-\-help\fR ]
+Displays the help message
 .TP
-\-v [ \-\-version ]
-Displays version
-information
+\fB\-v\fR [ \fB\-\-version\fR ]
+Displays version information
 .TP
-\-\-config FILE
-Reads configurat
-ion from FILE
-
-.SS Module options
-.TP
-\-\-module\-dir DIR
-Load all
-shareable
-modules in
-this directo
-ry
-.TP
-\-\-load\-module FILE
-Specifies
-additional
-module(s) to
-be loaded
-.TP
-\-\-no\-module\-dir
-Don't load
-modules from
-module
+\fB\-\-config\fR FILE
+Reads configuration from FILE
+.SS "Module options:"
+.TP
+\fB\-\-module\-dir\fR DIR
+Load all shareable modules in this
 directory
-
-.SS Broker Options
 .TP
-\-\-data\-dir DIR
-Directory to contain
-persistent data generated
-by the broker
+\fB\-\-load\-module\fR FILE
+Specifies additional module(s) to be
+loaded
+.TP
+\fB\-\-no\-module\-dir\fR
+Don't load modules from module
+directory
+.SS "Broker Options:"
+.TP
+\fB\-\-data\-dir\fR DIR
+Directory to contain persistent data
+generated by the broker
 .TP
-\-\-no\-data\-dir
-Don't use a data
-directory.  No persistent
-configuration will be
-loaded or stored
+\fB\-\-no\-data\-dir\fR
+Don't use a data directory.  No
+persistent configuration will be loaded
+or stored
 .TP
-\-p [ \-\-port ] PORT (5672)
-Tells the broker to
-listen on PORT
+\fB\-p\fR [ \fB\-\-port\fR ] PORT (5672)
+Tells the broker to listen on PORT
 .TP
-\-\-worker\-threads N (9)
-Sets the broker thread
-pool size
+\fB\-\-worker\-threads\fR N (3)
+Sets the broker thread pool size
 .TP
-\-\-max\-connections N (500)
-Sets the maximum allowed
-connections
+\fB\-\-max\-connections\fR N (500)
+Sets the maximum allowed connections
 .TP
-\-\-connection\-backlog N (10)
-Sets the connection
-backlog limit for the
-server socket
+\fB\-\-connection\-backlog\fR N (10)
+Sets the connection backlog limit for
+the server socket
 .TP
-\-m [ \-\-mgmt\-enable ] yes|no (1)
+\fB\-m\fR [ \fB\-\-mgmt\-enable\fR ] yes|no (1)
 Enable Management
 .TP
-\-\-mgmt\-qmf2 yes|no (1)
-Enable broadcast of
-management information
-over QMF v2
-.TP
-\-\-mgmt\-qmf1 yes|no (1)
-Enable broadcast of
-management information
-over QMF v1
-.TP
-\-\-mgmt\-pub\-interval SECONDS (10)
-Management Publish
-Interval
-.TP
-\-\-queue\-purge\-interval SECONDS (600)
-Interval between attempts
-to purge any expired
-messages from queues
-.TP
-\-\-auth yes|no (1)
-Enable authentication, if
-disabled all incoming
-connections will be
-trusted
-.TP
-\-\-realm REALM (QPID)
-Use the given realm when
-performing authentication
-.TP
-\-\-default\-queue\-limit BYTES (104857600)
-Default maximum size for
-queues (in bytes)
-.TP
-\-\-tcp\-nodelay
-Set TCP_NODELAY on TCP
-connections
-.TP
-\-\-require\-encryption
-Only accept connections
-that are encrypted
-\-\-known\-hosts\-url URL or \&'none'                     URL to send as
-\&'known\-hosts' to clients
-(\&'none' implies empty
-list)
-.TP
-\-\-sasl\-config DIR
-gets sasl config info
-from nonstandard location
-.TP
-\-\-max\-session\-rate MESSAGES/S (0)
-Sets the maximum message
-rate per session
-(0=unlimited)
-.TP
-\-\-async\-queue\-events yes|no (0)
-Set Queue Events async,
-used for services like
-replication
-.TP
-\-\-default\-flow\-stop\-threshold %MESSAGES (80)
-Queue capacity level at
-which flow control is
-activated.
-.TP
-\-\-default\-flow\-resume\-threshold %MESSAGES (70)
-Queue capacity level at
-which flow control is
-de\-activated.
-.TP
-\-\-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
+\fB\-\-mgmt\-qmf2\fR yes|no (1)
+Enable broadcast of management
+information over QMF v2
+.TP
+\fB\-\-mgmt\-qmf1\fR yes|no (1)
+Enable broadcast of management
+information over QMF v1
+.TP
+\fB\-\-mgmt\-pub\-interval\fR SECONDS (10)
+Management Publish Interval
+.TP
+\fB\-\-queue\-purge\-interval\fR SECONDS (600)
+Interval between attempts to purge any
+expired messages from queues
+.TP
+\fB\-\-auth\fR 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
+authentication
+.TP
+\fB\-\-default\-queue\-limit\fR BYTES (104857600)
+Default maximum size for queues (in
+bytes)
+.TP
+\fB\-\-tcp\-nodelay\fR
+Set TCP_NODELAY on TCP connections
+.TP
+\fB\-\-require\-encryption\fR
+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
+which flow control is activated.
+.TP
+\fB\-\-default\-flow\-resume\-threshold\fR 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
+at which an event will be raised
+.SS "Logging options:"
 .TP
-\-t [ \-\-trace ]
+\fB\-t\fR [ \fB\-\-trace\fR ]
 Enables all logging
 .TP
-\-\-log\-enable RULE (notice+)
-Enables logging for selected levels
-and components. RULE is in the form
-\&'LEVEL[+][:PATTERN]' Levels are one
-of:
-trace debug info notice warning
-error critical
+\fB\-\-log\-enable\fR 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
+critical
 For example:
 \&'\-\-log\-enable warning+' logs all
 warning, error and critical messages.
-\&'\-\-log\-enable debug:framing' logs
-debug messages from the framing
-namespace. This option can be used
-multiple times
+\&'\-\-log\-enable debug:framing' logs debug
+messages from the framing namespace.
+This option can be used multiple times
 .TP
-\-\-log\-time yes|no (1)
+\fB\-\-log\-time\fR yes|no (1)
 Include time in log messages
 .TP
-\-\-log\-level yes|no (1)
-Include severity level in log
-messages
+\fB\-\-log\-level\fR yes|no (1)
+Include severity level in log messages
 .TP
-\-\-log\-source yes|no (0)
+\fB\-\-log\-source\fR yes|no (0)
 Include source file:line in log
 messages
 .TP
-\-\-log\-thread yes|no (0)
+\fB\-\-log\-thread\fR yes|no (0)
 Include thread ID in log messages
 .TP
-\-\-log\-function yes|no (0)
+\fB\-\-log\-function\fR yes|no (0)
 Include function signature in log
 messages
 .TP
-\-\-log\-prefix STRING
+\fB\-\-log\-prefix\fR STRING
 Prefix to append to all log messages
-
-.SS Logging sink options
+.SS "Logging sink options:"
 .TP
-\-\-log\-to\-stderr yes|no (1)
+\fB\-\-log\-to\-stderr\fR yes|no (1)
 Send logging output to stderr
 .TP
-\-\-log\-to\-stdout yes|no (0)
+\fB\-\-log\-to\-stdout\fR yes|no (0)
 Send logging output to stdout
 .TP
-\-\-log\-to\-file FILE
+\fB\-\-log\-to\-file\fR FILE
 Send log output to FILE.
 .TP
-\-\-log\-to\-syslog yes|no (0)
+\fB\-\-log\-to\-syslog\fR yes|no (0)
 Send logging output to syslog;
-customize using \-\-syslog\-name and
-\-\-syslog\-facility
+customize using \fB\-\-syslog\-name\fR and
+\fB\-\-syslog\-facility\fR
 .TP
-\-\-syslog\-name NAME (lt\-qpidd)
+\fB\-\-syslog\-name\fR NAME (lt\-qpidd)
 Name to use in syslog messages
 .TP
-\-\-syslog\-facility LOG_XXX (LOG_DAEMON)
+\fB\-\-syslog\-facility\fR LOG_XXX (LOG_DAEMON)
 Facility to use in syslog messages
-
-.SS Daemon options
+.SS "Daemon options:"
 .TP
-\-d [ \-\-daemon ]
-Run as a daemon. Logs to syslog
-by default in this mode.
+\fB\-d\fR [ \fB\-\-daemon\fR ]
+Run as a daemon. Logs to syslog by
+default in this mode.
 .TP
-\-\-transport TRANSPORT (tcp)
-The transport for which to
-return the port
+\fB\-\-transport\fR TRANSPORT (tcp)
+The transport for which to return the
+port
 .TP
-\-\-pid\-dir DIR
-Directory where port\-specific
-PID file is stored
+\fB\-\-pid\-dir\fR DIR
+Directory where port\-specific PID file
+is stored
 .TP
-\-w [ \-\-wait ] SECONDS (600)
+\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
+initialize the daemon. If the daemon
+fails to initialize, prints an error
+and returns 1
 .TP
-\-c [ \-\-check ]
-Prints the daemon's process ID
-to stdout and returns 0 if the
-daemon is running, otherwise
-returns 1
+\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
 .TP
-\-q [ \-\-quit ]
+\fB\-q\fR [ \fB\-\-quit\fR ]
 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:
 
+  export QPID_PORT=6000
+  export QPID_MAX_CONNECTIONS=10
+  export QPID_LOG_TO_FILE=/tmp/qpidd.log
 .SH FILES
 .I /etc/qpidd.conf
 .RS
@@ -270,23 +239,9 @@ 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