cli: split usage strings into groups (patch by David-Sarah Hopwood)

src/allmydata/scripts/runner.py

@@ -10,24 +10,40 @@ pkg_resources.require('allmydata-tahoe')
 from allmydata.scripts.common import BaseOptions
 import debug, create_node, startstop_node, cli, keygen, stats_gatherer
 
-_general_commands = ( create_node.subCommands
+def group(s):
+    return [["\n" + s, None, None, None]]
+
+_commandUsage = ( group("Administration")
+                +   create_node.subCommands
                 +   keygen.subCommands
                 +   stats_gatherer.subCommands
+                + group("Controlling a node")
+                +   startstop_node.subCommands
+                + group("Debugging")
                 +   debug.subCommands
+                + group("Using the filesystem")
                 +   cli.subCommands
                 )
 
-class Options(BaseOptions, usage.Options):
+_subCommands = filter(lambda (a, b, c, d): not a.startswith("\n"), _commandUsage)
-    synopsis = "Usage:  tahoe <command> [command options]"
+_synopsis = "Usage:  tahoe <command> [command options]"
 
-    subCommands = []
+class Options(BaseOptions, usage.Options):
-    subCommands += _general_commands
+    synopsis = _synopsis
-    subCommands += startstop_node.subCommands
+    subCommands = _subCommands
+
+    def getUsage(self, **kwargs):
+        t = _Usage().getUsage(**kwargs)
+        return t + "\nPlease run 'tahoe <command> --help' for more details on each command.\n"
 
     def postOptions(self):
         if not hasattr(self, 'subOptions'):
             raise usage.UsageError("must specify a command")
 
+class _Usage(BaseOptions, usage.Options):
+    synopsis = _synopsis
+    subCommands = _commandUsage
+
 def runner(argv,
            run_by_human=True,
            stdin=sys.stdin, stdout=sys.stdout, stderr=sys.stderr,