gsu: Improve help text of complete subcommand.
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 24 Aug 2014 14:57:08 +0000 (16:57 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Fri, 29 Aug 2014 19:39:58 +0000 (21:39 +0200)
The current help text talks about two forms to run this command,
but only one is mentioned. This commit tries to clarify that the
function behaves differently when called without argument.

misc/gsu/subcommand

index 43f7df7..4e36362 100644 (file)
@@ -202,11 +202,13 @@ Command line completion.
 
 Usage: complete [<cword> <word>...]
 
-In the first form, the command prints all possible completions to stdout.
-This can be used from the completion function of the shell.
+When executed without argument the command writes bash code to
+stdout. This code is suitable to be evaled from .bashrc to enable
+completion.
 
-Completion code suitable to be evaled is written to stdout if no argument
-was given.
+If at least one argument is given, all possible completions are
+written to stdout. This can be used from the completion function of
+the subcommand.
 "
 
 _com_help()