QPID-4060 - qpid-stat - Improve the help text to clarify use of the different display modes

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

2 files changed, 20 insertions, 6 deletions

diff --git a/qpid/tools/src/py/qpid-stat b/qpid/tools/src/py/qpid-stat
index 5a816baf6e..835f9da2f1 100755
--- a/qpid/tools/src/py/qpid-stat
+++ b/qpid/tools/src/py/qpid-stat
@@ -52,7 +52,16 @@ def OptionsAndArguments(argv):
 
     global config
 
-    parser = OptionParser(usage="usage: %prog [options] -[gcequm] [object-name]")
+    usage = \
+"""%prog -g [options]
+       %prog -c [options]
+       %prog -e [options]
+       %prog -q [options] [queue-name]
+       %prog -u [options]
+       %prog -m [options]
+       %prog -acl [options]"""
+
+    parser = OptionParser(usage=usage)
 
     group1 = OptionGroup(parser, "General Options")
     group1.add_option("-b", "--broker",  action="store", type="string", default="localhost", metavar="<url>",
@@ -64,7 +73,7 @@ def OptionsAndArguments(argv):
     group1.add_option("--ha-admin", action="store_true", help="Allow connection to a HA backup broker.")
     parser.add_option_group(group1)
 
-    group2 = OptionGroup(parser, "Display Options")
+    group2 = OptionGroup(parser, "Command Options")
     group2.add_option("-g", "--general", help="Show General Broker Stats",  action="store_const", const="g",   dest="show")
     group2.add_option("-c", "--connections", help="Show Connections",       action="store_const", const="c",   dest="show")
     group2.add_option("-e", "--exchanges", help="Show Exchanges",           action="store_const", const="e",   dest="show")
@@ -72,12 +81,14 @@ def OptionsAndArguments(argv):
     group2.add_option("-u", "--subscriptions", help="Show Subscriptions",   action="store_const", const="u",   dest="show")
     group2.add_option("-m", "--memory", help="Show Broker Memory Stats",    action="store_const", const="m",   dest="show")
     group2.add_option(      "--acl", help="Show Access Control List Stats", action="store_const", const="acl", dest="show")
-    group2.add_option("-S", "--sort-by",  metavar="<colname>",                   help="Sort by column name")
-    group2.add_option("-I", "--increasing", action="store_true", default=False,  help="Sort by increasing value (default = decreasing)")
-    group2.add_option("-L", "--limit", type="int", default=50, metavar="<n>",    help="Limit output to n rows")
-
     parser.add_option_group(group2)
 
+    group3 = OptionGroup(parser, "Display Options")
+    group3.add_option("-S", "--sort-by",  metavar="<colname>",                   help="Sort by column name")
+    group3.add_option("-I", "--increasing", action="store_true", default=False,  help="Sort by increasing value (default = decreasing)")
+    group3.add_option("-L", "--limit", type="int", default=50, metavar="<n>",    help="Limit output to n rows")
+    parser.add_option_group(group3)
+
     opts, args = parser.parse_args(args=argv)
 
     if not opts.show:
diff --git a/qpid/tools/src/py/qpidtoollibs/broker.py b/qpid/tools/src/py/qpidtoollibs/broker.py
index 840db05795..d34c2e6ced 100644
--- a/qpid/tools/src/py/qpidtoollibs/broker.py
+++ b/qpid/tools/src/py/qpidtoollibs/broker.py
@@ -191,6 +191,9 @@ class BrokerAgent(object):
   def getAcl(self):
     return self._getSingleObject(Acl)
 
+  def getMemory(self):
+    return self._getSingleObject(Memory)
+
   def echo(self, sequence, body):
     """Request a response to test the path to the management broker"""
     pass