.\" -*- nroff -*-
.\"
.\" 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 QDSTAT 8
.SH NAME
qdstat \- A tool to inspect Dispatch router networks
.SH SYNOPSIS
qdstat [OPTIONS]
.SH DESCRIPTION
qdstat shows status information about networks of Dispatch routers.
It can display connections, network nodes and links, and router stats
such as memory use.
.PP
See <http://qpid.apache.org/components/dispatch-router/> for more
information.
.SH OPTIONS
.IP "-b, --bus URL"
The URL of the router network to connect to.
.IP "-t, --timeout SECONDS"
The maximum time to wait for connection, in seconds.
.IP "--sasl-mechanism MECHANISM"
The SASL mechanism to use for authentication.  One of "EXTERNAL",
"ANONYMOUS", "PLAIN", "CRAM-MD5", "DIGEST-MD5", or "GSSAPI".  SASL
automatically picks the most secure available mechanism.  Use this
option to override it.
.IP "--ssl-certificate PATH"
The path to the SSL certificate file, in PEM format.
.IP "--ssl-key PATH"
The path to the SSL private key file, in PEM format.
.IP "-g, --general"
Show general router stats.
.IP "-c, --connections"
Show connections.
.IP "-l, --links"
Show router links.
.IP "-n, --nodes"
Show router nodes.
.IP "-a, --address"
Show router addresses.
.IP "-m, --memory"
Show router memory stats.
.IP "-h, --help"
Display a brief usage message and exit.
.SH FILES
.I /etc/qpid-dispatch/qdstat.conf
.SH SEE ALSO
.BR qdrouterd (8),
.BR qdrouterd.conf (5),
.BR qdstat.conf (5)
.SH AUTHOR
Apache Qpid <http://qpid.apache.org/>
.SH COPYRIGHT
Copyright 2013 The Apache Software Foundation