aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README20
-rw-r--r--doc/man/auto-auto-complete.119
2 files changed, 30 insertions, 9 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
diff --git a/doc/man/auto-auto-complete.1 b/doc/man/auto-auto-complete.1
index 9c79c26..e2c6efc 100644
--- a/doc/man/auto-auto-complete.1
+++ b/doc/man/auto-auto-complete.1
@@ -4,15 +4,15 @@ auto-auto-complete - Autogenerate shell auto-completion scripts
.SH SYNOPSIS
.B auto-auto-complete
.I SHELL
-.B \-\-output
+.B \-o
.I OUTPUT
-.B \-\-source
+.B \-s
.I SOURCE
.RI [ VARIABLE \fB=\fP VALUE ]...
.br
.B auto-auto-complete
.I SHELL
-.B \-\-where
+.B \-w
.I COMMAND
.SH DESCRIPTION
.B auto-auto-complete
@@ -23,7 +23,7 @@ from the file
and stores it to
.IR OUTPUT .
Or, if
-.B \-\-where
+.B \-w
is used, print to stdout where such generate file should
be installed for the command
.IR COMMAND ,
@@ -32,6 +32,17 @@ and the shell
.PP
When generating a file, a series of variables can defined
using the argument pattern \(aq'\fIVARIABLE\fP\fB=\fP\fIVALUE\fP\(aq.
+.SH OPTIONS
+.BR \-o ,\ \-\-output \ \fIOUTPUT\fP
+The name of the file to generate.
+.TP
+.BR \-s ,\ \-f \,\ \-\-source ,\ \-\-file \ \fISOURCE\fP
+The name of the file to parse.
+.TP
+.BR \-w ,\ \-\-where \ \fICOMMAND\fP
+Print where the script shall be installed if the name of
+the command is
+.IR COMMAND .
.SH RATIONALE
Noone really wants to write shell auto-completion scripts,
especially not for more than one shell. But of course we