aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 15 insertions, 5 deletions
diff --git a/README b/README
index afaee77..bff90b5 100644
--- a/README
+++ b/README
@@ -2,19 +2,29 @@ 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
+ auto-auto-complete SHELL -o OUTPUT -s SOURCE [VARIABLE=VALUE]...
+ auto-auto-complete SHELL -w 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 installed be stored for the command COMMAND, and the shell
- SHELL.
+ Or, if -w is used, print to stdout where such generate file
+ installed 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'.
+OPTIONS
+ -o, --output OUTPUT
+ The name of the file to generate.
+
+ -s, -f, --source, --file SOURCE
+ The name of the file to parse.
+
+ -w, --where COMMAND
+ Print where the script shall be installed if
+ the name of the command is COMMAND.
+
RATIONALE
Noone really wants to write shell auto-completion scripts,
especially not for more than one shell. But of course we