Fix short help strings and add a global help message

Author: myw

tmuxp/cli.py

@@ -306,6 +306,10 @@ def reattach(session):
 @click.option('--log_level', default='INFO',
               help='Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)')
 def cli(log_level):
+    """Manage tmux sessions.
+
+    Pass the "--help" argument to any command to see detailed help.
+    See detailed documentation and examples at http://tmuxp.readthedocs.io/en/latest/"""
     try:
         has_required_tmux_version()
     except exc.TmuxpException as e:
@@ -351,7 +355,9 @@ def startup(config_dir):
 @click.option('-S', 'socket_path', help='pass-through for tmux -L')
 @click.option('-L', 'socket_name', help='pass-through for tmux -L')
 def command_freeze(session_name, socket_name, socket_path):
-    """Write configuration for a snapshot of the current session into a tmuxp config."""
+    """Snapshot a session into a config.
+
+    If SESSION_NAME is provided, snapshot that session. Otherwise, use the current session."""
 
     t = Server(
         socket_name=socket_name,
@@ -434,7 +440,7 @@ def command_freeze(session_name, socket_name, socket_path):
         sys.exit()
 
 
-@cli.command(name='load')
+@cli.command(name='load', short_help='Load tmuxp workspaces.')
 @click.pass_context
 @click.argument('config', click.Path(exists=True), nargs=-1,
                 callback=resolve_config_argument)
@@ -502,6 +508,7 @@ def command_load(ctx, config, socket_name, socket_path, answer_yes,
 
 @cli.group(name='import')
 def import_config_cmd():
+    """Import a teamocil/tmuxinator config."""
     pass
 
 
@@ -560,32 +567,32 @@ def import_config(configfile, importfunc):
         sys.exit()
 
 
-@import_config_cmd.command(name='teamocil')
+@import_config_cmd.command(name='teamocil', short_help='Convert and import a teamocil config.')
 @click.argument(
     'configfile', click.Path(exists=True), nargs=1,
     callback=_create_resolve_config_argument(get_teamocil_dir)
 )
 def command_import_teamocil(configfile):
-    """Import teamocil config to tmuxp format."""
+    """Convert a teamocil config from CONFIGFILE to tmuxp format and import it into tmuxp."""
 
     import_config(configfile, config.import_teamocil)
 
 
-@import_config_cmd.command(name='tmuxinator')
+@import_config_cmd.command(name='tmuxinator', short_help='Convert and import a tmuxinator config.')
 @click.argument(
     'configfile', click.Path(exists=True), nargs=1,
     callback=_create_resolve_config_argument(get_tmuxinator_dir)
 )
 def command_import_tmuxinator(configfile):
-    """Import tmuxinator config to tmuxp format."""
+    """Convert a tmuxinator config from CONFIGFILE to tmuxp format and import it into tmuxp."""
     import_config(configfile, config.import_tmuxinator)
 
 
 @cli.command(name='convert')
 @click.argument('config', click.Path(exists=True), nargs=1,
                 callback=resolve_config_argument)
 def command_convert(config):
-    """Convert tmuxp config to and from JSON and YAML."""
+    """Convert a tmuxp config between JSON and YAML."""
 
     _, ext = os.path.splitext(config)
     if 'json' in ext: