From ce1a0eaa58f7ad07c5389996a90c4b02bdf573fc Mon Sep 17 00:00:00 2001 From: johannst Date: Mon, 13 Apr 2020 19:02:58 +0000 Subject: deploy: 43e402ba2320ced7972d33c9442b2745afe230f6 --- bash.html | 41 +++++++++++++++++++++++++++++++++-------- 1 file changed, 33 insertions(+), 8 deletions(-) (limited to 'bash.html') diff --git a/bash.html b/bash.html index 9f47774..87a909f 100644 --- a/bash.html +++ b/bash.html @@ -81,7 +81,7 @@ @@ -251,18 +251,43 @@ COMP_CWORD # index into COMP_WORDS with current cursor position # out COMPREPLY # array with possible completions -

compgen builtin is used to generate possible matches for word out of possible options. -The syntax is as follows:

+

The compgen builtin is used to generate possible matches by comparing word +against words generated by option.

compgen [option] [word]
 
 # usefule options:
+# -W <list>    specify list of possible completions
+# -d           generate list with dirs
+# -f           generate list with files
+# -u           generate list with users
+# -e           generate list with exported variables
 
-# -W <list>    compare against word-list
+# compare "f" against words "foo" "foobar" "bar" and generate matches
 compgen -W "foo foobar bar" "f"
 
-# -d    compare against dir names
-# -f    compare against file names
+# compare "hom" against file/dir names and generate matches
 compgen -d -f "hom"
+
+

Example

+

Skeleton to copy/paste for writing simple completions.

+

Assume a program foo with the following interface:

+
foo -c green|red|blue -s low|high -f <file> -h
+
+

The completion handler could be implemented as follows:

+
function _foo() {
+    local curr=$2
+    local prev=$3
+
+    local opts="-c -s -f -h"
+    case $prev in
+        -c) COMPREPLY=( $(compgen -W "green red blue" -- $curr) );;
+        -s) COMPREPLY=( $(compgen -W "low high" -- $curr) );;
+        -f) COMPREPLY=( $(compgen -f -- $curr) );;
+        *)  COMPREPLY=( $(compgen -W "$opts" -- $curr) );;
+    esac
+}
+
+complete -F _foo foo
@@ -276,7 +301,7 @@ compgen -d -f "hom" - @@ -294,7 +319,7 @@ compgen -d -f "hom" - -- cgit v1.2.3