Add documentation for `powerline --help`

powerline/shell.py

@@ -52,17 +52,18 @@ def get_argparser(parser=None, *args, **kwargs):
 		import argparse
 		parser = argparse.ArgumentParser
 	p = parser(*args, **kwargs)
-	p.add_argument('ext', nargs=1)
+	p.add_argument('ext', nargs=1, help='Extension: application for which powerline command is launched (usually `shell\' or `tmux\')')
-	p.add_argument('side', nargs='?', choices=('left', 'right', 'above', 'aboveleft'))
+	p.add_argument('side', nargs='?', choices=('left', 'right', 'above', 'aboveleft'), help='Side: `left\' and `right\' represent left and right side respectively, `above\' emits lines that are supposed to be printed just above the prompt and `aboveleft\' is like concatenating `above\' with `left\' with the exception that only one Python instance is used in this case.')
-	p.add_argument('-r', '--renderer_module', metavar='MODULE', type=str)
+	p.add_argument('-r', '--renderer_module', metavar='MODULE', type=str,
-	p.add_argument('-w', '--width', type=int)
+				help='Renderer module. Usually something like `bash_prompt\' or `zsh_prompt\', is supposed to be set only in shell-specific bindings file.')
-	p.add_argument('--last_exit_code', metavar='INT', type=int)
+	p.add_argument('-w', '--width', type=int, help='Maximum prompt with. Triggers truncation of some segments')
-	p.add_argument('--last_pipe_status', metavar='LIST', default='', type=lambda s: [int(status) for status in s.split()])
+	p.add_argument('--last_exit_code', metavar='INT', type=int, help='Last exit code')
-	p.add_argument('--jobnum', metavar='INT', type=int)
+	p.add_argument('--last_pipe_status', metavar='LIST', default='', type=lambda s: [int(status) for status in s.split()], help='Like above, but is supposed to contain space-separated array of statuses, representing exit statuses of commands in one pipe.')
-	p.add_argument('-c', '--config', metavar='KEY.KEY=VALUE', action='append')
+	p.add_argument('--jobnum', metavar='INT', type=int, help='Number of jobs.')
-	p.add_argument('-t', '--theme_option', metavar='THEME.KEY.KEY=VALUE', action='append')
+	p.add_argument('-c', '--config', metavar='KEY.KEY=VALUE', action='append', help='Configuration overrides for `config.json\'. Is translated to a dictionary and merged with the dictionary obtained from actual JSON configuration: KEY.KEY=VALUE is translated to `{"KEY": {"KEY": VALUE}}\' and then merged recursively. VALUE may be any JSON value, values that are not `null\', `true\', `false\', start with digit, `{\', `[\' are treated like strings. If VALUE is omitted then corresponding key is removed.')
-	p.add_argument('-p', '--config_path', metavar='PATH')
+	p.add_argument('-t', '--theme_option', metavar='THEME.KEY.KEY=VALUE', action='append', help='Like above, but theme-specific. THEME should point to an existing and used theme to have any effect, but it is fine to use any theme here.')
-	p.add_argument('-R', '--renderer_arg', metavar='KEY=VAL', action='append')
+	p.add_argument('-R', '--renderer_arg', metavar='KEY=VAL', action='append', help='Like above, but provides argument for renderer. Is supposed to be used only by shell bindings to provide various data like last_exit_code or last_pipe_status (they are not using --renderer_arg for historical resons: renderer_arg was added later).')
+	p.add_argument('-p', '--config_path', metavar='PATH', help='Path to configuration directory. If it is present then configuration files will only be seeked in the provided path.')
 	return p