QPID-7821: Add man pages for all executables. Adapted from a patch from Irina Boverman.
Project: http://git-wip-us.apache.org/repos/asf/qpid-cpp/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-cpp/commit/cd6cad73 Tree: http://git-wip-us.apache.org/repos/asf/qpid-cpp/tree/cd6cad73 Diff: http://git-wip-us.apache.org/repos/asf/qpid-cpp/diff/cd6cad73 Branch: refs/heads/master Commit: cd6cad7364afd2ed78a21c2cad42c85304d8080e Parents: 26b6c37 Author: Justin Ross <jr...@apache.org> Authored: Mon Mar 12 15:37:45 2018 -0700 Committer: Justin Ross <jr...@apache.org> Committed: Wed Mar 14 10:46:27 2018 -0700 ---------------------------------------------------------------------- docs/man/CMakeLists.txt | 4 +- docs/man/generate-manpages.sh | 40 +++ docs/man/generate_manpage | 27 -- docs/man/groffify_options.sed | 25 -- docs/man/groffify_template.sed | 21 -- docs/man/qmf-gen.1 | 51 ++++ docs/man/qmf-gen.x | 38 +++ docs/man/qpid-config.1 | 204 +++++++++++++ docs/man/qpid-config.x | 89 ++++++ docs/man/qpid-ha.1 | 35 +++ docs/man/qpid-ha.x | 38 +++ docs/man/qpid-printevents.1 | 57 ++++ docs/man/qpid-printevents.x | 44 +++ docs/man/qpid-queue-stats.1 | 41 +++ docs/man/qpid-queue-stats.x | 38 +++ docs/man/qpid-receive.1 | 223 ++++++++++++++ docs/man/qpid-receive.x | 38 +++ docs/man/qpid-route.1 | 99 ++++++ docs/man/qpid-route.x | 38 +++ docs/man/qpid-send.1 | 255 ++++++++++++++++ docs/man/qpid-send.x | 38 +++ docs/man/qpid-stat.1 | 88 ++++++ docs/man/qpid-stat.x | 47 +++ docs/man/qpid-tool.1 | 37 +++ docs/man/qpid-tool.x | 38 +++ docs/man/qpidd.1 | 590 ++++++++++++++++++++++-------------- docs/man/qpidd.x | 2 +- 27 files changed, 1944 insertions(+), 301 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/docs/man/CMakeLists.txt b/docs/man/CMakeLists.txt index fe94dc2..3146421 100644 --- a/docs/man/CMakeLists.txt +++ b/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) - http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/generate-manpages.sh ---------------------------------------------------------------------- diff --git a/docs/man/generate-manpages.sh b/docs/man/generate-manpages.sh new file mode 100755 index 0000000..3d47376 --- /dev/null +++ b/docs/man/generate-manpages.sh @@ -0,0 +1,40 @@ +#!/bin/sh +# +# 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. +# +# +# 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 + +exit + http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/generate_manpage ---------------------------------------------------------------------- diff --git a/docs/man/generate_manpage b/docs/man/generate_manpage deleted file mode 100755 index 2d6c146..0000000 --- a/docs/man/generate_manpage +++ /dev/null @@ -1,27 +0,0 @@ -#!/bin/sh -# -# 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. -# - -test -n "$3" || { echo "Usage: $0 <source> <qpidd> <output>"; exit 1; } - -$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 http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/groffify_options.sed ---------------------------------------------------------------------- diff --git a/docs/man/groffify_options.sed b/docs/man/groffify_options.sed deleted file mode 100644 index c0f295e..0000000 --- a/docs/man/groffify_options.sed +++ /dev/null @@ -1,25 +0,0 @@ -# -# 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. -# -s/^\( \{2\}\)\(.*)\)\( \{2,\}\)/.TP\n\2\n/ -s/^\( \{2\}\)\(.*\]\)\( \{2,\}\)/.TP\n\2\n/ -s/^\( \{2\}\)\(.*\b\)\( \{2,\}\)/.TP\n\2\n/ -s/^\([A-Z].*\):$/.SS \1/ -s/-/\\-/g -s/^ \{2,\}// -s/\('.*'\)/\\\&\1/ http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/groffify_template.sed ---------------------------------------------------------------------- diff --git a/docs/man/groffify_template.sed b/docs/man/groffify_template.sed deleted file mode 100644 index 74aaed3..0000000 --- a/docs/man/groffify_template.sed +++ /dev/null @@ -1,21 +0,0 @@ -# -# 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. -# -/\[FILES\]/ i\ -.PP -s/^\[\([A-Z ]*\)\]/.SH \1/ http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qmf-gen.1 ---------------------------------------------------------------------- diff --git a/docs/man/qmf-gen.1 b/docs/man/qmf-gen.1 new file mode 100644 index 0000000..1373986 --- /dev/null +++ b/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, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qmf-gen.x ---------------------------------------------------------------------- diff --git a/docs/man/qmf-gen.x b/docs/man/qmf-gen.x new file mode 100644 index 0000000..955529a --- /dev/null +++ b/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, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-config.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-config.1 b/docs/man/qpid-config.1 new file mode 100644 index 0000000..1736712 --- /dev/null +++ b/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, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-config.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-config.x b/docs/man/qpid-config.x new file mode 100644 index 0000000..07297a9 --- /dev/null +++ b/docs/man/qpid-config.x @@ -0,0 +1,89 @@ +.\" +.\" 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] + +qpid-config \- QPID Broker Configuration Tool + +[SYNOPSIS] + +qpid-config [OPTIONS] commands + +[=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""" + +[=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' + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-ha.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-ha.1 b/docs/man/qpid-ha.1 new file mode 100644 index 0000000..48fbcb6 --- /dev/null +++ b/docs/man/qpid-ha.1 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-HA "1" "March 2018" "qpid-ha (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-ha \- Tool for QPID HA +.SH SYNOPSIS + +qpid-ha <command> [<arguments>] +.SH DESCRIPTION + +Shows broker and HA status, HA configuration and sets up replication. +.PP +usage: qpid\-ha <command> [<arguments>] +.PP +Commands are: +.TP +ping +Check if the broker is alive and responding. +.TP +status +Print HA status. +.TP +replicate +Set up replication from <queue> on <remote\-broker> to <queue> on the current broker. +.TP +query +Print HA configuration and status. +.PP +For help with a command type: qpid\-ha <command> \fB\-\-help\fR +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-ha.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-ha.x b/docs/man/qpid-ha.x new file mode 100644 index 0000000..8434e46 --- /dev/null +++ b/docs/man/qpid-ha.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] + +qpid-ha \- Tool for QPID HA + +[SYNOPSIS] + +qpid-ha <command> [<arguments>] + +[DESCRIPTION] + +Shows broker and HA status, HA configuration and sets up replication. + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-printevents.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-printevents.1 b/docs/man/qpid-printevents.1 new file mode 100644 index 0000000..1acb6ce --- /dev/null +++ b/docs/man/qpid-printevents.1 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-PRINTEVENTS "1" "March 2018" "qpid-printevents (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-printevents \- Collect and Print Events. +.SH SYNOPSIS + +qpid-printevents [options] [broker-addr]... +.SH DESCRIPTION +qpid\-printevents [options] [broker\-addr]... +.PP +Collect and print events from one or more Qpid message brokers. +.PP +If no broker\-addr is supplied, qpid\-printevents connects to 'localhost:5672'. +.PP +[broker\-addr] syntax: +.IP +[username/password@] hostname +ip\-address [:<port>] +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-heartbeats\fR +Use heartbeats. +.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. +.SH EXAMPLES + +Examples: + +$ qpid-printevents localhost:5672 + +$ qpid-printevents 10.1.1.7:10000 + +$ qpid-printevents guest/guest@broker-host:10000 +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-printevents.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-printevents.x b/docs/man/qpid-printevents.x new file mode 100644 index 0000000..f601a41 --- /dev/null +++ b/docs/man/qpid-printevents.x @@ -0,0 +1,44 @@ +.\" +.\" 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] + +qpid-printevents \- Collect and Print Events. + +[SYNOPSIS] + +qpid-printevents [options] [broker-addr]... + +[=EXAMPLES] + +Examples: + +$ qpid-printevents localhost:5672 + +$ qpid-printevents 10.1.1.7:10000 + +$ qpid-printevents guest/guest@broker-host:10000 + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-queue-stats.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-queue-stats.1 b/docs/man/qpid-queue-stats.1 new file mode 100644 index 0000000..c4dfd6f --- /dev/null +++ b/docs/man/qpid-queue-stats.1 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-QUEUE-STATS "1" "March 2018" "qpid-queue-stats (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-queue-stats \- View QPID Broker Queue Stats +.SH SYNOPSIS + +qpid-queue-stats [options] +.SH DESCRIPTION + +Shows information about QPID broker queues. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-a\fR BROKER_ADDRESS, \fB\-\-broker\-address\fR=\fI\,BROKER_ADDRESS\/\fR +broker\-addr is in the form: [username/password@] hostname | ip\-address [:<port>] ex: localhost, +10.1.1.7:10000, broker\-host:10000, guest/guest@localhost +.TP +\fB\-f\fR FILTER, \fB\-\-filter\fR=\fI\,FILTER\/\fR +a list of comma separated queue names (regex are accepted) to show +.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) +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-queue-stats.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-queue-stats.x b/docs/man/qpid-queue-stats.x new file mode 100644 index 0000000..f0031fa --- /dev/null +++ b/docs/man/qpid-queue-stats.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] + +qpid-queue-stats \- View QPID Broker Queue Stats + +[SYNOPSIS] + +qpid-queue-stats [options] + +[DESCRIPTION] + +Shows information about QPID broker queues. + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-receive.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-receive.1 b/docs/man/qpid-receive.1 new file mode 100644 index 0000000..22e8d5d --- /dev/null +++ b/docs/man/qpid-receive.1 @@ -0,0 +1,223 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-RECEIVE "1" "March 2018" "qpid-receive (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-receive \- AMQP Message Receiver +.SH SYNOPSIS + +qpid-receive [OPTIONS] -a [ --address ] ADDRESS +.SH DESCRIPTION + +Receives AMQP messages from AMQP sources. +.SH OPTIONS +.TP +\fB\-b\fR [ \fB\-\-broker\fR ] URL (127.0.0.1) +url of broker to connect to +.TP +\fB\-a\fR [ \fB\-\-address\fR ] ADDRESS +address to receive from +.TP +\fB\-\-connection\-options\fR OPTIONS +options for the connection +.TP +\fB\-\-timeout\fR TIMEOUT (0) +timeout in seconds to wait before +exiting +.TP +\fB\-f\fR [ \fB\-\-forever\fR ] +ignore timeout and wait forever +.TP +\fB\-m\fR [ \fB\-\-messages\fR ] N (0) +Number of messages to receive; 0 means +receive indefinitely +.TP +\fB\-\-ignore\-duplicates\fR +Detect and ignore duplicates (by +checking 'sn' header) +.TP +\fB\-\-verify\-sequence\fR +Verify there are no gaps in the message +sequence (by checking 'sn' header) +.TP +\fB\-\-check\-redelivered\fR +Fails with exception if a duplicate is +not marked as redelivered (only +relevant when ignore\-duplicates is +selected) +.TP +\fB\-\-capacity\fR N (1000) +Pre\-fetch window (0 implies no +pre\-fetch) +.TP +\fB\-\-ack\-frequency\fR N (100) +Ack frequency (0 implies none of the +messages will get accepted) +.TP +\fB\-\-tx\fR N (0) +batch size for transactions (0 implies +transaction are not used) +.TP +\fB\-\-rollback\-frequency\fR N (0) +rollback frequency (0 implies no +transaction will be rolledback) +.TP +\fB\-\-print\-content\fR yes|no (1) +print out message content +.TP +\fB\-\-print\-object\-type\fR yes|no (0) +print a description of the content's +object type if relevant +.TP +\fB\-\-print\-headers\fR yes|no (0) +print out message headers +.TP +\fB\-\-failover\-updates\fR +Listen for membership updates +distributed via amq.failover +.TP +\fB\-\-report\-total\fR +Report total throughput and latency +statistics +.TP +\fB\-\-report\-every\fR N (0) +Report throughput and latency +statistics every N messages. +.TP +\fB\-\-report\-header\fR yes|no (1) +Headers on report. +.TP +\fB\-\-ready\-address\fR ADDRESS +send a message to this address when +ready to receive +.TP +\fB\-\-receive\-rate\fR N (0) +Receive at rate of N messages/second. 0 +means receive as fast as possible. +.TP +\fB\-\-reply\-to\fR REPLY\-TO +specify reply\-to address on response +messages +.TP +\fB\-\-ignore\-reply\-to\fR +Do not send replies even if reply\-to is +set +.TP +\fB\-\-help\fR +print this usage statement +.SS "Logging options:" +.TP +\fB\-t\fR [ \fB\-\-trace\fR ] +Enables all logging +.TP +\fB\-\-log\-enable\fR RULE (notice+) +Enables logging for selected levels and +components. RULE is in the form +\&'LEVEL[+\-][:PATTERN]' +LEVEL is one of: +.TP +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: +.TP +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Application 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 +\fB\-\-log\-disable\fR RULE +Disables logging for selected levels +and components. RULE is in the form +\&'LEVEL[+\-][:PATTERN]' +LEVEL is one of: +.TP +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: +.TP +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Application 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) +Include time in log messages +.TP +\fB\-\-log\-level\fR yes|no (1) +Include severity level in log messages +.TP +\fB\-\-log\-source\fR yes|no (0) +Include source file:line in log +messages +.TP +\fB\-\-log\-thread\fR yes|no (0) +Include thread ID in log messages +.TP +\fB\-\-log\-function\fR yes|no (0) +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 prepend to all log messages +.SS "Logging sink options:" +.TP +\fB\-\-log\-to\-stderr\fR yes|no (1) +Send logging output to stderr +.TP +\fB\-\-log\-to\-stdout\fR yes|no (0) +Send logging output to stdout +.TP +\fB\-\-log\-to\-file\fR FILE +Send log output to FILE. +.TP +\fB\-\-log\-to\-syslog\fR yes|no (0) +Send logging output to syslog; +customize using \fB\-\-syslog\-name\fR and +\fB\-\-syslog\-facility\fR +.TP +\fB\-\-syslog\-name\fR NAME +Name to use in syslog messages +.TP +\fB\-\-syslog\-facility\fR LOG_XXX (LOG_DAEMON) +Facility to use in syslog messages +.PP +Address must be specified! +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-receive.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-receive.x b/docs/man/qpid-receive.x new file mode 100644 index 0000000..6608eb1 --- /dev/null +++ b/docs/man/qpid-receive.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] + +qpid-receive \- AMQP Message Receiver + +[SYNOPSIS] + +qpid-receive [OPTIONS] -a [ --address ] ADDRESS + +[DESCRIPTION] + +Receives AMQP messages from AMQP sources. + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-route.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-route.1 b/docs/man/qpid-route.1 new file mode 100644 index 0000000..4f7674b --- /dev/null +++ b/docs/man/qpid-route.1 @@ -0,0 +1,99 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-ROUTE "1" "March 2018" "qpid-route (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-route \- Management Tool for QPID Routes +.SH SYNOPSIS + +qpid-route [OPTIONS] <commands> +.SH DESCRIPTION + +Manages QPID routes. +.IP +qpid\-route [OPTIONS] dynamic del <dest\-broker> <src\-broker> <exchange> +.TP +qpid\-route [OPTIONS] route add +<dest\-broker> <src\-broker> <exchange> <routing\-key> [tag] [exclude\-list] [mechanism] +.TP +qpid\-route [OPTIONS] route del +<dest\-broker> <src\-broker> <exchange> <routing\-key> +.TP +qpid\-route [OPTIONS] queue add +<dest\-broker> <src\-broker> <exchange> <queue> [mechanism] +.TP +qpid\-route [OPTIONS] queue del +<dest\-broker> <src\-broker> <exchange> <queue> +.TP +qpid\-route [OPTIONS] route list +[<dest\-broker>] +.IP +qpid\-route [OPTIONS] route flush [<dest\-broker>] +qpid\-route [OPTIONS] route map [<broker>] +.TP +qpid\-route [OPTIONS] link add +<dest\-broker> <src\-broker> [mechanism] +.TP +qpid\-route [OPTIONS] link del +<dest\-broker> <src\-broker> +.IP +qpid\-route [OPTIONS] link list [<dest\-broker>] +.PP +ADDRESS syntax: +.IP +[username/password@] hostname +ip\-address [:<port>] +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-timeout=\fR<secs> +Maximum time to wait for broker connection (in seconds) +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Verbose output +.TP +\fB\-q\fR, \fB\-\-quiet\fR +Quiet output, don't print duplicate warnings +.TP +\fB\-d\fR, \fB\-\-durable\fR +Added configuration shall be durable +.TP +\fB\-e\fR, \fB\-\-del\-empty\-link\fR +Delete link after deleting last route on the link +.TP +\fB\-s\fR, \fB\-\-src\-local\fR +Make connection to source broker (push route) +.TP +\fB\-\-ack=\fR<n> +Acknowledge transfers over the bridge in batches of N +.TP +\fB\-\-credit=\fR<msgs> +Maximum number of messages a sender can have outstanding (0=unlimited) +.TP +\fB\-t\fR <transport>, \fB\-\-transport=\fR<transport> +Transport to use for links, defaults to tcp +.TP +\fB\-\-client\-sasl\-mechanism=\fR<mech> +SASL mechanism for authentication (e.g. EXTERNAL, ANONYMOUS, PLAIN, CRAM\-MD5, DIGEST\-MD5, GSSAPI). Used when +the client connects to the destination broker (not for authentication between the source and destination +brokers \- that is specified using the [mechanisms] argument to 'add route'). 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. +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-route.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-route.x b/docs/man/qpid-route.x new file mode 100644 index 0000000..6ca5cea --- /dev/null +++ b/docs/man/qpid-route.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] + +qpid-route \- Management Tool for QPID Routes + +[SYNOPSIS] + +qpid-route [OPTIONS] <commands> + +[DESCRIPTION] + +Manages QPID routes. + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-send.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-send.1 b/docs/man/qpid-send.1 new file mode 100644 index 0000000..c50988c --- /dev/null +++ b/docs/man/qpid-send.1 @@ -0,0 +1,255 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-SEND "1" "March 2018" "qpid-send (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-send \- AMQP Message Sender +.SH SYNOPSIS + +qpid-send [OPTIONS] -a [ --address ] ADDRESS +.SH DESCRIPTION + +Sends AMQP messages to AMQP sources. +.SH OPTIONS +.TP +\fB\-b\fR [ \fB\-\-broker\fR ] URL (127.0.0.1) +url of broker to connect to +.TP +\fB\-a\fR [ \fB\-\-address\fR ] ADDRESS +address to send to +.TP +\fB\-\-connection\-options\fR OPTIONS +options for the connection +.TP +\fB\-m\fR [ \fB\-\-messages\fR ] N (1) +stop after N messages have been sent, 0 +means no limit +.TP +\fB\-i\fR [ \fB\-\-id\fR ] ID +use the supplied id instead of +generating one +.TP +\fB\-\-reply\-to\fR REPLY\-TO +specify reply\-to address +.TP +\fB\-\-send\-eos\fR N (0) +Send N EOS messages to mark end of +input +.TP +\fB\-\-durable\fR yes|no (0) +Mark messages as durable. +.TP +\fB\-\-ttl\fR msecs (0) +Time\-to\-live for messages, in +milliseconds +.TP +\fB\-\-priority\fR PRIORITY (0) +Priority for messages (higher value +implies higher priority) +.TP +\fB\-P\fR [ \fB\-\-property\fR ] NAME=VALUE +specify message property +.TP +\fB\-\-correlation\-id\fR ID +correlation\-id for message +.TP +\fB\-\-user\-id\fR USERID +userid for message +.TP +\fB\-\-auto\-user\-id\fR yes| no (0) +set userid for message based on +authenticated identity +.TP +\fB\-\-content\-string\fR CONTENT +use CONTENT as message content +.TP +\fB\-\-content\-size\fR N (0) +create an N\-byte message content +.TP +\fB\-M\fR [ \fB\-\-content\-map\fR ] NAME=VALUE +specify entry for map content +.TP +\fB\-\-content\-stdin\fR +read message content from stdin, one +line per message +.TP +\fB\-\-capacity\fR N (1000) +size of the senders outgoing message +queue +.TP +\fB\-\-tx\fR N (0) +batch size for transactions (0 implies +transaction are not used) +.TP +\fB\-\-rollback\-frequency\fR N (0) +rollback frequency (0 implies no +transaction will be rolledback) +.TP +\fB\-\-failover\-updates\fR +Listen for membership updates +distributed via amq.failover +.TP +\fB\-\-report\-total\fR +Report total throughput statistics +.TP +\fB\-\-report\-every\fR N (0) +Report throughput statistics every N +messages +.TP +\fB\-\-report\-header\fR yes|no (1) +Headers on report. +.TP +\fB\-\-send\-rate\fR N (0) +Send at rate of N messages/second. 0 +means send as fast as possible. +.TP +\fB\-\-sequence\fR yes|no (1) +Add a sequence number messages property +(required for duplicate/lost message +detection) +.TP +\fB\-\-timestamp\fR yes|no (1) +Add a time stamp messages property +(required for latency measurement) +.TP +\fB\-\-group\-key\fR KEY +Generate groups of messages using +message header 'KEY' to hold the group +identifier +.TP +\fB\-\-group\-prefix\fR STRING (GROUP\-) +Generate group identifers with 'STRING' +prefix (if group\-key specified) +.TP +\fB\-\-group\-size\fR N (10) +Number of messages per a group (if +group\-key specified) +.TP +\fB\-\-group\-randomize\-size\fR +Randomize the number of messages per +group to [1...group\-size] (if group\-key +specified) +.TP +\fB\-\-group\-interleave\fR N (1) +Simultaineously interleave messages +from N different groups (if group\-key +specified) +.TP +\fB\-\-help\fR +print this usage statement +.SS "Logging options:" +.TP +\fB\-t\fR [ \fB\-\-trace\fR ] +Enables all logging +.TP +\fB\-\-log\-enable\fR RULE (notice+) +Enables logging for selected levels and +components. RULE is in the form +\&'LEVEL[+\-][:PATTERN]' +LEVEL is one of: +.TP +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: +.TP +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Application 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 +\fB\-\-log\-disable\fR RULE +Disables logging for selected levels +and components. RULE is in the form +\&'LEVEL[+\-][:PATTERN]' +LEVEL is one of: +.TP +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: +.TP +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Application 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) +Include time in log messages +.TP +\fB\-\-log\-level\fR yes|no (1) +Include severity level in log messages +.TP +\fB\-\-log\-source\fR yes|no (0) +Include source file:line in log +messages +.TP +\fB\-\-log\-thread\fR yes|no (0) +Include thread ID in log messages +.TP +\fB\-\-log\-function\fR yes|no (0) +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 prepend to all log messages +.SS "Logging sink options:" +.TP +\fB\-\-log\-to\-stderr\fR yes|no (1) +Send logging output to stderr +.TP +\fB\-\-log\-to\-stdout\fR yes|no (0) +Send logging output to stdout +.TP +\fB\-\-log\-to\-file\fR FILE +Send log output to FILE. +.TP +\fB\-\-log\-to\-syslog\fR yes|no (0) +Send logging output to syslog; +customize using \fB\-\-syslog\-name\fR and +\fB\-\-syslog\-facility\fR +.TP +\fB\-\-syslog\-name\fR NAME +Name to use in syslog messages +.TP +\fB\-\-syslog\-facility\fR LOG_XXX (LOG_DAEMON) +Facility to use in syslog messages +.PP +Address must be specified! +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-send.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-send.x b/docs/man/qpid-send.x new file mode 100644 index 0000000..60723a7 --- /dev/null +++ b/docs/man/qpid-send.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] + +qpid-send \- AMQP Message Sender + +[SYNOPSIS] + +qpid-send [OPTIONS] -a [ --address ] ADDRESS + +[DESCRIPTION] + +Sends AMQP messages to AMQP sources. + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-stat.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-stat.1 b/docs/man/qpid-stat.1 new file mode 100644 index 0000000..24551a2 --- /dev/null +++ b/docs/man/qpid-stat.1 @@ -0,0 +1,88 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-STAT "1" "March 2018" "qpid-stat (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-stat \- Show QPID Broker Stats +.SH SYNOPSIS + +qpid-stat <commands> [OPTIONS] +.SH DESCRIPTION + +Shows general broker stats, connections, exchanges, queues, +subsriptions, access control list stats and broker memory stats. + +Usage: qpid-stat -g [options] + qpid-stat -c [options] + qpid-stat -e [options] + qpid-stat -q [options] [queue-name] + qpid-stat -u [options] + qpid-stat -m [options] + qpid-stat --acl [options] +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.IP +General Options: +.TP +\fB\-b\fR <url>, \fB\-\-broker=\fR<url> +URL of the broker to query +.TP +\fB\-t\fR <secs>, \fB\-\-timeout=\fR<secs> +Maximum time to wait for broker connection (in seconds) +.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 +Command Options: +.TP +\fB\-g\fR, \fB\-\-general\fR +Show General Broker Stats +.TP +\fB\-c\fR, \fB\-\-connections\fR +Show Connections +.TP +\fB\-e\fR, \fB\-\-exchanges\fR +Show Exchanges +.TP +\fB\-q\fR, \fB\-\-queues\fR +Show Queues +.TP +\fB\-u\fR, \fB\-\-subscriptions\fR +Show Subscriptions +.TP +\fB\-m\fR, \fB\-\-memory\fR +Show Broker Memory Stats +.TP +\fB\-\-acl\fR +Show Access Control List Stats +.IP +Display Options: +.TP +\fB\-S\fR <colname>, \fB\-\-sort\-by=\fR<colname> +Sort by column name +.TP +\fB\-I\fR, \fB\-\-increasing\fR +Sort by increasing value (default = decreasing) +.TP +\fB\-L\fR <n>, \fB\-\-limit=\fR<n> +Limit output to n rows +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-stat.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-stat.x b/docs/man/qpid-stat.x new file mode 100644 index 0000000..09e8fea --- /dev/null +++ b/docs/man/qpid-stat.x @@ -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. +.\" + +[NAME] + +qpid-stat \- Show QPID Broker Stats + +[SYNOPSIS] + +qpid-stat <commands> [OPTIONS] + +[=DESCRIPTION] + +Shows general broker stats, connections, exchanges, queues, +subsriptions, access control list stats and broker memory stats. + +Usage: qpid-stat -g [options] + qpid-stat -c [options] + qpid-stat -e [options] + qpid-stat -q [options] [queue-name] + qpid-stat -u [options] + qpid-stat -m [options] + qpid-stat --acl [options] + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-tool.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpid-tool.1 b/docs/man/qpid-tool.1 new file mode 100644 index 0000000..21ab702 --- /dev/null +++ b/docs/man/qpid-tool.1 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPID-TOOL "1" "March 2018" "qpid-tool (qpid-cpp) version 1.38.0" "User Commands" +.SH NAME + +qpid-tool \- Management Tool for QPID +.SH SYNOPSIS + +qpid-tool [OPTIONS] [[<username>/<password>@]<target-host>[:<tcp-port>]] +.SH DESCRIPTION + +Prints lists of objects, object's content and sets timestamp format. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-b\fR <address>, \fB\-\-broker=\fR<address> +Address of qpidd broker with syntax: [username/password@] hostname | ip\-address [:<port>] +.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<path> +SSL certificate for client authentication +.TP +\fB\-\-ssl\-key=\fR<path> +Private key (if not contained in certificate) +.SH AUTHOR + +The Apache Qpid Project, d...@qpid.apache.org +.SH "REPORTING BUGS" + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpid-tool.x ---------------------------------------------------------------------- diff --git a/docs/man/qpid-tool.x b/docs/man/qpid-tool.x new file mode 100644 index 0000000..8f60c2f --- /dev/null +++ b/docs/man/qpid-tool.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] + +qpid-tool \- Management Tool for QPID + +[SYNOPSIS] + +qpid-tool [OPTIONS] [[<username>/<password>@]<target-host>[:<tcp-port>]] + +[DESCRIPTION] + +Prints lists of objects, object's content and sets timestamp format. + +[AUTHOR] + +The Apache Qpid Project, d...@qpid.apache.org + +[REPORTING BUGS] + +Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpidd.1 ---------------------------------------------------------------------- diff --git a/docs/man/qpidd.1 b/docs/man/qpidd.1 index 58234b0..26e1c19 100644 --- a/docs/man/qpidd.1 +++ b/docs/man/qpidd.1 @@ -1,369 +1,523 @@ -.\" -.\" 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" "November 2017" "qpidd (qpid-cpp) version 1.38.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH QPIDD "1" "March 2018" "qpidd (qpid-cpp) version 1.38.0" "User Commands" .SH NAME qpidd \- the Qpid AMQP Message Broker Daemon - .SH SYNOPSIS -qpidd [-p port] [--config config_file] [--data-dir directory] - +qpidd [OPTIONS] .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 ] +\fB\-h\fR [ \fB\-\-help\fR ] Displays the help message .TP -\-v [ \-\-version ] +\fB\-v\fR [ \fB\-\-version\fR ] Displays version information .TP -\-\-config FILE (/etc/qpid/qpidd.conf) +\fB\-\-config\fR FILE (/etc/qpid/qpidd.conf) Reads configuration from FILE -\-\-client\-config FILE (/etc/qpid/qpidc.conf) -Reads client configuration from FILE +.TP +\fB\-\-client\-config\fR 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 +.SS "Module options:" +.TP +\fB\-\-module\-dir\fR DIR (/usr/lib64/qpid/daemon) +Load all shareable modules in this directory .TP -\-\-load\-module FILE -Specifies additional module(s) to be +\fB\-\-load\-module\fR FILE +Specifies additional module(s) to be loaded .TP -\-\-no\-module\-dir -Don't load modules from module +\fB\-\-no\-module\-dir\fR +Don't load modules from module directory - -.SS Broker Options -\-\-data\-dir DIR (/home/aconway/.qpidd) -Directory to contain persistent data +.SS "Broker Options:" +.TP +\fB\-\-data\-dir\fR DIR ($HOME/.qpidd) +Directory to contain persistent data generated by the broker .TP -\-\-no\-data\-dir -Don't use a data directory. No +\fB\-\-no\-data\-dir\fR +Don't use a data directory. No persistent configuration will be loaded or stored .TP -\-\-paging\-dir DIR +\fB\-\-paging\-dir\fR DIR Directory in which paging files will be created for paged queues .TP -\-p [ \-\-port ] PORT (5672) +\fB\-p\fR [ \fB\-\-port\fR ] PORT (5672) Tells the broker to listen on PORT -\-\-interface <interface name>|<interface address> -Which network interfaces to use to +.TP +\fB\-\-interface\fR <interface name>|<interface address> +Which network interfaces to use to listen for incoming connections -\-\-listen\-disable <transport name> Transports to disable listening .TP -\-\-worker\-threads N (5) +\fB\-\-listen\-disable\fR <transport name> +Transports to disable listening +.TP +\fB\-\-protocols\fR <protocol name+version> +Which protocol versions to allow +.TP +\fB\-\-worker\-threads\fR N (9) Sets the broker thread pool size .TP -\-\-connection\-backlog N (10) -Sets the connection backlog limit for +\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\-publish yes|no (1) -Enable Publish of Management Data (\&'no' +\fB\-\-mgmt\-publish\fR yes|no (1) +Enable Publish of Management Data ('no' implies query\-only) .TP -\-\-mgmt\-qmf2 yes|no (1) -Enable broadcast of management +\fB\-\-mgmt\-qmf2\fR yes|no (1) +Enable broadcast of management information over QMF v2 .TP -\-\-mgmt\-qmf1 yes|no (0) -Enable broadcast of management +\fB\-\-mgmt\-qmf1\fR yes|no (0) +Enable broadcast of management information over QMF v1 .TP -\-\-mgmt\-pub\-interval SECONDS (10s) +\fB\-\-mgmt\-pub\-interval\fR SECONDS (10s) Management Publish Interval -\-\-queue\-purge\-interval SECONDS (600s) -Interval between attempts to purge any +.TP +\fB\-\-queue\-purge\-interval\fR SECONDS (600s) +Interval between attempts to purge any expired messages from queues .TP -\-\-auth yes|no (1) -Enable authentication, if disabled all +\fB\-\-auth\fR yes|no (1) +Enable authentication, if disabled all incoming connections will be trusted .TP -\-\-realm REALM (QPID) -Use the given realm when performing +\fB\-\-realm\fR REALM (QPID) +Use the given realm when performing authentication -\-\-default\-queue\-limit BYTES (104857600) -Default maximum size for queues (in +.TP +\fB\-\-sasl\-service\-name\fR NAME +The service name to specify for SASL +.TP +\fB\-\-default\-queue\-limit\fR BYTES (104857600) +Default maximum size for queues (in bytes) .TP -\-\-tcp\-nodelay +\fB\-\-tcp\-nodelay\fR Set TCP_NODELAY on TCP connections .TP -\-\-require\-encryption -Only accept connections that are +\fB\-\-require\-encryption\fR +Only accept connections that are encrypted -\-\-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 +.TP +\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 +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 +.TP +\fB\-\-default\-flow\-stop\-threshold\fR PERCENT (80) +Percent of queue's maximum capacity at which flow control is activated. -\-\-default\-flow\-resume\-threshold PERCENT (70) -Percent of queue's maximum capacity at +.TP +\fB\-\-default\-flow\-resume\-threshold\fR PERCENT (70) +Percent of queue's maximum capacity at which flow control is de\-activated. -\-\-default\-event\-threshold\-ratio %age of limit (80) -The ratio of any specified queue limit +.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 -\-\-default\-message\-group GROUP\-IDENTIFER (qpid.no\-group) -Group identifier to assign to messages +.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 -\-\-enable\-timestamp yes|no (0) -Add current time to each received +\fB\-\-enable\-timestamp\fR 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 +\fB\-\-link\-maintenance\-interval\fR SECONDS (2s) +Interval to check federation link +health and re\-connect if need be +.TP +\fB\-\-link\-heartbeat\-interval\fR SECONDS (120s) +Heartbeat interval for a federation link -\-\-max\-negotiate\-time MILLISECONDS (10000) -Maximum time a connection can take to +.TP +\fB\-\-dtx\-default\-timeout\fR SECONDS (60) +Default timeout for DTX transaction +before aborting it +.TP +\fB\-\-dtx\-max\-timeout\fR SECONDS (3600) +Maximum allowed timeout for DTX +transaction. A value of zero disables +maximum timeout limit checks and allows +arbitrarily large timeout settings. +.TP +\fB\-\-max\-negotiate\-time\fR MILLISECONDS (10000) +Maximum time a connection can take to send the initial protocol negotiation .TP -\-\-federation\-tag NAME +\fB\-\-federation\-tag\fR NAME Override the federation tag - -.SS Logging options .TP -\-t [ \-\-trace ] +\fB\-\-session\-max\-unacked\fR DELIVERIES (5000) +Maximum number of un\-acknowledged +outoing messages per sesssion +.SS "Logging options:" +.TP +\fB\-t\fR [ \fB\-\-trace\fR ] Enables all logging .TP -\-\-log\-enable RULE (notice+) +\fB\-\-log\-enable\fR RULE (notice+) Enables logging for selected levels and -components. RULE is in the form +components. RULE is in the form \&'LEVEL[+\-][:PATTERN]' -LEVEL is one of: -trace debug info notice warning error +LEVEL is one of: +.TP +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 +PATTERN is a logging category name, or +a namespace\-qualified function name or +name fragment. Logging category names +are: +.TP +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Application Model Unspecified For example: \&'\-\-log\-enable warning+' -logs all warning, error and critical +logs all warning, error and critical messages. \&'\-\-log\-enable trace+:Broker' -logs all category \&'Broker' messages. +logs all category 'Broker' messages. \&'\-\-log\-enable debug:framing' -logs debug messages from all functions -with \&'framing' in the namespace or +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 +\fB\-\-log\-disable\fR 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 +LEVEL is one of: +.TP +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 +PATTERN is a logging category name, or +a namespace\-qualified function name or +name fragment. Logging category names +are: +.TP +Security Broker Management Protocol +System HA Messaging Store Network Test +Client Application Model Unspecified For example: \&'\-\-log\-disable warning\-' -disables logging all warning, notice, +disables logging all warning, notice, info, debug, and trace messages. \&'\-\-log\-disable trace:Broker' -disables all category \&'Broker' trace +disables all category 'Broker' trace messages. \&'\-\-log\-disable debug\-:qmf::' -disables logging debug and trace -messages from all functions with +disables logging debug and trace +messages from all functions with \&'qmf::' in the 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) +\fB\-\-log\-level\fR yes|no (1) Include severity level in log messages .TP -\-\-log\-source yes|no (0) -Include source file:line in log +\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) -Include function signature in log +\fB\-\-log\-function\fR yes|no (0) +Include function signature in log messages .TP -\-\-log\-hires\-timestamp yes|no (0) -Use hi\-resolution timestamps in log +\fB\-\-log\-hires\-timestamp\fR yes|no (0) +Use hi\-resolution timestamps in log messages .TP -\-\-log\-category yes|no (1) +\fB\-\-log\-category\fR yes|no (1) Include category in log messages .TP -\-\-log\-prefix STRING +\fB\-\-log\-prefix\fR STRING Prefix to prepend 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 (qpidd) +\fB\-\-syslog\-name\fR NAME (qpidd) Name to use in syslog messages -\-\-syslog\-facility LOG_XXX (LOG_DAEMON) +.TP +\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 +\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 +\fB\-\-transport\fR TRANSPORT (tcp) +The transport for which to return the port .TP -\-\-pid\-dir DIR (/home/aconway/.qpidd) -Directory where port\-specific PID file +\fB\-\-pid\-dir\fR DIR ($HOME/.qpidd) +Directory where port\-specific PID file is stored .TP -\-w [ \-\-wait ] SECONDS (600) -Sets the maximum wait time to -initialize or shutdown the daemon. If +\fB\-\-pidfile\fR FILE +File name to store the PID in daemon +mode. Used as\-is, no directory or +suffixes added. +.TP +\fB\-\-close\-fd\fR FD +File descriptors that the daemon should +close +.TP +\fB\-w\fR [ \fB\-\-wait\fR ] 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 -\-c [ \-\-check ] -Prints the daemon's process ID to -stdout and returns 0 if the daemon is +\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 ] -Tells the daemon to shut down - +\fB\-q\fR [ \fB\-\-quit\fR ] +Tells the daemon to shut down with an +INT signal .TP -\-\-socket\-fd FD -File descriptor for tcp listening socket - -.SS ACL Options +\fB\-k\fR [ \fB\-\-kill\fR ] +Kill the daemon with a KILL signal. .TP -\-\-acl\-file FILE -The policy file to load from, loaded from -data dir +\fB\-\-socket\-fd\fR FD +File descriptor for tcp listening +socket +.SS "ACL Options:" .TP -\-\-connection\-limit\-per\-user N (0) -The maximum number of connections allowed -per user. 0 implies no limit. +\fB\-\-acl\-file\fR FILE +The policy file to load from, loaded +from data dir .TP -\-\-max\-connections N (500) -The maximum combined number of connections -allowed. 0 implies no limit. +\fB\-\-connection\-limit\-per\-user\fR N (0) +The maximum number of connections +allowed per user. 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. +\fB\-\-max\-connections\fR N (500) +The maximum combined number of +connections allowed. 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 +\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. +.SS "SSL Settings:" .TP -\-\-ssl\-use\-export\-policy +\fB\-\-ssl\-use\-export\-policy\fR Use NSS export policy .TP -\-\-ssl\-cert\-password\-file PATH -File containing password to use for +\fB\-\-ssl\-cert\-password\-file\fR PATH +File containing password to use for accessing certificate database .TP -\-\-ssl\-cert\-db PATH -Path to directory containing certificate -database +\fB\-\-ssl\-cert\-db\fR PATH +Path to directory containing +certificate database .TP -\-\-ssl\-cert\-name NAME (gonzo) +\fB\-\-ssl\-cert\-name\fR NAME (localhost.localdomain) Name of the certificate to use .TP -\-\-ssl\-port PORT (5671) -Port on which to listen for SSL +\fB\-\-ssl\-port\fR PORT (5671) +Port on which to listen for SSL connections .TP -\-\-ssl\-require\-client\-authentication -Forces clients to authenticate in order +\fB\-\-ssl\-require\-client\-authentication\fR +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 +\fB\-\-ssl\-sasl\-no\-dict\fR +Disables SASL mechanisms that are +vulnerable to passive dictionary\-based password attacks +.SS "AMQP 1.0 Options:" +.TP +\fB\-\-domain\fR DOMAIN +Domain of this broker +.TP +\fB\-\-queue\-patterns\fR PATTERN +Pattern for on\-demand queues +.TP +\fB\-\-topic\-patterns\fR PATTERN +Pattern for on\-demand topics +.SS "HA Options:" +.TP +\fB\-\-ha\-cluster\fR yes|no (0) +Join a HA active/passive cluster. +.TP +\fB\-\-ha\-queue\-replication\fR yes|no (0) +Enable replication of specific queues +without joining a cluster +.TP +\fB\-\-ha\-brokers\-url\fR URL +URL with address of each broker in the +cluster. +.TP +\fB\-\-ha\-public\-url\fR URL +URL advertized to clients to connect to +the cluster. +.TP +\fB\-\-ha\-replicate\fR LEVEL (none) +Replication level for creating queues +and exchanges if there is no +qpid.replicate argument supplied. LEVEL +is 'none', 'configuration' or 'all' +.TP +\fB\-\-ha\-username\fR USER +Username for connections between HA +brokers +.TP +\fB\-\-ha\-password\fR PASS +Password for connections between HA +brokers +.TP +\fB\-\-ha\-mechanism\fR MECH +Authentication mechanism for +connections between HA brokers +.TP +\fB\-\-ha\-backup\-timeout\fR SECONDS (10s) +Maximum time to wait for an expected +backup to connect and become ready. +.TP +\fB\-\-ha\-flow\-messages\fR N (1000) +Flow control message count limit for +replication, 0 means no limit +.TP +\fB\-\-ha\-flow\-bytes\fR N (0) +Flow control byte limit for +replication, 0 means no limit +.SS "Linear Store Options:" +.TP +\fB\-\-store\-dir\fR DIR +Store directory location for +persistence (instead of using +\fB\-\-data\-dir\fR value). Required if +\fB\-\-no\-data\-dir\fR is also used. +.TP +\fB\-\-truncate\fR yes|no (0) +If yes|true|1, will truncate the store +(discard any existing records). If +no|false|0, will preserve the existing +store files for recovery. +.TP +\fB\-\-wcache\-page\-size\fR N (16) +Size of the pages in the write page +cache in KiB. Allowable values \- powers +of 2 starting at 4 (4, 8, 16, 32...) +Lower values decrease latency at the +expense of throughput. +.TP +\fB\-\-wcache\-num\-pages\fR N (16) +Number of pages in the write page +cache. Minimum value: 4. +.TP +\fB\-\-tpl\-wcache\-page\-size\fR N (4) +Size of the pages in the transaction +prepared list write page cache in KiB. +Allowable values \- powers of 2 starting +at: 4 (4, 8, 16, 32...) Lower values +decrease latency at the expense of +throughput. +.TP +\fB\-\-tpl\-wcache\-num\-pages\fR N (16) +Number of pages in the transaction +prepared list write page cache. Minimum +value: 4. +.TP +\fB\-\-efp\-partition\fR N (1) +Empty File Pool partition to use for +finding empty journal files +.TP +\fB\-\-efp\-file\-size\fR N (2048) +Empty File Pool file size in KiB to use +for journal files. Must be a multiple +of 4 KiB. +.TP +\fB\-\-overwrite\-before\-return\fR yes|no (0) +If yes|true|1, will overwrite each +store file with zeros before returning +it to the Empty File Pool. When not in +use (the default), then old message +data remains in the file, but is +overwritten on next use. This option +should only be used where security +considerations justify it as it makes +the store somewhat slower. +.TP +\fB\-\-journal\-flush\-timeout\fR SECONDS (500ms) +Maximum time to wait to flush journal. +Use ms, us units for small time values +(eg 10ms) \- no space between value and +unit. +.SS "Store Options:" +.TP +\fB\-\-storage\-provider\fR PROVIDER +Name of the storage provider to use. +.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 @@ -378,23 +532,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, d...@qpid.apache.org - -.SH REPORTING BUGS +.SH "REPORTING BUGS" Please report bugs to us...@qpid.apache.org http://git-wip-us.apache.org/repos/asf/qpid-cpp/blob/cd6cad73/docs/man/qpidd.x ---------------------------------------------------------------------- diff --git a/docs/man/qpidd.x b/docs/man/qpidd.x index 6efa5f3..7ad7e71 100644 --- a/docs/man/qpidd.x +++ b/docs/man/qpidd.x @@ -23,7 +23,7 @@ qpidd \- the Qpid AMQP Message Broker Daemon [SYNOPSIS] -qpidd [-p port] [--config config_file] [--data-dir directory] +qpidd [OPTIONS] [DESCRIPTION] --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
