From b7b445d1352bdf3fa152ef8ab6e841b1dcbbdac6 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 2 Dec 2015 10:07:07 +0100 Subject: improve readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README b/README index 8b9cb92..531920c 100644 --- a/README +++ b/README @@ -1 +1,21 @@ -Autogenerate shell auto-completion scripts +NAME + auto-auto-complete - Autogenerate shell auto-completion scripts + +SYNOPSIS + auto-auto-complete SHELL --output OUTPUT --source SOURCE [VARIABLE=VALUE]... + auto-auto-complete SHELL --where COMMAND + +DESCRIPTION + auto-auto-complete generates a shell auto-completion script for + the shell SHELL, from the file SOURCE, and stores it to OUTPUT. + Or, if --where is used, print to stdout, where such generate + file should be stored for the command COMMAND, and the shell SHELL. + + When generating a file, a series of variables can defined using + the argument pattern 'VARIABLE=VALUE'. + +SEE ALSO + bash-completion, bash(1), fish(1), zsh(1) + + Full documentation available locally via: info '(auto-auto-complete) + -- cgit v1.2.3-70-g09d2