QPID-7821: Add man pages for all executables. Adapted from a patch fr…

…om Irina Boverman.

docs/man/CMakeLists.txt

@@ -17,6 +17,6 @@
 # under the License.
 #
 
-INSTALL (FILES qpidd.1
+install (FILES qpidd.1 qmf-gen.1 qpid-printevents.1 qpid-receive.1 qpid-send.1 qpid-tool.1
+               qpid-config.1 qpid-ha.1 qpid-queue-stats.1 qpid-route.1 qpid-stat.1
          DESTINATION ${QPID_INSTALL_MANDIR}/man1)
-

docs/man/generate_manpage → docs/man/generate-manpages.sh

@@ -17,11 +17,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+#
+# Assumes all tools are installed
+#
+ver="($(qpidd --version | cut -d"(" -f2)"
+#
+help2man --no-info --include=qpidd.x --output=qpidd.1 --version-option="--version" qpidd
+#
+man_pages="qpid-tool qmf-gen qpid-config qpid-ha qpid-printevents qpid-queue-stats qpid-route qpid-stat"
+for page in ${man_pages} 
+do
+  help2man --no-info --include=${page}.x --output=${page}.1 --version-string=" $ver" $page
+done
+#
+man_pages="qpid-receive qpid-send"
+for page in ${man_pages} 
+do
+  help2man --no-info --include=${page}.x --output=${page}.1 --version-string=" $ver" --no-discard-stderr $page
+done
 
-test -n "$3" || { echo "Usage: $0 <source> <qpidd> <output>"; exit 1; }
+exit
 
-$2 --help --no-module-dir | grep -v 'Usage: ' | sed -f $(dirname $0)/groffify_options.sed > .temp.options.groff
-cat $1 | sed -f $(dirname $0)/groffify_template.sed | sed -e '/^\.PP$/ r .temp.options.groff' -e "/^.SH NAME/ i\
-.TH QPIDD \"1\" \"$(date +'%B %Y')\" \"$($2 -v)\" \"User Commands\"
-" > $3
-rm .temp.options.groff

docs/man/qmf-gen.1

@@ -0,0 +1,51 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH QMF-GEN "1" "March 2018" "qmf-gen  (qpid-cpp) version 1.38.0" "User Commands"
+.SH NAME
+
+qmf-gen \- QMF Tool
+.SH SYNOPSIS
+
+qmf-gen [options] schema-document...
+.SH DESCRIPTION
+
+QPID management framework tool.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-o\fR DIR, \fB\-\-outputdir\fR=\fI\,DIR\/\fR
+Output directory
+.TP
+\fB\-c\fR FILE, \fB\-\-cmakelists\fR=\fI\,FILE\/\fR
+CMakeLists fragment
+.TP
+\fB\-m\fR FILE, \fB\-\-makefile\fR=\fI\,FILE\/\fR
+Makefile fragment
+.TP
+\fB\-t\fR FILE, \fB\-\-typefile\fR=\fI\,FILE\/\fR
+Override type descriptor file
+.TP
+\fB\-d\fR DIR, \fB\-\-templatedir\fR=\fI\,DIR\/\fR
+Override template directory
+.TP
+\fB\-p\fR GENPREFIX, \fB\-\-gen\-prefix\fR=\fI\,GENPREFIX\/\fR
+Prefix for generated files in make dependencies
+.TP
+\fB\-q\fR, \fB\-\-qpid\-broker\fR
+Generate makefile for Qpid broker
+.TP
+\fB\-b\fR, \fB\-\-broker\-plugin\fR
+Generate code for use in a qpid broker plugin
+.TP
+\fB\-2\fR, \fB\-\-v2\-style\fR
+Generate code for use with the QMFv2 Agent API
+.TP
+\fB\-l\fR, \fB\-\-qpid\-logs\fR
+Generate code for QPID_LOG statements in classes constructor/destructor
+.SH AUTHOR
+
+The Apache Qpid Project, [email protected]
+.SH "REPORTING BUGS"
+
+Please report bugs to [email protected]

docs/man/qmf-gen.x

@@ -0,0 +1,38 @@
+.\"
+.\" 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.
+.\"
+
+[NAME]
+
+qmf-gen \- QMF Tool
+
+[SYNOPSIS]
+
+qmf-gen [options] schema-document...
+
+[DESCRIPTION]
+
+QPID management framework tool.
+
+[AUTHOR]
+
+The Apache Qpid Project, [email protected]
+
+[REPORTING BUGS]
+
+Please report bugs to [email protected]

docs/man/qpid-config.1

@@ -0,0 +1,204 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
+.TH QPID-CONFIG "1" "March 2018" "qpid-config  (qpid-cpp) version 1.38.0" "User Commands"
+.SH NAME
+
+qpid-config \-  QPID Broker Configuration Tool
+.SH SYNOPSIS
+
+qpid-config [OPTIONS] commands
+.SH DESCRIPTION
+
+Usage:  qpid-config [OPTIONS]
+        qpid-config [OPTIONS] exchanges [filter-string]
+        qpid-config [OPTIONS] queues    [filter-string]
+        qpid-config [OPTIONS] add exchange <type> <name> [AddExchangeOptions]
+        qpid-config [OPTIONS] del exchange <name>
+        qpid-config [OPTIONS] add queue <name> [AddQueueOptions]
+        qpid-config [OPTIONS] del queue <name> [DelQueueOptions]
+        qpid-config [OPTIONS] bind   <exchange-name> <queue-name> [binding-key]
+                  <for type xml>     [-f -|filename]
+                  <for type header>  [all|any] k1=v1 [, k2=v2...]
+        qpid-config [OPTIONS] unbind <exchange-name> <queue-name> [binding-key]
+        qpid-config [OPTIONS] reload-acl
+        qpid-config [OPTIONS] add <type> <name> [--argument <property-name>=<property-value>]
+        qpid-config [OPTIONS] del <type> <name>
+        qpid-config [OPTIONS] list <type> [--show-property <property-name>]
+        qpid-config [OPTIONS] log [<logstring>]
+        qpid-config [OPTIONS] shutdown"""
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.IP
+General Options:
+.TP
+\fB\-t\fR <secs>, \fB\-\-timeout=\fR<secs>
+Maximum time to wait for broker connection (in seconds)
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+Show bindings in queue or exchange list
+.TP
+\fB\-b\fR <address>, \fB\-\-broker=\fR<address>
+Address of qpidd broker with syntax: [username/password@] hostname | ip\-address [:<port>]
+.HP
+\fB\-a\fR <address>, \fB\-\-broker\-addr=\fR<address>
+.TP
+\fB\-\-sasl\-mechanism=\fR<mech>
+SASL mechanism for authentication (e.g. EXTERNAL, ANONYMOUS, PLAIN, CRAM\-MD5, DIGEST\-MD5, GSSAPI). SASL
+automatically picks the most secure available mechanism \- use this option to override.
+.TP
+\fB\-\-sasl\-service\-name\fR=\fI\,SASL_SERVICE_NAME\/\fR
+SASL service name to use
+.TP
+\fB\-\-ssl\-certificate=\fR<cert>
+Client SSL certificate (PEM Format)
+.TP
+\fB\-\-ssl\-key=\fR<key>
+Client SSL private key (PEM Format)
+.TP
+\fB\-\-ha\-admin\fR
+Allow connection to a HA backup broker.
+.IP
+Options for Listing Exchanges and Queues:
+.TP
+\fB\-\-ignore\-default\fR
+Ignore the default exchange in exchange or queue list
+.IP
+Options for Adding Exchanges and Queues:
+.TP
+\fB\-\-alternate\-exchange=\fR<aexname>
+Name of the alternate\-exchange for the new queue or exchange. Exchanges route messages to the alternate
+exchange if they are unable to route them elsewhere. Queues route messages to the alternate exchange if they
+are rejected by a subscriber or orphaned by queue deletion.
+.TP
+\fB\-\-durable\fR
+The new queue or exchange is durable.
+.TP
+\fB\-\-replicate=\fR<level>
+Enable automatic replication in a HA cluster. <level> is 'none', 'configuration' or 'all').
+.IP
+Options for Adding Queues:
+.TP
+\fB\-\-file\-count=\fR<n>
+[legacystore] Number of files in queue's persistence journal
+.TP
+\fB\-\-file\-size=\fR<n>
+[legactystore] File size in pages (64KiB/page)
+.TP
+\fB\-\-efp\-partition\-num=\fR<n>
+[linearstore] EFP partition number
+.TP
+\fB\-\-efp\-pool\-file\-size=\fR<n>
+[linearstore] EFP file size (KiB)
+.TP
+\fB\-\-wcache\-page\-size=\fR<n>
+[linearstore] Per\-queue buffer page size (kiB), value may be powers of 2 starting at 4 (4, 8, 16, 32...)
+.TP
+\fB\-\-wcache\-num\-pages=\fR<n>
+[linearstore] Per\-queue num buffer pages
+.TP
+\fB\-\-max\-queue\-size=\fR<n>
+Maximum in\-memory queue size as bytes
+.TP
+\fB\-\-max\-queue\-count=\fR<n>
+Maximum in\-memory queue size as a number of messages
+.TP
+\fB\-\-limit\-policy=\fR<policy>
+Action to take when queue limit is reached
+.TP
+\fB\-\-lvq\-key=\fR<key>
+Last Value Queue key
+.TP
+\fB\-\-flow\-stop\-size=\fR<n>
+Turn on sender flow control when the number of queued bytes exceeds this value.
+.TP
+\fB\-\-flow\-resume\-size=\fR<n>
+Turn off sender flow control when the number of queued bytes drops below this value.
+.TP
+\fB\-\-flow\-stop\-count=\fR<n>
+Turn on sender flow control when the number of queued messages exceeds this value.
+.TP
+\fB\-\-flow\-resume\-count=\fR<n>
+Turn off sender flow control when the number of queued messages drops below this value.
+.TP
+\fB\-\-group\-header=\fR<header\-name>
+Enable message groups. Specify name of header that holds group identifier.
+.TP
+\fB\-\-shared\-groups\fR
+Allow message group consumption across multiple consumers.
+.TP
+\fB\-\-argument=\fR<NAME=VALUE>
+Specify a key\-value pair to add to queue arguments
+.TP
+\fB\-\-start\-replica=\fR<broker\-url>
+Start replication from the same\-named queue at <broker\-url>
+.IP
+Options for Adding Exchanges:
+.TP
+\fB\-\-sequence\fR
+Exchange will insert a 'qpid.msg_sequence' field in the message header
+.TP
+\fB\-\-ive\fR
+Exchange will behave as an 'initial\-value\-exchange', keeping a reference  to the last message forwarded and
+enqueuing that message to newly bound queues.
+.IP
+Options for Deleting Queues:
+.TP
+\fB\-\-force\fR
+Force delete of queue even if it's currently used or it's not empty
+.TP
+\fB\-\-force\-if\-not\-empty\fR
+Force delete of queue even if it's not empty
+.TP
+\fB\-\-force\-if\-used\fR
+Force delete of queue even if it's currently used
+.IP
+Options for Declaring Bindings:
+.TP
+\fB\-f\fR <file.xq>, \fB\-\-file=\fR<file.xq>
+For XML Exchange bindings \- specifies the name of a file containing an XQuery.
+.IP
+Formatting options for 'list' action:
+.TP
+\fB\-\-show\-property=\fR<property\-name>
+Specify a property of an object to be included in output
+.SH EXAMPLES
+
+$ qpid-config add queue q
+
+$ qpid-config add exchange direct d -a localhost:5672
+
+$ qpid-config exchanges -b 10.1.1.7:10000
+
+$ qpid-config queues -b guest/guest@broker-host:10000
+
+Add Exchange <type> values:
+
+    direct     Direct exchange for point-to-point communication
+    fanout     Fanout exchange for broadcast communication
+    topic      Topic exchange that routes messages using binding keys with wildcards
+    headers    Headers exchange that matches header fields against the binding keys
+    xml        XML Exchange - allows content filtering using an XQuery
+
+
+Queue Limit Actions:
+
+    none (default) - Use broker's default policy
+    reject         - Reject enqueued messages
+    ring           - Replace oldest unacquired message with new
+
+Replication levels:
+
+    none           - no replication
+    configuration  - replicate queue and exchange existence and bindings, but not messages.
+    all            - replicate configuration and messages
+
+Log <logstring> value:
+
+    Comma separated <module>:<level> pairs, e.g. 'info+,debug+:Broker,trace+:Queue'
+.SH AUTHOR
+
+The Apache Qpid Project, [email protected]
+.SH "REPORTING BUGS"
+
+Please report bugs to [email protected]