Repository: qpid-site Updated Branches: refs/heads/asf-site 3e3e9ea18 -> 18828d3b5
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/18828d3b/input/releases/qpid-dispatch-master/qdstat.8.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/qdstat.8.html b/input/releases/qpid-dispatch-master/qdstat.8.html deleted file mode 100644 index 529b962..0000000 --- a/input/releases/qpid-dispatch-master/qdstat.8.html +++ /dev/null @@ -1,1467 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" - "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> -<head> -<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> -<title>qdstat(8)</title> -<style type="text/css"> -/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ - -/* Default font. */ -body { - font-family: Georgia,serif; -} - -/* Title font. */ -h1, h2, h3, h4, h5, h6, -div.title, caption.title, -thead, p.table.header, -#toctitle, -#author, #revnumber, #revdate, #revremark, -#footer { - font-family: Arial,Helvetica,sans-serif; -} - -body { - margin: 1em 5% 1em 5%; -} - -a { - color: blue; - text-decoration: underline; -} -a:visited { - color: fuchsia; -} - -em { - font-style: italic; - color: navy; -} - -strong { - font-weight: bold; - color: #083194; -} - -h1, h2, h3, h4, h5, h6 { - color: #527bbd; - margin-top: 1.2em; - margin-bottom: 0.5em; - line-height: 1.3; -} - -h1, h2, h3 { - border-bottom: 2px solid silver; -} -h2 { - padding-top: 0.5em; -} -h3 { - float: left; -} -h3 + * { - clear: left; -} -h5 { - font-size: 1.0em; -} - -div.sectionbody { - margin-left: 0; -} - -hr { - border: 1px solid silver; -} - -p { - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -ul, ol, li > p { - margin-top: 0; -} -ul > li { color: #aaa; } -ul > li > * { color: black; } - -.monospaced, code, pre { - font-family: "Courier New", Courier, monospace; - font-size: inherit; - color: navy; - padding: 0; - margin: 0; -} - - -#author { - color: #527bbd; - font-weight: bold; - font-size: 1.1em; -} -#email { -} -#revnumber, #revdate, #revremark { -} - -#footer { - font-size: small; - border-top: 2px solid silver; - padding-top: 0.5em; - margin-top: 4.0em; -} -#footer-text { - float: left; - padding-bottom: 0.5em; -} -#footer-badges { - float: right; - padding-bottom: 0.5em; -} - -#preamble { - margin-top: 1.5em; - margin-bottom: 1.5em; -} -div.imageblock, div.exampleblock, div.verseblock, -div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, -div.admonitionblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.admonitionblock { - margin-top: 2.0em; - margin-bottom: 2.0em; - margin-right: 10%; - color: #606060; -} - -div.content { /* Block element content. */ - padding: 0; -} - -/* Block element titles. */ -div.title, caption.title { - color: #527bbd; - font-weight: bold; - text-align: left; - margin-top: 1.0em; - margin-bottom: 0.5em; -} -div.title + * { - margin-top: 0; -} - -td div.title:first-child { - margin-top: 0.0em; -} -div.content div.title:first-child { - margin-top: 0.0em; -} -div.content + div.title { - margin-top: 0.0em; -} - -div.sidebarblock > div.content { - background: #ffffee; - border: 1px solid #dddddd; - border-left: 4px solid #f0f0f0; - padding: 0.5em; -} - -div.listingblock > div.content { - border: 1px solid #dddddd; - border-left: 5px solid #f0f0f0; - background: #f8f8f8; - padding: 0.5em; -} - -div.quoteblock, div.verseblock { - padding-left: 1.0em; - margin-left: 1.0em; - margin-right: 10%; - border-left: 5px solid #f0f0f0; - color: #888; -} - -div.quoteblock > div.attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock > pre.content { - font-family: inherit; - font-size: inherit; -} -div.verseblock > div.attribution { - padding-top: 0.75em; - text-align: left; -} -/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ -div.verseblock + div.attribution { - text-align: left; -} - -div.admonitionblock .icon { - vertical-align: top; - font-size: 1.1em; - font-weight: bold; - text-decoration: underline; - color: #527bbd; - padding-right: 0.5em; -} -div.admonitionblock td.content { - padding-left: 0.5em; - border-left: 3px solid #dddddd; -} - -div.exampleblock > div.content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } -a.image:visited { color: white; } - -dl { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -dt { - margin-top: 0.5em; - margin-bottom: 0; - font-style: normal; - color: navy; -} -dd > *:first-child { - margin-top: 0.1em; -} - -ul, ol { - list-style-position: outside; -} -ol.arabic { - list-style-type: decimal; -} -ol.loweralpha { - list-style-type: lower-alpha; -} -ol.upperalpha { - list-style-type: upper-alpha; -} -ol.lowerroman { - list-style-type: lower-roman; -} -ol.upperroman { - list-style-type: upper-roman; -} - -div.compact ul, div.compact ol, -div.compact p, div.compact p, -div.compact div, div.compact div { - margin-top: 0.1em; - margin-bottom: 0.1em; -} - -tfoot { - font-weight: bold; -} -td > div.verse { - white-space: pre; -} - -div.hdlist { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -div.hdlist tr { - padding-bottom: 15px; -} -dt.hdlist1.strong, td.hdlist1.strong { - font-weight: bold; -} -td.hdlist1 { - vertical-align: top; - font-style: normal; - padding-right: 0.8em; - color: navy; -} -td.hdlist2 { - vertical-align: top; -} -div.hdlist.compact tr { - margin: 0; - padding-bottom: 0; -} - -.comment { - background: yellow; -} - -.footnote, .footnoteref { - font-size: 0.8em; -} - -span.footnote, span.footnoteref { - vertical-align: super; -} - -#footnotes { - margin: 20px 0 20px 0; - padding: 7px 0 0 0; -} - -#footnotes div.footnote { - margin: 0 0 5px 0; -} - -#footnotes hr { - border: none; - border-top: 1px solid silver; - height: 1px; - text-align: left; - margin-left: 0; - width: 20%; - min-width: 100px; -} - -div.colist td { - padding-right: 0.5em; - padding-bottom: 0.3em; - vertical-align: top; -} -div.colist td img { - margin-top: 0.3em; -} - -@media print { - #footer-badges { display: none; } -} - -#toc { - margin-bottom: 2.5em; -} - -#toctitle { - color: #527bbd; - font-size: 1.1em; - font-weight: bold; - margin-top: 1.0em; - margin-bottom: 0.1em; -} - -div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { - margin-top: 0; - margin-bottom: 0; -} -div.toclevel2 { - margin-left: 2em; - font-size: 0.9em; -} -div.toclevel3 { - margin-left: 4em; - font-size: 0.9em; -} -div.toclevel4 { - margin-left: 6em; - font-size: 0.9em; -} - -span.aqua { color: aqua; } -span.black { color: black; } -span.blue { color: blue; } -span.fuchsia { color: fuchsia; } -span.gray { color: gray; } -span.green { color: green; } -span.lime { color: lime; } -span.maroon { color: maroon; } -span.navy { color: navy; } -span.olive { color: olive; } -span.purple { color: purple; } -span.red { color: red; } -span.silver { color: silver; } -span.teal { color: teal; } -span.white { color: white; } -span.yellow { color: yellow; } - -span.aqua-background { background: aqua; } -span.black-background { background: black; } -span.blue-background { background: blue; } -span.fuchsia-background { background: fuchsia; } -span.gray-background { background: gray; } -span.green-background { background: green; } -span.lime-background { background: lime; } -span.maroon-background { background: maroon; } -span.navy-background { background: navy; } -span.olive-background { background: olive; } -span.purple-background { background: purple; } -span.red-background { background: red; } -span.silver-background { background: silver; } -span.teal-background { background: teal; } -span.white-background { background: white; } -span.yellow-background { background: yellow; } - -span.big { font-size: 2em; } -span.small { font-size: 0.6em; } - -span.underline { text-decoration: underline; } -span.overline { text-decoration: overline; } -span.line-through { text-decoration: line-through; } - -div.unbreakable { page-break-inside: avoid; } - - -/* - * xhtml11 specific - * - * */ - -div.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-weight: bold; - color: #527bbd; -} -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - - -/* - * html5 specific - * - * */ - -table.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -thead, p.tableblock.header { - font-weight: bold; - color: #527bbd; -} -p.tableblock { - margin-top: 0; -} -table.tableblock { - border-width: 3px; - border-spacing: 0px; - border-style: solid; - border-color: #527bbd; - border-collapse: collapse; -} -th.tableblock, td.tableblock { - border-width: 1px; - padding: 4px; - border-style: solid; - border-color: #527bbd; -} - -table.tableblock.frame-topbot { - border-left-style: hidden; - border-right-style: hidden; -} -table.tableblock.frame-sides { - border-top-style: hidden; - border-bottom-style: hidden; -} -table.tableblock.frame-none { - border-style: hidden; -} - -th.tableblock.halign-left, td.tableblock.halign-left { - text-align: left; -} -th.tableblock.halign-center, td.tableblock.halign-center { - text-align: center; -} -th.tableblock.halign-right, td.tableblock.halign-right { - text-align: right; -} - -th.tableblock.valign-top, td.tableblock.valign-top { - vertical-align: top; -} -th.tableblock.valign-middle, td.tableblock.valign-middle { - vertical-align: middle; -} -th.tableblock.valign-bottom, td.tableblock.valign-bottom { - vertical-align: bottom; -} - - -/* - * manpage specific - * - * */ - -body.manpage h1 { - padding-top: 0.5em; - padding-bottom: 0.5em; - border-top: 2px solid silver; - border-bottom: 2px solid silver; -} -body.manpage h2 { - border-style: none; -} -body.manpage div.sectionbody { - margin-left: 3em; -} - -@media print { - body.manpage div#toc { display: none; } -} - - -</style> -<script type="text/javascript"> -/*<+'])'); - // Function that scans the DOM tree for header elements (the DOM2 - // nodeIterator API would be a better technique but not supported by all - // browsers). - var iterate = function (el) { - for (var i = el.firstChild; i != null; i = i.nextSibling) { - if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { - var mo = re.exec(i.tagName); - if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { - result[result.length] = new TocEntry(i, getText(i), mo[1]-1); - } - iterate(i); - } - } - } - iterate(el); - return result; - } - - var toc = document.getElementById("toc"); - if (!toc) { - return; - } - - // Delete existing TOC entries in case we're reloading the TOC. - var tocEntriesToRemove = []; - var i; - for (i = 0; i < toc.childNodes.length; i++) { - var entry = toc.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' - && entry.getAttribute("class") - && entry.getAttribute("class").match(/^toclevel/)) - tocEntriesToRemove.push(entry); - } - for (i = 0; i < tocEntriesToRemove.length; i++) { - toc.removeChild(tocEntriesToRemove[i]); - } - - // Rebuild TOC entries. - var entries = tocEntries(document.getElementById("content"), toclevels); - for (var i = 0; i < entries.length; ++i) { - var entry = entries[i]; - if (entry.element.id == "") - entry.element.id = "_toc_" + i; - var a = document.createElement("a"); - a.href = "#" + entry.element.id; - a.appendChild(document.createTextNode(entry.text)); - var div = document.createElement("div"); - div.appendChild(a); - div.className = "toclevel" + entry.toclevel; - toc.appendChild(div); - } - if (entries.length == 0) - toc.parentNode.removeChild(toc); -}, - - -///////////////////////////////////////////////////////////////////// -// Footnotes generator -///////////////////////////////////////////////////////////////////// - -/* Based on footnote generation code from: - * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html - */ - -footnotes: function () { - // Delete existing footnote entries in case we're reloading the footnodes. - var i; - var noteholder = document.getElementById("footnotes"); - if (!noteholder) { - return; - } - var entriesToRemove = []; - for (i = 0; i < noteholder.childNodes.length; i++) { - var entry = noteholder.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") - entriesToRemove.push(entry); - } - for (i = 0; i < entriesToRemove.length; i++) { - noteholder.removeChild(entriesToRemove[i]); - } - - // Rebuild footnote entries. - var cont = document.getElementById("content"); - var spans = cont.getElementsByTagName("span"); - var refs = {}; - var n = 0; - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnote") { - n++; - var note = spans[i].getAttribute("data-note"); - if (!note) { - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - spans[i].setAttribute("data-note", note); - } - noteholder.innerHTML += - "<div class='footnote' id='_footnote_" + n + "'>" + - "<a href='#_footnoteref_" + n + "' title='Return to text'>" + - n + "</a>. " + note + "</div>"; - var id =spans[i].getAttribute("id"); - if (id != null) refs["#"+id] = n; - } - } - if (n == 0) - noteholder.parentNode.removeChild(noteholder); - else { - // Process footnoterefs. - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnoteref") { - var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); - href = href.match(/#.*/)[0]; // Because IE return full URL. - n = refs[href]; - spans[i].innerHTML = - "[<a href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - } - } - } -}, - -install: function(toclevels) { - var timerId; - - function reinstall() { - asciidoc.footnotes(); - if (toclevels) { - asciidoc.toc(toclevels); - } - } - - function reinstallAndRemoveTimer() { - clearInterval(timerId); - reinstall(); - } - - timerId = setInterval(reinstall, 500); - if (document.addEventListener) - document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); - else - window.onload = reinstallAndRemoveTimer; -} - -} -asciidoc.install(); -/*]]>*/ -</script> -</head> -<body class="manpage"> -<div id="header"> -<h1> -qdstat(8) Manual Page -</h1> -<h2>NAME</h2> -<div class="sectionbody"> -<p>qdstat - - show status and statistics for a running 'qdrouterd' -</p> -</div> -</div> -<div id="content"> -<div class="sect1"> -<h2 id="_synopsis">SYNOPSIS</h2> -<div class="sectionbody"> -<div class="paragraph"><p><strong>qdstat</strong> [<em>OPTIONS</em>]</p></div> -</div> -</div> -<div class="sect1"> -<h2 id="_description">DESCRIPTION</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Shows status information about networks of Dispatch routers. It can display -connections, network nodes and links, and router stats such as memory use.</p></div> -</div> -</div> -<div class="sect1"> -<h2 id="_options">OPTIONS</h2> -<div class="sectionbody"> -<div class="paragraph"><p>-h, --help -: show this help message and exit</p></div> -<div class="paragraph"><p>--version -: Print version and exit.</p></div> -<div class="paragraph"><p>-g, --general -: Show General Router Stats</p></div> -<div class="paragraph"><p>-c, --connections -: Show Connections</p></div> -<div class="paragraph"><p>-l, --links -: Show Router Links</p></div> -<div class="paragraph"><p>-n, --nodes -: Show Router Nodes</p></div> -<div class="paragraph"><p>-a, --address -: Show Router Addresses</p></div> -<div class="paragraph"><p>-m, --memory -: Show Router Memory Stats</p></div> -<div class="paragraph"><p>--autolinks -: Show Auto Links</p></div> -<div class="paragraph"><p>--linkroutes -: Show Link Routes</p></div> -<div class="paragraph"><p>-v, --verbose -: Show maximum detail</p></div> -<div class="paragraph"><p>--log -: Show recent log entries</p></div> -<div class="paragraph"><p>--limit=LIMIT -: Limit number of log entries</p></div> -<div class="sect2"> -<h3 id="_connection_options">Connection Options</h3> -<div class="paragraph"><p>-b URL, --bus=URL -: URL of the messaging bus to connect to (default 0.0.0.0)</p></div> -<div class="paragraph"><p>-r ROUTER-ID, --router=ROUTER-ID -: Router to be queried</p></div> -<div class="paragraph"><p>-t SECS, --timeout=SECS -: Maximum time to wait for connection in seconds (default 5)</p></div> -<div class="paragraph"><p>--ssl-certificate=CERT -: Client SSL certificate (PEM Format)</p></div> -<div class="paragraph"><p>--ssl-key=KEY -: Client SSL private key (PEM Format)</p></div> -<div class="paragraph"><p>--ssl-trustfile=TRUSTED-CA-DB -: Trusted Certificate Authority Database file (PEM Format)</p></div> -<div class="paragraph"><p>--ssl-password=PASSWORD -: Certificate password, will be prompted if not specifed.</p></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_output_columns">OUTPUT COLUMNS</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_qdstat_c">qdstat -c</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> -id -</dt> -<dd> -<p> -Unique connection identifier -</p> -</dd> -<dt class="hdlist1"> -host -</dt> -<dd> -<p> -The hostname or internet address of the remotely connected AMQP container -</p> -</dd> -<dt class="hdlist1"> -container -</dt> -<dd> -<p> -The container-name of the remotely connected AMQP container -</p> -</dd> -<dt class="hdlist1"> -role -</dt> -<dd> -<p> -The configured role of the connection -</p> -<div class="ulist"><ul> -<li> -<p> -normal - Normal connections from client to router -</p> -</li> -<li> -<p> -inter-router - Connection between routers to form a network -</p> -</li> -<li> -<p> -route-container - Connection to/from a Broker or other host to receive link-routes and waypoints -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -dir -</dt> -<dd> -<p> -The direction of connection establishment -</p> -<div class="ulist"><ul> -<li> -<p> -in - The connection was initiated by the remote container -</p> -</li> -<li> -<p> -out - The connection was initiated by this router -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -security -</dt> -<dd> -<p> -A description of the security/encryption in effect for this -connection -</p> -</dd> -<dt class="hdlist1"> -authentication -</dt> -<dd> -<p> -The method and user-id of the authenticated user for -this connection -</p> -</dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_qdstat_l">qdstat -l</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> -type -</dt> -<dd> -<p> -Type of link -</p> -<div class="ulist"><ul> -<li> -<p> -router-control - An inter-router link that is reserved for control messages exchanged between routers -</p> -</li> -<li> -<p> -inter-router - An inter-router link that is used for normal message-routed deliveries -</p> -</li> -<li> -<p> -endpoint - A normal link to an external endpoint container -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -dir -</dt> -<dd> -<p> -The direction of message flow on the link -</p> -<div class="ulist"><ul> -<li> -<p> -in - Deliveries flow inbound to the router -</p> -</li> -<li> -<p> -out - Deliveries flow outbound from the router -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -conn id -</dt> -<dd> -<p> -Unique identifier of the connection over which this link is -attached -</p> -</dd> -<dt class="hdlist1"> -id -</dt> -<dd> -<p> -Unique identifier of this link -</p> -</dd> -<dt class="hdlist1"> -peer -</dt> -<dd> -<p> -For link-routed links, the unique identifier of the peer link. In -link routing, an inbound link is paired with an outbound link -</p> -</dd> -<dt class="hdlist1"> -class -</dt> -<dd> -<p> -Class of the address bound to the link -</p> -</dd> -<dt class="hdlist1"> -addr -</dt> -<dd> -<p> -The address bound to the link -</p> -</dd> -<dt class="hdlist1"> -phs -</dt> -<dd> -<p> -The phase of the address bound to the link -</p> -</dd> -<dt class="hdlist1"> -cap -</dt> -<dd> -<p> -The capacity, in deliveries, of the link -</p> -</dd> -<dt class="hdlist1"> -undel -</dt> -<dd> -<p> -The number of undelivered messages stored on the link’s FIFO -</p> -</dd> -<dt class="hdlist1"> -unsettled -</dt> -<dd> -<p> -The number of unsettled deliveries being tracked by the link -</p> -</dd> -<dt class="hdlist1"> -deliveries -</dt> -<dd> -<p> -The total number of deliveries that have transited this link -</p> -</dd> -<dt class="hdlist1"> -admin -</dt> -<dd> -<p> -The administrative status of the link -</p> -<div class="ulist"><ul> -<li> -<p> -enabled - The link is enabled for normal operation -</p> -</li> -<li> -<p> -disabled - The link is disabled and should be quiescing or stopped (not yet supported) -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -oper -</dt> -<dd> -<p> -The operational status of the link -</p> -<div class="ulist"><ul> -<li> -<p> -up - The link is operational -</p> -</li> -<li> -<p> -down - The link is not attached -</p> -</li> -<li> -<p> -quiescing - The link is in the process of quiescing (not yet supported) -</p> -</li> -<li> -<p> -idle - The link has completed quiescing and is idle (not yet supported) -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -name -</dt> -<dd> -<p> -The link name (only shown if the -v option is provided) -</p> -</dd> -</dl></div> -<div class="sect3"> -<h4 id="_qdstat_n">qdstat -n</h4> -<div class="dlist"><dl> -<dt class="hdlist1"> -router-id -</dt> -<dd> -<p> -Identifier of the router -</p> -</dd> -<dt class="hdlist1"> -next-hop -</dt> -<dd> -<p> -If this router is not a neighbor, identifies the next-hop neighbor used to reach this router -</p> -</dd> -<dt class="hdlist1"> -link -</dt> -<dd> -<p> -Unique identifier of the link to the neighbor router -</p> -</dd> -<dt class="hdlist1"> -cost -</dt> -<dd> -<p> -The topology cost to this remote router (with -v option only) -</p> -</dd> -<dt class="hdlist1"> -neighbors -</dt> -<dd> -<p> -The list of neighbor routers (the router’s link-state) (with -v option only) -</p> -</dd> -<dt class="hdlist1"> -valid-origins -</dt> -<dd> -<p> -The list of origin routers for which the best path to the listed router passes through this router (with -v option only) -</p> -</dd> -</dl></div> -</div> -</div> -<div class="sect2"> -<h3 id="_qdstat_a">qdstat -a</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> -class -</dt> -<dd> -<p> -The class of the listed address -</p> -<div class="ulist"><ul> -<li> -<p> -local - Address that is local to this router -</p> -</li> -<li> -<p> -topo - Topological address used for router control messages -</p> -</li> -<li> -<p> -router - A summary router address used to route messages to a remote router’s local addresses -</p> -</li> -<li> -<p> -mobile - A mobile address for an attached consumer or producer -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -addr -</dt> -<dd> -<p> -The address text -</p> -</dd> -<dt class="hdlist1"> -phs -</dt> -<dd> -<p> -For mobile addresses only, the phase of the address. Direct addresses have only a phase 0. Waypoint addresses have multiple phases, normally 0 and 1. -</p> -</dd> -<dt class="hdlist1"> -distrib -</dt> -<dd> -<p> -Distribution method used for this address -</p> -<div class="ulist"><ul> -<li> -<p> -multicast - A copy of each message is delivered once to each consumer for the address -</p> -</li> -<li> -<p> -closest - Each message is delivered to only one consumer for the address. The closest (lowest cost) consumer will be chosen. If there are multiple lowest-cost consumers, deliveries will be spread across those consumers. -</p> -</li> -<li> -<p> -balanced - Each message is delivered to only one consumer for the address. The consumer with the fewest outstanding (unsettled) deliveries will be chosen. The cost of the route to the consumer is a threshold for delivery (i.e. higher cost consumers will only receive deliveries if closer consumers are backed up). -</p> -</li> -<li> -<p> -flood - Used only for router-control traffic. This is multicast without prevention of duplicate deliveries. -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -in-proc -</dt> -<dd> -<p> -The number of in-process consumers for this address -</p> -</dd> -<dt class="hdlist1"> -local -</dt> -<dd> -<p> -The number of local (on this router) consumers for this address -</p> -</dd> -<dt class="hdlist1"> -remote -</dt> -<dd> -<p> -The number of remote routers that have at least one consumer for this address -</p> -</dd> -<dt class="hdlist1"> -cntnr -</dt> -<dd> -<p> -The number of locally attached containers that are destinations for link-routes on this address -</p> -</dd> -<dt class="hdlist1"> -in -</dt> -<dd> -<p> -The number of deliveries for this address that entered the network on this router -</p> -</dd> -<dt class="hdlist1"> -out -</dt> -<dd> -<p> -The number of deliveries for this address that exited the network on this router -</p> -</dd> -<dt class="hdlist1"> -thru -</dt> -<dd> -<p> -The number of deliveries for this address that were forwarded to other routers -</p> -</dd> -<dt class="hdlist1"> -to-proc -</dt> -<dd> -<p> -The number of deliveries for this address that were delivered to an in-process consumer -</p> -</dd> -<dt class="hdlist1"> -from-proc -</dt> -<dd> -<p> -The number of deliveries for this address that were received from an in-process producer -</p> -</dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_qdstat_linkroutes">qdstat --linkroutes</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> -prefix -</dt> -<dd> -<p> -The prefix for matching addresses of routed links -</p> -</dd> -<dt class="hdlist1"> -dir -</dt> -<dd> -<p> -The direction (from the router’s perspective) of matching links -</p> -</dd> -<dt class="hdlist1"> -distrib -</dt> -<dd> -<p> -The distribution method used for routed links -</p> -<div class="ulist"><ul> -<li> -<p> -linkBalanced - the only supported distribution for routed links -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -status -</dt> -<dd> -<p> -Operational status of the link route -</p> -<div class="ulist"><ul> -<li> -<p> -active - Route is actively routing attaches (i.e. ready for use) -</p> -</li> -<li> -<p> -inactive - Route is inactive because there is no local destination connected -</p> -</li> -</ul></div> -</dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_qstat_autolinks">qstat --autolinks</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> -addr -</dt> -<dd> -<p> -The address of the auto link -</p> -</dd> -<dt class="hdlist1"> -dir -</dt> -<dd> -<p> -The direction of message flow for the auto link -</p> -<div class="ulist"><ul> -<li> -<p> -in - Messages flow in from the route-container to the router network -</p> -</li> -<li> -<p> -out - Messages flow out to the route-container from the router network -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -phs -</dt> -<dd> -<p> -Phase of the address for this auto link -</p> -</dd> -<dt class="hdlist1"> -link -</dt> -<dd> -<p> -Unique identifier of the link managed by this auto link -</p> -</dd> -<dt class="hdlist1"> -status -</dt> -<dd> -<p> -The operational status of this auto link -</p> -<div class="ulist"><ul> -<li> -<p> -inactive - There is no connected container for this auto link -</p> -</li> -<li> -<p> -attaching - The link is attaching to the container -</p> -</li> -<li> -<p> -failed - The link-attach failed -</p> -</li> -<li> -<p> -active - The link is operational -</p> -</li> -<li> -<p> -quiescing - The link is quiescing (not yet supported) -</p> -</li> -<li> -<p> -idle - The link is idle (not yet supported) -</p> -</li> -</ul></div> -</dd> -<dt class="hdlist1"> -lastErr -</dt> -<dd> -<p> -The description of the last attach failure that occurred on this auto link -</p> -</dd> -</dl></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_see_also">SEE ALSO</h2> -<div class="sectionbody"> -<div class="paragraph"><p><em>qdrouterd(8)</em>, <em>qdmanage(8)</em>, <em>qdrouterd.conf(5)</em></p></div> -<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p></div> -</div> -</div> -</div> -<div id="footnotes"><hr /></div> -<div id="footer"> -<div id="footer-text"> -Last updated 2016-06-23 12:32:19 EDT -</div> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/18828d3b/input/releases/qpid-dispatch-master/qdstat.8.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-dispatch-master/qdstat.8.html.in b/input/releases/qpid-dispatch-master/qdstat.8.html.in index 529b962..9a8bd4c 100644 --- a/input/releases/qpid-dispatch-master/qdstat.8.html.in +++ b/input/releases/qpid-dispatch-master/qdstat.8.html.in @@ -1,815 +1,58 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" - "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> -<head> -<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.6.8" /> -<title>qdstat(8)</title> -<style type="text/css"> -/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ - -/* Default font. */ -body { - font-family: Georgia,serif; -} - -/* Title font. */ -h1, h2, h3, h4, h5, h6, -div.title, caption.title, -thead, p.table.header, -#toctitle, -#author, #revnumber, #revdate, #revremark, -#footer { - font-family: Arial,Helvetica,sans-serif; -} - -body { - margin: 1em 5% 1em 5%; -} - -a { - color: blue; - text-decoration: underline; -} -a:visited { - color: fuchsia; -} - -em { - font-style: italic; - color: navy; -} - -strong { - font-weight: bold; - color: #083194; -} - -h1, h2, h3, h4, h5, h6 { - color: #527bbd; - margin-top: 1.2em; - margin-bottom: 0.5em; - line-height: 1.3; -} - -h1, h2, h3 { - border-bottom: 2px solid silver; -} -h2 { - padding-top: 0.5em; -} -h3 { - float: left; -} -h3 + * { - clear: left; -} -h5 { - font-size: 1.0em; -} - -div.sectionbody { - margin-left: 0; -} - -hr { - border: 1px solid silver; -} - -p { - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -ul, ol, li > p { - margin-top: 0; -} -ul > li { color: #aaa; } -ul > li > * { color: black; } - -.monospaced, code, pre { - font-family: "Courier New", Courier, monospace; - font-size: inherit; - color: navy; - padding: 0; - margin: 0; -} - - -#author { - color: #527bbd; - font-weight: bold; - font-size: 1.1em; -} -#email { -} -#revnumber, #revdate, #revremark { -} - -#footer { - font-size: small; - border-top: 2px solid silver; - padding-top: 0.5em; - margin-top: 4.0em; -} -#footer-text { - float: left; - padding-bottom: 0.5em; -} -#footer-badges { - float: right; - padding-bottom: 0.5em; -} - -#preamble { - margin-top: 1.5em; - margin-bottom: 1.5em; -} -div.imageblock, div.exampleblock, div.verseblock, -div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, -div.admonitionblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.admonitionblock { - margin-top: 2.0em; - margin-bottom: 2.0em; - margin-right: 10%; - color: #606060; -} - -div.content { /* Block element content. */ - padding: 0; -} - -/* Block element titles. */ -div.title, caption.title { - color: #527bbd; - font-weight: bold; - text-align: left; - margin-top: 1.0em; - margin-bottom: 0.5em; -} -div.title + * { - margin-top: 0; -} - -td div.title:first-child { - margin-top: 0.0em; -} -div.content div.title:first-child { - margin-top: 0.0em; -} -div.content + div.title { - margin-top: 0.0em; -} - -div.sidebarblock > div.content { - background: #ffffee; - border: 1px solid #dddddd; - border-left: 4px solid #f0f0f0; - padding: 0.5em; -} - -div.listingblock > div.content { - border: 1px solid #dddddd; - border-left: 5px solid #f0f0f0; - background: #f8f8f8; - padding: 0.5em; -} - -div.quoteblock, div.verseblock { - padding-left: 1.0em; - margin-left: 1.0em; - margin-right: 10%; - border-left: 5px solid #f0f0f0; - color: #888; -} - -div.quoteblock > div.attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock > pre.content { - font-family: inherit; - font-size: inherit; -} -div.verseblock > div.attribution { - padding-top: 0.75em; - text-align: left; -} -/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ -div.verseblock + div.attribution { - text-align: left; -} - -div.admonitionblock .icon { - vertical-align: top; - font-size: 1.1em; - font-weight: bold; - text-decoration: underline; - color: #527bbd; - padding-right: 0.5em; -} -div.admonitionblock td.content { - padding-left: 0.5em; - border-left: 3px solid #dddddd; -} - -div.exampleblock > div.content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; } -a.image:visited { color: white; } - -dl { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -dt { - margin-top: 0.5em; - margin-bottom: 0; - font-style: normal; - color: navy; -} -dd > *:first-child { - margin-top: 0.1em; -} - -ul, ol { - list-style-position: outside; -} -ol.arabic { - list-style-type: decimal; -} -ol.loweralpha { - list-style-type: lower-alpha; -} -ol.upperalpha { - list-style-type: upper-alpha; -} -ol.lowerroman { - list-style-type: lower-roman; -} -ol.upperroman { - list-style-type: upper-roman; -} - -div.compact ul, div.compact ol, -div.compact p, div.compact p, -div.compact div, div.compact div { - margin-top: 0.1em; - margin-bottom: 0.1em; -} - -tfoot { - font-weight: bold; -} -td > div.verse { - white-space: pre; -} - -div.hdlist { - margin-top: 0.8em; - margin-bottom: 0.8em; -} -div.hdlist tr { - padding-bottom: 15px; -} -dt.hdlist1.strong, td.hdlist1.strong { - font-weight: bold; -} -td.hdlist1 { - vertical-align: top; - font-style: normal; - padding-right: 0.8em; - color: navy; -} -td.hdlist2 { - vertical-align: top; -} -div.hdlist.compact tr { - margin: 0; - padding-bottom: 0; -} - -.comment { - background: yellow; -} - -.footnote, .footnoteref { - font-size: 0.8em; -} - -span.footnote, span.footnoteref { - vertical-align: super; -} - -#footnotes { - margin: 20px 0 20px 0; - padding: 7px 0 0 0; -} - -#footnotes div.footnote { - margin: 0 0 5px 0; -} - -#footnotes hr { - border: none; - border-top: 1px solid silver; - height: 1px; - text-align: left; - margin-left: 0; - width: 20%; - min-width: 100px; -} - -div.colist td { - padding-right: 0.5em; - padding-bottom: 0.3em; - vertical-align: top; -} -div.colist td img { - margin-top: 0.3em; -} - -@media print { - #footer-badges { display: none; } -} - -#toc { - margin-bottom: 2.5em; -} - -#toctitle { - color: #527bbd; - font-size: 1.1em; - font-weight: bold; - margin-top: 1.0em; - margin-bottom: 0.1em; -} - -div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { - margin-top: 0; - margin-bottom: 0; -} -div.toclevel2 { - margin-left: 2em; - font-size: 0.9em; -} -div.toclevel3 { - margin-left: 4em; - font-size: 0.9em; -} -div.toclevel4 { - margin-left: 6em; - font-size: 0.9em; -} - -span.aqua { color: aqua; } -span.black { color: black; } -span.blue { color: blue; } -span.fuchsia { color: fuchsia; } -span.gray { color: gray; } -span.green { color: green; } -span.lime { color: lime; } -span.maroon { color: maroon; } -span.navy { color: navy; } -span.olive { color: olive; } -span.purple { color: purple; } -span.red { color: red; } -span.silver { color: silver; } -span.teal { color: teal; } -span.white { color: white; } -span.yellow { color: yellow; } - -span.aqua-background { background: aqua; } -span.black-background { background: black; } -span.blue-background { background: blue; } -span.fuchsia-background { background: fuchsia; } -span.gray-background { background: gray; } -span.green-background { background: green; } -span.lime-background { background: lime; } -span.maroon-background { background: maroon; } -span.navy-background { background: navy; } -span.olive-background { background: olive; } -span.purple-background { background: purple; } -span.red-background { background: red; } -span.silver-background { background: silver; } -span.teal-background { background: teal; } -span.white-background { background: white; } -span.yellow-background { background: yellow; } - -span.big { font-size: 2em; } -span.small { font-size: 0.6em; } - -span.underline { text-decoration: underline; } -span.overline { text-decoration: overline; } -span.line-through { text-decoration: line-through; } - -div.unbreakable { page-break-inside: avoid; } - - -/* - * xhtml11 specific - * - * */ - -div.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-weight: bold; - color: #527bbd; -} -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - - -/* - * html5 specific - * - * */ - -table.tableblock { - margin-top: 1.0em; - margin-bottom: 1.5em; -} -thead, p.tableblock.header { - font-weight: bold; - color: #527bbd; -} -p.tableblock { - margin-top: 0; -} -table.tableblock { - border-width: 3px; - border-spacing: 0px; - border-style: solid; - border-color: #527bbd; - border-collapse: collapse; -} -th.tableblock, td.tableblock { - border-width: 1px; - padding: 4px; - border-style: solid; - border-color: #527bbd; -} - -table.tableblock.frame-topbot { - border-left-style: hidden; - border-right-style: hidden; -} -table.tableblock.frame-sides { - border-top-style: hidden; - border-bottom-style: hidden; -} -table.tableblock.frame-none { - border-style: hidden; -} - -th.tableblock.halign-left, td.tableblock.halign-left { - text-align: left; -} -th.tableblock.halign-center, td.tableblock.halign-center { - text-align: center; -} -th.tableblock.halign-right, td.tableblock.halign-right { - text-align: right; -} - -th.tableblock.valign-top, td.tableblock.valign-top { - vertical-align: top; -} -th.tableblock.valign-middle, td.tableblock.valign-middle { - vertical-align: middle; -} -th.tableblock.valign-bottom, td.tableblock.valign-bottom { - vertical-align: bottom; -} - - -/* - * manpage specific - * - * */ - -body.manpage h1 { - padding-top: 0.5em; - padding-bottom: 0.5em; - border-top: 2px solid silver; - border-bottom: 2px solid silver; -} -body.manpage h2 { - border-style: none; -} -body.manpage div.sectionbody { - margin-left: 3em; -} - -@media print { - body.manpage div#toc { display: none; } -} - - -</style> -<script type="text/javascript"> -/*<+'])'); - // Function that scans the DOM tree for header elements (the DOM2 - // nodeIterator API would be a better technique but not supported by all - // browsers). - var iterate = function (el) { - for (var i = el.firstChild; i != null; i = i.nextSibling) { - if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { - var mo = re.exec(i.tagName); - if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { - result[result.length] = new TocEntry(i, getText(i), mo[1]-1); - } - iterate(i); - } - } - } - iterate(el); - return result; - } - - var toc = document.getElementById("toc"); - if (!toc) { - return; - } - - // Delete existing TOC entries in case we're reloading the TOC. - var tocEntriesToRemove = []; - var i; - for (i = 0; i < toc.childNodes.length; i++) { - var entry = toc.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' - && entry.getAttribute("class") - && entry.getAttribute("class").match(/^toclevel/)) - tocEntriesToRemove.push(entry); - } - for (i = 0; i < tocEntriesToRemove.length; i++) { - toc.removeChild(tocEntriesToRemove[i]); - } - - // Rebuild TOC entries. - var entries = tocEntries(document.getElementById("content"), toclevels); - for (var i = 0; i < entries.length; ++i) { - var entry = entries[i]; - if (entry.element.id == "") - entry.element.id = "_toc_" + i; - var a = document.createElement("a"); - a.href = "#" + entry.element.id; - a.appendChild(document.createTextNode(entry.text)); - var div = document.createElement("div"); - div.appendChild(a); - div.className = "toclevel" + entry.toclevel; - toc.appendChild(div); - } - if (entries.length == 0) - toc.parentNode.removeChild(toc); -}, - - -///////////////////////////////////////////////////////////////////// -// Footnotes generator -///////////////////////////////////////////////////////////////////// - -/* Based on footnote generation code from: - * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html - */ - -footnotes: function () { - // Delete existing footnote entries in case we're reloading the footnodes. - var i; - var noteholder = document.getElementById("footnotes"); - if (!noteholder) { - return; - } - var entriesToRemove = []; - for (i = 0; i < noteholder.childNodes.length; i++) { - var entry = noteholder.childNodes[i]; - if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") - entriesToRemove.push(entry); - } - for (i = 0; i < entriesToRemove.length; i++) { - noteholder.removeChild(entriesToRemove[i]); - } - - // Rebuild footnote entries. - var cont = document.getElementById("content"); - var spans = cont.getElementsByTagName("span"); - var refs = {}; - var n = 0; - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnote") { - n++; - var note = spans[i].getAttribute("data-note"); - if (!note) { - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - spans[i].setAttribute("data-note", note); - } - noteholder.innerHTML += - "<div class='footnote' id='_footnote_" + n + "'>" + - "<a href='#_footnoteref_" + n + "' title='Return to text'>" + - n + "</a>. " + note + "</div>"; - var id =spans[i].getAttribute("id"); - if (id != null) refs["#"+id] = n; - } - } - if (n == 0) - noteholder.parentNode.removeChild(noteholder); - else { - // Process footnoterefs. - for (i=0; i<spans.length; i++) { - if (spans[i].className == "footnoteref") { - var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); - href = href.match(/#.*/)[0]; // Because IE return full URL. - n = refs[href]; - spans[i].innerHTML = - "[<a href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; - } - } - } -}, - -install: function(toclevels) { - var timerId; - - function reinstall() { - asciidoc.footnotes(); - if (toclevels) { - asciidoc.toc(toclevels); - } - } - - function reinstallAndRemoveTimer() { - clearInterval(timerId); - reinstall(); - } - - timerId = setInterval(reinstall, 500); - if (document.addEventListener) - document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); - else - window.onload = reinstallAndRemoveTimer; -} - -} -asciidoc.install(); -/*]]>*/ -</script> -</head> -<body class="manpage"> -<div id="header"> -<h1> -qdstat(8) Manual Page -</h1> <h2>NAME</h2> -<div class="sectionbody"> <p>qdstat - show status and statistics for a running 'qdrouterd' </p> -</div> -</div> -<div id="content"> -<div class="sect1"> -<h2 id="_synopsis">SYNOPSIS</h2> -<div class="sectionbody"> -<div class="paragraph"><p><strong>qdstat</strong> [<em>OPTIONS</em>]</p></div> -</div> -</div> -<div class="sect1"> -<h2 id="_description">DESCRIPTION</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Shows status information about networks of Dispatch routers. It can display -connections, network nodes and links, and router stats such as memory use.</p></div> -</div> -</div> -<div class="sect1"> -<h2 id="_options">OPTIONS</h2> -<div class="sectionbody"> -<div class="paragraph"><p>-h, --help -: show this help message and exit</p></div> -<div class="paragraph"><p>--version -: Print version and exit.</p></div> -<div class="paragraph"><p>-g, --general -: Show General Router Stats</p></div> -<div class="paragraph"><p>-c, --connections -: Show Connections</p></div> -<div class="paragraph"><p>-l, --links -: Show Router Links</p></div> -<div class="paragraph"><p>-n, --nodes -: Show Router Nodes</p></div> -<div class="paragraph"><p>-a, --address -: Show Router Addresses</p></div> -<div class="paragraph"><p>-m, --memory -: Show Router Memory Stats</p></div> -<div class="paragraph"><p>--autolinks -: Show Auto Links</p></div> -<div class="paragraph"><p>--linkroutes -: Show Link Routes</p></div> -<div class="paragraph"><p>-v, --verbose -: Show maximum detail</p></div> -<div class="paragraph"><p>--log -: Show recent log entries</p></div> -<div class="paragraph"><p>--limit=LIMIT -: Limit number of log entries</p></div> -<div class="sect2"> -<h3 id="_connection_options">Connection Options</h3> -<div class="paragraph"><p>-b URL, --bus=URL -: URL of the messaging bus to connect to (default 0.0.0.0)</p></div> -<div class="paragraph"><p>-r ROUTER-ID, --router=ROUTER-ID -: Router to be queried</p></div> -<div class="paragraph"><p>-t SECS, --timeout=SECS -: Maximum time to wait for connection in seconds (default 5)</p></div> -<div class="paragraph"><p>--ssl-certificate=CERT -: Client SSL certificate (PEM Format)</p></div> -<div class="paragraph"><p>--ssl-key=KEY -: Client SSL private key (PEM Format)</p></div> -<div class="paragraph"><p>--ssl-trustfile=TRUSTED-CA-DB -: Trusted Certificate Authority Database file (PEM Format)</p></div> -<div class="paragraph"><p>--ssl-password=PASSWORD -: Certificate password, will be prompted if not specifed.</p></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_output_columns">OUTPUT COLUMNS</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_qdstat_c">qdstat -c</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> +<h2><a name="_synopsis"></a>SYNOPSIS</h2> +<p><strong>qdstat</strong> [<b>OPTIONS</b>]</p> +<h2><a name="_description"></a>DESCRIPTION</h2> +<p>Shows status information about networks of Dispatch routers. It can display +connections, network nodes and links, and router stats such as memory use.</p> +<h2><a name="_options"></a>OPTIONS</h2> +<p>-h, --help +: show this help message and exit</p> +<p>--version +: Print version and exit.</p> +<p>-g, --general +: Show General Router Stats</p> +<p>-c, --connections +: Show Connections</p> +<p>-l, --links +: Show Router Links</p> +<p>-n, --nodes +: Show Router Nodes</p> +<p>-a, --address +: Show Router Addresses</p> +<p>-m, --memory +: Show Router Memory Stats</p> +<p>--autolinks +: Show Auto Links</p> +<p>--linkroutes +: Show Link Routes</p> +<p>-v, --verbose +: Show maximum detail</p> +<p>--log +: Show recent log entries</p> +<p>--limit=LIMIT +: Limit number of log entries</p> +<h3><a name="_connection_options"></a>Connection Options</h3> +<p>-b URL, --bus=URL +: URL of the messaging bus to connect to (default 0.0.0.0)</p> +<p>-r ROUTER-ID, --router=ROUTER-ID +: Router to be queried</p> +<p>-t SECS, --timeout=SECS +: Maximum time to wait for connection in seconds (default 5)</p> +<p>--ssl-certificate=CERT +: Client SSL certificate (PEM Format)</p> +<p>--ssl-key=KEY +: Client SSL private key (PEM Format)</p> +<p>--ssl-trustfile=TRUSTED-CA-DB +: Trusted Certificate Authority Database file (PEM Format)</p> +<p>--ssl-password=PASSWORD +: Certificate password, will be prompted if not specifed.</p> +<h2><a name="_output_columns"></a>OUTPUT COLUMNS</h2> +<h3><a name="_qdstat_c"></a>qdstat -c</h3> +<dl> +<dt> id </dt> <dd> @@ -817,7 +60,7 @@ id Unique connection identifier </p> </dd> -<dt class="hdlist1"> +<dt> host </dt> <dd> @@ -825,7 +68,7 @@ host The hostname or internet address of the remotely connected AMQP container </p> </dd> -<dt class="hdlist1"> +<dt> container </dt> <dd> @@ -833,14 +76,14 @@ container The container-name of the remotely connected AMQP container </p> </dd> -<dt class="hdlist1"> +<dt> role </dt> <dd> <p> The configured role of the connection </p> -<div class="ulist"><ul> +<ul> <li> <p> normal - Normal connections from client to router @@ -856,16 +99,16 @@ inter-router - Connection between routers to form a network route-container - Connection to/from a Broker or other host to receive link-routes and waypoints </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> dir </dt> <dd> <p> The direction of connection establishment </p> -<div class="ulist"><ul> +<ul> <li> <p> in - The connection was initiated by the remote container @@ -876,9 +119,9 @@ in - The connection was initiated by the remote container out - The connection was initiated by this router </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> security </dt> <dd> @@ -887,7 +130,7 @@ A description of the security/encryption in effect for this connection </p> </dd> -<dt class="hdlist1"> +<dt> authentication </dt> <dd> @@ -896,19 +139,17 @@ The method and user-id of the authenticated user for this connection </p> </dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_qdstat_l">qdstat -l</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> +</dl> +<h3><a name="_qdstat_l"></a>qdstat -l</h3> +<dl> +<dt> type </dt> <dd> <p> Type of link </p> -<div class="ulist"><ul> +<ul> <li> <p> router-control - An inter-router link that is reserved for control messages exchanged between routers @@ -924,16 +165,16 @@ inter-router - An inter-router link that is used for normal message-routed deliv endpoint - A normal link to an external endpoint container </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> dir </dt> <dd> <p> The direction of message flow on the link </p> -<div class="ulist"><ul> +<ul> <li> <p> in - Deliveries flow inbound to the router @@ -944,9 +185,9 @@ in - Deliveries flow inbound to the router out - Deliveries flow outbound from the router </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> conn id </dt> <dd> @@ -955,7 +196,7 @@ Unique identifier of the connection over which this link is attached </p> </dd> -<dt class="hdlist1"> +<dt> id </dt> <dd> @@ -963,7 +204,7 @@ id Unique identifier of this link </p> </dd> -<dt class="hdlist1"> +<dt> peer </dt> <dd> @@ -972,7 +213,7 @@ For link-routed links, the unique identifier of the peer link. In link routing, an inbound link is paired with an outbound link </p> </dd> -<dt class="hdlist1"> +<dt> class </dt> <dd> @@ -980,7 +221,7 @@ class Class of the address bound to the link </p> </dd> -<dt class="hdlist1"> +<dt> addr </dt> <dd> @@ -988,7 +229,7 @@ addr The address bound to the link </p> </dd> -<dt class="hdlist1"> +<dt> phs </dt> <dd> @@ -996,7 +237,7 @@ phs The phase of the address bound to the link </p> </dd> -<dt class="hdlist1"> +<dt> cap </dt> <dd> @@ -1004,7 +245,7 @@ cap The capacity, in deliveries, of the link </p> </dd> -<dt class="hdlist1"> +<dt> undel </dt> <dd> @@ -1012,7 +253,7 @@ undel The number of undelivered messages stored on the link’s FIFO </p> </dd> -<dt class="hdlist1"> +<dt> unsettled </dt> <dd> @@ -1020,7 +261,7 @@ unsettled The number of unsettled deliveries being tracked by the link </p> </dd> -<dt class="hdlist1"> +<dt> deliveries </dt> <dd> @@ -1028,14 +269,14 @@ deliveries The total number of deliveries that have transited this link </p> </dd> -<dt class="hdlist1"> +<dt> admin </dt> <dd> <p> The administrative status of the link </p> -<div class="ulist"><ul> +<ul> <li> <p> enabled - The link is enabled for normal operation @@ -1046,16 +287,16 @@ enabled - The link is enabled for normal operation disabled - The link is disabled and should be quiescing or stopped (not yet supported) </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> oper </dt> <dd> <p> The operational status of the link </p> -<div class="ulist"><ul> +<ul> <li> <p> up - The link is operational @@ -1076,9 +317,9 @@ quiescing - The link is in the process of quiescing (not yet supported) idle - The link has completed quiescing and is idle (not yet supported) </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> name </dt> <dd> @@ -1086,11 +327,10 @@ name The link name (only shown if the -v option is provided) </p> </dd> -</dl></div> -<div class="sect3"> -<h4 id="_qdstat_n">qdstat -n</h4> -<div class="dlist"><dl> -<dt class="hdlist1"> +</dl> +<h4><a name="_qdstat_n"></a>qdstat -n</h4> +<dl> +<dt> router-id </dt> <dd> @@ -1098,7 +338,7 @@ router-id Identifier of the router </p> </dd> -<dt class="hdlist1"> +<dt> next-hop </dt> <dd> @@ -1106,7 +346,7 @@ next-hop If this router is not a neighbor, identifies the next-hop neighbor used to reach this router </p> </dd> -<dt class="hdlist1"> +<dt> link </dt> <dd> @@ -1114,7 +354,7 @@ link Unique identifier of the link to the neighbor router </p> </dd> -<dt class="hdlist1"> +<dt> cost </dt> <dd> @@ -1122,7 +362,7 @@ cost The topology cost to this remote router (with -v option only) </p> </dd> -<dt class="hdlist1"> +<dt> neighbors </dt> <dd> @@ -1130,7 +370,7 @@ neighbors The list of neighbor routers (the router’s link-state) (with -v option only) </p> </dd> -<dt class="hdlist1"> +<dt> valid-origins </dt> <dd> @@ -1138,20 +378,17 @@ valid-origins The list of origin routers for which the best path to the listed router passes through this router (with -v option only) </p> </dd> -</dl></div> -</div> -</div> -<div class="sect2"> -<h3 id="_qdstat_a">qdstat -a</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> +</dl> +<h3><a name="_qdstat_a"></a>qdstat -a</h3> +<dl> +<dt> class </dt> <dd> <p> The class of the listed address </p> -<div class="ulist"><ul> +<ul> <li> <p> local - Address that is local to this router @@ -1172,9 +409,9 @@ router - A summary router address used to route messages to a remote router̵ mobile - A mobile address for an attached consumer or producer </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> addr </dt> <dd> @@ -1182,7 +419,7 @@ addr The address text </p> </dd> -<dt class="hdlist1"> +<dt> phs </dt> <dd> @@ -1190,14 +427,14 @@ phs For mobile addresses only, the phase of the address. Direct addresses have only a phase 0. Waypoint addresses have multiple phases, normally 0 and 1. </p> </dd> -<dt class="hdlist1"> +<dt> distrib </dt> <dd> <p> Distribution method used for this address </p> -<div class="ulist"><ul> +<ul> <li> <p> multicast - A copy of each message is delivered once to each consumer for the address @@ -1218,9 +455,9 @@ balanced - Each message is delivered to only one consumer for the address. The flood - Used only for router-control traffic. This is multicast without prevention of duplicate deliveries. </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> in-proc </dt> <dd> @@ -1228,7 +465,7 @@ in-proc The number of in-process consumers for this address </p> </dd> -<dt class="hdlist1"> +<dt> local </dt> <dd> @@ -1236,7 +473,7 @@ local The number of local (on this router) consumers for this address </p> </dd> -<dt class="hdlist1"> +<dt> remote </dt> <dd> @@ -1244,7 +481,7 @@ remote The number of remote routers that have at least one consumer for this address </p> </dd> -<dt class="hdlist1"> +<dt> cntnr </dt> <dd> @@ -1252,7 +489,7 @@ cntnr The number of locally attached containers that are destinations for link-routes on this address </p> </dd> -<dt class="hdlist1"> +<dt> in </dt> <dd> @@ -1260,7 +497,7 @@ in The number of deliveries for this address that entered the network on this router </p> </dd> -<dt class="hdlist1"> +<dt> out </dt> <dd> @@ -1268,7 +505,7 @@ out The number of deliveries for this address that exited the network on this router </p> </dd> -<dt class="hdlist1"> +<dt> thru </dt> <dd> @@ -1276,7 +513,7 @@ thru The number of deliveries for this address that were forwarded to other routers </p> </dd> -<dt class="hdlist1"> +<dt> to-proc </dt> <dd> @@ -1284,7 +521,7 @@ to-proc The number of deliveries for this address that were delivered to an in-process consumer </p> </dd> -<dt class="hdlist1"> +<dt> from-proc </dt> <dd> @@ -1292,12 +529,10 @@ from-proc The number of deliveries for this address that were received from an in-process producer </p> </dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_qdstat_linkroutes">qdstat --linkroutes</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> +</dl> +<h3><a name="_qdstat_linkroutes"></a>qdstat --linkroutes</h3> +<dl> +<dt> prefix </dt> <dd> @@ -1305,7 +540,7 @@ prefix The prefix for matching addresses of routed links </p> </dd> -<dt class="hdlist1"> +<dt> dir </dt> <dd> @@ -1313,29 +548,29 @@ dir The direction (from the router’s perspective) of matching links </p> </dd> -<dt class="hdlist1"> +<dt> distrib </dt> <dd> <p> The distribution method used for routed links </p> -<div class="ulist"><ul> +<ul> <li> <p> linkBalanced - the only supported distribution for routed links </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> status </dt> <dd> <p> Operational status of the link route </p> -<div class="ulist"><ul> +<ul> <li> <p> active - Route is actively routing attaches (i.e. ready for use) @@ -1346,14 +581,12 @@ active - Route is actively routing attaches (i.e. ready for use) inactive - Route is inactive because there is no local destination connected </p> </li> -</ul></div> +</ul> </dd> -</dl></div> -</div> -<div class="sect2"> -<h3 id="_qstat_autolinks">qstat --autolinks</h3> -<div class="dlist"><dl> -<dt class="hdlist1"> +</dl> +<h3><a name="_qstat_autolinks"></a>qstat --autolinks</h3> +<dl> +<dt> addr </dt> <dd> @@ -1361,14 +594,14 @@ addr The address of the auto link </p> </dd> -<dt class="hdlist1"> +<dt> dir </dt> <dd> <p> The direction of message flow for the auto link </p> -<div class="ulist"><ul> +<ul> <li> <p> in - Messages flow in from the route-container to the router network @@ -1379,9 +612,9 @@ in - Messages flow in from the route-container to the router network out - Messages flow out to the route-container from the router network </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> phs </dt> <dd> @@ -1389,7 +622,7 @@ phs Phase of the address for this auto link </p> </dd> -<dt class="hdlist1"> +<dt> link </dt> <dd> @@ -1397,14 +630,14 @@ link Unique identifier of the link managed by this auto link </p> </dd> -<dt class="hdlist1"> +<dt> status </dt> <dd> <p> The operational status of this auto link </p> -<div class="ulist"><ul> +<ul> <li> <p> inactive - There is no connected container for this auto link @@ -1435,9 +668,9 @@ quiescing - The link is quiescing (not yet supported) idle - The link is idle (not yet supported) </p> </li> -</ul></div> +</ul> </dd> -<dt class="hdlist1"> +<dt> lastErr </dt> <dd> @@ -1445,23 +678,7 @@ lastErr The description of the last attach failure that occurred on this auto link </p> </dd> -</dl></div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_see_also">SEE ALSO</h2> -<div class="sectionbody"> -<div class="paragraph"><p><em>qdrouterd(8)</em>, <em>qdmanage(8)</em>, <em>qdrouterd.conf(5)</em></p></div> -<div class="paragraph"><p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p></div> -</div> -</div> -</div> -<div id="footnotes"><hr /></div> -<div id="footer"> -<div id="footer-text"> -Last updated 2016-06-23 12:32:19 EDT -</div> -</div> -</body> -</html> +</dl> +<h2><a name="_see_also"></a>SEE ALSO</h2> +<p><b>qdrouterd(8)</b>, <b>qdmanage(8)</b>, <b>qdrouterd.conf(5)</b></p> +<p><a href="http://qpid.apache.org/components/dispatch-router";>http://qpid.apache.org/components/dispatch-router</a></p> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/18828d3b/scripts/gen-dispatch-release-books ---------------------------------------------------------------------- diff --git a/scripts/gen-dispatch-release-books b/scripts/gen-dispatch-release-books index 56b2f56..5447259 100755 --- a/scripts/gen-dispatch-release-books +++ b/scripts/gen-dispatch-release-books @@ -31,19 +31,14 @@ def gen_books_and_man(release, source_dir, output_dir): build_doc = join(build_dir, "doc") - # Rename .html to .html.in to get site style. - for f in list_dir(build_doc, "*.html"): - if not f == "index.html": # Use gen-dispatch-release-page index. - copy(join(build_doc, f), join(output_dir, f) + ".in") - - # Copy other doc files. - for f in list_dir(build_doc, "*.html", "*.pdf", "*.png"): - if not f == "index.html": # Use gen-dispatch-release-page index. + # .html.in files are raw HTML bodies, the render script will apply the site style. + for f in list_dir(build_doc, "*.html.in", "*.pdf", "*.png"): + if not f == "index.html.in": # Use gen-dispatch-release-page index. copy(join(build_doc, f), join(output_dir, f)) ## Now do stuff ## release, issues_release, source_release, release_dir, checkout_dir = setup_release_script() -source_dir = export_release_from_git("dispatch", source_release) +source_dir = checkout_dir or export_release_from_git("dispatch", source_release) gen_books_and_man(release, source_dir, release_dir) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
