Changes between Version 5 and Version 6 of BashCommandCompletion

Timestamp:

Apr 30, 2008, 1:04:57 AM (17 years ago)

Author:

fthomas

Comment:

use the new names for the client and command line tool

BashCommandCompletion

@@ -1 @@
-= Command completion for boinc_client and boinc_cmd =
+= Command completion for boinc and boinccmd =
 
-The bash shell has a useful facility to complete commands when you press [TAB]. There is a script which goes a bit further and lets bash complete [UnixClient boinc_client's] and [BoincCmd boinc_cmd's] commands and options.
+The bash shell has a useful facility to complete commands when you press `[TAB]`. There is a script which goes a bit further and lets bash complete [UnixClient boinc's] and [BoincCmd boinccmd's] commands and options.
 
-For example if you type '''boinc_cmd --get_[TAB]''' it gives you all commands which begin with --get_:
+For example if you type '''`boinccmd --get_[TAB]`''' it gives you all commands which begin with `--get_`:
 {{{
+~$ boinccmd --get_
 --get_cc_status            --get_project_status
 --get_disk_usage           --get_proxy_settings
@@ -13 +14 @@
 --get_project_config_poll
 }}}
-If you now press 'p' the selection is reduced to:
+If you now press `p` and then `[TAB]` again the selection is reduced to:
 {{{
+~$ boinccmd --get_pro
 --get_project_config       --get_project_status
 --get_project_config_poll  --get_proxy_settings
 }}}
-and so on. The script also completes host names after the --host option.
+and so on. The script also completes host names after the `--host` option.
 
-To use this command completion, save the following script on a file and source it in bash.
+To use this command completion, save the following script on a file (e.g. `boinc.bash`) and source it in bash:
 {{{
-#!comment
-instructions are needed on what exactly users are supposed to do to use the script, ie what "source it in bash" means.
+~$ source boinc.bash
 }}}
+
 ----
+
 {{{
 #!bash
 # Source this file in bash to get command completion (using tab)
-# for boinc_client and boinc_cmd
+# for boinc and boinccmd
 # Written by Frank S. Thomas
 
-_boinc_client()
+_boinc()
 {
     local cur prev opts
@@ -39 +42 @@
     prev="${COMP_WORDS[COMP_CWORD-1]}"
 
-    opts="$(boinc_client --help | \
+    opts="$(boinc --help | \
         sed -n -r 's/^[[:space:]]*(--[a-z_]*).*/\1/p')"
 
@@ -66 +69 @@
     fi
 }
-complete -F _boinc_client -o default boinc_client
+complete -F _boinc -o default boinc
 
-_boinc_cmd()
+_boinccmd()
 {
     local cur prev opts cmds
@@ -76 +79 @@
 
     opts="--host --passwd -h --help -V --version"
-    cmds="$(boinc_cmd --help 2>&1 | \
+    cmds="$(boinccmd --help 2>&1 | \
         sed -n -r 's/^[[:space:]]*(--[a-z_]*).*/\1/p')"
 
@@ -124 +127 @@
     esac
 }
-complete -F _boinc_cmd boinc_cmd
+complete -F _boinccmd boinccmd
 # vim: syntax=sh
 }}}