aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-12-02 10:07:07 +0100
committerMattias Andrée <maandree@operamail.com>2015-12-02 10:07:07 +0100
commitb7b445d1352bdf3fa152ef8ab6e841b1dcbbdac6 (patch)
treec0fdebe474d4bcad31358bc126cfccc7f279190a
parentupdate dist (diff)
downloadauto-auto-complete-b7b445d1352bdf3fa152ef8ab6e841b1dcbbdac6.tar.gz
auto-auto-complete-b7b445d1352bdf3fa152ef8ab6e841b1dcbbdac6.tar.bz2
auto-auto-complete-b7b445d1352bdf3fa152ef8ab6e841b1dcbbdac6.tar.xz
improve readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--README22
1 files changed, 21 insertions, 1 deletions
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)
+