Added error message if COMPLETION-BASH is source directly.
[mmh] / docs / COMPLETION-BASH
1 # nmh completion for bash
2 # Copyright 2003 "Wade Richards" <wade@wabyn.net>
3 # Permission granted to redistribute under the BSD license
4
5 [ "$BASH_COMPLETION" ] || echo "ERROR: COMPLETION-BASH is not intended to be \
6 sourced directly, but rather added to a bash-completion package installation."
7
8 have show &&
9 _nmh()
10 {
11     # args: command comp-word prev-word
12     local command current prev folder origfolder i orig_opts
13
14     COMPREPLY=()
15     current=${COMP_WORDS[COMP_CWORD]}
16     prev=${COMP_WORDS[COMP_CWORD-1]}
17     command=$1
18
19     orig_opts=$(shopt -p extglob)
20     shopt -s extglob
21
22     # Get the folder, if specified
23     for (( i=0; i < ${#COMP_WORDS}-1; i++ ))
24     do
25         case "${COMP_WORDS[i]}" in
26         \++([a-zA-Z_]) )
27             folder=${COMP_WORDS[i]}
28             origfolder=$( folder -f )
29             ;;
30         esac
31     done
32
33     case $current in
34     -* )
35         # Command-line switches for the most common commands.
36         case $command in
37         ali )
38             # no sequences or messages
39             options=(-alias -list -nolist -normalize -nonormalize -user
40                     -nouser -version -help)
41             ;;
42         burst )
43             options=(-inplace -noinplace -quiet -noquiet -verbose
44                     -noverbose -version -help)
45             ;;
46         comp )
47             options=(-form -use -nouse
48                     -editor -noedit -whatnowproc -nowhatnowproc
49                     -version -help )
50            ;;
51         flist* )
52             options=(-sequence -all -noall -showzero -noshowzero
53                     -recurse -norecurse -fast -nofast -alpha -noalpha -version
54                     -help)
55             ;;
56         folder* )
57             options=(-all -noall -create -nocreate -fast -nofast -header
58                     -noheader -recurse -norecurse -total -nototal -list -nolist
59                     -push -pop -pack -nopack -print -verbose -noverbose
60                     -version -help)
61             ;;
62         forw )
63             options=(-annotate -noannotate -form
64                     -editor -noedit -whatnowproc
65                     -nowhatnowproc -build
66                     -version -help)
67             ;;
68         inc )
69             options=(-audit -noaudit -changecur -nochangecur -form
70                     -file -silent -nosilent -truncate -notruncate -width
71                     -version -help)
72             ;;
73         mark )
74             options=(-sequence -add -delete -list -public -nopublic
75                     -zero -nozero -version -help)
76             ;;
77         next )
78             options=(-showmimeproc -header -noheader -checkmime
79                     -nocheckmime -version -help)
80             ;;
81         packf )
82             options=(-file -version -help)
83             ;;
84         pick )
85             options=(-and -or -not -lbrace -rbrace --component -cc
86                     -date -from -search -subject -to -after -before -datefield
87                     -sequence -public -nopublic -zero -nozero -list -nolist
88                     -version -help)
89             ;;
90         prev )
91             options=(-showproc -showmimeproc -header -noheader -checkmime
92                     -nocheckmime -version -help)
93             ;;
94         refile )
95             options=(-link -nolink -preserve -nopreserve -unlink
96                     -nounlink -src -file -rmmproc -normmproc -version -help)
97             ;;
98         repl )
99             options=(-annotate -noannotate -group -nogroup -cc
100                     -nocc -query -noquery -form -filter -nofilter
101                     -mime -nomime -editor -noedit -whatnowproc
102                     -nowhatnowproc -build -file -version -help)
103             ;;
104         rmf )
105             options=(-interactive -nointeractive -version -help)
106             ;;
107         rmm )
108             options=(-link -nolink -version -help)
109             ;;
110         scan )
111             options=(-form -header -noheader
112                     -width -file -version -help )
113             ;;
114         show )
115             options=(-showproc -showmimeproc -header -noheader
116                     -checkmime -nocheckmime -version -help)
117             ;;
118         sortm )
119             options=(-datefield -textfield -notextfield -limit -nolimit
120                     -verbose -noverbose -version -help)
121             ;;
122         * )
123             options=(-help -version -seq)
124             ;;
125         esac
126         ;;
127
128     +* )
129         # Folders
130         options=( $( folder -all -r -fast | grep -v "^\." | sed "s/^/+/" ) )
131         ;;
132
133     +([0-9a-z])-* )
134         # Partial range
135         start=${current/%-*/}
136         options=( $( scan $folder -form "=%(msg)" "${start}-last" ) first prev cur next last )
137         options=( ${options[@]//#/${start}-} )
138         ;;
139
140     +([0-9]) )
141         # Message number, or start of range
142         options=( $( scan $folder -form "=%(msg)" ) first prev cur next last )
143         options=( ${options[@]} ${options[@]//%/-} )
144         ;;
145
146     [fpcnlu]* )
147         # special message aliases
148         options=( first prev cur next last unseen )
149         ;;
150
151         # What about sequences?  I can't quite see how to get the list of possible sequences, so I
152         # guess the user will have to type them in the old-fashioned way.
153
154     esac
155
156     eval $orig_opts
157
158     COMPREPLY=( $( compgen -W "${options[*]}" -- $current ) )
159     return 0
160 }
161 [ "$have" ] && complete -F _nmh ali anno burst comp dist flist flists folder folders forw inc mark mhbuild mhl mhlist mhmail mhparam mhpath mhshow mhstore msgchk next packf pick prev prompter rcvdist rcvpack rcvstore refile repl rmf rmm scan send sendfiles show slocal sortm whatnow