aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2026-02-22 13:50:24 +0100
committerMattias Andrée <m@maandree.se>2026-02-22 13:50:24 +0100
commit76a75f0eec01609cc76badc960fd9385affd40b1 (patch)
treea184974b04d322cd6a2a3b41a124a3087fc3cd92
parentRemove old make rule (diff)
downloadauto-auto-complete-76a75f0eec01609cc76badc960fd9385affd40b1.tar.gz
auto-auto-complete-76a75f0eec01609cc76badc960fd9385affd40b1.tar.bz2
auto-auto-complete-76a75f0eec01609cc76badc960fd9385affd40b1.tar.xz
fix doc textHEAD7.2.3master
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
-rw-r--r--README6
-rw-r--r--auto-auto-complete.114
-rw-r--r--doc/example10
3 files changed, 15 insertions, 15 deletions
diff --git a/README b/README
index 9abfaee..3dc6ac5 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
NAME
- auto-auto-complete - Autogenerate shell auto-completion scripts
+ auto-auto-complete - Auto-generate shell auto-completion scripts
SYNOPSIS
auto-auto-complete shell (-w command | -o output -s source [variable=value] ...)
@@ -9,7 +9,7 @@ DESCRIPTION
auto-auto-complete provides a LISP-like declarative language for
creating auto-completion scripts for commands in a shell-agnostic way.
- However, auto-auto-complete's language is limited in comparsion to
+ However, auto-auto-complete's language is limited in comparison to
for example raw auto-completion scripts for the bash shell, however
it is well enough for most projects.
@@ -43,7 +43,7 @@ OPERANDS
of values for that variable.
RATIONALE
- Noone really wants to write shell auto-completion scripts,
+ No one really wants to write shell auto-completion scripts,
especially not for more than one shell. But of course we
want to have it.
diff --git a/auto-auto-complete.1 b/auto-auto-complete.1
index 1a9fead..dbc6697 100644
--- a/auto-auto-complete.1
+++ b/auto-auto-complete.1
@@ -1,6 +1,6 @@
.TH AUTO-AUTO-COMPLETE 1 AUTO-AUTO-COMPLETE
.SH NAME
-auto-auto-complete - Autogenerate shell auto-completion scripts
+auto-auto-complete - Auto-generate shell auto-completion scripts
.SH SYNOPSIS
.B auto-auto-complete
@@ -22,7 +22,7 @@ generates a shell auto-completion script.
provides a LISP-like declarative language for creating auto-completion
scripts for commands in a shell-agnostic way. However,
.BR auto-auto-complete 's
-language is limited in comparsion to for example raw auto-completion
+language is limited in comparison to for example raw auto-completion
scripts for the bash shell, however it is well enough for most projects.
.SH OPTIONS
.BR \-o ,\ \-\-output \ \fIoutput\fP
@@ -82,10 +82,10 @@ be started inside quotes.
The backslash character
.RB ( \e )
can be used to force the following character to be parsed
-verbatim, this is called escaping. It is highly discourage to
+verbatim, this is called escaping. It is highly discouraged to
use this to escape new lines, especially if the new line
-encoding used in the document is carrige return–line feed, as
-that would only escape the carrige return. There is also a set
+encoding used in the document is carriage return–line feed, as
+that would only escape the carriage return. There is also a set
of characters that have a special meaning when they are escaped:
.TP
.B a
@@ -640,7 +640,7 @@ to be suggested without the
.RE
.PP
However, if the shell supports executing comments
-to get suggetions we want to utilise this.
+to get suggestions we want to utilise this.
.PP
.RS
.nf
@@ -760,7 +760,7 @@ You can also redirect to files:
.B a b> c
.SH RATIONALE
-Noone really wants to write shell auto-completion scripts,
+No one really wants to write shell auto-completion scripts,
especially not for more than one shell. But of course we
want to have it.
diff --git a/doc/example b/doc/example
index 58c37b1..74bf56e 100644
--- a/doc/example
+++ b/doc/example
@@ -23,23 +23,23 @@
; -l → symlink (allowed by default on all), -r → regular, -b → block device,
; -c → character device, -S → block device or character device, -p → pipe
(multiple argumented
- ((options -f --file --pony) (complete --file --pony) (arg PONY) (suggest pony-f) (files -f *.pony) (desc 'Specify the pony that should printed'))
- ((options +f ++file ++pony) (complete ++file ++pony) (arg PONY) (suggest pony+f) (files -f *.pony) (desc 'Specify the extrapony that should printed'))
+ ((options -f --file --pony) (complete --file --pony) (arg PONY) (suggest pony-f) (files -f *.pony) (desc 'Specify the pony that should be printed'))
+ ((options +f ++file ++pony) (complete ++file ++pony) (arg PONY) (suggest pony+f) (files -f *.pony) (desc 'Specify the extrapony that should be printed'))
((options -q --quote) (complete --quote) (arg PONY) (suggest pony-q) (files -f *.pony) (desc 'Specify the pony that should quote herself'))
- ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) (suggest balloon) (files -f (case (ponysay *.say) (ponyhink *.think))) (desc 'Specify message balloon style'))
+ ((options -b --bubble --balloon) (complete --balloon) (arg STYLE) (suggest balloon) (files -f (case (ponysay *.say) (ponythink *.think))) (desc 'Specify message balloon style'))
((options -W --wrap) (complete --wrap) (arg COLUMN) (suggest wrap) (files -0) (desc 'Specify wrapping column'))
((options +c --colour) (complete --colour) (arg ANSI-COLOUR) (files -0) (desc 'Specify colour of the balloon, balloon link and message'))
((options --colour-bubble --colour-balloon) (arg ANSI-COLOUR) (files -0) (desc 'Specify colour of the balloon'))
((options --colour-link) (arg ANSI-COLOUR) (files -0) (desc 'Specify colour of the balloon link'))
((options --colour-msg --colour-message) (arg ANSI-COLOUR) (files -0) (desc 'Specify colour of the message'))
((options --colour-pony) (arg ANSI-COLOUR) (files -0) (desc 'Specify colour of the pony (if uncoloured)'))
- ((options --colour-wrap --colour-hyphen) (arg ANSI-COLOUR) (files -0) (desc 'Specify addition colour of wrapping hyphen'))
+ ((options --colour-wrap --colour-hyphen) (arg ANSI-COLOUR) (files -0) (desc 'Specify additional colour of wrapping hyphen'))
)
; `bind` copies everything that is missing except `options` and `complete`
(variadic (options --f --files --ponies) (bind -f) (desc 'Specify the ponies that may be printed'))
(variadic (options ++f ++files ++ponies) (bind +f) (desc 'Specify the extraponies that may be printed'))
- (variadic (options --q --quotes) (bind -q) (desc 'Specify the pony that may quote themself'))
+ (variadic (options --q --quotes) (bind -q) (desc 'Specify the pony that may quote themselves'))
(suggestion message (verbatim MESSAGE)
)