diff options
| -rw-r--r-- | Completion/Base/Widget/_generic | 11 | ||||
| -rw-r--r-- | Doc/Zsh/compsys.yo | 5565 |
2 files changed, 3500 insertions, 2076 deletions
diff --git a/Completion/Base/Widget/_generic b/Completion/Base/Widget/_generic new file mode 100644 index 000000000..9a5e726df --- /dev/null +++ b/Completion/Base/Widget/_generic @@ -0,0 +1,11 @@ +#autoload + +local curcontext="${curcontext:-}" + +if [[ -z "$curcontext" ]]; then + curcontext="${WIDGET}:::" +else + curcontext="${WIDGET}:${curcontext#*:}" +fi + +_main_complete "$@" diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo index 2c7d813d6..2a9aae63a 100644 --- a/Doc/Zsh/compsys.yo +++ b/Doc/Zsh/compsys.yo @@ -1,4 +1,4 @@ -texinode(Completion System)(Zftp Function System)(Zsh Modules)(Top) +texinode(Completion System)(Completion Using compctl)(Completion Widgets)(Top) chapter(Completion System) cindex(completion system) cindex(completion, programmable) @@ -7,9 +7,9 @@ sect(Description) This describes the shell code for the new completion system. It consists of various shell functions; those beginning `tt(comp)' are to be called -directly by the user, while those beginning `tt(_)' are called by the -completion code. The shell functions of the second set which implement -completion behaviour and which may be bound to keystrokes, are referred to +directly, while those beginning `tt(_)' are called by the +completion code. The shell functions of the second set, which implement +completion behaviour and may be bound to keystrokes, are referred to as `widgets'. startmenu() @@ -26,11 +26,10 @@ sect(Initialization) findex(compinstall) cindex(completion system, installing) -The function tt(compinstall) can be run by a user to set up the completion -system for use, which also provides options for more advanced usage. -However, if the system was installed completely, it should be enough to +If the system was installed completely, it should be enough to call the shell function tt(compinit) from your initialization file; see the -next section. +next section. However, the function tt(compinstall) can be run by a user +to configure various aspects of the completion system. Usually, tt(compinstall) will insert code into tt(.zshrc), although if that is not writable it will save it in another file and tell you that @@ -40,60 +39,66 @@ them to an earlier place in the file if tt(.zshrc) usually returns early. So long as you keep them all together (including the comment lines at the start and finish), you can rerun tt(compinstall) and it will correctly locate and modify these lines. Note, however, that any code you add to -this section by hand is likely to be lost if you rerun tt(compinstall). +this section by hand is likely to be lost if you rerun tt(compinstall), +although lines using the command `tt(zstyle)' should be gracefully handled. + The new code will take effect next time you start the shell, or run -tt(.zshrc) by hand. - -To run it, you will need to make sure it is in a directory mentioned in your -tt($fpath) parameter, and that it is autoloaded (`tt(autoload -U -compinstall)' is recommended). It will ask you various questions about how -you would like completion set up. It is in two parts; the basic part -locates the completion files and decides where to put your personal -dumpfile, used to speed up initialization after the first time. After -that, you will be asked if you wish to go on to the advanced set-up; if you -answer tt(n), you can rerun tt(compinstall) later without having to -re-enter any of the basic settings. - -You can abort the installation any time you are being prompted for -information, and your tt(.zshrc) will not be altered at all. - -After initialization all the builtin completion widgets such as -tt(expand-or-complete) will be redefined to use the new completion system. -Should you need to, you can still bind keys to the old functions by putting -a `tt(.)' in front, e.g. `tt(.expand-or-complete)'. +tt(.zshrc) by hand; there is also an option to make them take effect +immediately. However, if tt(compinstall) has removed definitions, you will +need to restart the shell to see the changes. + +To run tt(compinstall) you will need to make sure it is in a directory +mentioned in your tt(fpath) parameter, which should already be the case if +zsh was properly configured as long as your startup files do not remove the +appropriate directories from tt(fpath). Then it must be autoloaded +(`tt(autoload -U compinstall)' is recommended). You can abort the +installation any time you are being prompted for information, and your +tt(.zshrc) will not be altered at all; changes only take place right at the +end, where you are specifically asked for confirmation. subsect(Use of compinit) findex(compinit) cindex(completion system, initializing) This section describes the use of tt(compinit) to initialize completion for -the current session when run directly by the user; if you have run +the current session when called directly; if you have run tt(compinstall) it will be called automatically from your tt(.zshrc). To initialize the system, the function tt(compinit) should be in a -directory mentioned in the tt($fpath) variable, and should be autoloaded -(`tt(autoload -U compinit)' is recommended). When run, it will define a +directory mentioned in the tt(fpath) parameter, and should be autoloaded +(`tt(autoload -U compinit)' is recommended), and then run simply as +`tt(compinit)'. This will define a few utility functions, arrange for all the necessary shell functions to be -autoloaded, and will then re-bind all keys that do completion to use the -new system. Note that this means that the tt(zsh/complist) module has -to be loaded before the completion system is initialized (i.e. the -tt(compinit) function is called) to make sure that the tt(menu-select) -widget defined by it will be redefined, too. +autoloaded, and will then re-define all widgets that do completion to use the +new system. If you use the tt(menu-select) widget, which is part of the +tt(zsh/complist) module, you should make sure that that module is loaded +before the call to tt(compinit) so that that widget is also +re-defined. If completion styles (see below) are set up to perform +expansion as well as completion by default, and the TAB key is bound to +tt(expand-or-complete), tt(compinit) will rebind it to tt(complete-word); +this is necessary to use the correct form of expansion. + +Should you need to use the original completion commands, you can still +bind keys to the old widgets by putting a `tt(.)' in front of the +widget name, e.g. `tt(.expand-or-complete)'. To speed up the running of tt(compinit), it can be made to produce a dumped -configuration which will be read in on future invocations; this is the -default, although it can be turned off by calling tt(compinit) with the +configuration that will be read in on future invocations; this is the +default, but can be turned off by calling tt(compinit) with the option tt(-D). The dumped file is tt(.zcompdump) in the same directory as the startup files (i.e. tt($ZDOTDIR) or tt($HOME)); alternatively, an explicit file name can be given by `tt(compinit -d) -var(dumpfile)'. On the next call to tt(compinit), the dumped file will be -read instead of a full initialization. +var(dumpfile)'. The next invocation of tt(compinit) will read the dumped +file instead of performing a full initialization. If the number of completion files changes, tt(compinit) will recognise this and produce a new dump file. However, if the name of a function or the arguments in the first line of a tt(#compdef) function (as described below) -change, it is easiest to delete the dump file by hand so that the next time -tt(compinit) will re-create it. +change, it is easiest to delete the dump file by hand so that +tt(compinit) will re-create it the next time it is run. The check +performed to see if there are new functions can be omitted by giving +the option tt(-C). In this case the dump file will only be created if +there isn't one already. The dumping is actually done by another function, tt(compdump), but you will only need to run this yourself if you change the configuration @@ -104,6 +109,27 @@ If the parameter tt(_compdir) is set, tt(compinit) uses it as a directory where completion functions can be found; this is only necessary if they are not already in the function search path. +For security reasons tt(compinit) also checks if the completion system +would use files not owned by root or by the current user, or files in +directories that are world- or group-writable or that are not owned by +root or by the current user. If such files or directories are found, +tt(compinit) will ask if the completion system should really be used. To +avoid these tests and make all files found be used without asking, use the +option tt(-u), and to make tt(compinit) silently ignore all insecure files +and directories use the option tt(-i). This security check is skipped +entirely when the tt(-C) option is given. + +findex(compaudit) +The security check can be retried at any time by running the function +tt(compaudit). This is the same check used by tt(compinit), but when it +is executed directly any changes to tt(fpath) are made local to the +function so they do not persist. The directories to be checked may be +passed as arguments; if none are given, tt(compaudit) uses tt(fpath) and +tt(_compdir) to find completion system directories, adding missing ones +to tt(fpath) as necessary. To force a check of exactly the directories +currently named in tt(fpath), set tt(_compdir) to an empty string before +calling tt(compaudit) or tt(compinit). + subsect(Autoloaded files) cindex(completion system, autoloaded functions) @@ -111,73 +137,82 @@ The convention for autoloaded functions used in completion is that they start with an underscore; as already mentioned, the tt(fpath/FPATH) parameter must contain the directory in which they are stored. If tt(zsh) was properly installed on your system, then tt(fpath/FPATH) automatically -contains the required directories. +contains the required directories for the standard functions. For incomplete installations, if tt(compinit) does not find enough files beginning with an underscore (fewer than twenty) in the search path, it will try to find more by adding the directory tt(_compdir) to the search -path; if you have run tt(compinstall), this will be set automatically. -Furthermore, if the directory in question ends in the path segment -tt(Core), or has a subdirectory named tt(Core), tt(compinit) will add all -subdirectories of the directory where tt(Core) is to the path: this allows +path. If that directory has a subdirectory named tt(Base), all +subdirectories will be added to the path. Furthermore, if the subdirectory +tt(Base) has a subdirectory named tt(Core), tt(compinit) will add all +subdirectories of the subdirectories is to the path: this allows the functions to be in the same format as in the tt(zsh) source distribution. +cindex(compdef, use of by compinit) When tt(compinit) is run, it searches all such files accessible via tt(fpath/FPATH) and reads the first line of each of them. This line should -contain one of the tags described below. Files whose first line does not +contain one of the tags described below. Files whose first line does not start with one of these tags are not considered to be part of the completion system and will not be treated specially. The tags are: startitem() -item(tt(#compdef) var(names...))( +item(tt(#compdef) var(names...) [ tt(-[pP]) var(patterns...) [ tt(-N) var(names...) ] ])( The file will be made autoloadable and the function defined in it will be called when completing var(names), each of which is either the name of a command whose arguments are to be completed or one of a number of special contexts in the form tt(-)var(context)tt(-) described -below for the tt(_complete) function. -) -item(tt(#compdef -p) var(pattern))( -The file will be made autoloadable and the function defined in it will be -called when completing for a command whose name matches the given -var(pattern) (a standard globbing pattern). Note that only one -var(pattern) may be given. -) -item(tt(#compdef -P) var(pattern))( -Like the previous one, but the function will be called only if no -completion function for the command on the line could be found. +below. + +Each var(name) may also be of the form `var(cmd)tt(=)var(service)'. +When completing the command var(cmd), the function typically behaves as +if the command (or special context) var(service) was being completed +instead. This provides a way of altering the behaviour of functions +that can perform many different completions. It is implemented +by setting the parameter tt($service) when calling the function; +the function may choose to interpret this how it wishes, and simpler +functions will probably ignore it. + +If the tt(#compdef) line contains one of the options tt(-p) or tt(-P), +the words following are taken to be patterns. The function will be +called when completion is attempted for a command or context that matches +one of the patterns. The options tt(-p) and tt(-P) are used to specify +patterns to be tried before or after other completions respectively. +Hence tt(-P) may be used to specify default actions. + +The option tt(-N) is used after a list following tt(-p) or tt(-P); it +specifies that remaining words no longer define patterns. It is +possible to toggle between the three options as many times as necessary. ) item(tt(#compdef -k) var(style key-sequences...))( -This can be used to bind special completion functions to the -var(key-sequences). It creates a widget behaving like the builtin widget -var(style), which must be one of those that perform completion, namely -tt(complete-word), tt(delete-char-or-list), tt(expand-or-complete), -tt(expand-or-complete-prefix), tt(list-choices), tt(menu-complete), -tt(menu-expand-or-complete), or tt(reverse-menu-complete). If the -tt(complist) module is loaded (see +This option creates a widget behaving like the +builtin widget var(style) and binds it to the given var(key-sequences), +if any. The var(style) must be one of the builtin widgets that perform +completion, namely tt(complete-word), tt(delete-char-or-list), +tt(expand-or-complete), tt(expand-or-complete-prefix), tt(list-choices), +tt(menu-complete), tt(menu-expand-or-complete), or +tt(reverse-menu-complete). If the tt(zsh/complist) module is loaded (see ifzman(zmanref(zshmodules))\ ifnzman(noderef(The zsh/complist Module))\ -), the tt(menu-select) widget can be used, too. Note that the -bindings will not be used if the key is already bound (that -is, is bound to something other than tt(undefined-key)). +) the widget tt(menu-select) is also available. -The widget is then bound to all the var(key-sequences) given, if any: when -one of the var(key-sequences) is typed, the function in the file will -be invoked to generate the matches. The widget created has the same -name as the file and can also be bound to other keys using tt(bindkey) -as usual. +When one of the var(key-sequences) is typed, the function in the file will +be invoked to generate the matches. Note that a key will not be re-bound +if if it already was (that is, was bound to something other than +tt(undefined-key)). The widget created has the same name as the file and +can be bound to any other keys using tt(bindkey) as usual. ) item(tt(#compdef -K) var(widget-name) var(style) var(key-sequences) ...)( -This is similar to tt(-k), with the same var(style) and var(key-sequences) -arguments arguments, preceeded by a string giving the name of a widget. -In this case only one var(key-sequences) argument may be given, but the -entire set of three arguments may be repeated with a different set of -arguments. In particular, the var(widget-name) must be distinct in each -set. It should begin with `tt(_)', else one will be added, and should not -clash with the name of any existing widget: names based on the name of the -function are most useful. For example, +This is similar to tt(-k) except that only one var(key-sequences) +argument may be given for each var(widget-name) var(style) pair. +However, the entire set of three arguments may be repeated with a +different set of arguments. Note in particular that the +var(widget-name) must be distinct in each set. If it does not begin with +`tt(_)' this will be added. The var(widget-name) should not clash with +the name of any existing widget: names based on the name of the function +are most useful. For example, example(#compdef -K _foo_complete complete-word "^X^C" \ _foo_list list-choices "^X^D") @@ -185,54 +220,197 @@ example(#compdef -K _foo_complete complete-word "^X^C" \ (all on one line) defines a widget tt(_foo_complete) for completion, bound to `tt(^X^C)', and a widget tt(_foo_list) for listing, bound to `tt(^X^D)'. ) -item(tt(#autoload))( -This is used for files defining utility function that are not to be -called directly as completion functions but should be loaded automatically -when invoked. Typically they are to be called from within one of the -completion functions. +item(tt(#autoload) [ var(options) ])( +Functions with the tt(#autoload) tag are marked for autoloading but +are not otherwise treated specially. Typically they are to be called +from within one of the completion functions. Any var(options) supplied +will be passed to the tt(autoload) builtin; a typical use is tt(+X) to +force the function to be loaded immediately. Note that the tt(-U) and +tt(-z) flags are always added implicitly. +) +enditem() + +The tt(#) is part of the tag name and no white space is allowed after it. +The tt(#compdef) tags use the tt(compdef) function described below; the +main difference is that the name of the function is supplied implicitly. + +The special contexts for which completion functions can be defined are: + +startitem() +kindex(-array-value-, completion context) +item(tt(-array-value-))( +The right hand side of an array-assignment +(`tt(foo=LPAR()...RPAR())') +) +kindex(-brace-parameter-, completion context) +item(tt(-brace-parameter-))( +The name of a parameter expansion within braces (`tt(${...})') +) +kindex(-assign-parameter-, completion context) +item(tt(-assign-parameter-))( +The name of a parameter in an assignment, i.e. on the left hand side of +an `tt(=)' +) +kindex(-command-, completion context) +item(tt(-command-))( +A word in command position +) +kindex(-condition-, completion context) +item(tt(-condition-))( +A word inside a condition (`tt([[...]])') +) +kindex(-default-, completion context) +item(tt(-default-))( +Any word for which no other completion is defined +) +kindex(-equal-, completion context) +item(tt(-equal-))( +A word beginning with an equals sign +) +kindex(-first-, completion context) +item(tt(-first-))( +This is tried before any other completion function. The function called +may set the tt(_compskip) parameter to one of various values: +tt(all): no further completion is attempted; a string +containing the substring tt(patterns): no pattern completion functions +will be called; a string containing tt(default): the +function for the `tt(-default-)' context will not be called, but +functions defined for commands will +) +kindex(-math-, completion context) +item(tt(-math-))( +Inside mathematical contexts, such as +`tt(LPAR()LPAR())...tt(RPAR()RPAR())' +) +kindex(-parameter-, completion context) +item(tt(-parameter-))( +The name of a parameter expansion (`tt($...)') +) +kindex(-redirect-, completion context) +item(tt(-redirect-))( +The word after a redirection operator. +) +kindex(-subscript-, completion context) +item(tt(-subscript-))( +The contents of a parameter subscript. +) +kindex(-tilde-, completion context) +item(tt(-tilde-))( +After an initial tilde (`tt(~)'), but before the first slash +in the word. +) +kindex(-value-, completion context) +item(tt(-value-))( +On the right hand side of an assignment. ) enditem() -Note that the tt(#) is part of the tag name and no white space is allowed -after it. The tt(#compdef) tags use the tt(compdef) function described -below; the main difference is that the name of the function is supplied -implicitly. +Default implementations are supplied for each of these +contexts. In most cases the context tt(-)var(context)tt(-) is +implemented by a corresponding function tt(_)var(context), for example +the context `tt(-tilde-)' and the function `tt(_tilde)'). + +The contexts tt(-redirect-) and tt(-value-) allow extra context-specific +information. (Internally, this is handled by the functions for each +context calling the function tt(_dispatch).) The extra +information is added separated by commas. + +For the tt(-redirect-) context, the extra information is in the form +`tt(-redirect-,)var(op)tt(,)var(command)', where var(op) is the +redirection operator and var(command) is the name of the command on +the line. If there is no command on the line yet, the var(command) +field will be empty. + +For the tt(-value-) context, the form is +`tt(-value-,)var(name)tt(,)var(command)', where var(name) is the name of +the parameter. In the case of elements of an associative array, for +example `tt(assoc=LPAR()key <TAB>)', var(name) is expanded to +`var(name)tt(-)var(key)'. In certain special contexts, such as +completing after `tt(make CFLAGS=)', the var(command) part gives the +name of the command, here tt(make); otherwise it is empty. + +It is not necessary to define fully specific completions as the +functions provided will try to generate completions by progressively +replacing the elements with `tt(-default-)'. For example, when +completing after `tt(foo=<TAB>)', tt(_value) will try the names +`tt(-value-,foo,)' (note the empty var(command) part), +`tt(-value-,foo,-default-)' and`tt(-value-,-default-,-default-)', in +that order, until it finds a function to handle the context. + +As an example: + +example(compdef '_files -g "*.log"' '-redirect-,2>,-default-') + +completes files matching `tt(*.log)' after `tt(2> <TAB>)' for any +command with no more specific handler defined. + +Also: + +example(compdef _foo -value-,-default-,-default-) + +specifies that tt(_foo) provides completions for the values of +parameters for which no special function has been defined. This is +usually handled by the function tt(_value) itself. + +The same lookup rules are used when looking up styles (as described +below); for example + +example(zstyle ':completion:*:*:-redirect-,2>,*:*' file-patterns '*.log') + +is another way to make completion after `tt(2> <TAB>)' complete files +matching `tt(*.log)'. subsect(Functions) -The tt(compinit) file defines the following function, which may -also be called directly by the user. +The following function is defined by tt(compinit) and may be called +directly. findex(compdef) cindex(completion system, adding definitions) startitem() -xitem(tt(compdef) [ tt(-an) ] var(function names...)) +xitem(tt(compdef) [ tt(-an) ] var(function names...) [ tt(-[pP]) var(patterns...) [ tt(-N) var(names...) ] ]) xitem(tt(compdef -d) var(names...)) -xitem(tt(compdef -p) [ tt(-a) ] var(function pattern)) -xitem(tt(compdef -P) [ tt(-a) ] var(function pattern)) xitem(tt(compdef -k) [ tt(-an) ] var(function style key-sequences...)) item(tt(compdef -K) [ tt(-an) ] var(function name style key-sequences ...))( -The first form tells the completion system to call the given -var(function) when completing for the contexts or commands -whose var(names) are given: this is like the tt(#compdef) tag. If the -tt(-n) option is given, any existing completion behaviour for particular -contexts or commands will not be altered. These definitions can be deleted -by giving the tt(-d) option as in the second form. - -The form with tt(-p) is similar to the first, but var(function) will be -called for all commands whose name matches the var(pattern); this is like -the tt(#compdef -p) function tag. - -The form with tt(-P) is like the third, but the var(function) will be -called only if no function for the command itself was found or if one -was found and it set the tt(_compskip) parameter to a value em(not) -containing the substring tt(patterns). +The first form defines the var(function) to call for completion in the +given contexts as described for the tt(#compdef) tag above. + +Alternatively, all the arguments may have the form +`var(cmd)tt(=)var(service)'. Here var(service) should already have been +defined by `var(cmd1)tt(=)var(service)' lines in tt(#compdef) files, as +described above. The argument for var(cmd) will be completed in the +same way as var(service). + +The var(function) argument may alternatively be a string containing any +shell code. The string will be executed using the tt(eval) builtin +command to generate completions. This provides a way of avoiding having +to define a new completion function. For example, to complete +files ending in `tt(.h)' as arguments to the command tt(foo): + +example(compdef '_files -g "*.h"' foo) + +The option tt(-n) prevents any completions already defined for the +command or context from being overwritten. + +The option tt(-d) deletes any completion defined for the command or +contexts listed. + +The var(names) may also contain tt(-p), tt(-P) and tt(-N) options as +described for the tt(#compdef) tag. The effect on the argument list is +identical, switching between definitions of patterns tried initially, +patterns tried finally, and normal commands and contexts. + +The parameter tt($_compskip) may be set by any function defined for a +pattern context. If it is set to a value containing the substring +`tt(patterns)' none of the pattern-functions will be called; if it is +set to a value containing the substring `tt(all)', no other function +will be called. The form with tt(-k) defines a widget with the same name as the var(function) -which will be called for each of the var(key-sequences); this is like the +that will be called for each of the var(key-sequences); this is like the tt(#compdef -k) tag. The function should generate the completions needed and will otherwise behave like the builtin widget whose name is given as -the var(style) argument. The widgets usable for this are: +the var(style) argument. The widgets usable for this are: tt(complete-word), tt(delete-char-or-list), tt(expand-or-complete), tt(expand-or-complete-prefix), tt(list-choices), tt(menu-complete), tt(menu-expand-or-complete), and tt(reverse-menu-complete), as well as @@ -246,12 +424,22 @@ var(name), var(style) and var(key-sequences), where the latter two are as for tt(-k) and the first must be a unique widget name beginning with an underscore. -In each of the forms supporting it the tt(-a) option makes the -var(function) autoloadable (exactly equivalent to -tt(autoload -U )var(function)). +Wherever applicable, the tt(-a) option makes the var(function) +autoloadable, equivalent to tt(autoload -U )var(function). ) enditem() +The function tt(compdef) can be used to associate existing completion +functions with new commands. For example, + +example(compdef _pids foo) + +uses the function tt(_pids) to complete process IDs for the command tt(foo). + +Note also the tt(_gnu_generic) function described below, which can be +used to complete options for commands that understand the +`tt(-)tt(-help)' option. + texinode(Completion System Configuration)(Control Functions)(Initialization)(Completion System) sect(Completion System Configuration) cindex(completion system, configuration) @@ -262,394 +450,533 @@ generated. subsect(Overview) -When completion is attempted somewhere on a command line the -completion system first tries to find out the context where completion -was tried. The context depends on such things as the name of the -command when completing an argument, and possibily also -the name of an option when completing an argument to that option. - -For the context a name consisting of multiple fields is built. This -name is then used to look up styles that can be used to configure the -completion system. Since it is not possible to build the whole context -name in advance, completion function may modify some of the fields and -hence the context name used for lookup may vary during the same call -to the completion system. - -The context name always consists of the following fields, separated -by colons: - -startitem() -item()( +When completion is attempted somewhere on the command line the +completion system first works out the context. This takes account of a +number of things including the command word (such as `tt(grep)' or +`tt(zsh)') and options to which the current word may be an argument +(such as the `tt(-o)' option to tt(zsh) which takes a shell option as an +argument). + +This context information is condensed into a string consisting of +multiple fields separated by colons, referred to simply as `the context' +in the remainder of the documentation. This is used to look up +em(styles), context-sensitive options that can be used to configure the +completion system. The context used for lookup may vary during the same +call to the completion system. + +The context string always consists of the following fields, separated +by colons and with a leading colon before the first: + +startitemize() +itemiz(\ The literal string tt(completion), saying that this style is used by -the completion system. -) -item()( -The var(function); in many cases this field will be blank, but when -the completion system is called from other functions, like -tt(predict-on) or one of the functions in the tt(Command) directory of -the distribution, this field contains the (probably abbreviated) name -of that function. -) -item()( -The var(completer) currently active, i.e. the name of the completer -function without the leading underscore. Such a completer is in -overall control of how completion is to be performed; `tt(complete)' -is the basic one for ordinary completion, but completers may perform -various related tasks such as correction, or modify the behaviour of a -later completer (see +the completion system. This distinguishes the context from those used +by, for example, zle widgets and ZFTP functions. +) +itemiz(\ +The var(function), if completion is called from a named widget rather +than through the normal completion system. Typically this is blank, but +it is set by special widgets such as tt(predict-on) and the various +functions in the tt(Widget) directory of the distribution to the name of +that function, often in an abbreviated form. +) +itemiz(\ +The var(completer) currently active, the name of the function without the +leading underscore and with other underscores converted to hyphens. A +`completer' is in overall control of how completion is to be performed; +`tt(complete)' is the simplest, but other completers exist to perform +related tasks such as correction, or to modify the behaviour of a later +completer. See ifzman(the section `Control Functions' below)\ ifnzman(noderef(Control Functions)) -for more information). -) -item()( -The var(context) or var(command). This is either one of the special -context names such as tt(-condition-) as explained for the -tt(_complete) completer below, or the name of the command we are -completing arguments for. Completion functions for commands that have -sub-commands usually modify this field to contain the name of the -command followed by a minus sign and the sub-command (e.g. the -completion function for the tt(cvs) command sets this field to strings -such as tt(cvs-add) when completing for the tt(add) sub-command). -) -item()( -The var(argument), describing which argument we are -completing. Normally this is either a string of the form -tt(argument-)var(n), where var(n) is the number of the argument or it -is a string of the form tt(-)var(opt)tt(-)var(n) when completing the -var(n)'th argument of the option var(opt). -) -item()( -The var(tag). Tags are used for two purposes: to describe the types -of matches a completion function can generate for a certain context -and to simplify the definition of styles that are tested. -) -enditem() +for more information. +) +itemiz(\ +The var(command) or a special tt(-)var(context)tt(-), just at it appears +following the tt(#compdef) tag or the tt(compdef) function. Completion +functions for commands that have sub-commands usually modify this field +to contain the name of the command followed by a minus sign and the +sub-command. For example, the completion function for the tt(cvs) +command sets this field to tt(cvs-add) when completing arguments to +the tt(add) subcommand. +) +itemiz(\ +The var(argument); this indicates which command line or option argument +we are completing. For command arguments this generally takes the form +tt(argument-)var(n), where var(n) is the number of the argument, +and for arguments to options the form tt(option-)var(opt)tt(-)var(n) +where var(n) is the number of the argument to option var(opt). However, +this is only the case if the command line is parsed with standard +UNIX-style options and arguments, so many completions do not set this. +) +itemiz(\ +The var(tag). Tags are used to discriminate between the types +of matches a completion function can generate in a certain context and +are described further below. +) +enditemize() As an example, the context name -`tt(:completion::complete:dvips:-o-1:files)' says that normal -completion was attempted on an argument of the tt(dvips) -command (more precisely: completion was attempted on the first -argument after the tt(-o) option) and the completion function will -generate filenames for this context. - -In many of the possible contexts the completion system can generate -matches, often multiple types of matches. These types are represented as -simple names called `tags'. The completion system will decide internally -what sort of tags are allowed; a list of the standard possibilities is given -below. To determine in which order the tags are to be used by the -completion function, the `tt(tag-order)' style for the appropriate -context may be set, as described in the list of standard styles below. -Only those types of matches whose tags were selected by this style -will be produced, and in the order given. - -The tt(_complete_help) bindable command described in + +example(tt(:completion::complete:dvips:option-o-1:files)) + +says that normal completion was attempted as the first argument to the +option tt(-o) of the command tt(dvips): + +example(tt(dvips -o ...)) + +and the completion function will generate filenames. + +Each type of completion the system can perform in a given context is +described by a `tag', a short descriptive string such as tt(files) in +the example above. Any completion function may use any tag name it +likes, but a list of the more common ones is given below. + +Usually completion will be tried by all possible tags in an order given +by the completion function. However, this can be altered by using the +tt(tag-order) style. Completion is then restricted to the list of given +tags in the given order. + +The tt(_complete_help) bindable command shows all the contexts and tags +available for completion at a particular point. This provides an easy +way of finding information for tt(tag-order) and other styles. It is +described in ifzman(the section `Bindable Commands' below)\ -ifnzman(noderef(Bindable Commands)) -can be invoked to find out the context and tag names used at a particular -point in completion. It shows a list of context names and the -tag names used in those contexts if completion were tried at the -current cursor position. Hence one can easily find out all the -information needed to change the behaviour of the tt(tag-order) style -for a particular context. - -Completion behaviour can be modified by various other -styles defined with the tt(zstyle) builtin command -(see -ifzman(zmanref(zshmodules))\ +ifnzman(noderef(Bindable Commands)). + +Styles determine such things as how the matches are generated, similarly +to shell options but with much more control. They can have any number +of strings as their value. They are defined with the tt(zstyle) builtin +command (\ +ifzman(see zmanref(zshmodules))\ ifnzman(noderef(The zsh/zutil Module))). -When looking up styles the completion system uses full context names, -including the tag. -Styles determine such things as how the matches are generated; some of them -correspond to shell options (for example, the use of menu completion), but -styles provide more specific control. They can have any number of strings as -their value. Looking up the value of a style therefore consists of two -things: the context, which may be matched as a pattern, and the name of -the style itself, which must be given exactly. +When looking up styles the completion system uses full context names, +including the tag. Looking up the value of a style therefore consists +of two things: the context, which may be matched as a pattern, and the +name of the style itself, which must be given exactly. For example, many completion functions can generate matches in a simple and a verbose form and use the tt(verbose) style to decide -which form should be used. To make all such functions always use the -verbose form one can simply call +which form should be used. To make all such functions use the verbose form, +put example(zstyle ':completion:*' verbose yes) -in one of the startup files like tt(.zshrc). This definition simply -means that the tt(verbose) style has tt(yes) as its value in every -context inside the completion system. If the pattern were `tt(*)', it -would mean that the verbose style had this value anywhere the style -mechanism is used. +in a startup file (probably tt(.zshrc)). +This gives the tt(verbose) style the value tt(yes) in every +context inside the completion system, unless that context has a more +specific definition. It is best to avoid giving the context as `tt(*)' +in case the style has some meaning outside the completion system. + +Many such general purpose styles can be configured simply by using the +tt(compinstall) function. -As a more specific example, the completion function for the tt(kill) -builtin command uses the tt(verbose) style to decide if jobs and processes -are listed only as job numbers and process identifiers or if they are -listed with the full job texts and the command lines of the processes (the -latter is achieved by calling the tt(ps) command). To make this builtin -list the matches only as numbers one could call: +A more specific example of the use of the tt(verbose) style is by the +completion for the tt(kill) builtin. If the style is set, the builtin +lists full job texts and process command lines; otherwise it shows the +bare job numbers and PIDs. To turn the style off for this use only: example(zstyle ':completion:*:*:kill:*' verbose no) -Furthermore, if one wanted to see the command lines for processes but not the -job texts one could use the fact that the context name contains the tag name -when styles are looked up. As the function for the tt(kill) -builtin command uses the tags tt(jobs) and tt(processes), we can use: +For even more control, the style can use one of the tags `tt(jobs)' or +`tt(processes)'. To turn off verbose display only for jobs: example(zstyle ':completion:*:*:kill:*:jobs' verbose no) +The tt(-e) option to tt(zstyle) even allows completion function code to +appear as the argument to a style; this requires some understanding of +the internals of completion functions (see +ifzman(see zmanref(zshcompwid))\ +ifnzman(noderef(Completion Widgets)))\ +). For example: + +example(zstyle -e ':completion:*' completer ' + if [[ $words[1] = cvs ]]; then + reply=(_complete) + else + reply=(_complete _approximate) + fi') + +uses the value `tt(_complete)' for the tt(completer) style in most +contexts, but the value `tt(_complete _approximate)' when the first word +on the command line is `tt(cvs)'. This is probably more conveniently done +by specifying the style for two different contexts. This form can be +slow and should be avoided for commonly examined styles such +as tt(menu) and tt(list-rows-first). + Note that the order in which styles are em(defined) does not matter; the style mechanism uses the most specific possible match for a particular style to determine the set of values. More precisely, strings are -preferred over patterns (for example, `tt(:completion:complete:foo)' is -more specific than `tt(:completion:complete:*')), and longer patterns are +preferred over patterns (for example, `tt(:completion::complete:foo)' is +more specific than `tt(:completion::complete:*')), and longer patterns are preferred over shorter patterns. -As for tags, completion functions can use any number of styles, so -there can't be a complete list. However, the following two sections -list those tags and styles that are used in many places of the -completion system. +Style names like those of tags are arbitrary and depend on the completion +function. However, the following two sections list some of the most +common tags and styles. subsect(Standard Tags) cindex(completion system, tags) -Here are the tags currently used by the completion system. Note that -some of these tags are not actually used while generating matches, -but are only used by some completion functions when looking up -styles. +Some of the following are only used when looking up particular styles +and do not refer to a type of match. startitem() +kindex(accounts, completion tag) item(tt(accounts))( used to look up the tt(users-hosts) style ) -item(tt(all-files))( -for the names of all files -) +kindex(all-expansions, completion tag) item(tt(all-expansions))( -used by the tt(_expand) completer when adding the string containing -all expansions +used by the tt(_expand) completer when adding the single string containing +all possible expansions +) +kindex(all-files, completion tag) +item(tt(all-files))( +for the names of all files (as distinct from a particular subset, see the +tt(globbed-files) tag). ) +kindex(arguments, completion tag) item(tt(arguments))( -when an argument of a command may be completed +for arguments to a command ) +kindex(arrays, completion tag) item(tt(arrays))( for names of array parameters ) +kindex(association-keys, completion tag) item(tt(association-keys))( -for keys of associative arrays (e.g. when completing inside a -subscript of such a parameter) +for keys of associative arrays; used when completing inside a +subscript to a parameter of this type ) +kindex(bookmarks, completion tag) item(tt(bookmarks))( when completing bookmarks (e.g. for URLs and the tt(zftp) function suite) ) +kindex(builtins, completion tag) item(tt(builtins))( for names of builtin commands ) +kindex(characters, completion tag) item(tt(characters))( -used for commands like tt(stty) when completing characters; also used -when completing character classes after a opening bracket +for single characters in arguments of commands such as tt(stty). Also used +when completing character classes after an opening bracket +) +kindex(colormapids, completion tag) +item(tt(colormapids))( +for X colormap ids ) +kindex(colors, completion tag) item(tt(colors))( for color names ) +kindex(commands, completion tag) item(tt(commands))( -for names of external commands and names of sub-commands (used by some -commands like tt(cvs)) +for names of external commands. Also used by complex commands such as +tt(cvs) when completing names subcommands. ) +kindex(contexts, completion tag) +item(tt(contexts))( +for contexts in arguments to the tt(zstyle) builtin command +) +kindex(corrections, completion tag) item(tt(corrections))( -used by the tt(_approximate) and tt(_correct) completers for the possible +used by the tt(_approximate) and tt(_correct) completers for possible corrections ) +kindex(cursors, completion tag) item(tt(cursors))( for cursor names used by X programs ) +kindex(default, completion tag) item(tt(default))( -used to look up default values for various styles that may also be set -for tags that are used when generating matches +used in some contexts to provide a way of supplying a default when more +specific tags are also valid. Note that this tag is +used when only the var(function) field of the context name is set ) +kindex(descriptions, completion tag) item(tt(descriptions))( -used when looking up the value of the tt(format) style for -descriptions +used when looking up the value of the tt(format) style to generate +descriptions for types of matches ) +kindex(devices, completion tag) item(tt(devices))( for names of device special files ) +kindex(directories, completion tag) item(tt(directories))( for names of directories ) +kindex(directory-stack, completion tag) item(tt(directory-stack))( for entries in the directory stack ) +kindex(displays, completion tag) item(tt(displays))( for X display names ) +kindex(domains, completion tag) item(tt(domains))( for network domains ) +kindex(expansions, completion tag) item(tt(expansions))( -used by the tt(_expand) completer for possible expansions +used by the tt(_expand) completer for individual words (as opposed to +the complete set of expansions) resulting from the expansion of a word +on the command line ) +kindex(extensions, completion tag) item(tt(extensions))( for X server extensions ) +kindex(file-descriptors, completion tag) +item(tt(file-descriptors))( +for numbers of open file descriptors +) +kindex(files, completion tag) item(tt(files))( -used by completion functions that can complete some kind of filenames -and different types of matches +the generic file-matching tag used by functions completing filenames ) +kindex(fonts, completion tag) item(tt(fonts))( -used for X font names +for X font names +) +kindex(fstypes, completion tag) +item(tt(fstypes))( +for file system types (e.g. for the tt(mount) command) ) +kindex(functions, completion tag) item(tt(functions))( -names of functions (shell functions or other kinds of functions for -some commands) +names of functions DASH()- normally shell functions, although certain +commands may understand other kinds of function ) +kindex(globbed-files, completion tag) item(tt(globbed-files))( -for names of files matching the glob pattern used by completion -functions that expect a certain type of file +for filenames when the name has been generated by pattern matching ) +kindex(groups, completion tag) item(tt(groups))( -used when completing names of user groups +for names of user groups ) +kindex(history-words, completion tag) item(tt(history-words))( for words from the history ) +kindex(hosts, completion tag) item(tt(hosts))( for hostnames ) +kindex(indexes, completion tag) item(tt(indexes))( -used for array indexes +for array indexes ) +kindex(jobs, completion tag) item(tt(jobs))( -used for jobs +for jobs (as listed by the `tt(jobs)' builtin) ) +kindex(interfaces, completion tag) +item(tt(interfaces))( +for network interfaces +) +kindex(keymaps, completion tag) item(tt(keymaps))( for names of zsh keymaps ) +kindex(keysyms, completion tag) item(tt(keysyms))( for names of X keysyms ) -item(tt(local-directories))( -for names of directories in the current working directory when -completing for the tt(cd) builtin command -) +kindex(libraries, completion tag) item(tt(libraries))( for names of system libraries ) +kindex(limits, completion tag) item(tt(limits))( for system limits ) +kindex(local-directories, completion tag) +item(tt(local-directories))( +for names of directories that are subdirectories of the current working +directory when completing arguments of tt(cd) and related builtin +commands (compare tt(path-directories)) +) +kindex(manuals, completion tag) item(tt(manuals))( for names of manual pages ) +kindex(mailboxes, completion tag) +item(tt(mailboxes))( +for e-mail folders +) +kindex(maps, completion tag) item(tt(maps))( -for map names (e.g. YP maps) +for map names (e.g. NIS maps) ) +kindex(messages, completion tag) item(tt(messages))( used to look up the tt(format) style for messages ) +kindex(modifiers, completion tag) item(tt(modifiers))( for names of X modifiers ) +kindex(modules, completion tag) item(tt(modules))( for modules (e.g. tt(zsh) modules) ) +kindex(my-accounts, completion tag) item(tt(my-accounts))( used to look up the tt(users-hosts) style ) +kindex(named-directories, completion tag) item(tt(named-directories))( for named directories (you wouldn't have guessed that, would you?) ) +kindex(names, completion tag) item(tt(names))( for all kinds of names ) +kindex(newsgroups, completion tag) +item(tt(newsgroups))( +for USENET groups +) +kindex(nicknames, completion tag) item(tt(nicknames))( -for nicknames of YP maps +for nicknames of NIS maps ) +kindex(options, completion tag) item(tt(options))( for command options ) +kindex(original, completion tag) item(tt(original))( used by the tt(_approximate), tt(_correct) and tt(_expand) completers when -adding the original string +offering the original string as a match ) +kindex(other-accounts, completion tag) item(tt(other-accounts))( used to look up the tt(users-hosts) style ) +kindex(packages, completion tag) item(tt(packages))( for packages (e.g. tt(rpm) or installed tt(Debian) packages) ) +kindex(parameters, completion tag) item(tt(parameters))( for names of parameters ) +kindex(path-directories, completion tag) item(tt(path-directories))( -for names of directories in directories from the tt(cdpath) array when -completing for the tt(cd) builtin command +for names of directories found by searching the tt(cdpath) array when +completing arguments of tt(cd) and related builtin commands (compare +tt(local-directories)) ) +kindex(paths, completion tag) item(tt(paths))( -used to look up the values of the tt(expand), tt(cursor) and +used to look up the values of the tt(expand), tt(ambiguous) and tt(special-dirs) styles ) -item(tt(pids))( -for process identifiers -) -item(tt(pids-list))( -used to look up the tt(command) style when generating the list to -display for process identifiers -) +kindex(pods, completion tag) item(tt(pods))( -for perl pods +for perl pods (documentation files) ) +kindex(ports, completion tag) item(tt(ports))( for communication ports ) +kindex(prefixes, completion tag) item(tt(prefixes))( -for prefixes (like those of an URL) +for prefixes (like those of a URL) ) +kindex(printers, completion tag) item(tt(printers))( -for printer names +for print queue names ) +kindex(processes, completion tag) item(tt(processes))( for process identifiers ) +kindex(processes-names, completion tag) +item(tt(processes-names))( +used to look up the tt(command) style when generating the names of +processes for tt(killall) +) +kindex(sequences, completion tag) item(tt(sequences))( for sequences (e.g. tt(mh) sequences) ) +kindex(sessions, completion tag) item(tt(sessions))( for sessions in the tt(zftp) function suite ) +kindex(signals, completion tag) item(tt(signals))( for signal names ) +kindex(strings, completion tag) item(tt(strings))( for strings (e.g. the replacement strings for the tt(cd) builtin command) ) +kindex(styles, completion tag) +item(tt(styles))( +for styles used by the zstyle builtin command +) +kindex(suffixes, completion tag) +item(tt(suffixes))( +for filename extensions +) +kindex(tags, completion tag) item(tt(tags))( for tags (e.g. tt(rpm) tags) ) +kindex(targets, completion tag) item(tt(targets))( for makefile targets ) +kindex(time-zones, completion tag) +item(tt(time-zones))( +for time zones (e.g. when setting the tt(TZ) parameter) +) +kindex(types, completion tag) item(tt(types))( -for types of whatever (e.g. adress types for the tt(xhost) command) +for types of whatever (e.g. address types for the tt(xhost) command) ) +kindex(urls, completion tag) item(tt(urls))( -used to look up the tt(path) and tt(local) styles when completing URLs +used to look up the tt(urls) and tt(local) styles when completing URLs ) +kindex(users, completion tag) item(tt(users))( for usernames ) +kindex(values, completion tag) item(tt(values))( -when completing a value out of a set of values (or a list of such -values) +for one of a set of values in certain lists +) +kindex(variant, completion tag) +item(tt(variant))( +used by tt(_pick_variant) to look up the command to run when determining +what program is installed for a particular command name. ) +kindex(visuals, completion tag) +item(tt(visuals))( +for X visuals +) +kindex(warnings, completion tag) item(tt(warnings))( used to look up the tt(format) style for warnings ) +kindex(widgets, completion tag) item(tt(widgets))( for zsh widget names ) +kindex(windows, completion tag) item(tt(windows))( for IDs of X windows ) +kindex(zsh-options, completion tag) item(tt(zsh-options))( for shell options ) @@ -658,255 +985,444 @@ enditem() subsect(Standard Styles) cindex(completion system, styles) -Here are the names of the styles used by the completion system. Note -that the values of several of these styles represent boolean -values. In all these cases any of the strings `tt(true)', `tt(on)', -`tt(yes)', and `tt(1)' can be used for the truth value `true' and -the strings `tt(false)', `tt(off)', `tt(no)', and `tt(0)' are -interpreted as `false'. The behavior for any other value is undefined -unless the description for the particular style mentions other -possible values. +Note that the values of several of these styles represent boolean +values. Any of the strings `tt(true)', `tt(on)', +`tt(yes)', and `tt(1)' can be used for the value `true' and +any of the strings `tt(false)', `tt(off)', `tt(no)', and `tt(0)' for +the value `false'. The behavior for any other value is undefined +except where explicitly mentioned. The default value may +be either true or false if the style is not set. + +Some of these styles are tested first for every possible tag +corresponding to a type of match, and if no style was found, for the +tt(default) tag. The most notable styles of this type are tt(menu), +tt(list-colors) and styles controlling completion listing such as +tt(list-packed) and tt(last-prompt)). When tested for the tt(default) +tag, only the var(function) field of the context will be set so that +a style using the default tag will normally be defined along the lines of: + +example(zstyle ':completion:*:default' menu ...) startitem() +kindex(accept-exact, completion style) item(tt(accept-exact))( -This is tested for the default tag and the tags used when generating -matches. If it is set to `true' for at least one match which is the -same as the string on the line, this match will immediately be -accepted. -) +This is tested for the default tag in addition to the tags valid for +the current context. If it is set to `true' and any of the trial +matches is the same as the string on the command line, this match will +immediately be accepted (even if it would otherwise be considered +ambiguous). + +When completing pathnames (where the tag used is `tt(paths)') +this style accepts any number of patterns as the value in addition to +the boolean values. Pathnames matching one of these +patterns will be accepted immediately even if the command line contains +some more partially typed pathname components and these match no file +under the directory accepted. + +This style is also used by the tt(_expand) completer to decide if +words beginning with a tilde or parameter expansion should be +expanded. For example, if there are parameters +tt(foo) and tt(foobar), the string `tt($foo)' will only be expanded if +tt(accept-exact) is set to `true'; otherwise the completion system will +be allowed to complete tt($foo) to tt($foobar). If the style is set to +`continue', _expand will add the expansion as a match and the completion +system will also be allowed to continue. +) +kindex(add-space, completion style) item(tt(add-space))( -This style is used by the tt(_prefix) completer to decide if a space -should be inserted before the suffix. -) +This style is used by the tt(_expand) completer. If it is true (the +default), a space will be inserted after all words resulting from the +expansion, or a slash in the case of directory names. If the value +is `tt(file)', the completer will only add a space +to names of existing files. Either a boolean true or the value +`tt(file)' may be combined with `tt(subst)', in which case the completer +will not add a space to words generated from the expansion of a +substitution of the form `tt($LPAR()...RPAR())' or `tt(${...})'. + +The tt(_prefix) completer uses this style as a simple boolean value +to decide if a space should be inserted before the suffix. +) +kindex(ambiguous, completion style) +item(tt(ambiguous))( +This applies when completing non-final components of filename paths, in +other words those with a trailing slash. If it is set, the cursor is +left after the first ambiguous component, even if menu completion is in +use. The style is always tested with the tt(paths) tag. +) +kindex(assign-list, completion style) +item(tt(assign-list))( +When completing after an equals sign that is being treated as an +assignment, the completion system normally completes only one filename. +In some cases the value may be a list of filenames separated by colons, +as with tt(PATH) and similar parameters. This style can be set to a +list of patterns matching the names of such parameters. + +The default is to complete lists when the word on the line already +contains a colon. +) +kindex(auto-description, completion style) item(tt(auto-description))( -If set, this style's value will be used as the description for options which +If set, this style's value will be used as the description for options that are not described by the completion functions, but that have exactly -one argument. The sequence `tt(%d)' in the value will be replaced by -the description for this argument. Depending on personal preferences, +one argument. The sequence `tt(%d)' in the value will be replaced by +the description for this argument. Depending on personal preferences, it may be useful to set this style to something like `tt(specify: %d)'. Note that this may not work for some commands. ) -item(tt(break))( -This style is used by the tt(incremental-complete-word) widget (found -in the tt(Functions/Zle) directory of the distribution). Its value -should be a pattern and all keys matching this pattern will cause the -widget to stop incremental completion without the key having any -further effect. -) +kindex(avoid-completer, completion style) +item(tt(avoid-completer))( +This is used by the tt(_all_matches) completer to decide if the string +consisting of all matches should be added to the list currently being +generated. Its value is a list of names of completers. If any of +these is the name of the completer that generated the matches in this +completion, the string will not be added. + +The default value for this style is `tt(_expand _old_list _correct +_approximate)', i.e. it contains the completers for which a string +with all matches will almost never be wanted. +) +kindex(cache-path, completion style) +item(tt(cache-path))( +This style defines the path where any cache files containing dumped +completion data are stored. It defaults to `tt($ZDOTDIR/.zcompcache)', or +`tt($HOME/.zcompcache)' if tt($ZDOTDIR) is not defined. The completion +cache will not be used unless the tt(use-cache) style is set. +) +kindex(cache-policy, completion style) +item(tt(cache-policy))( +This style defines the function that will be used to determine whether +a cache needs rebuilding. See the section on the tt(_cache_invalid) +function below. +) +kindex(call-command, completion style) +item(tt(call-command))( +This style is used in the function for commands such as tt(make) and +tt(ant) where calling the command directly to generate matches suffers +problems such as being slow or, as in the case of tt(make) can +potentially causes actions in the makefile to be executed. If it is set +to `true' the command is called to generate matches. The default value +of this style is `false'. +) +kindex(command, completion style) item(tt(command))( -This style can be used to override the defaults in several completion -functions for how commands are called to generate information about -possible matches. The strings in the value are joined with spaces -between them to build the command line to execute. If the value starts -with a hyphen the string built will be prepended to the default -supplied by the completion function. This allows one to easily stick a -tt(builtin) or tt(command) in front of the default in case one has, -for example, a shell function with the same name as the command -called, but for completion purposes one needs to ensure that the real -command is called. - -For example, the function generating process IDs as matches uses this -style with the tt(pids) tag to generate the IDs to complete and iwhen -the tt(verbose) style is `true', it uses this style with the -tt(pids-list) tag to generate the strings to display. When using -different values for these two tags one should ensure that the process -IDs appear in the same order in both lists. +In many places, completion functions need to call external commands to +generate the list of completions. This style can be used to override the +command that is called in some such cases. The elements of the value are +joined with spaces to form a command line to execute. The value can also +start with a hyphen, in which case the usual command will be added to the +end; this is most useful for putting `tt(builtin)' or `tt(command)' in +front to make sure the appropriate version of a command is called, for +example to avoid calling a shell function with the same name as an external +command. + +As an example, the completion function for process IDs uses this +style with the tt(processes) tag to generate the IDs to complete and +the list of processes to display (if the tt(verbose) style is `true'). +The list produced by the command should look like the output of the +tt(ps) command. The first line is not displayed, but is searched for +the string `tt(PID)' (or `tt(pid)') to find the position of the +process IDs in the following lines. If the line does not contain +`tt(PID)', the first numbers in each of the other lines are taken as the +process IDs to complete. + +Note that the completion function generally has to call the specified +command for each attempt to generate the completion list. Hence +care should be taken to specify only commands that take a short +time to run, and in particular to avoid any that may never terminate. +) +kindex(command-path, completion style) +item(tt(command-path))( +This is a list of directories to search for commands to complete. The +default for this style is the value of the special parameter tt(path). +) +kindex(commands, completion style) +item(tt(commands))( +This is used by the function completing sub-commands for the system +initialisation scripts (residing in tt(/etc/init.d) or somewhere not +too far away from that). Its values give the default commands to +complete for those commands for which the completion function isn't +able to find them out automatically. The default for this style are +the two strings `tt(start)' and `tt(stop)'. +) +kindex(complete, completion style) +item(tt(complete))( +This is used by the tt(_expand_alias) function when invoked as a +bindable command. If it set to `true' and the word on the command +line is not the name of an alias, matching alias names will be +completed. ) +kindex(completer, completion style) item(tt(completer))( -The strings given as the value of this style give the names of the +The strings given as the value of this style provide the names of the completer functions to use. The available completer functions are described in ifzman(the section `Control Functions' below)\ ifnzman(noderef(Control Functions))\ . -Note that the widget functions from the distribution that call the -completion code (namely, the tt(incremental-complete-word) and the -tt(predict-on) widgets) set up their top-level context name before -calling completion. This allows one to define different sets of -completer functions for normal completion and for these widgets. For -example, to use completion, approximation and correction for normal -completion, completion and correction for incremental completion and -only completion for prediction one could use: - -example(zstyle ':completion:*' completer _complete _correct _approximate -zstyle ':completion:incremental:*' completer _complete _correct -zstyle ':completion:predict:*' completer _complete) - -The default value for this style is tt(_complete), i.e. normally only -completion will be done. -) -item(tt(completions))( -This style is used by the tt(_expand) completer function. - -If this is set to an non-empty string it should be an expression -usable inside a `tt($((...)))' arithmetical expression. The completer -function evaluates this expression and if the result is `tt(1)', no -expansions will be generated, but instead the completions will be -generated as normal and all of them will be inserted into the command -line. -) +Each string may be either the name of a completer function or a string +of the form `var(function)tt(:)var(name)'. In the first case the +var(completer) field of the context will contain the name of the +completer without the leading underscore and with all other +underscores replaced by hyphens. In the second case the +var(function) is the name of the completer to call, but the context +will contain the user-defined var(name) in the var(completer) field of +the context. If the var(name) starts with a hyphen, the string for the +context will be build from the name of the completer function as in +the first case with the var(name) appended to it. For example: + +example(zstyle ':completion:*' completer _complete _complete:-foo) + +Here, completion will call the tt(_complete) completer twice, once +using `tt(complete)' and once using `tt(complete-foo)' in the +var(completer) field of the context. Normally, using the same +completer more than once only makes sense when used with the +`var(functions)tt(:)var(name)' form, because otherwise the context +name will be the same in all calls to the completer; possible +exceptions to this rule are the tt(_ignored) and tt(_prefix) +completers. + +The default value for this style is `tt(_complete _ignored)': +only completion will be done, first using the tt(ignored-patterns) style +and the tt($fignore) array and then without ignoring matches. +) +kindex(condition, completion style) item(tt(condition))( -This style is used by the tt(_list) completer function. - -If it is not set or set to the empty string, the insertion of -matches will be delayed unconditionally. If it is set, the value -should be an expression usable inside a `tt($((...)))' -arithmetical expression. In this case, delaying will be done if the -expression evaluates to `tt(1)'. For example, with - -example(zstyle ':completion:*:list:::' condition 'NUMERIC != 1') - -delaying will be done only if given an explicit numeric argument -other than `tt(1)'. -) -item(tt(cursor))( -This is used together with the tt(paths) tag by the function -generating filenames as matches to find out if the cursor should be left -after the first ambiguous pathname component even when menucompletion -is used. - -The tt(predict-on) widget uses this style to decide where to place the -cursor after completion has been tried. If it is set to tt(complete), -the cursor is left at the place where completion left it, but only if -it is after a character equal to the one just inserted by the user. If -it is after another character, the value is treated as if it where the -string tt(key). If the value is set to tt(key), the cursor is left -after the var(n)th occurrence of the character just inserted, where -var(n) is the number of times that character appeared in the word -before completion was attempted. In short, this has the effect of -leaving the cursor after the character just typed even if the -completion code found out that no other characters need to be inserted -at that position. Finally, any other value for this style -unconditionally leaves the cursor at the position where the completion -code left it. +This style is used by the tt(_list) completer function to decide if +insertion of matches should be delayed unconditionally. The default is +`true'. +) +kindex(disabled, completion style) +item(tt(disabled))( +If this is set to `true', the tt(_expand_alias) completer and bindable +command will try to expand disabled aliases, too. The default is +`tt(false)'. ) +kindex(disable-stat, completion style) item(tt(disable-stat))( -This is used with the an empty tag by the function completing for the -tt(cvs) command to decide if the tt(zsh/stat) module should be used to -generate only names of modified files in the appropriate places. +This is used with an empty tag by the tt(_cvs) function +to decide whether the tt(zsh/stat) module should be used to +generate names of modified files in the appropriate places (this is its +only use). If the style is set, completion will use the tt(ls) command. ) +kindex(domains, completion style) item(tt(domains))( -If set, gives the names of network domains that should be -completed. If this is not set by the user domain names mentioned in -tt(/etc/resolv.conf) will be used. +A list of names of network domains for completion. +If this is not set, domain names will be taken from +the file tt(/etc/resolv.conf). ) +kindex(expand, completion style) item(tt(expand))( This style is used when completing strings consisting of multiple -parts, such as path names. If its -value contains the string tt(prefix), the partially typed word from -the line will be expanded as far as possible even if trailing parts -can not be completed. If it contains the string tt(suffix) -and normal (non-menu-) completion is used, matching names for -components after the first ambiguous one will be added, too. This -means that the resulting string is the longest unambiguous string -possible, but if menucompletion is started on the list of matches -generated this way (e.g. due to the option tt(AUTO_MENU) being set), -this will also cycle through the names of the files in pathname -components after the first ambiguous one. -) +parts, such as path names. + +If one of its values is the string `tt(prefix)', the partially typed +word from the line will be expanded as far as possible even if trailing +parts cannot be completed. + +If one of its values is the string `tt(suffix)', matching names for +components after the first ambiguous one will also be added. This means +that the resulting string is the longest unambiguous string possible. +However, menu completion can be used to cycle through all matches. +) +kindex(fake, completion style) +item(tt(fake))( +This style may be set for any completion context. It +specifies additional strings that will always be completed in that +context. The form of each string is `var(value)tt(:)var(description)'; +the colon and description may be omitted, but any literal colons in +var(value) must be quoted with a backslash. Any var(description) +provided is shown alongside the value in completion listings. + +It is important to use a sufficiently restrictive context when specifying +fake strings. Note that the styles tt(fake-files) and tt(fake-parameters) +provide additional features when completing files or parameters. +) +kindex(fake-files, completion style) +item(tt(fake-files))( +This style is used when completing files and looked up +without a tag. Its values are of the form +`var(dir)tt(:)var(names...)'. This will add the var(names) (strings +separated by spaces) as +possible matches when completing in the directory var(dir), even if no +such files really exist. + +This can be useful on systems that support special filesystems whose +top-level pathnames can not be listed or generated with glob patterns. +It can also be used for directories for which one does not have read +permission. +) +kindex(fake-parameters, completion style) +item(tt(fake-parameters))( +This is used by the completion function for parameter names. +Its values are names of parameters that might not yet be +set but should be completed nonetheless. Each name may also be +followed by a colon and a string specifying the type of the parameter +(like `tt(scalar)', `tt(array)' or `tt(integer)'). If the type is +given, the name will only be completed if parameters of that type are +required in the particular context. Names for which no type is +specified will always be completed. +) +kindex(file-patterns, completion style) item(tt(file-patterns))( -In most places where filenames are completed, the function tt(_files) -is used which can be configured with this style. If the style is -unset, tt(_files) offers up to three tags: tt(globbed-files), -tt(directories) and tt(all-files), depending on the types of files -expected by the caller of tt(_files). Using the tt(tag-order) style -described below it is possible to specify when which type of files -should be tried. - -If the tt(file-patterns) style is set, the default tags are not -used. Instead, the value of the style says which tags and which -patterns are to be offered. The strings in the value are of the form -`var(patterns)tt(:)var(tag)'. The var(patterns) gives one or more glob -patterns separated by spaces that are to be used to generate -filenames. If it is the empty string, i.e. the string starts with a -colon, then the glob patterns supplied by the completion function will -be used. Colons in the pattern have to be preceded by a backslash to -make them distinguishable from the colon before the var(tag). The -var(tag)s of all strings in the value will be offered by tt(_files) -and used when looking up other styles. The var(tag) may also be -followed by an optional second colon and a description. If that is -given, this description will be used for the `tt(%d)' in the value of +This is used by the standard function for completing filenames, +tt(_files). If the style is unset up to three tags are offered, +`tt(globbed-files)',`tt(directories)' and `tt(all-files)', depending on +the types of files expected by the caller of tt(_files). The first two +(`tt(globbed-files)' and `tt(directories)') are normally offered +together to make it easier to complete files in sub-directories. + +The tt(file-patterns) style provides alternatives to the default tags, +which are not used. Its value consists of elements of the form +`var(pattern)tt(:)var(tag)'; each string may contain any number of +such specifications separated by spaces. + +The var(pattern) is a pattern that is to be used to generate filenames. +Any occurrence of the sequence `tt(%p)' is replaced by any pattern(s) +passed by the function calling tt(_files). Colons in the pattern must +be preceded by a backslash to make them distinguishable from the colon +before the var(tag). If more than one pattern is needed, the patterns +can be given inside braces, separated by commas. + +The var(tag)s of all strings in the value will be offered by tt(_files) +and used when looking up other styles. Any var(tag)s in the same +word will be offered at the same time and before later words. +If no `tt(:)var(tag)' is given the `tt(files)' tag will be used. + +The var(tag) may also be followed by an optional second colon and a +description, which will be used for the `tt(%d)' in the value of the tt(format) style (if that is set) instead of the default -description supplied by the completion function. If the description +description supplied by the completion function. If the description given here contains itself a `tt(%d)', that is replaced with the description supplied by the completion function. For example, to make the tt(rm) command first complete only names of -object files and the names of all files if no object file matches -the string on the line, one would do: - -example(zstyle ':completion:*:*:rm:*' file-patterns \ - '*.o:object-files' ':all-files') - -Note also that during the execution of completion functions, the -tt(EXTENDED_GLOB) option is in effect, so the characters `tt(#)', -`tt(~)' and `tt(^)' have special meanings in the patterns. -) +object files and then the names of all files if there is no matching +object file: + +example(zstyle ':completion:*:*:rm:*' file-patterns \ + '*.o:object-files' '%p:all-files') + +To alter the default behaviour of file completion DASH()- offer files +matching a pattern and directories on the first attempt, then all files +DASH()- to offer only matching files on the first attempt, then directories, +and finally all files: + +example(zstyle ':completion:*' file-patterns \ + '%p:globbed-files' '*(-/):directories' '*:all-files') + +This works even where there is no special pattern: tt(_files) matches +all files using the pattern `tt(*)' at the first step and stops when it +sees this pattern. Note also it will never try a pattern more than once +for a single completion attempt. + +During the execution of completion functions, the tt(EXTENDED_GLOB) +option is in effect, so the characters `tt(#)', `tt(~)' and `tt(^)' have +special meanings in the patterns. +) +kindex(file-sort, completion style) +item(tt(file-sort))( +The standard filename completion function uses this style without a tag +to determine in which order the names should be listed; menu completion +will cycle through them in the same order. The possible +values are: `tt(size)' to sort by the size of the file; +`tt(links)' to sort by the number of links to the file; +`tt(modification)' (or `tt(time)' or `tt(date)') to sort by the last +modification time; `tt(access)' to sort by the last access time; and +`tt(inode)' (or `tt(change)') to sort by the last inode change +time. If the style is set to any other value, or is unset, files will be +sorted alphabetically by name. If the value contains the string +`tt(reverse)', sorting is done in the opposite order. +) +kindex(filter, completion style) +item(tt(filter))( +This is used by the LDAP plugin for e-mail address completion to specify +the attributes to match against when filtering entries. So for example, if +the style is set to `tt(sn)', matching is done against surnames. Standard +LDAP filtering is used so normal completion matching is bypassed. If this +style is not set, the LDAP plugin is skipped. You may also need to set the +tt(command) style to specify how to connect to your LDAP server. +) +kindex(force-list, completion style) +item(tt(force-list))( +This forces a list of completions to be shown at any point where listing is +done, even in cases where the list would usually be suppressed. +For example, normally the list is only shown if +there are at least two different matches. By setting this style to +`tt(always)', the list will always be shown, even if there is only a +single match that will immediately be accepted. The style may also +be set to a number. In this case the list will be shown if there are +at least that many matches, even if they would all insert the same +string. + +This style is tested for the default tag as well as for each tag valid +for the current completion. Hence the listing can be forced only for +certain types of match. +) +kindex(format, completion style) item(tt(format))( If this is set for the tt(descriptions) tag, its value is used as a -string to display above matches in completion lists. The sequence +string to display above matches in completion lists. The sequence `tt(%d)' in this string will be replaced with a short description of -what these matches are. This string may also contain the sequences to -specify output attributes, such as `tt(%b)' and `tt(%s)'. +what these matches are. This string may also contain the sequences to +specify output attributes, such as `tt(%B)', `tt(%S)' and +`tt(%{)...tt(%})'. -For the same purpose, this style is also tested with the tags used -when matches are generated before it is tested for the -tt(descriptions) tag. This gives the possibility to define different -format strings for different types of matches. +The style is tested with each tag valid for the current completion +before it is tested for the tt(descriptions) tag. Hence different format +strings can be defined for different types of match. Note also that some completer functions define additional -`tt(%)'-sequences. These are described for the completer functions that +`tt(%)'-sequences. These are described for the completer functions that make use of them. -For the tt(messages) tag, this defines a string used by some -completion functions to display messages. Here, the `tt(%d)' is -replaced with the message given by the completion function. - -Finally, for the tt(warnings) tag, it is printed when no matches could -be generated at all. In this case the `tt(%d)' is replaced with the -descriptions for the matches that were expected. If the value does not -contain a `tt(%d)', then those descriptions are added in the same way -as matches are added, i.e. they appear below the value for the -tt(format) style laid out in columns. The descriptions are added as if -for the tag tt(warnings) so that you can use the tt(list-colors) style -for that tag to highlight them. - -Here and in all other cases where the completion system uses `tt(%)' -sequences, the `tt(%)' may be followed by field width specifications as -described for the tt(zformat) builtin command from the tt(zutil) -module, see +Some completion functions display messages that may be customised by +setting this style for the tt(messages) tag. Here, the `tt(%d)' is +replaced with a message given by the completion function. + +Finally, the format string is looked up with the tt(warnings) tag, +for use when no matches could be generated at all. In this case the +`tt(%d)' is replaced with the descriptions for the matches that were +expected separated by spaces. The sequence `tt(%D)' is replaced with +the same descriptions separated by newlines. + +It is possible to use printf-style field width specifiers with `tt(%d)' +and similar escape sequences. This is handled by the tt(zformat) +builtin command from the tt(zsh/zutil) module, see ifzman(zmanref(zshmodules))\ ifnzman(noderef(The zsh/zutil Module))\ . ) +kindex(glob, completion style) item(tt(glob))( -Like tt(completions), this is used by the tt(_expand) completer. - -The value is used like the one for tt(completions) and if it evaluates to -`tt(1)', globbing will be attempted on the words resulting from -substitution (see the tt(substitute) style) or the original string -from the line. +This is used by the tt(_expand) completer. If +it is set to `true' (the default), globbing will be attempted on the +words resulting from a previous substitution (see the tt(substitute) +style) or else the original string from the line. ) +kindex(global, completion style) +item(tt(global))( +If this is set to `true' (the default), the tt(_expand_alias) +completer and bindable command will try to expand global aliases. +) +kindex(group-name, completion style) item(tt(group-name))( -The completion system can put different types of matches in different -groups which are then displayed separately in the list of possible -completions. This style can be use to give the names for these groups -for particular tags. For example, in command position the completion +The completion system can group different types of matches, which appear +in separate lists. This style can be used to give the names of groups +for particular tags. For example, in command position the completion system generates names of builtin and external commands, names of -aliases and shell functions and reserved words as possible -completions. To have the external commands and shell functions listed -separately, one can set: +aliases, shell functions and parameters and reserved words as possible +completions. To have the external commands and shell functions listed +separately: example(zstyle ':completion:*:*:-command-:*:commands' group-name commands zstyle ':completion:*:*:-command-:*:functions' group-name functions) -This also means that if the same name is used for different types of -matches, then those matches will be displayed together in the same -group. +As a consequence, any match with the same tag will be displayed in the +same group. -If the name given is the empty string, then the name of the tag for -the matches will be used as the name of the group. So, to have all +If the name given is the empty string the name of the tag for +the matches will be used as the name of the group. So, to have all different types of matches displayed separately, one can just set: example(zstyle ':completion:*' group-name '') @@ -914,247 +1430,426 @@ example(zstyle ':completion:*' group-name '') All matches for which no group name is defined will be put in a group named tt(-default-). ) +kindex(group-order, completion style) item(tt(group-order))( -This style is to be used together with the tt(group-name) style. Once -different types of matches are put into different groups, this style -can be used to define in which order these groups should appear in the -list. The strings in the value are taken as group names and the named -groups will be shown in the order in which their names appear in the -value. All groups whose names are not given in the value of this style -will appear in the order defined by the function generating the -matches. +This style is additional to the tt(group-name) style to specify the +order for display of the groups defined by that style (compare tt(tag-order), +which determines which completions appear at all). The groups named +are shown in the given order; any other groups +are shown in the order defined by the completion function. For example, to have names of builtin commands, shell functions and -external commands appear in this order when completing in command -position one would set: +external commands appear in that order when completing in command +position: -example(zstyle ':completion:*:*:-command-:*' group-order builtins functions commands) +example(zstyle ':completion:*:*:-command-:*' group-order \ + builtins functions commands) ) +kindex(groups, completion style) item(tt(groups))( -A style holding the names of the groups that should be completed. If -this is not set by the user, the group names from the YP database or -the file `tt(/etc/group)' will be used. +A list of names of UNIX groups. If this is not set, +group names are taken from the YP database or the file `tt(/etc/group)'. ) +kindex(hidden, completion style) item(tt(hidden))( -If this is set to one of the `true' values, the matches for the tags -for which this is set will not appear in the list; only the -description for the matches as set with the tt(format) style will be -shown. If this is set to tt(all), not even the description will be +If this is set to true, matches for the given context +will not be listed, although +any description for the matches set with the tt(format) style will be +shown. If it is set to `tt(all)', not even the description will be displayed. -Note that the matches will still be completed, they are just not shown -in the list. To avoid having matches considered as possible -completions at all the tt(tag-order) style can be modified as described +Note that the matches will still be completed; they are just not shown +in the list. To avoid having matches considered as possible +completions at all, the tt(tag-order) style can be modified as described below. ) +kindex(hosts, completion style) item(tt(hosts))( -A style holding the names of hosts that should be completed. If this -is not set by the user the hostnames in `tt(/etc/hosts)' will be used. +A list of names of hosts that should be completed. If this is not set, +hostnames are taken from the file `tt(/etc/hosts)'. ) +kindex(hosts-ports, completion style) item(tt(hosts-ports))( This style is used by commands that need or accept hostnames and -ports. The strings in the value should be of the form -`var(host)tt(:)var(port)'. These hostnames and ports are completed -depending on the information already on the line, so that if, for -example, the hostname is already typed, only those ports will be -completed for which pairs with the hostname from the line exist. -) +network ports. The strings in the value should be of the form +`var(host)tt(:)var(port)'. Valid ports are determined by the presence +of hostnames; multiple ports for the same host may appear. +) +kindex(ignore-line, completion style) +item(tt(ignore-line))( +This is tested for each tag valid for the current completion. If +it is set to `tt(true)', none of the words that are already on the line +will be considered as possible completions. If it is set to +`tt(current)', the word the cursor is on will not be considered as a +possible completion. The value `tt(current-shown)' is similar but only +applies if the list of completions is currently shown on the screen. +Finally, if the style is set to `tt(other)', no word apart from the +current one will be considered as a possible completion. + +The values `tt(current)' and `tt(current-shown)' are a bit like the +opposite of the tt(accept-exact) style: only strings with +missing characters will be completed. + +Note that you almost certainly don't want to set this to `true' or +`tt(other)' for a general +context such as `tt(:completion:*)'. This is because it would disallow +completion of, for example, options multiple times even if the command +in question accepts the option more than once. +) +kindex(ignore-parents, completion style) item(tt(ignore-parents))( -When completing files it is possible to make names of directories -already mentioned on the line or the current working directory be -ignored. The style is tested for the tt(files) tag and if its value -contains the string tt(parent), then the name of any directory whose -path is already contained in the word on the line is ignored. For -example, when completing after tt(foo/../), the directory tt(foo) will -not be considered a valid completion. - -If the style contains the string tt(pwd), then the name of the current -working directory will not be completed, so that, for example, -completion after tt(../) will not use the name of the current +The style is tested without a tag by the function completing pathnames +in order to determine whether to ignore +the names of directories already mentioned in the current word, or the +name of the current working directory. The value must include one or both +of the following strings: + +startitem() +item(tt(parent))( +The name of any directory whose path is already contained in the word on +the line is ignored. For example, when completing after tt(foo/../), the +directory tt(foo) will not be considered a valid completion. +) +item(tt(pwd))( +The name of the current working directory will not be completed; hence, +for example, completion after tt(../) will not use the name of the current directory. +) +enditem() -If the style contains the string tt(..) both tests will only be -performed if the word on the line contains the substring tt(../) and -if the value contains the string tt(directory), then the tests will -only be performed if only names of directories are completed. +In addition, the value may include one or both of: -Note that names of directories ignored because of one of the tests -will be placed in the alternate set of completions so that they will -be completed if there are no other possible completions. +startitem() +item(tt(..))( +Ignore the specified directories only when the word on the line contains +the substring `tt(../)'. ) -item(tt(ignored-patterns))( -This style is used with the tags used when adding matches and defines a -couple of patterns. All matches that are matched by any of these -patterns will be ignored as long as there are other matches not -matched by any of the patterns. It is a more configurable version -of the shell parameter tt($fignore). +item(tt(directory))( +Ignore the specified directories only when names of directories are +completed, not when completing names of files. +) +enditem() -Note that during the execution of completion functions, the -tt(EXTENDED_GLOB) option is in effect, so the characters `tt(#)', -`tt(~)' and `tt(^)' have special meanings in the patterns. +Excluded values act in a similar fashion to values of the +tt(ignored-patterns) style, so they can be restored to consideration by +the tt(_ignored) completer. ) +kindex(ignored-patterns, completion style) +item(tt(ignored-patterns))( +A list of patterns; any trial completion matching one of the patterns +will be excluded from consideration. The +tt(_ignored) completer can appear in the list of completers to +restore the ignored matches. This is a more configurable +version of the shell parameter tt($fignore). + +Note that the +tt(EXTENDED_GLOB) option is set during the execution of completion +functions, so the characters `tt(#)', `tt(~)' and `tt(^)' have special +meanings in the patterns. +) +kindex(insert, completion style) +item(tt(insert))( +This style is used by the tt(_all_matches) completer to decide whether to +insert the list of all matches unconditionally instead of adding the +list as another match. +) +kindex(insert-ids, completion style) +item(tt(insert-ids))( +When completing process IDs, for example as arguments to the tt(kill) and +tt(wait) builtins the name of a +command may be converted to the appropriate process ID. A problem +arises when the process name typed is not unique. By default (or if this +style is set explicitly to `tt(menu)') the name will be converted +immediately to a set of possible IDs, and menu completion will be started +to cycle through them. + +If the value of the style is `tt(single)', +the shell will wait until the user has typed enough to make the command +unique before converting the name to an ID; attempts at completion will +be unsuccessful until that point. If the value is any other +string, menu completion will be started when the string typed by the +user is longer than the common prefix to the corresponding IDs. +) +kindex(insert-tab, completion style) +item(tt(insert-tab))( +If this is set to `true', the completion system will +insert a TAB character (assuming that was used to start completion) instead +of performing completion when there is no non-blank character to the left +of the cursor. If it is set to `false', completion will be done even there. + +The value may also contain the substrings `tt(pending)' or +`tt(pending=)var(val)'. In this case, the typed character will be +inserted instead of staring completion when there is unprocessed input +pending. If a var(val) is given, completion will not be done if there +are at least that many characters of unprocessed input. This is often +useful when pasting characters into a terminal. Note +however, that it relies on the tt($PENDING) special parameter from the +tt(zsh/zle) module being set properly which is not guaranteed on all +platforms. + +The default value of this style is `true' except for completion within +tt(vared) builtin command where it is `false'. +) +kindex(insert-unambiguous, completion style) item(tt(insert-unambiguous))( -This is used by the tt(_match) and tt(_approximate) completer -functions. If it is set to `true', the completer will start menu -completion only if no unambiguous string could be generated that is at -least as long as the original string from the line. Note that the -tt(_approximate) completer uses it after setting the completer field -in the context name to one of tt(correct-)var(num) or -tt(approximate-)var(num), where var(num) is the number of errors that -were accepted. -) +This is used by the tt(_match) and tt(_approximate) completers. +These completers are often used with menu completion since the word typed +may bear little resemblance to the final completion. +However, if this style is `true', the completer will start menu +completion only if it could find no unambiguous initial string at +least as long as the original string typed by the user. + +In the case of the tt(_approximate) completer, the completer +field in the context will already have been set to one of +tt(correct-)var(num) or tt(approximate-)var(num), where var(num) is the +number of errors that were accepted. + +In the case of the tt(_match) completer, the style may also be set to +the string `tt(pattern)'. Then the pattern on the line is left +unchanged if it does not match unambiguously. +) +kindex(keep-prefix, completion style) +item(tt(keep-prefix))( +This style is used by the tt(_expand) completer. If it is `true', the +completer will try to keep a prefix containing a tilde or parameter +expansion. Hence, for example, the string `tt(~/f*)' would be expanded to +`tt(~/foo)' instead of `tt(/home/user/foo)'. If the style is set to +`tt(changed)' (the default), the prefix will only be left unchanged if +there were other changes between the expanded words and the original +word from the command line. Any other value forces the prefix to be +expanded unconditionally. + +The behaviour of expand when this style is true is to cause tt(_expand) +to give up when a single expansion with the restored prefix is the same +as the original; hence any remaining completers may be called. +) +kindex(last-prompt, completion style) item(tt(last-prompt))( -This is used to determine if the completion code should try to put the -cursor back onto the previous command line after showing a completion -listing (as for the tt(ALWAYS_LAST_PROMPT) option). Like several other -styles it is tested for the tt(default) tag and all tags used when -generating matches. The cursor will be moved back to the previous line -if this style is `true' for all types of matches added. Note also that -this is independent of the numeric argument -- unlike the -tt(ALWAYS_LAST_PROMPT) option. -) +This is a more flexible form of the tt(ALWAYS_LAST_PROMPT) option. +If it is true, the completion system will try to return the cursor to +the previous command line after displaying a completion list. It is +tested for all tags valid for the current completion, then the +tt(default) tag. The cursor will be moved back to the +previous line if this style is `true' for all types of match. Note +that unlike the tt(ALWAYS_LAST_PROMPT) option this is independent of the +numeric prefix argument. +) +kindex(list, completion style) item(tt(list))( -This is used by the tt(_history_complete_word) bindable command -(context `tt(:completion:history-words)') and by the -tt(incremental-complete-word) widget (context `tt(:completion:incremental)). - -The tt(_history_complete_word) bindable command uses this style to -decide if the available matches should be shown. - -When using the tt(incremental-complete-word) widget, this style says -if the matches should be listed on every key press (if they fit on the -screen). - -The tt(predict-on) widget uses this style to decide if the completion -should be shown even if there is only one possible completion. This is -done if the value of this style is the string tt(always). +This style is used by the tt(_history_complete_word) bindable command. +If it is set to `true' it has no effect. If it is set to `false' +matches will not be listed. This overrides the setting of the options +controlling listing behaviour, in particular tt(AUTO_LIST). The context +always starts with `tt(:completion:history-words)'. ) +kindex(list-colors, completion style) item(tt(list-colors))( -If the tt(zsh/complist) module is used, this style can be used to set -color specifications as with the tt(ZLS_COLORS) and tt(ZLS_COLOURS) -parameters (see +If the tt(zsh/complist) module is loaded, this style can be used to set +color specifications. This mechanism replaces the use of the +tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters described in ifzman(the section `The zsh/complist Module' in zmanref(zshmodules))\ ifnzman(noderef(The zsh/complist Module))\ -). +, but the syntax is the same. If this style is set for the tt(default) tag, the strings in the value -are taken as specifications that are to be used everywhere. If it is +are taken as specifications that are to be used everywhere. If it is set for other tags, the specifications are used only for matches of -the type described by the tag. For this to work, the tt(group-name) -style has to be set to an empty string. If the tt(group-name) tag -specifies other names for the groups the matches in these groups can -be colored by using these names together with the `tt((group)...)' -syntax described for the tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters -and adding the specifications to the value for this style with the -tt(default) tag. +the type described by the tag. For this to work best, the tt(group-name) +style must be set to an empty string. + +In addition to setting styles for specific tags, it is also possible to +use group names specified explicitly by the tt(group-name) tag together +with the `tt((group))' syntax allowed by the tt(ZLS_COLORS) and +tt(ZLS_COLOURS) parameters and simply using the tt(default) tag. -To be able to share the same specifications one has set up for the GNU -version of the tt(ls) command one can use: +It is possible to use any color specifications already set up for the GNU +version of the tt(ls) command: example(zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}) -And to get the default colors (which are the same as for the GNU -tt(ls) command) one should set the style to an empty value. +The default colors are the same as for the GNU tt(ls) command and can be +obtained by setting the style to an empty string (i.e. tt('')). ) -item(tt(list-packed))( -Like the tt(list-colors) style, this is tested with the tt(default) -tag and all tags used when generating matches. If it is set to `true' -for a tag, the matches added for it will be listed as if the -tt(LIST_PACKED) option were set for them. If it is set to `false', -they are listed normally. +kindex(list-grouped, completion style) +item(tt(list-grouped))( +If this style is `true' (the default), the completion system will try to +make certain completion listings more compact by grouping matches. +For example, options for commands that have the same description (shown +when the tt(verbose) style is set to `true') will appear as a single +entry. However, menu selection can be used to cycle through all the +matches. ) +kindex(list-packed, completion style) +item(tt(list-packed))( +This is tested for each tag valid in the current context as well as the +tt(default) tag. If it is set to `true', the corresponding matches +appear in listings as if the tt(LIST_PACKED) option were set. If it is +set to `false', they are listed normally. +) +kindex(list-prompt, completion style) +item(tt(list-prompt))( +If this style is set for the tt(default) tag, +completion lists that don't fit on the screen can be scrolled (see +ifzman(the description of the tt(zsh/complist) module in zmanref(zshmodules))\ +ifnzman(noderef(The zsh/complist Module))\ +). The value, if not the empty string, will be displayed after every +screenful and the shell will prompt for a key press; if the style is +set to the empty string, +a default prompt will be used. + +The value may contain the escape sequences: +`tt(%l)' or `tt(%L)', which will be replaced by the number of the last line +displayed and the total number of lines; `tt(%m)' or `tt(%M)', +the number of the last match shown and the total number of +matches; and `tt(%p)' and `tt(%P)', `tt(Top)' +when at the beginning of the list, `tt(Bottom)' when at the end and the +position shown as a percentage of the total length otherwise. In each +case the form with the uppercase letter will be replaced by a string of fixed +width, padded to the right with spaces, while the lowercase form will +be replaced by a variable width string. As in other prompt strings, the +escape sequences `tt(%S)', `tt(%s)', `tt(%B)', `tt(%b)', `tt(%U)', +`tt(%u)' for entering and leaving the display modes +standout, bold and underline are also available, as is the form +`tt(%{)...tt(%})' for enclosing escape sequences which display with zero +width. +) +kindex(list-rows-first, completion style) item(tt(list-rows-first))( -This style is tested like the tt(list-packed) style and determines if -matches are to be listed in a rows-first fashion, as for the -tt(LIST_ROWS_FIRST) option. -) +This style is tested in the same way as the tt(list-packed) style and +determines whether matches are to be listed in a rows-first fashion as +if the tt(LIST_ROWS_FIRST) option were set. +) +kindex(list-suffixes, completion style) +item(tt(list-suffixes))( +This style is used by the function that completes filenames. If it is +true, and completion is attempted on a string containing multiple partially +typed pathname components, all ambiguous components will be shown. +Otherwise, completion stops at the first ambiguous component. +) +kindex(list-separator, completion style) +item(tt(list-separator))( +The value of this style is used in completion listing to separate the +string to complete from a description when possible (e.g. when +completing options). It defaults to `tt(-)tt(-)' (two hyphens). +) +kindex(local, completion style) item(tt(local))( -This style is used by completion functions which generate URLs as -possible matches to add suitable matches when a URL points to a -local web server. Its value should consist of three strings: a -hostname, the path to the default web pages for the server and the +This is for use with functions that complete URLs for which the +corresponding files are available directly from the filing system. +Its value should consist of three strings: a +hostname, the path to the default web pages for the server, and the directory name used by a user placing web pages within their home area. + +For example: + +example(zstyle ':completion:*' local toast \ + /var/http/public/toast public_html) + +Completion after `tt(http://toast/stuff/)' will look for files in the +directory tt(/var/http/public/toast/stuff), while completion after +`tt(http://toast/~yousir/)' will look for files in the directory +tt(~yousir/public_html). ) +kindex(mail-directory, completion style) +item(tt(mail-directory))( +If set, zsh will assume that mailbox files can be found in +the directory specified. It defaults to `tt(~/Mail)'. +) +kindex(match-original, completion style) item(tt(match-original))( This is used by the tt(_match) completer. If it is set to tt(only), tt(_match) will try to generate matches without inserting a `tt(*)' at the cursor position. If set to any other non-empty value, it will first try to generate matches without inserting the `tt(*)' and if that yields no matches, it will try again with the `tt(*)' -inserted. +inserted. If it is unset or set to the empty string, matching will +only be performed with the `tt(*)' inserted. ) +kindex(matcher, completion style) item(tt(matcher))( -This style is tested for tags used when generating matches. Its value -is used as an additional match specification to use when adding the -matches as described in +This style is tested separately for each tag valid in the current +context. Its value is added to any match specifications given by the +tt(matcher-list) style. It should be in the form described in ifzman(the section `Matching Control' in zmanref(zshcompwid))\ ifnzman(noderef(Matching Control))\ . ) +kindex(matcher-list, completion style) item(tt(matcher-list))( -This style is used by the main completion function to retrieve match -specifications that are to be used everywhere. Its value should be a -list of such specifications. The completion system will try them one -after another for each completer selected. For example, to first try -simple completion and, if that generates no matches, case-insensitive -completion one would do: +This style can be set to a list of match specifications that are to +be applied everywhere. Match specifications are described in +ifzman(the section `Matching Control' in zmanref(zshcompwid))\ +ifnzman(noderef(Matching Control))\ +. +The completion system will try them one after another for each completer +selected. For example, to try first simple completion and, if that +generates no matches, case-insensitive completion: example(zstyle ':completion:*' matcher-list '' 'm:{a-zA-Z}={A-Za-z}') -But the style allows even finer control: the style is looked up for -every completer tried with the name of the completer (without the -leading underscore) in the context name. For example, if one uses the -completers tt(_complete) and tt(_prefix) and wants to try -case-insensitive completion only when using the tt(_complete) -completer, one would do: +By default each specification replaces the previous one; however, if a +specification is prefixed with tt(+), it is added to the existing list. +Hence it is possible to create increasingly general specifications +without repetition: + +example(zstyle ':completion:*' matcher-list '' '+m{a-Z}={A-Z}' '+m{A-Z}={a-z}') + +It is possible to create match specifications valid for particular +completers by using the third field of the context. For example, to +use the completers tt(_complete) and tt(_prefix) but only allow +case-insensitive completion with tt(_complete): example(zstyle ':completion:*' completer _complete _prefix -zstyle ':completion:*:complete*:*' matcher-list '' 'm:{a-zA-Z}={A-Za-z}') - -Note that there is no colon directly after the `tt(complete)'. That's -because the completion system really uses the name of the completer -followed by a minus sign and a number in the var(completer) field of -the context name. This is useful if, for example, one wants to try -normal completion without a match specification and with -case-insensitive matching first, correction if that doesn't generate -any matches and partial-word completion if that doesn't yield any -matches either. In such a case one can give the tt(_complete) -completer more than once in the tt(completer) style and define different -match specifications for them, as in: - -example(zstyle ':completion:*' completer _complete _correct _complete -zstyle ':completion:*:complete-1:*' matcher-list '' 'm:{a-zA-Z}={A-Za-z}' -zstyle ':completion:*:complete-2:*' matcher-list \ +zstyle ':completion:*:complete:*' matcher-list \ + '' 'm:{a-zA-Z}={A-Za-z}') + +User-defined names, as explained for the tt(completer) style, are +available. This makes it possible to try the same completer more than +once with different match specifications each time. For example, to try +normal completion without a match specification, then normal completion +with case-insensitive matching, then correction, and finally +partial-word completion: + +example(zstyle ':completion:*' completer _complete _correct _complete:foo +zstyle ':completion:*:complete:*' matcher-list \ + '' 'm:{a-zA-Z}={A-Za-z}' +zstyle ':completion:*:foo:*' matcher-list \ 'm:{a-zA-Z}={A-Za-z} r:|[-_./]=* r:|=*') -Note that in any case an unset style makes the completion code use no -global match specification. Also, some completers (like tt(_correct) -and tt(_approximate)) do not use the match specifications. But even if -such completers are used one can use the simple form to set this style -(as in the first example above) because such completers will make sure -that they are executed only once even if multiple match specifications -have been given. +If the style is unset in any context no match specification is applied. +Note also that some completers such as tt(_correct) and tt(_approximate) +do not use the match specifications at all, though these completers will +only ever called once even if the tt(matcher-list) contains more than +one element. + +Where multiple specifications are useful, note that the em(entire) +completion is done for each element of tt(matcher-list), which can +quickly reduce the shell's performance. As a rough rule of thumb, +one to three strings will give acceptable performance. On the other +hand, putting multiple space-separated values into the same string does +not have an appreciable impact on performance. ) +kindex(max-errors, completion style) item(tt(max-errors))( This is used by the tt(_approximate) and tt(_correct) completer functions -to determine the maximum number of errors to accept. The completer will try +to determine the maximum number of errors to allow. The completer will try to generate completions by first allowing one error, then two errors, and -so on, until either a match was found or the maximum number of errors -given by this style has been reached. +so on, until either a match or matches were found or the maximum number of +errors given by this style has been reached. -If the value for this style contains the string tt(numeric), the +If the value for this style contains the string `tt(numeric)', the completer function will take any numeric argument as the maximum number of errors allowed. For example, with example(zstyle ':completion:*:approximate:::' max-errors 2 numeric) -two errors will be allowed if no numeric argument is given. However, -with a numeric argument of six (as in `tt(ESC-6 TAB)'), up to six +two errors are allowed if no numeric argument is given, but with +a numeric argument of six (as in `tt(ESC-6 TAB)'), up to six errors are accepted. Hence with a value of `tt(0 numeric)', no correcting completion will be attempted unless a numeric argument is given. -If the value contains the string tt(not-numeric), the completer +If the value contains the string `tt(not-numeric)', the completer will em(not) try to generate corrected completions when given a numeric argument, so in this case the number given should be greater than zero. For example, `tt(2 not-numeric)' specifies that @@ -1164,49 +1859,102 @@ performed. The default value for this style is `tt(2 numeric)'. ) +kindex(max-matches-width, completion style) +item(tt(max-matches-width))( +This style is used to determine the trade off between the width of the +display used for matches and the width used for their descriptions when +the tt(verbose) style is in effect. The value gives the number of +display columns to reserve for the matches. The default is half the +width of the screen. + +This has the most impact when several matches have the +same description and so will be grouped together. Increasing the style +will allow more matches to be grouped together; decreasing it will allow +more of the description to be visible. +) +kindex(menu, completion style) item(tt(menu))( -This style is tested for the tt(default) tag and the tags used when -adding matches. The value should be one of the `true' values (tt(yes), -tt(true), tt(1), or tt(on)) if menu completion should be started when -matches for the given tag (or always in case of the tt(default) tag) -are generated. If none of these values is defined for any of the tags -used, but for at least one of these tags the value is the string -tt(auto), this says that the same behavior as for the tt(AUTO_MENU) -option should be used. Finally, if menucompletion is started by some -other means (e.g. by setting the tt(MENU_COMPLETE) option) and the -value for one of the tags used is `false' (i.e. tt(no), tt(false), -tt(0), or tt(off)), then menucompletion will em(not) be started for -this completion. Note that the values defined for normal tags -override the value set for the tt(default) tag. - -Either instead of or in addition to one of the values above, the value -for this style may also contain the string tt(select), optionally -followed by an equal sign and a number. In this case menuselection -(as defined by the tt(zsh/computil) module) will be started. Without the -optional number, it will be started unconditionally and with a number -it will be started only if at least that many matches are generated -(if the values for more than one tag define such a number, the -smallest one is taken). Starting menuselection can explicitly be -turned off by defining a value containing the string -tt(no-select). +If this is true in the context of any of the tags defined +for the current completion menu completion will be used. The value for +a specific tag will take precedence over that for the `tt(default)' tag. + +If none of the values found in this way is true but at least +one is set to `tt(auto)', the shell behaves as if the tt(AUTO_MENU) +option is set. + +If one of the values is explicitly set to false, menu +completion will be explicitly turned off, overriding the +tt(MENU_COMPLETE) option and other settings. + +In the form `tt(yes=)var(num)', where `tt(yes)' may be any of the +true values (`tt(yes)', `tt(true)', `tt(on)' and `tt(1)'), +menu completion will be turned on if there are at least var(num) matches. +In the form `tt(yes=long)', menu completion will be turned on +if the list does not fit on the screen. This does not activate menu +completion if the widget normally only lists completions, but menu +completion can be activated in that case with the value `tt(yes=long-list)' +(Typically, the value `tt(select=long-list)' described later is more +useful as it provides control over scrolling.) + +Similarly, with any of the `false' values (as in `tt(no=10)'), menu +completion will em(not) be used if there are var(num) or more matches. + +The value of this widget also controls menu selection, as implemented by +the tt(zsh/complist) module. The following values may appear either +alongside or instead of the values above. + +If the value contains the string `tt(select)', menu selection +will be started unconditionally. + +In the form `tt(select=)var(num)', menu selection will only be started if +there are at least var(num) matches. If the values for more than one +tag provide a number, the smallest number is taken. + +Menu selection can be turned off explicitly by defining a value +containing the string`tt(no-select)'. + +It is also possible to start menu selection only if the list of +matches does not fit on the screen by using the value +`tt(select=long)'. To start menu selection even if the current widget +only performs listing, use the value `tt(select=long-list)'. + +To turn on menu completion or menu selection when a there are a certain +number of matches em(or) the list of matches does not fit on the +screen, both of `tt(yes=)' and `tt(select=)' may be given twice, once +with a number and once with `tt(long)' or `tt(long-list)'. + +Finally, it is possible to activate two special modes of menu selection. +The word `tt(interactive)' in the value causes interactive mode +to be entered immediately when menu selection is started; see +ifzman(the description of the tt(zsh/complist) module in zmanref(zshmodules))\ +ifnzman(noderef(The zsh/complist Module))\ +) for a description of interactive mode. Including the string +`tt(search)' does the same for incremental search mode. To select backward +incremental search, include the string `tt(search-backward)'. ) -item(tt(numbers))( -This is used with the tt(jobs) tag. If it is `true', the completions -will use the job numbers instead of the shortest unambiguous strings -of the jobs' command lines. If the value is a number, job numbers will -only be used if for at least one of the jobs that many (or more) words -from the command line string have to be used to make the strings -unambiguous. E.g. if it is set to `tt(1)', strings will only be used -if all jobs differ in the first word on their command lines. +kindex(muttrc, completion style) +item(tt(muttrc))( +If set, gives the location of the mutt configuration file. It defaults +to `tt(~/.muttrc)'. ) +kindex(numbers, completion style) +item(tt(numbers))( +This is used with the tt(jobs) tag. If it is `true', the shell will +complete job numbers instead of the shortest unambiguous prefix +of the job command text. If the value is a number, job numbers will +only be used if that many words from the job descriptions are required to +resolve ambiguities. For example, if the value is `tt(1)', strings will +only be used if all jobs differ in the first word on their command lines. +) +kindex(old-list, completion style) item(tt(old-list))( -This is used by the tt(_oldlist) completer. If this is set to tt(always), +This is used by the tt(_oldlist) completer. If it is set to `tt(always)', then standard widgets which perform listing will retain the current list of -matches, however they were generated. If it is set to tt(never), this will -not be done (the behaviour without the tt(_oldlist) completer). If it is -unset, or any other value, then the existing list of completions will -be displayed if it is not already; otherwise, the standard completion -list will be generated: this is the default behaviour of +matches, however they were generated; this can be turned off explicitly +with the value `tt(never)', giving the behaviour without the tt(_oldlist) +completer. If the style is unset, or any other value, then the existing +list of completions is displayed if it is not already; otherwise, the +standard completion list is generated; this is the default behaviour of tt(_oldlist). However, if there is an old list and this style contains the name of the completer function that generated the list, then the old list will be used even if it was generated by a widget which does @@ -1220,345 +1968,550 @@ tt(_oldlist), it will instead show the list of corrections already generated. As another example consider the tt(_match) completer: with the -tt(insert-unambiguous) style set to `true' it inserts only an -unambiguous prefix string if there is any. But since this may remove -parts of the original pattern, attempting completion again may result -in more matches than on the first attempt. But by using the -tt(_oldlist) completer and setting this style to tt(_match), the list of -matches generated on the first attempt will be used again. +tt(insert-unambiguous) style set to `true' it inserts only a common prefix +string, if there is any. However, this may remove parts of the original +pattern, so that further completion could produce more matches than on the +first attempt. By using the tt(_oldlist) completer and setting this style +to tt(_match), the list of matches generated on the first attempt will be +used again. +) +kindex(old-matches, completion style) +item(tt(old-matches))( +This is used by the tt(_all_matches) completer to decide if an old +list of matches should be used if one exists. This is selected by one of +the `true' values or by the string `tt(only)'. If +the value is `tt(only)', tt(_all_matches) will only use an old list +and won't have any effect on the list of matches currently being +generated. + +If this style is set it is generally unwise to call the tt(_all_matches) +completer unconditionally. One possible use is for either this style or +the tt(completer) style to be defined with the tt(-e) option to +tt(zstyle) to make the style conditional. ) +kindex(old-menu, completion style) item(tt(old-menu))( -This is used by the tt(_oldlist) completer. Here it controls how menu +This is used by the tt(_oldlist) completer. It controls how menu completion behaves when a completion has already been inserted and the -user types a standard completion key type such as tt(TAB). The default +user types a standard completion key such as tt(TAB). The default behaviour of tt(_oldlist) is that menu completion always continues with the existing list of completions. If this style is set to `false', however, a new completion is started if the old list was -generated by a different completion command (the behaviour without the -tt(_oldlist) completer). +generated by a different completion command; this is the behaviour without +the tt(_oldlist) completer. For example, suppose you type tt(^Xc) to generate a list of corrections, -and menu completion is started in one of the usual ways. Usually, typing -tt(TAB) at this point would start trying to complete the line as it now -appears. With tt(_oldlist), it will instead continue to cycle through the -list of completions. +and menu completion is started in one of the usual ways. Usually, or with +this style set to tt(false), typing tt(TAB) at this point would start +trying to complete the line as it now appears. With tt(_oldlist), it +instead continues to cycle through the list of corrections. ) +kindex(original, completion style) item(tt(original))( This is used by the tt(_approximate) and tt(_correct) completers to decide if the original string should be added as -one possible completion. Normally, this is done only if there are +a possible completion. Normally, this is done only if there are at least two possible corrections, but if this style is set to `true', it -will always be added. Note that these completers use this style after -setting the completer field in the context name to -tt(correct-)var(num) or tt(approximate-)var(num), where var(num) is -the number of errors that were accepted. +is always added. Note that the style will be examined with the +completer field in the context name set to tt(correct-)var(num) or +tt(approximate-)var(num), where var(num) is the number of errors that +were accepted. ) +kindex(packageset, completion style) item(tt(packageset))( -A style containing an override for the default package set -for that context. For example, +This style is used when completing arguments of the Debian `tt(dpkg)' +program. It contains an override for the default package set +for a given context. For example, -example(zstyle ':completion:*:complete:dpkg:--status-1:' packageset avail) +example(zstyle ':completion:*:complete:dpkg:option--status-1:*' \ + packageset avail) -will cause available packages, rather than only installed packages, -to be completed for `dpkg --status'. +causes available packages, rather than only installed packages, +to be completed for `tt(dpkg -)tt(-status)'. ) +kindex(path, completion style) item(tt(path))( -This is used together with the the tt(urls) tag by completion -functions that generate URLs as possible matches. It should be set to -the path of a directory containing sub-directories named like -`tt(http)', `tt(ftp)', `tt(bookmark)', and so on. These -sub-directories should contain files and other sub-directories whose -pathnames are possible completions after the initial `tt(http://)', -`tt(ftp://)', etc. See the description in the file tt(_urls) in the -tt(User) sub-directory of the completion system for more information. - -Also, the function that completes color names uses this style with the -tt(colors) tag. Here, the value should be the pathname of a file -containing color names in the format of an X11 tt(rgb.txt) file. That -file (if it can be found) will be used as the default if the style is -not set. -) +The function that completes color names uses this style with the +tt(colors) tag. The value should be the pathname of a file +containing color names in the format of an X11 tt(rgb.txt) file. If +the style is not set but this file is found in one of various standard +locations it will be used as the default. +) +kindex(pine-directory, completion style) +item(tt(pine-directory))( +If set, specifies the directory containing PINE mailbox files. It +defaults to `tt(~/mail)'. +) +kindex(ports, completion style) item(tt(ports))( -A style holding the service names of ports to complete. If this is -not set by the user, the service names from `tt(/etc/services)' will -be used. -) -item(tt(prefer-ignored))( -This style is tested by the main completion function before calling a -completer. The context name is formed in the same way as for the -tt(matcher-list) style, i.e. it contains the name of the completer -that will be called plus a hyphen and the number of the call to that -completer. - -If the style is set to true and completion did not generate any normal -matches yet, but there are matches that were ignored because they -matched one of the patterns given with the tt(fignore) array or the -tt(ignored-patterns) style, these ignored matches are used immediatly -and no other completer will be called. - -It is sometimes useful to set this style for the tt(correct) or -tt(approximate) completer so that ignored matches are prefered over -corrections. - -example(zstyle ':completion:*:complete-2:*' prefer-ignored yes -zstyle ':completion:*:(correct|approximate)-1:*' prefer-ignored yes) +A list of Internet service names (network ports) to complete. If this is +not set, service names are taken from the file `tt(/etc/services)'. ) +kindex(prefix-hidden, completion style) item(tt(prefix-hidden))( -This is used when matches with a common prefix are added (e.g. option -names). If it is `true', this prefix will not be shown in the list of -matches. +This is used for certain completions which share a common prefix, for +example command options beginning with dashes. If it is `true', the +prefix will not be shown in the list of matches. The default value for this style is `false'. ) +kindex(prefix-needed, completion style) item(tt(prefix-needed))( -This, too, is used for matches with a common prefix. If it is set to -`true' this common prefix has to be typed by the user to generate the -matches. E.g. for options this means that the `tt(-)', `tt(+)', or -`tt(-)tt(-)' has to be on the line to make option names be completed at -all. - -The default style for this style is `true'. -) -item(tt(prompt))( -The tt(incremental-complete-word) widget shows the value of this -style in the status line during incremental completion. The sequence -`tt(%u)' is replaced by the unambiguous part of all matches if there -is any and it is different from the word on the line. A `tt(%s)' is -replaced with `tt(-no match-)', `tt(-no prefix-)', or an empty string -if there is no completion matching the word on the line, if the -matches have no common prefix different from the word on the line or -if there is such a common prefix, respectively. The sequence `tt(%c)' -is replaced by the name of the completer function that generated the -matches (without the leading underscore). Finally, `tt(%n)' is -replaced by the number of matches generated, `tt(%a)' is replaced by -an empty string if the matches are in the normal set (i.e. the one -without file names with one of the suffixes from the -tt(ignored-suffixes) style) and with `tt( -alt-)' if the matches are -in the alternate set, and if the tt(list) style is set, `tt(%l)' is -replaced by `tt(...)' if the list of matches is too long to fit on the -screen and with an empty string otherwise. If the tt(list) style is -`false', `tt(%l)' will always be removed. +This, too, is used for matches with a common prefix. If it is set to +`true' this common prefix must be typed by the user to generate the +matches. In the case of command options, this means that the initial +`tt(-)', `tt(+)', or `tt(-)tt(-)' must be typed explicitly before option +names will be completed. + +The default value for this style is `true'. ) +kindex(preserve-prefix, completion style) +item(tt(preserve-prefix))( +This style is used when completing path names. Its value should be a +pattern matching an initial prefix of the word to complete that should +be left unchanged under all circumstances. For example, on some Unices +an initial `tt(//)' (double slash) has a special meaning; setting +this style to the string `tt(//)' will preserve it. As another example, +setting this style to `tt(?:/)' under Cygwin would allow completion +after `tt(a:/...)' and so on. +) +kindex(range, completion style) +item(tt(range))( +This is used by the tt(_history) completer and the +tt(_history_complete_word) bindable command to decide which words +should be completed. + +If it is a singe number, only the last var(N) words from the history +will be completed. + +If it is a range of the form `var(max)tt(:)var(slice)', +the last var(slice) words will be completed; then if that +yields no matches, the var(slice) words before those will be tried and +so on. This process stops either when at least one match was been +found, or var(max) words have been tried. + +The default is to complete all words from the history at once. +) +kindex(regular, completion style) +item(tt(regular))( +This style is used by the tt(_expand_alias) completer and bindable +command. If set to `tt(true)' (the default), regular aliases will be +expanded but only in command position. If it is set to `tt(false)', +regular aliases will never be expanded. If it is set to `tt(always)', +regular aliases will be expanded even if not in command position. +) +kindex(remote-access, completion style) +item(tt(remote-access))( +If set to tt(false), certain commands will be prevented from making +Internet connections to retrieve remote information. This includes the +completion for the tt(CVS) command. + +It is not always possible to know if connections are in fact to a remote +site, so some may be prevented unnecessarily. +) +kindex(remove-all-dups, completion style) item(tt(remove-all-dups))( -The tt(_history_complete_word) bindable command uses this to decide if -all duplicate matches should be removed, rather than just consecutive -duplicates. -) +The tt(_history_complete_word) bindable command and the tt(_history) +completer use this to decide if all duplicate matches should be +removed, rather than just consecutive duplicates. +) +kindex(select-prompt, completion style) +item(tt(select-prompt))( +If this is set for the tt(default) tag, its +value will be displayed during menu selection (see the tt(menu) style +above) when the completion list does not fit on the screen as a +whole. The same escapes as for the tt(list-prompt) style are +understood, except that the numbers refer to the match or line the mark is +on. A default prompt is used when the value is the empty string. +) +kindex(select-scroll, completion style) +item(tt(select-scroll))( +This style is tested for the tt(default) tag and determines how a +completion list is scrolled during a menu selection (see the tt(menu) +style above) when the completion list does not fit on the screen as a +whole. If the value is `tt(0)' (zero), the list is scrolled by +half-screenfuls; if it is a positive integer, the list is scrolled by the +given number of lines; if it is a negative number, the list is scrolled by a +screenful minus the absolute value of the given number of lines. +The default is to scroll by single lines. +) +kindex(separate-sections, completion style) +item(tt(separate-sections))( +This style is used with the tt(manuals) tag when completing names of +manual pages. If it is `true', entries for different sections are +added separately using tag names of the form `tt(manual.)var(X)', +where var(X) is the section number. When the tt(group-name) style is +also in effect, pages from different sections will appear separately. +This style is also used similarly with the tt(words) style when +completing words for the dict command. It allows words from different +dictionary databases to be added separately. +The default for this style is `false'. +) +kindex(show-completer, completion style) +item(tt(show-completer))( +Tested whenever a new completer is tried. If it is true, the completion +system outputs a progress message in the listing area showing what +completer is being tried. The message will be overwritten by any output +when completions are found and is removed after completion is finished. +) +kindex(single-ignored, completion style) item(tt(single-ignored))( -Using styles like tt(ignored-patterns) allows one to put some matches -in the alternate set of matches which is only used if there are no -`normal' matches. Having only one such normally ignored match is often -a special case because one probably doesn't want that match to be -inserted immediatly. This style allows to configure what to do in such -a case. If its value is tt(show), the single match will only be shown, -not inserted. If the value is tt(menu), then the single match and the -original string are both added as matches and menucompletion is -started so that one can easily select either of them. +This is used by the tt(_ignored) completer when there is only one match. +If its value is `tt(show)', the single match will be +displayed but not inserted. If the value is `tt(menu)', then the single +match and the original string are both added as matches and menu completion +is started, making it easy to select either of them. ) +kindex(sort, completion style) item(tt(sort))( -If set to `true', completion functions that generate words from the -history as possible matches sort these words alphabetically instead of -keeping them in the order in which they appear in the history (from -youngest to oldest). - -The completion function that generates filenames as possible matches -uses this style with the tt(files) tag to determine in which order the -names should be listed and completed when using menucompletion. The -value may be one of tt(size) to sort them by the size of the file, -tt(links) to sort them by the number of links to the file, -tt(modification) (or tt(time) or tt(date)) to sort them by the last -modification time, tt(access) to sort them by the last access time, or -tt(inode) (or tt(change)) to sort them by the last inode change -time. Any other value (or not setting this style at all) makes them be -sorted alphabetically by name. If the value contains the string -tt(reverse), sorting is done in decreasing order. - -This is also used by the tt(_expand) completer. Here, if it is set to -`true', the expansions generated will always be sorted. If it is set -to tt(menu), then the expansions are only sorted when they are offered -as single strings (not in the string containing all possible -expansions). -) +Many completion widgets call tt(_description) at some point which +decides whether the matches are added sorted or unsorted (often +indirectly via tt(_wanted) or tt(_requested)). This style can be set +explicitly to one of the usual true or false values as an override. +If it is not set for the context, the standard behaviour of the +calling widget is used. + +The style is tested first against the full context including the tag, and +if that fails to produce a value against the context without the tag. + +If the calling widget explicitly requests unsorted matches, this is usually +honoured. However, the default (unsorted) behaviour of completion +for the command history may be overridden by setting the style to +tt(true). + +In the tt(_expand) completer, if it is set to +`true', the expansions generated will always be sorted. If it is set +to `tt(menu)', then the expansions are only sorted when they are offered +as single strings but not in the string containing all possible +expansions. +) +kindex(special-dirs, completion style) item(tt(special-dirs))( Normally, the completion code will not produce the directory names -tt(.) and tt(..) as possible completions. If this style is set to -`true', it will add both `tt(.)' and `tt(..)' as possible completions, -if it is set to tt(..), only `tt(..)' will be added. +`tt(.)' and `tt(..)' as possible completions. If this style is set to +`true', it will add both `tt(.)' and `tt(..)' as possible completions; +if it is set to `tt(..)', only `tt(..)' will be added. + +The following example sets tt(special-dirs) to `tt(..)' when the +current prefix is empty, is a single `tt(.)', or consists only of a path +beginning with `tt(../)'. Otherwise the value is `false'. + +example(zstyle -e ':completion:*' special-dirs \ + '[[ $PREFIX = LPAR()../RPAR()#LPAR()|.|..RPAR() ]] && reply=LPAR()..RPAR()') ) +kindex(squeeze-slashes, completion style) item(tt(squeeze-slashes))( -If set to `true', sequences of slashes (like in `tt(foo//bar)') will be -treated as if they were only one slash when completing pathnames. +If set to `true', sequences of slashes in filename paths (for example in +`tt(foo//bar)') will be treated as a single slash. This is the usual +behaviour of UNIX paths. However, by default the file completion +function behaves as if there were a `tt(*)' between the slashes. ) +kindex(stop, completion style) item(tt(stop))( If set to `true', the tt(_history_complete_word) bindable -command will always insert matches as if menucompletion were started -and it will stop when the last match is inserted. If this style is set -to tt(verbose) a message will be displayed when the last match is reached. - -This style is also used by the tt(incremental-complete-word) -widget. Here its value is used like the one for the tt(break) -style. But all keys matching the pattern given as its value will stop -incremental completion and will then execute their usual function. -) +command will stop once when reaching the beginning or end of the +history. Invoking tt(_history_complete_word) will then wrap around to +the opposite end of the history. If this style is set to `false' (the +default), tt(_history_complete_word) will loop immediately as in a +menu completion. +) +kindex(strip-comments, completion style) +item(tt(strip-comments))( +If set to `true', this style causes non-essential comment text to be +removed from completion matches. Currently it is only used when +completing e-mail addresses where it removes any display name from the +addresses, cutting them down to plain var(user@host) form. +) +kindex(subst-globs-only, completion style) +item(tt(subst-globs-only))( +This is used by the tt(_expand) completer. If it is set to `true', +the expansion will only be used if it resulted from globbing; hence, +if expansions resulted from the use of the tt(substitute) style +described below, but these were not further changed by globbing, the +expansions will be rejected. + +The default for this style is `false'. +) +kindex(substitute, completion style) item(tt(substitute))( -If this is unset or set to the empty string, the tt(_expand) completer -will first try to expand all substitutions in the string (such as -`tt($LPAR()...RPAR())' and `tt(${...})'). If this is set to an -non-empty string it should be an expression usable inside a `tt($((...)))' -arithmetical expression. In this case, expansion of substitutions will -be done if the expression evaluates to `tt(1)'. For example, with - -example(zstyle ':completion:*:expand:::' substitute '${NUMERIC:-1} != 1') - -substitution will be performed only if given an explicit numeric -argument other than `tt(1)', as by typing `tt(ESC 2 TAB)'. -) +This boolean style controls whether the tt(_expand) completer will +first try to expand all substitutions in the string (such as +`tt($LPAR()...RPAR())' and `tt(${...})'). + +The default is `true'. +) +kindex(suffix, completion style) +item(tt(suffix))( +This is used by the tt(_expand) completer if the word starts with a +tilde or contains a parameter expansion. If it is set to `true', the +word will only be expanded if it doesn't have a suffix, i.e. if it is +something like `tt(~foo)' or `tt($foo)' rather than `tt(~foo/)' or +`tt($foo/bar)', unless that suffix itself contains characters eligible +for expansion. The default for this style is `true'. +) +kindex(tag-order, completion style) item(tt(tag-order))( This provides a mechanism for sorting how the tags available in a particular context will be used. The values for the style are sets of space-separated lists of tags. The tags in each value will be tried at the same time; if no match is -found, the next value is used. +found, the next value is used. (See the tt(file-patterns) style for +an exception to this behavior.) + +For example: -For example (with the tt(file-patterns) style not set for tt(gunzip)), +example(zstyle ':completion:*:complete:-command-:*' tag-order \ + 'commands functions') -example(zstyle ':completion:*:complete:gunzip:*' tag-order \ - 'globbed-files directories' all-files) +specifies that completion in command position first offers +external commands and shell functions. Remaining tags will be tried if +no completions are found. -specifies that, when completing arguments of the command tt(gunzip), -files generated by patterns (in this case, those ending in tt(.gz)) and -any directories will be presented first, and if that fails, any other files -will be tried. A string starting with an exclamation mark (`tt(!)') -specifies names of tags that are not to be used -- the effect will be +In addition to tag names, each string in the value may take one of the +following forms: + +startitem() +item(tt(-))( +If any value consists of only a hyphen, +then em(only) the tags specified in the other values are +generated. Normally all tags not explicitly selected are tried last +if the specified tags fail to generate any matches. This means +that a single value consisting only of a single hyphen +turns off completion. +) +item(tt(!) var(tags)...)( +A string starting with an exclamation mark +specifies names of tags that are em(not) to be used. The effect is the same as if all other possible tags for the context had been -listed. If any string in the value consists of only a hyphen -(`tt(-)'), then only the tags selected by the other strings will be -generated. Normally all tags not explicitly selected will be tried at -the end if the selected tags did not generate any matches. This means -that a value of only one hyphen turns off completion in a particular -context. - -In strings not starting with an exclamation mark, it is also possible -to specify tag aliases instead of only tags. These are of the form -`var(tag)tt(:)var(alias)', where var(tag) is one of the tags offered -by the completion function for the current context and var(alias) is a -name. For this, the completion function will generate matches in the -same way as for the var(tag) but it will use the var(alias) in place -of the tag in the context names used to look up styles. This can be +listed. +) +item(var(tag)tt(:)var(label) ...)( +Here, var(tag) is one of the standard tags and var(label) is an +arbitrary name. Matches are generated as normal but the name var(label) +is used in contexts instead of var(tag). This is not useful in words +starting with tt(!). + +If the var(label) starts with a hyphen, the var(tag) is prepended to the +var(label) to form the name used for lookup. This can be used to make the completion system try a certain tag more than once, -supplying different style settings for each attempt. For example, - -example(zstyle ':completion:*:*:-command-:*' tag-order 'functions:-non-comp' -zstyle '*:-non-comp' ignored-patterns '_*') - -Makes completion in command position first try only names of shell -functions that don't match the pattern `tt(_*)'. If that generates no -matches, the default of trying all the other things that can be -completed in command position is used, including the names of all -shell functions. Note that the var(alias) used in this example -`tt(-non-comp)' with the hyphen at the bginning is not in any way -special to the completion system. But since no other tag starts with a -hyphen, using such a name allows to use a context pattern as short as -the one in the second line without making it ambiguous. - -The var(alias) may optionally be followed by a second colon and a -description. This description will then be used for the `tt(%d)' in +supplying different style settings for each attempt; see below for an +example. +) +item(var(tag)tt(:)var(label)tt(:)var(description))( +As before, but tt(description) will replace the `tt(%d)' in the value of the tt(format) style instead of the default description -supplied by the completion function. Spaces in the description have to -be quoted by preceding them with a backslash and a `tt(%d)' appearing -in the description is replaced with the description given by the +supplied by the completion function. Spaces in the description must +be quoted with a backslash. A `tt(%d)' appearing +in var(description) is replaced with the description given by the completion function. +) +enditem() -Strings in the value may also be of the form `var(func)tt(())'. In -this case the function var(func) will be called which can then define -in which order tags are to be used based on additional context -information. See the tt(_sort_tags) function below for a description -of how such functions can be implemented. The return value of the -function is used to decide if the following values for the style -should be used. If it is zero, they are used and if it is non-zero, -they are not used. For example: - -example(non-empty() { [[ -n $PREFIX ]] } -zstyle ':completion:*:*:-command-:*' tag-order 'non-empty()') - -Makes completion in command position happen only if the string on the -line is not empty (this is tested using the tt(PREFIX) -parameter which is special in completion widgets, see +In any of the forms above the tag may be a pattern or several +patterns in the form `tt({)var(pat1)tt(,)var(pat2...)tt(})'. In this +case all matching tags will be used except +for any given explicitly in the same string. + +One use of these features is to try +one tag more than once, setting other styles differently on +each attempt, but still to use all the other tags without having to +repeat them all. For example, to make completion of function names in +command position ignore all the completion functions starting with an +underscore the first time completion is tried: + +example(zstyle ':completion:*:*:-command-:*' tag-order \ + 'functions:-non-comp *' functions +zstyle ':completion:*:functions-non-comp' ignored-patterns '_*') + +On the first attempt, all tags will be offered but the tt(functions) tag +will be replaced by tt(functions-non-comp). The tt(ignored-patterns) style +is set for this tag to exclude functions starting with an underscore. +If there are no matches, the second value of the +tt(tag-order) style is used which completes functions using the default +tag, this time presumably including all function names. + +The matches for one tag can be split into different groups. For example: + +example(zstyle ':completion:*' tag-order \ + 'options:-long:long\ options + options:-short:short\ options + options:-single-letter:single\ letter\ options' + +zstyle ':completion:*:options-long' ignored-patterns '[-+](|-|[^-]*)' +zstyle ':completion:*:options-short' ignored-patterns '--*' '[-+]?' +zstyle ':completion:*:options-single-letter' ignored-patterns '???*') + +With the tt(group-names) style set, options beginning with +`tt(-)tt(-)', options beginning with a single `tt(-)' or `tt(+)' but +containing multiple characters, and single-letter options will be +displayed in separate groups with different descriptions. + +Another use of patterns is to +try multiple match specifications one after another. The +tt(matcher-list) style offers something similar, but it is tested very +early in the completion system and hence can't be set for single +commands nor for more specific contexts. Here is how to +try normal completion without any match specification and, if that +generates no matches, try again with case-insensitive matching, restricting +the effect to arguments of the command tt(foo): + +example(zstyle ':completion:*:*:foo:*' tag-order '*' '*:-case' +zstyle ':completion:*-case' matcher 'm:{a-z}={A-Z}') + +First, all the tags offered when completing after tt(foo) are tried using +the normal tag name. If that generates no matches, the second value of +tt(tag-order) is used, which tries all tags again except that this time +each has tt(-case) appended to its name for lookup of styles. Hence this +time the value for the tt(matcher) style from the second call to tt(zstyle) +in the example is used to make completion case-insensitive. + +It is possible to use the tt(-e) option of the tt(zstyle) builtin +command to specify conditions for the use of particular tags. For +example: + +example(zstyle -e '*:-command-:*' tag-order ' + if [[ -n $PREFIX$SUFFIX ]]; then + reply=( ) + else + reply=( - ) + fi') + +Completion in command position will be attempted only if the string +typed so far is not empty. This is tested using the tt(PREFIX) +special parameter; see ifzman(zshcompwid)\ -ifnzman(the section noderef(Completion System))\ -)\ -for a description of these special parameters). +ifnzman(noderef(Completion Widgets)) +for a description of parameters which are special inside completion widgets. +Setting tt(reply) to an empty array provides the default +behaviour of trying all tags at once; setting it to an +array containing only a hyphen disables the use of all tags and hence of +all completions. + +If no tt(tag-order) style has been defined for a context, the strings +`tt((|*-)argument-* (|*-)option-* values)' and `tt(options)' plus all +tags offered by the completion function will be used to provide a +sensible default behavior that causes arguments (whether normal command +arguments or arguments of options) to be completed before option names for +most commands. +) +kindex(urls, completion style) +item(tt(urls))( +This is used together with the the tt(urls) tag by +functions completing URLs. -If no style has been defined for a context, the strings tt(arguments -values) and tt(options) plus all tags offered by the completion -function will be used to provide a sensible default behavior. The tags -given used by the tt(_files) function (either the default tags -tt(globbed-files), tt(directories) and tt(all-files) or the tags -specified by the tt(file-patterns) style) will be added one-by-one so -that the different patterns represented by them will be tried one -after another. +If the value consists of more than one string, or if the only string +does not name a file or directory, the strings are used as the URLs to +complete. + +If the value contains only one string which is the name of a normal +file the URLs are taken from that file (where the URLs may be +separated by white space or newlines). + +Finally, if the only string in the value names a directory, the +directory hierarchy rooted at this directory gives the completions. The +top level directory should be the file access method, such as +`tt(http)', `tt(ftp)', `tt(bookmark)' and so on. In many cases the next +level of directories will be a filename. The directory hierarchy can +descend as deep as necessary. + +For example, + +example(zstyle ':completion:*' urls ~/.urls +mkdir -p ~/.urls/ftp/ftp.zsh.org/pub/development ) + +allows completion of all the components of the URL +tt(ftp://ftp.zsh.org/pub/development) after suitable commands such as +`tt(netscape)' or `tt(lynx)'. Note, however, that access methods and +files are completed separately, so if the tt(hosts) style is set hosts +can be completed without reference to the tt(urls) style. + +See the description in the function tt(_urls) itself +for more information (e.g. `tt(more $^fpath/_urls(N))'). +) +kindex(use-cache, completion style) +item(tt(use-cache))( +If this is set, the completion caching layer is activated for any completions +which use it (via the tt(_store_cache), tt(_retrieve_cache), and +tt(_cache_invalid) functions). The directory containing the cache +files can be changed with the tt(cache-path) style. +) +kindex(use-compctl, completion style) item(tt(use-compctl))( -If this style is set to a string not equal to tt(false), tt(0), -tt(no), and tt(off), the completion system will use any completion -specifications defined with the tt(compctl) builtin command. If the -style is unset, this will only be done if the tt(zsh/compctl) module -is loaded. The string may also contain the substring tt(first) to make -the definition for tt(compctl -T) be used and the substring -tt(default) to make the one for tt(compctl -D) be used. +If this style is set to a string em(not) equal to tt(false), tt(0), +tt(no), and tt(off), the completion system may use any completion +specifications defined with the tt(compctl) builtin command. If the +style is unset, this is done only if the tt(zsh/compctl) module +is loaded. The string may also contain the substring `tt(first)' to +use completions defined with `tt(compctl -T)', and the substring +`tt(default)' to use the completion defined with `tt(compctl -D)'. Note that this is only intended to smooth the transition from tt(compctl) to the new completion system and may disappear in the future. Note also that the definitions from tt(compctl) will only be used if -there is no special completion function for the command completion is -done upon. -) +there is no specific completion function for the command in question. For +example, if there is a function tt(_foo) to complete arguments to the +command tt(foo), tt(compctl) will never be invoked for tt(foo). +However, the tt(compctl) version will be tried if tt(foo) only uses +default completion. +) +kindex(use-perl, completion style) +item(tt(use-perl))( +Various parts of the function system use awk to extract words from +files or command output as this universally available. However, many +versions of awk have arbitrary limits on the size of input. If this +style is set, perl will be used instead. This is almost always +preferable if perl is available on your system. + +Currently this is only used in completions for `make', but it may be +extended depending on authorial frustration. +) +kindex(users, completion style) item(tt(users))( -This may be set to a list of names that should be completed whenever -a username is needed. If it is not set or the string on the line +This may be set to a list of usernames to be completed. +If it is not set or the string on the line doesn't match any of the strings in this list, all usernames will be completed. ) +kindex(users-hosts, completion style) item(tt(users-hosts))( The values of this style should be of the form `var(user)tt(@)var(host)' or `var(user)tt(:)var(host)'. It is used for commands that need pairs of -user- and hostnames. For such commands, only the pairs from this style -are used and if, for example, the username is already typed, then only -the hostnames for which there is a pair with that username is defined. - -If set for the tt(my-accounts) tag, this is used for commands such as -tt(rlogin) and tt(ssh). I.e. the style should contain the names of the -user's own accounts. With the tt(other-accounts) tag this is used for -commands such as tt(talk) and tt(finger) and should contain other -people's accounts. Finally, this may also be used by some commands with -the tt(accounts) tag. -) -item(tt(users-hosts-ports))( -Like tt(users-hosts) but used for commands like tt(telnet) and -containing strings of the form `var(user)tt(@)var(host)tt(:)var(port)'. -) +user- and hostnames. These commands will complete usernames from this +style (only), and will restrict subsequent hostname completion to hosts +paired with that user in one of the values of the style. + +It is possible to group values for sets of commands which allow a remote +login, such as tt(rlogin) and tt(ssh), by using the tt(my-accounts) tag. +Similarly, values for sets of commands which usually refer to the +accounts of other people, such as tt(talk) and tt(finger), can be +grouped by using the tt(other-accounts) tag. More ambivalent commands +may use the tt(accounts) tag. +) +kindex(users-hosts-ports, completion style) item(tt(users-hosts-ports))( Like tt(users-hosts) but used for commands like tt(telnet) and containing strings of the form `var(user)tt(@)var(host)tt(:)var(port)'. ) +kindex(verbose, completion style) item(tt(verbose))( -This is used in several contexts to decide if only a simple or a -verbose list of matches should be generated. For example some commands -show descriptions for option names if this style is `true'. - -The default value for this style is `true'. +If set, as it is by default, the completion listing is more verbose. +In particular many commands show descriptions for options if this +style is `true'. ) +kindex(word, completion style) item(tt(word))( -To find out if listing should be performed on its own, the tt(_list) -completer normally compares the contents of the line with the contents -the line had at the time of the last invocation. If this style is set to -`true', comparison is done using only the current word. In this case, -attempting completion on a word equal to the one when completion was called -the last time will not delay the generation of matches. +This is used by the tt(_list) completer, which prevents the insertion of +completions until a second completion attempt when the line has not +changed. The normal way of finding out if the line has changed is to +compare its entire contents between the two occasions. If this style is +true, the comparison is instead performed only on the current word. +Hence if completion is performed on another word with the same contents, +completion will not be delayed. ) enditem() @@ -1568,108 +2521,57 @@ cindex(completion system, choosing completers) The initialization script tt(compinit) redefines all the widgets which perform completion to call the supplied widget function -tt(_main_complete). This function acts as a wrapper calling the -so-called `completer' functions that generate matches. If +tt(_main_complete). This function acts as a wrapper calling the +so-called `completer' functions that generate matches. If tt(_main_complete) is called with arguments, these are taken as the names of completer functions to be called in the order given. If no arguments are given, the set of functions to try is taken from the -tt(completer) style. For example, to use normal completion and +tt(completer) style. For example, to use normal completion and correction if that doesn't generate any matches: example(zstyle ':completion:*' completer _complete _correct) -after calling tt(compinit). The default value for this style -is `tt(_complete)', i.e. normally only ordinary -completion is tried. The tt(_main_complete) function uses the return -value of the completer functions to decide if other completers should be -called. If the return value is zero, no other completers are tried and the -tt(_main_complete) function returns. - -The following completer functions are contained in the distribution (users -may write their own): +after calling tt(compinit). The default value for this style is +`tt(_complete _ignored)', i.e. normally only ordinary completion is tried, +first with the effect of the tt(ignored-patterns) style and then without +it. The tt(_main_complete) function uses the return status of the completer +functions to decide if other completers should be called. If the return +status is zero, no other completers are tried and the tt(_main_complete) +function returns. + +If the first argument to tt(_main_complete) is a single hyphen, the +arguments will not be taken as names of completers. Instead, the +second argument gives a name to use in the var(completer) field of the +context and the other arguments give a command name and arguments to +call to generate the matches. + +The following completer functions are contained in the distribution, +although users may write their own. Note that in contexts the leading +underscore is stripped, for example basic completion is performed in the +context `tt(:completion::complete:)var(...)'. cindex(completion system, completers) startitem() -findex(_complete) -item(tt(_complete))( -This completer generates all possible completions in a context-sensitive -manner, i.e. using the settings defined with the tt(compdef) function -explained above and the current settings of all special parameters. +findex(_all_matches) +item(tt(_all_matches))( +This completer can be used to add a string consisting of all other +matches. As it influences later completers it must appear as the first +completer in the list. The list of all matches is affected by the +tt(avoid-completer) and tt(old-matches) styles described above. -To complete arguments of commands, tt(_complete) uses the utility function -tt(_normal), which is in turn responsible for finding the particular -function; it is described below. Various contexts of the form -tt(-)var(context)tt(-), as mentioned above for the tt(#compdef) tag, are -handled specially. These are: +It may be useful to use the tt(_generic) function described below +to bind tt(_all_matches) to its own keystroke, for example: -startitem() -item(tt(-equal-))( -for completion after an equal sign, other than one occurring in a -shell-variable assignment. -) -item(tt(-tilde-))( -for completion after a tilde (`tt(~)') character, but before a slash. -) -item(tt(-redirect-))( -for completion after a redirection operator. -) -item(tt(-math-))( -for completion inside mathematical contexts, such as -`tt(LPAR()LPAR())...tt(RPAR()RPAR())'. -) -item(tt(-subscript-))( -for completion inside subscripts. -) -item(tt(-value-))( -for completion on the right hand side of an assignment. -) -item(tt(-array-value-))( -for completion on the right hand side of an array-assignment -(`tt(foo=LPAR()...RPAR())'). -) -item(tt(-condition-))( -for completion inside conditions (`tt([[...]])'). -) -item(tt(-parameter-))( -for completing the name of a parameter expansion (`tt($...)'). -) -item(tt(-brace-parameter-))( -for completing the name of a parameter expansion within braces -(`tt(${...})'). -) -item(tt(-first-))( -for adding completions before any other completion functions are -tried; if this -function sets the tt(_compskip) parameter to tt(all), no other -completion functions will be called, if it is set to a string -containing the substring tt(patterns), no pattern completion functions -will be called, and if it is set to a string containing tt(default) -the function for the `tt(-default-)' context will not be called, but -functions defined for commands will. -) -item(tt(-default-))( -for generating completions when no special completion function is used. -) -item(tt(-command-))( -for completing in a command position. -) -enditem() - -Default implementations are supplied for each of these -contexts, in most cases named after the context itself -(e.g. completion for the `tt(-tilde-)' context is done by the function -named `tt(_tilde)'). - -Before trying to find a function for a specific context, tt(_complete) -checks if the parameter `tt(compcontext)' is set to a non-empty -value. If it is, the value is taken as the name of the context to use -and the function defined for that context will be called. +example(zle -C all-matches complete-word _generic +bindkey '^Xa' all-matches +zstyle ':completion:all-matches:*' old-matches only +zstyle ':completion:all-matches::::' completer _all_matches) ) findex(_approximate) item(tt(_approximate))( -This completer function uses the tt(_complete) completer to generate -a list of strings for the context the cursor is currently in, allowing -you to specify a maximum number of errors: see the description of +This is similar to the basic tt(_complete) completer but allows the +completions to undergo corrections. The maximum number of errors can be +specified by the tt(max-errors) style; see the description of approximate matching in ifzman(\ zmanref(zshexpn) @@ -1677,127 +2579,231 @@ zmanref(zshexpn) ifnzman(\ noderef(Filename Generation) )\ -for how errors are -counted. The resulting list of corrected and completed strings is then -presented to the user. The intended use of this completer function is to -try after the normal tt(_complete) completer by setting: +for how errors are counted. Normally this completer will only be tried +after the normal tt(_complete) completer: example(zstyle ':completion:*' completer _complete _approximate) This will give correcting completion if and only if -normal completion doesn't yield any possible completions. When +normal completion yields no possible completions. When corrected completions are found, the completer will normally start -menucompletion allowing you to cycle through these strings. +menu completion allowing you to cycle through these strings. This completer uses the tags tt(corrections) and tt(original) when -generating the possible coprrections and the original string. The +generating the possible corrections and the original string. The tt(format) style for the former may contain the additional sequences `tt(%e)' and `tt(%o)' which will be replaced by the number of errors accepted to generate the corrections and the original string, respectively. -Like all completers tt(_approximate) uses its name without the -undersccore in the var(completer) field of the context name. Once it -has started trying to generate matches, it will append a minus sign -and the number of errors accepted in this attempt to its name. So on the -first try the field contains `tt(approximate-1)', on the -second try `tt(approximate-2)', and so on. +The completer progressively increases the number of errors allowed up to +the limit by the tt(max-errors) style, hence if a completion is found +with one error, no completions with two errors will be shown, and so on. +It modifies the completer name in the context to indicate the number of +errors being tried: on the first try the completer field contains +`tt(approximate-1)', on the second try `tt(approximate-2)', and so on. + +When tt(_approximate) is called from another function, the number of +errors to accept may be passed with the tt(-a) option. The argument +is in the same format as the tt(max-errors) style, all in one string. + +Note that this completer (and the tt(_correct) completer mentioned +below) can be quite expensive to call, especially when a large number +of errors are allowed. One way to avoid this is to set up the +tt(completer) style using the tt(-e) option to zstyle so that some +completers are only used when completion is attempted a second time on +the same string, e.g.: + +example(zstyle -e ':completion:*' completer ' + if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]]; then + _last_try="$HISTNO$BUFFER$CURSOR" + reply=(_complete _match _prefix) + else + reply=(_ignored _correct _approximate) + fi') + +This uses the tt(HISTNO) parameter and the tt(BUFFER) and tt(CURSOR) +special parameters that are available inside zle and completion +widgets to find out if the command line hasn't changed since the last +time completion was tried. Only then are the tt(_ignored), +tt(_correct) and tt(_approximate) completers called. +) +findex(_complete) +item(tt(_complete))( +This completer generates all possible completions in a context-sensitive +manner, i.e. using the settings defined with the tt(compdef) function +explained above and the current settings of all special parameters. +This gives the normal completion behaviour. + +To complete arguments of commands, tt(_complete) uses the utility function +tt(_normal), which is in turn responsible for finding the particular +function; it is described below. Various contexts of the form +tt(-)var(context)tt(-) are handled specifically. These are all +mentioned above as possible arguments to the tt(#compdef) tag. + +Before trying to find a function for a specific context, tt(_complete) +checks if the parameter `tt(compcontext)' is set. Setting +`tt(compcontext)' allows the usual completion dispatching to be +overridden which is useful in places such as a function that uses +tt(vared) for input. If it is set to an array, the elements are taken +to be the possible matches which will be completed using the tag +`tt(values)' and the description `tt(value)'. If it is set to an +associative array, the keys are used as the possible completions and +the values (if non-empty) are used as descriptions for the matches. If +`tt(compcontext)' is set to a string containing colons, it should be of +the form `var(tag)tt(:)var(descr)tt(:)var(action)'. In this case the +var(tag) and var(descr) give the tag and description to use and the +var(action) indicates what should be completed in one of the forms +accepted by the tt(_arguments) utility function described below. + +Finally, if `tt(compcontext)' is set to a string without colons, the +value is taken as the name of the context to use and the function +defined for that context will be called. For this purpose, there is a +special context named tt(-command-line-) that completes whole command +lines (commands and their arguments). This is not used by the completion +system itself but is nonetheless handled when explicitly called. ) findex(_correct) item(tt(_correct))( -Generate corrections (but not completions) for the current word; this is -similar to spell-checking. This calls tt(_approximate) but uses a -different var(completer) field in the context name. +Generate corrections, but not completions, for the current word; this is +similar to tt(_approximate) but will not allow any number of extra +characters at the cursor as that completer does. The effect is +similar to spell-checking. It is based on tt(_approximate), but the +completer field in the context name is tt(correct). For example, with: example(zstyle ':completion:::::' completer _complete _correct _approximate -zstyle ':completion:*:correct:::' accept 2 not-numeric -zstyle ':completion:*:approximate:::' accept 3 numeric) +zstyle ':completion:*:correct:::' max-errors 2 not-numeric +zstyle ':completion:*:approximate:::' max-errors 3 numeric) -correction will accept up to two errors. If a numeric argument is +correction will accept up to two errors. If a numeric argument is given, correction will not be performed, but correcting completion will be, and will accept as many errors as given by the numeric -argument. Without a numeric argument, first correction and then +argument. Without a numeric argument, first correction and then correcting completion will be tried, with the first one accepting two -errors and the second one accepting three errors. +errors and the second one accepting three errors. + +When tt(_correct) is called as a function, the number of errors to accept +may be given following the tt(-a) option. The argument is in the same +form a values to the tt(accept) style, all in one string. This completer function is intended to be used without the tt(_approximate) completer or, as in the example, just before -it. Using it after the tt(_approximate) completer is useless since +it. Using it after the tt(_approximate) completer is useless since tt(_approximate) will at least generate the corrected strings -generated by the tt(_correct) completer -- and probably more. -) -findex(_match) -item(tt(_match))( -This completer is intended to be used after the tt(_complete) -completer. It allows one to give patterns on the command line and -to complete all strings matching these patterns from the set of -possible completions for the context the cursor is in, without having -to set the tt(GLOB_COMPLETE) option. - -Normally this will be done by taking the pattern from the line, -inserting a `tt(*)' at the cursor position and comparing the resulting -pattern with the possible completions generated. However, if the -tt(match-original) style has a value of tt(only), no `tt(*)' will be -inserted. If tt(match-original) has any other non-empty string as its -value, this completer will first try to generate matches without, then -with a `tt(*)' inserted at the cursor position. - -The generated matches will be offered in a menucompletion unless the -tt(insert-unambiguous) style is set to `true'. In -this case menucompletion will only be started if no unambiguous string -could be generated that is at least as long as the original string. - -Note that the matcher specifications defined globally or used by the -completion functions will not be used. +generated by the tt(_correct) completer DASH()- and probably more. ) findex(_expand) item(tt(_expand))( -This completer function does not really do completion, but instead +This completer function does not really perform completion, but instead checks if the word on the command line is eligible for expansion and, -if it is, gives detailed control over how this expansion is done. When -using this, one should not use the tt(expand-or-complete) widget, but -instead use tt(complete-word), as otherwise tt(expand-or-complete) -will expand the string on the line before the completion widget is -called. Also, this completer should be called before the tt(_complete) +if it is, gives detailed control over how this expansion is done. For +this to happen, the completion system needs to be invoked with +tt(complete-word), not tt(expand-or-complete) (the default binding for +tt(TAB)), as otherwise the string will be expanded by the shell's +internal mechanism before the completion system is started. +Note also this completer should be called before the tt(_complete) completer function. -The tags used when generating expansions are tt(all-expansions) for -the string containing all possible expansions, tt(expansions) when -adding the possible expansions as single matches and tt(original) when -adding the original string from the line. In which order these strings -are generated and which of these strings are generated at all can be -controlled by using the tt(group-order) style and by modifying the -tt(tag-order) style, as usual. +The tags used when generating expansions are tt(all-expansions) for the +string containing all possible expansions, tt(expansions) when adding +the possible expansions as single matches and tt(original) when adding +the original string from the line. The order in which these strings are +generated, if at all, can be controlled by the tt(group-order) and +tt(tag-order) styles, as usual. The format string for tt(all-expansions) and for tt(expansions) may contain the sequence `tt(%o)' which will be replaced by the original string from the line. -Which kind of expansion is tried is controlled by the tt(substitute) -nad tt(glob) styles. Note that neither of these has a default value so -that they have to be set to make tt(_expand) generate any expansions -at all. +The kind of expansion to be tried is controlled by the tt(substitute), +tt(glob) and tt(subst-globs-only) styles. -In a different mode selected by the tt(completions) style, all -em(completions) generated for the string on the line are inserted. +It is also possible to call tt(_expand) as a function, in which case the +different modes may be selected with options: tt(-s) for +tt(substitute), tt(-g) for tt(glob) and tt(-o) for tt(subst-globs-only). +) +findex(_expand_alias) +item(tt(_expand_alias))( +If the word the cursor is on is an alias, it is expanded and no other +completers are called. The types of aliases which are to be expanded can +be controlled with the styles tt(regular), tt(global) and tt(disabled). + +This function is also a bindable command, see +ifzman(the section `Bindable Commands' below)\ +ifnzman(noderef(Bindable Commands)). +) +findex(_history) +item(tt(_history))( +Complete words from the shell's command history. This completer +can be controlled by the tt(remove-all-dups), and tt(sort) styles as for the +tt(_history_complete_word) bindable command, see +ifzman(the section `Bindable Commands' below)\ +ifnzman(noderef(Bindable Commands)) +and +ifzman(the section `Completion System Configuration' above)\ +ifnzman(noderef(Completion System Configuration)). +) +findex(_ignored) +item(tt(_ignored))( +The tt(ignored-patterns) style can be set to a list of patterns which are +compared against possible completions; matching ones are removed. +With this completer those matches can be reinstated, as +if no tt(ignored-patterns) style were set. The completer actually +generates its own list of matches; which completers are invoked +is determined in the same way as for the tt(_prefix) completer. +The tt(single-ignored) style is also available as described above. ) findex(_list) item(tt(_list))( -This completer allows one to delay the insertion of matches until +This completer allows the insertion of matches to be delayed until completion is attempted a second time without the word on the line -being changed. On the first attempt, only the list of matches will be -shown. Styles used are tt(condition) and tt(word), see +being changed. On the first attempt, only the list of matches will be +shown. It is affected by the styles tt(condition) and tt(word), see ifzman(the section `Completion System Configuration' above)\ ifnzman(noderef(Completion System Configuration)). ) +findex(_match) +item(tt(_match))( +This completer is intended to be used after the tt(_complete) +completer. It behaves similarly but the string on the command line may +be a pattern to match against trial completions. This gives the effect +of the tt(GLOB_COMPLETE) option. + +Normally completion will be performed by taking the pattern from the line, +inserting a `tt(*)' at the cursor position and comparing the resulting +pattern with the possible completions generated. This can be modified +with the tt(match-original) style described above. + +The generated matches will be offered in a menu completion unless the +tt(insert-unambiguous) style is set to `true'; see the description above +for other options for this style. + +Note that matcher specifications defined globally or used by the +completion functions (the styles tt(matcher-list) and tt(matcher)) will +not be used. +) +findex(_menu) +item(tt(_menu))( +This completer was written as simple example function to show how menu +completion can be enabled in shell code. However, it has the notable +effect of disabling menu selection which can be useful with +tt(_generic) based widgets. It should be used as the first completer in +the list. Note that this is independent of the setting of the +tt(MENU_COMPLETE) option and does not work with the other menu +completion widgets such as tt(reverse-menu-complete), or +tt(accept-and-menu-complete). +) findex(_oldlist) item(tt(_oldlist))( This completer controls how the standard completion widgets behave when there is an existing list of completions which may have been generated by a special completion (i.e. a separately-bound completion -command). It should appear in the list of completers before any of +command). It allows the ordinary completion keys to continue to use the +list of completions thus generated, instead of producing a new list of +ordinary contextual completions. +It should appear in the list of completers before any of the widgets which generate matches. It uses two styles: tt(old-list) and tt(old-menu), see ifzman(the section `Completion System Configuration' above)\ @@ -1805,51 +2811,52 @@ ifnzman(noderef(Completion System Configuration)). ) findex(_prefix) item(tt(_prefix))( -This completer can be used to try completion with the suffix after the -cursor ignored. I.e. the suffix will not be considered to be part of -the word to complete and hence does not need to be matched. It uses -the tt(completer) style to decide which other completers to call to -try to generate matches. If this style is unset, the completers -currently used by the whole completion are used -- except, of course, -the tt(_prefix) completer itself. Also, if this completer appears more -than once in the list of completers only those completers not -already tried by the last invocation of tt(_prefix) will be -called. The completer field used to look up styles contains the string -`tt(prefix-)var(n)', where `var(n)' is the number of the call to -tt(_prefix). +This completer can be used to try completion with the suffix (everything +after the cursor) ignored. In other words, the suffix will not be +considered to be part of the word to complete. The effect is similar +to the tt(expand-or-complete-prefix) command. + +The tt(completer) style is used to decide which other completers are to +be called to generate matches. If this style is unset, the list of +completers set for the current context is used DASH()- except, of course, the +tt(_prefix) completer itself. Furthermore, if this completer appears +more than once in the list of completers only those completers not +already tried by the last invocation of tt(_prefix) will be called. For example, consider this global tt(completer) style: -example(zstyle ':completion:*' completer _complete _prefix _correct _prefix) +example(zstyle ':completion:*' completer \ + _complete _prefix _correct _prefix:foo) -This makes the tt(_prefix) completer try normal completion with the -suffix ignored. If that doesn't generate any matches and neither does -the call to the tt(_correct) completer after it, then tt(_prefix) will -be called a second time and will now only try correction with the -suffix ignored. If you want to use tt(_prefix) as the last resort and -want it to try only normal completion, you need to call: +Here, the tt(_prefix) completer tries normal completion but ignoring the +suffix. If that doesn't generate any matches, and neither does +the call to the tt(_correct) completer after it, tt(_prefix) will +be called a second time and, now only trying correction with the +suffix ignored. On the second invocation the completer part of the +context appears as `tt(foo)'. + +To use tt(_prefix) as the last resort and try only normal completion +when it is invoked: example(zstyle ':completion:*' completer _complete ... _prefix -zstyle ':completion::prefix-1:*' completer _complete) +zstyle ':completion::prefix:*' completer _complete) -The tt(add-space) style is used, too. If it is set to `true' then +The tt(add-space) style is also respected. If it is set to `true' then tt(_prefix) will insert a space between the matches generated (if any) and the suffix. -Note that using this completer will only work if the -tt(COMPLETE_IN_WORD) option is set. Because otherwise the cursor will -be set after the word before the completion code is called and hence -there will be no suffix. +Note that this completer is only useful if the +tt(COMPLETE_IN_WORD) option is set; otherwise, the cursor will +be moved to the end of the current word before the completion code is +called and hence there will be no suffix. ) -findex(_menu) -item(tt(_menu))( -This completer is a simple example function implemented to show how -menucompletion can be done in shell code. It should be used as the -first completer and has the effect of making the code perform -menucompletion. Note that this is independent of the setting of the -tt(MENU_COMPLETE) option and does not work with the other -menucompletion widgets such as tt(reverse-menu-complete), or -tt(accept-and-menu-complete). +findex(bashcompinit) +item(tt(bashcompinit))( +This function provides compatibility with bash's programmable completion +system. When run it will define the functions, tt(compgen) and +tt(complete) which correspond to the bash builtins with the same names. +It will then be possible to use completion specifications and functions +written for bash. ) enditem() @@ -1870,7 +2877,7 @@ tt(_bash_list-choices). It exists to provide compatibility with completion bindings in bash. The last character of the binding determines what is completed: `tt(!)', command names; `tt($)', environment variables; `tt(@)', host names; `tt(/)', file names; `tt(~)' user names. In bash, the -binding preceeded by `tt(\e)' gives completion, and preceeded by `tt(^X)' +binding preceded by `tt(\e)' gives completion, and preceded by `tt(^X)' lists options. As some of these bindings clash with standard zsh bindings, only `tt(\e~)' and `tt(^X~)' are bound by default. To add the rest, the following should be added to tt(.zshrc) after tt(compinit) has @@ -1898,13 +2905,48 @@ completions as possible choices. This stores the string `tt(correct-word)' in the var(function) field of the context name and then calls the tt(_correct) completer. ) +findex(_expand_alias (^Xa)) +item(tt(_expand_alias (^Xa)))( +This function can be used as a completer and as a bindable command. +It expands the word the cursor is on if it is an alias. The types of +alias expanded can be controlled with the styles tt(regular), tt(global) +and tt(disabled). + +When used as a bindable command there is one additional feature that +can be selected by setting the tt(complete) style to `true'. In this +case, if the word is not the name of an alias, tt(_expand_alias) tries +to complete the word to a full alias name without expanding it. It +leaves the cursor directly after the completed word so that invoking +tt(_expand_alias) once more will expand the now-complete alias name. +) findex(_expand_word (^Xe)) item(tt(_expand_word (^Xe)))( Performs expansion on the current word: equivalent to the standard -tt(expand-word) command, but using the tt(_expand) completer. Before -calling it, the var(function) field is set to `tt(expand-word)'. -) -findex(_history_complete_word) (\e/) +tt(expand-word) command, but using the tt(_expand) completer. Before +calling it, the var(function) field of the context is set to +`tt(expand-word)'. +) +findex(_generic) +item(tt(_generic))( +This function is not defined as a widget and not bound by +default. However, it can be used to define a widget and will then +store the name of the widget in the var(function) field of the context +and call the completion system. This allows custom completion widgets +with their own set of style settings to be defined easily. For example, +to define a widget that performs normal completion and starts +menu selection: + +example(zle -C foo complete-word _generic +bindkey '...' foo +zstyle ':completion:foo:*' menu yes select=1) + +Note in particular that the tt(completer) style may be set for the context +in order to change the set of functions used to generate possible matches. +If tt(_generic) is called with arguments, those are passed through to +tt(_main_complete) as the list of completers in place of those defined by +the tt(completer) style. +) +findex(_history_complete_word (\e/)) item(tt(_history_complete_word) (\e/))( Complete words from the shell's command history. This uses the tt(list), tt(remove-all-dups), tt(sort), and tt(stop) styles. @@ -1916,23 +2958,13 @@ on the command line (which may be blank). If given a numeric argument var(N), complete the var(N)th most recently modified file. Note the completion, if any, is always unique. ) -findex(_next_tags) -item(tt(_next_tags))( -This allows to complete types of matches that are not immediately -offered because of the setting of the tt(tag-order) style. After a -normal completion was tried, invoking this command makes the matches -for the next tag (or set of tags) be used. Repeatedly invoking this -command makes the following tags be used. To be able to complete the -matches selected by tt(_next_tags), the tt(completer) style should -contain tt(_next_tags) as its first string. With that, the normal key -binding (normally tt(TAB)) can be used to complete the matches shown -after the call to tt(_next_tags). - -Normally, this command is not bound to a key. To invoke it with, say -`tt(^Xn)', one would use: - -example(zle -C _next_tags complete-word _next_tags -bindkey '^Xn' _next_tags) +findex(_next_tags (^Xn)) +item(tt(_next_tags) (^Xn))( +This command alters the set of matches used to that for the next tag, or +set of tags, either as given by the tt(tag-order) style or as set by +default; these matches would otherwise not be available. +Successive invocations of the command cycle through all possible sets of +tags. ) findex(_read_comp (^X^R)) item(tt(_read_comp (^X^R)))( @@ -1944,7 +2976,7 @@ completions. Unambiguous parts of the function name will be completed automatically (normal completion is not available at this point) until a space is typed. -Any other string will be passed as a set of arguments to +Second, any other string will be passed as a set of arguments to tt(compadd) and should hence be an expression specifying what should be completed. @@ -1958,11 +2990,36 @@ Once a string has been read, the next call to tt(_read_comp) will use the existing string instead of reading a new one. To force a new string to be read, call tt(_read_comp) with a numeric argument. ) +findex(_complete_debug (^X?)) +item(tt(_complete_debug (^X?)))( +This widget performs ordinary completion, but captures in a temporary file +a trace of the shell commands executed by the completion system. Each +completion attempt gets its own file. A command to view each of these +files is pushed onto the editor buffer stack. +) findex(_complete_help (^Xh)) item(tt(_complete_help (^Xh)))( -This widget displays information about the context names, including +This widget displays information about the context names, the tags, and the completion functions used -when completing at the current cursor position. +when completing at the current cursor position. If given a numeric +argument other than tt(1) (as in `tt(ESC-2 ^Xh)'), then the styles +used and the contexts for which they are used will be shown, too. + +Note that the information about styles may be incomplete; it depends on the +information available from the completion functions called, which in turn +is determined by the user's own styles and other settings. +) +findex(_complete_tag (^Xt)) +item(tt(_complete_tag (^Xt)))( +This widget completes symbol tags created by the tt(etags) or tt(ctags) +programmes (note there is no connection with the completion system's tags) +stored in a file tt(TAGS), in the format used by tt(etags), or tt(tags), in the +format created by tt(ctags). It will look back up the path hierarchy for +the first occurrence of either file; if both exist, the file tt(TAGS) is +preferred. You can specify the full path to a tt(TAGS) or tt(tags) file by +setting the parameter tt($TAGSFILE) or tt($tagsfile) respectively. +The corresponding completion tags used are tt(etags) and tt(vtags), after +emacs and vi respectively. ) enditem() @@ -1971,1005 +3028,1358 @@ sect(Utility Functions) cindex(completion system, utility functions) Descriptions follow for utility functions that may be -useful when writing completion functions. Most of these reside in the -tt(Core) subdirectory except where noted. Like the example +useful when writing completion functions. If functions are installed in +subdirectories, most of these reside in the +tt(Base) subdirectory. Like the example functions for commands in the distribution, the utility functions -generating matches all follow the convention of returning zero if they +generating matches all follow the convention of returning status zero if they generated completions and non-zero if no matching completions could be added. -When writing completion functions or other ZLE widgets that call -completion, it might be interesting to know about two more features -offered by the tt(_main_complete) function. The arrays -tt(compprefuncs) and tt(comppostfuncs) may be set to contain names of -functions that are to be called immediately before or after completion -has been tried. The functions will only be called once, unless they -put themselves into the array again. +Two more features are offered by the tt(_main_complete) function. The +arrays tt(compprefuncs) and tt(comppostfuncs) may contain +names of functions that are to be called immediately before or after +completion has been tried. A function will only be called once unless +it explicitly reinserts itself into the array. startitem() -findex(_funcall) -item(tt(_funcall) var(return) var(name) [ var(args) ... ])( -If a function var(name) exists, it is called with the arguments -var(args). Unless it is the empty string or a single hyphen, -var(return) is taken as the name of a parameter and the return status -from the called function is stored in it. -The return value of tt(_funcall) itself is zero if the function -var(name) exists and was called and non-zero otherwise. -) -findex(_compalso) -item(tt(_compalso) var(names) ...)( -This function looks up the definitions for the context and command -names given as arguments and calls the handler functions for them if -there is a definition (given with the tt(compdef) function). For -example, the function completing inside subscripts might use -`tt(_compalso -math-)' to include the completions generated for -mathematical environments. -) -findex(_call) -item(tt(_call) var(tag) var(string) ...)( -This function is used in places where a command is called and the user -should have the possibility to override the default for calling this -command. It looks up the tt(command) style with the supplied -var(tag). If the style is set, its value is used as the command to -execute. - -In any case, the var(strings) from the call to tt(_call) or from the -style are concatenated with spaces between them and the resulting -string is evaluated. The return value is the return value of the -command called. -) -findex(_normal) -item(tt(_normal))( -This function is used for normal command completion. If -completion is attempted on the first word, command names are -completed. Otherwise, the arguments are completed by calling the -functions defined for this command, including those functions defined -for patterns matching the command name. This function can also be -called by other completion functions if they have to complete a range -of words as a separate command. For example, the function to complete after -the pre-command specifiers such as tt(nohup) removes the first word from -the tt(words) array, decrements the tt(CURRENT) parameter, then calls this -function. - -When calling a function defined for a pattern, this function also -checks if the parameter tt(_compskip) is set and uses the value in the -same way it is used after calling the completion function for the -tt(-first-) context. With this -one can write a pattern completion function that keeps other functions -from being tried simply by setting this parameter to any value. -) -findex(_description) -item(tt(_description) [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(specs) ... ])( -This function tests some styles for the var(tag) and and stores -options usable for tt(compadd) in the array with the given var(name) -which guarantee that the matches are generated as requested by the -user. The styles tested are: tt(format) (which is first tested for the -given tag and then for the tt(descriptions) tag if that isn't -defined), tt(hidden) and tt(group-name) (the last two are tested only -for the tag given as the first argument). This function also calls the -tt(_setup) function which tests some more styles. - -The format string from the style (if any) will be modified so that the -sequence `tt(%d)' is replaced by the var(descr) given as the third -argument. If tt(_description) is called with more than three -arguments, these var(specs) should be of the form -`var(char)tt(:)var(str)' and every appearance of `tt(%)var(char)' in -the format string will be replaced by var(string). - -The options placed in the array will also make sure that the matches -are placed in a separate group, depending on the value of the -tt(group-name) style. Normally a sorted group will be used for this -(with the `tt(-J)' option), but if a option starting with `tt(-V)', -`tt(-J)', `tt(-1)', or `tt(-2)' is given, that option will be included -in the array, so that it is possible to make the group unsorted by -giving the option `tt(-V)', `tt(-1V)', or `tt(-2V)'. - -In most cases, this function will be used like this: - -example(local expl -_description expl files file -compadd "$expl[@]" - "$files[@]") -) -findex(_message) -item(tt(_message) [ -r ] var(descr))( -The var(descr) is used like the third -argument to the tt(_description) function. However, the resulting -string will always be shown whether or not matches were -generated. This is useful to display help texts in places where no -completions can be generated automatically. - -This function also uses the tt(format) style for the tt(messages) tag in -preference to the tt(format) style for the tt(descriptions) tag. The -latter is used only if the former is unset. - -If the tt(-r) option is given, no style is used and the var(descr) is -used literally as the string to display. This is only used in cases -where that string is taken from some pre-processed argument list -containing an expanded description. -) -findex(_setup) -item(tt(_setup) var(tag))( -This function expects a tag as its argument and sets up the special -parameters used by the completion system appropriately for the tag, -using styles such as tt(list-colors) and tt(last-prompt). - -Note that this function is called automatically from tt(_description) -so that one normally doesn't have to call it explicitly. -) -findex(_tags) -item(tt(_tags) [ tt(-C) var(name) [ var(tags) ... ] ])( -If called with arguments, these are taken as the names of the tags for -the types of matches the calling completion function can generate in -the current context. These tags are stored internally and sorted by -using the tt(tag-order) style. Following calls to this function -without arguments from the same function will then select the first, -second, etc. set of tags requested by the user. To test if a certain -tag should be tried, the tt(_requested) function has to be called (see -below). - -The return value is zero if at least one of the tags is requested and -non-zero otherwise. - -This function also accepts the tt(-C) option followed by a -var(name). This name is temporarily (i.e. not visible outside -tt(_tags)) stored in the argument field of the context name in the -tt(curcontext) parameter. This allows to make tt(_tags) use a more -specific context name without having to change and reset the -tt(curcontext) parameter (which would otherwise have the same effect). -) -findex(_try) -item(tt(_try) [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(options) ... ])( -This function should be called repeatedly to generate the tag -aliases. On each call it will check if another tag alias is to be used -and, if there is at least one, zero is returned. If no more tag -aliases are to be used, a non-zero status is returned. - -The tt(-12JV) options and the first three arguments are given to the -tt(_desciption) function using the alias tag instead of the first -argument is appropriate. The var(options) given after the var(descr) -should be other options to be used for tt(compadd) or whatever -function is to be called to add the matches. tt(_try) will store these -var(options) in the parameter whose var(name) is given as the second -argument. This is done in such a way that the description given by the -user to the tt(tag-order) style is prefered over the one given to -tt(_try). - -Note that this function must not be called without a previous call to -tt(_tags), tt(_wanted) or tt(_requested) because it uses the alias -tags for the current tag found by these functions. - -A normal use of this function for the alias tags for the tag tt(foo) -looks like this: - -example(local expl ret=1 -... -_wanted foo || return 1 -... -while _try foo expl '...'; do - compadd "$expl[@]" ... && ret=0 -done -... -return ret -) -) -findex(_loop) -item(tt(_loop) [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(command) var(args) ... ])( -This is a convenient interface to the tt(_try) function, implementing -the loop shown in the example above. The var(command) is the one that -should be called to generate the matches. The options stored in the -parameter var(name) will automatically be inserted into the var(args) -given to the var(command). Normally, they are put directly after the -var(command), but if one of the var(args) is a single hyphen, they are -inserted directly before that. If the hyphen is the last argument, -that will be removed from the argument list before the var(command) is -called. This allows to use tt(_loop) in almost all cases where the -matches can be generated by a single call to the tt(compadd) builtin -command or by a call to one of the utility functions. +findex(_all_labels) +item(tt(_all_labels) [ tt(-x) ] [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(command) var(args) ... ])( +This is a convenient interface to the tt(_next_label) function below, +implementing the loop shown in the tt(_next_label) example. The +var(command) and its arguments are called to generate the matches. The +options stored in the parameter var(name) will automatically be inserted +into the var(args) passed to the var(command). Normally, they are put +directly after the var(command), but if one of the var(args) is a single +hyphen, they are inserted directly before that. If the hyphen is the last +argument, it will be removed from the argument list before the +var(command) is called. This allows tt(_all_labels) to be used in almost all +cases where the matches can be generated by a single call to the +tt(compadd) builtin command or by a call to one of the utility functions. For example: example(local expl ... -_wanted foo || return 1 -... -_loop foo expl '...' compadd ... - $matches) +if _requested foo; then + ... + _all_labels foo expl '...' compadd ... - $matches +fi) Will complete the strings from the tt(matches) parameter, using tt(compadd) with additional options which will take precedence over -those generated by tt(_loop). -) -findex(_requested) -item(tt(_requested) [ tt(-12VJ) ] var(tag) [ var(name) var(descr) [ var(command) var(args) ... ] ])( -A function that uses tt(_tags) to register tags and then calls it to -loop over the requested sets of tags should call this function to -check if a certain tag is currently requested. This normally has to be -done in a loop such as: - -example(_tags foo bar baz -while _tags; do - if _requested foo; then - ... - fi - ... # test other tags - ... # exit loop if matches were generated -done) - -So, the first argument for tt(_requested) is used as the name of a tag -and if that tag is currently requested, the return value is zero (and -non-zero otherwise). - -If the var(name) and the var(descr) are given, tt(_requested) calls the -tt(_description) function with these arguments, including the options. - -If the var(command) is given, the tt(_loop) function will be called -immediatly with the same arguments. - -This is often useful to do both the testing of the tag, -getting the description for the matches and adding the matches at -once. E.g.: - -example(local expl ret=1 -_tags foo bar baz -while _tags; do - _requested foo expl 'description' \ - compadd foobar foobaz && ret=0 - ... - (( ret )) || break -done) -) -findex(_wanted) -item(tt(_wanted) [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(specs) ... ])( -In many contexts only one type of matches can be generated but even -then it should be tested if the tag representing those matches is -requested by the user. This function makes that easier. - -Like tt(_requested) it gets arguments as for tt(_description). -With the var(tag) it calls tt(_tags) and if that returns zero -(i.e. the var(tag) is requested by the user) it calls tt(_description). So, -if you want to offer only one tag and immediatly want to use the -description built, you can just do: - -example(_wanted tag expl 'description' \ - compadd matches...) +those generated by tt(_all_labels). ) findex(_alternative) -item(tt(_alternative) [ tt(-C) var(name) ] var(specs) ...)( -This function is useful if you offer multiple tags and building the -matches for them is easy enough. It basically implements a loop like -the one described for the tt(_tags) function above above. - -The tags to use and what to do if the tags are requested are described -using the var(specs) which are of the form: -`var(tag)tt(:)var(descr)tt(:)var(action)'. The var(tag)s are offered -using tt(_tags) and if the tag is requested, the var(action) is -executed with the given var(descr) (description). The var(action)s -supported are those used by the tt(_arguments) function (described -below), without the `tt(->)var(state)' form. - -For example, the var(action) may be a simple function call. With that -one could do: - -example(_alternative \ - 'users:user:_users' \ +item(tt(_alternative) [ tt(-C) var(name) ] var(spec) ...)( +This function is useful in simple cases where multiple tags are available. +Essentially it implements a loop like the one described for the tt(_tags) +function below. + +The tags to use and the action to perform if a tag is requested are +described using the var(spec)s which are of the form: +`var(tag)tt(:)var(descr)tt(:)var(action)'. The var(tag)s are offered using +tt(_tags) and if the tag is requested, the var(action) is executed with the +given description var(descr). The var(action)s are those accepted +by the tt(_arguments) function (described below), excluding the +`tt(->)var(state)' and `tt(=)var(...)' forms. + +For example, the var(action) may be a simple function call: + +example(_alternative \ + 'users:user:_users' \ 'hosts:host:_hosts') -to offer usernames and hostnames as possible matches (which are -generated by the tt(_users) and tt(_hosts) functions respectively). +offers usernames and hostnames as possible matches, +generated by the tt(_users) and tt(_hosts) functions respectively. -Note that, like tt(_arguments) this will also use tt(_loop) to execute -the actions, so one doesn't need to call that explicitly unless -another tag is to be used, for example in a function called from -tt(_alternative). +Like tt(_arguments), this functions uses tt(_all_labels) to execute +the actions, which will loop over all sets of tags. Special handling is +only required if there is an additional valid tag, for example inside a +function called from tt(_alternative). Like tt(_tags) this function supports the tt(-C) option to give a different name for the argument context field. ) -findex(_describe) -item(tt(_describe) var(descr) var(name1) [ var(name2) ] var(opts) ... tt(-)tt(-) ...)( -This function can be used to add options or values with descriptions -as matches. The var(descr) is taken as a string to display above -the matches if the tt(format) style for the tt(descriptions) tag is set. - -After this one or two names of arrays followed by options to give -to tt(compadd) must be given. The first array contains the possible -completions with their descriptions (with the description separated -by a colon from the completion string). If the second array is given, -it should have the same number of elements as the first one and these -elements are added as possible completions instead of the strings from -the first array. In any case, however, the completion list will show -the strings from the first array. - -Any number of array/option sequences may be given separated by -`tt(-)tt(-)'. This allows one to display matches together that need -to be added with different options for tt(compadd). - -Before the first argument, the option `tt(-o)' may be given. It says -that the matches added are option names. This will make tt(_describe) -use the tt(prefix-hidden), tt(prefix-needed) and tt(verbose) styles -to find out if the strings should be added at all and if the -descriptions should be shown. Without the `tt(-o)' option, only the -tt(verbose) style is used. - -tt(_describe) uses the tt(_loop) function to generate the matches, so -that one doesn't need to put it into a loop over the tag aliases. -) -findex(_multi_parts) -item(tt(_multi_parts) var(sep) var(array))( -This function gets two arguments: a separator character and an -array. As usual, the var(array) may be either the -name of an array parameter or a literal array in the form -`tt(LPAR()foo bar)tt(RPAR())' (i.e. a list of words separated by white -space in parentheses). With these arguments, this function will -complete to strings from the array where the parts separated by the -separator character are completed independently. For example, the -tt(_tar) function from the distribution caches the pathnames from the -tar file in an array and then calls this function to complete these -names in the way normal filenames are completed by the -tt(_path_files) function. - -If given the tt(-i) option a single match left will be accepted -immediatly even if that means that additional parts for which no -separators were on the line are to be inserted. When completing from a -fixed set of possible completions which are really words, this is -often the expected behaviour. But if tt(_multi_parts) should behave -like completing pathnames, the tt(-i) option should not be used. - -Like other utility functions, this function accepts the `tt(-V)', -`tt(-J)', `tt(-1)', `tt(-2)', `tt(-n)', `tt(-f)', `tt(-X)', `tt(-M)', `tt(-P)', -`tt(-S)', `tt(-r)', `tt(-R)', and `tt(-q)' options and passes them to -the tt(compadd) builtin. -) -findex(_sep_parts) -item(tt(_sep_parts))( -This function gets as arguments alternating arrays and separators. -The arrays specify completions for parts of strings to be separated by the -separators. The arrays may be the names of array parameters or -a quoted list of words in parentheses. For example, with the array -`tt(hosts=(ftp news))' the call `tt(_sep_parts '(foo bar)' @ hosts)' will -complete the string `tt(f)' to `tt(foo)' and the string `tt(b@n)' to -`tt(bar@news)'. +findex(_arguments) +item(tt(_arguments) [ tt(-swWACRS) ] [ tt(-O) var(name) ] [ tt(-M) var(matchspec) ] [ tt(:) ] var(spec) ...)( +This function can be used to give a complete specification for +completion for a command whose arguments follow standard UNIX option and +argument conventions. The following forms specify individual sets of +options and arguments; to avoid ambiguity, these may be separated from the +options to tt(_arguments) itself by a single colon. -This function passes the `tt(-V)', `tt(-J)', `tt(-1)', `tt(-2)', -`tt(-n)', `tt(-X)', `tt(-M)', `tt(-P)', `tt(-S)', `tt(-r)', `tt(-R)', -and `tt(-q)' options and their arguments to the tt(compadd) builtin -used to add the matches. +startitem() +xitem(var(n)tt(:)var(message)tt(:)var(action)) +item(var(n)tt(::)var(message)tt(:)var(action))( +This describes the var(n)'th normal argument. The var(message) will be +printed above the matches generated and the var(action) indicates what can +be completed in this position (see below). If there are two colons +before the var(message) the argument is optional. If the +var(message) contains only white space, nothing will be printed above +the matches unless the action adds an explanation string itself. +) +xitem(tt(:)var(message)tt(:)var(action)) +item(tt(::)var(message)tt(:)var(action))( +Similar, but describes the em(next) argument, whatever number that +happens to be. If all arguments are specified in this form in the +correct order the numbers are unnecessary. +) +xitem(tt(*:)var(message)tt(:)var(action)) +xitem(tt(*::)var(message)tt(:)var(action)) +item(tt(*:::)var(message)tt(:)var(action))( +This describes how arguments (usually non-option arguments, those not +beginning with tt(-) or tt(+)) are to be completed when neither +of the first two forms was provided. Any number of arguments can +be completed in this fashion. + +With two colons before the var(message), the tt(words) special array and +the tt(CURRENT) special parameter are modified to refer only to the +normal arguments when the var(action) is executed or evaluated. With +three colons before the var(message) they are modified to refer only to +the normal arguments covered by this description. ) -findex(_path_files) -findex(_files) -item(tt(_path_files) and tt(_files))( -The function tt(_path_files) is used throughout the shell code -to complete filenames. It allows completion of partial paths. For -example, the string `tt(/u/i/s/sig)' may be completed to -`tt(/usr/include/sys/signal.h)'. The option `tt(-/)' specifies that -only directories should be completed. The option `tt(-g) var(pattern)' -says that only files matching the var(pattern) should be completed, -and the `tt(-f)' option, which is the default, completes all -filenames. The option `tt(-W) var(paths)' may be used to specify path -prefixes that are to be prepended to the string from the line to -generate the filenames but that should not be inserted in the line or -shown in a completion listing. The var(paths) may be the name of an -array parameter, a literal list of paths enclosed in parentheses or -an absolute pathname. -Additionally, the `tt(-F)' -option from the tt(compadd) builtin is supported, giving direct control -over which filenames should be ignored. If no such option is given, -the tt(ignored-suffixes) style is used. - -The function tt(_files) uses the tt(file-patterns) style and calls -tt(_path_files) with all the arguments it was passed except for tt(-g) -and tt(-/). These two options are used depending on the setting of the -tt(file-patterns) style. - -These functions also accept the `tt(-J)', `tt(-V)', `tt(-1)', -`tt(-2)', `tt(-n)', `tt(-X)', `tt(-M)', `tt(-P)', `tt(-S)', `tt(-q)', -`tt(-r)', and `tt(-R)' options from the tt(compadd) builtin. +xitem(var(optspec)) +item(var(optspec):var(...))( +This describes an option. The colon indicates handling for one or more +arguments to the option; if it is not present, the option is assumed to +take no arguments. + +By default, options are multi-character name, one `tt(-)var(word)' per +option. With tt(-s), options may be single characters, with more than +one option per word, although words starting with two hyphens, such as +`tt(-)tt(-prefix)', are still considered complete option names. This is +suitable for standard GNU options. + +The combination of tt(-s) with tt(-w) allows single-letter options to be +combined in a single word even if one or more of the options take +arguments. For example, if tt(-a) takes an argument, with no +tt(-s) `tt(-ab)' is considered as a single (unhandled) option; with +tt(-s) tt(-ab) is an option with the argument `tt(b)'; with both tt(-s) +and tt(-w), tt(-ab) may be the option tt(-a) and the option(-b) with +arguments still to come. + +The option tt(-W) takes this a stage further: it is possible to +complete single-letter options even after an argument that occurs in the +same word. However, it depends on the action performed whether options +will really be completed at this point. For more control, use a +utility function like tt(_guard) as part of the action. + +The following forms are available for the initial var(optspec), whether +or not the option has arguments. -Finally, the tt(_path_files) function uses the styles tt(expand), -tt(cursor) and tt(special-dirs) with the tt(paths) tag. -) -findex(_parameters) -item(tt(_parameters))( -This should be used to complete parameter names. All arguments are -passed unchanged to the tt(compadd) builtin. +startitem() +item(tt(*)var(optspec))( +Here var(optspec) is one of the remaining forms below. This indicates +the following var(optspec) may be repeated. Otherwise if the +corresponding option is already present on the command line to the left +of the cursor it will not be offered again. +) +xitem(tt(-)var(optname)) +item(tt(+)var(optname))( +In the simplest form the var(optspec) is just the option name beginning +with a minus or a plus sign, such as `tt(-foo)'. The first argument for +the option (if any) must follow as a em(separate) word directly after the +option. + +Either of `tt(-+)var(optname)' and `tt(+-)var(optname)' can be used to +specify that tt(-)var(optname) and tt(+)var(optname) are both valid. + +In all the remaining forms, the leading `tt(-)' may be replaced by or +paired with `tt(+)' in this way. +) +item(tt(-)var(optname)tt(-))( +The first argument of the option must come directly after the option name +em(in the same word). For example, `tt(-foo-:)var(...)' specifies that +the completed option and argument will look like `tt(-foo)var(arg)'. +) +item(tt(-)var(optname)tt(+))( +The first argument may appear immediately after var(optname) in the same +word, or may appear as a separate word after the option. For example, +`tt(-foo+:)var(...)' specifies that the completed option and argument +will look like either `tt(-foo)var(arg)' or `tt(-foo) var(arg)'. +) +item(tt(-)var(optname)tt(=))( +The argument may appear as the next word, or in same word as the option +name provided that it is separated from it by an equals sign, for +example `tt(-foo=)var(arg)' or `tt(-foo) var(arg)'. +) +item(tt(-)var(optname)tt(=-))( +The argument to the option must appear after an equals sign in the same +word, and may not be given in the next argument. +) +item(var(optspec)tt([)var(explanation)tt(]))( +An explanation string may be appended to any of the preceding forms of +var(optspec) by enclosing it in brackets, as in `tt(-q[query operation])'. + +The tt(verbose) style is used to decide whether the explanation strings +are displayed with the option in a completion listing. + +If no bracketed explanation string is given but the tt(auto-description) +style is set and only one argument is described for this var(optspec), the +value of the style is displayed, with any appearance of the sequence +`tt(%d)' in it replaced by the var(message) of the first var(optarg) +that follows the var(optspec); see below. ) -findex(_options) -item(tt(_options))( -This can be used to complete option names. It uses a matching -specification that ignores a leading `tt(no)', ignores underscores and -allows the user to type upper-case letters, making them match their -lower-case counterparts. All arguments passed to this function are -propagated unchanged to the tt(compadd) builtin. -) -findex(_set_options) -findex(_unset_options) -item(tt(_set_options) and tt(_unset_options))( -These functions complete only set or unset options, with the same -matching specification used in the tt(_options) function. +enditem() -Note that you need to uncomment a few lines in the tt(_main_complete) -function for these functions to work properly. The lines in question -are used to store the option settings in effect before the completion -widget locally sets the options it needs. -) -findex(_arguments) -item(tt(_arguments) var(specs) ...)( -This function resides in the tt(Base) subdirectory of the example -completion system because it is not used by the core system. +It is possible for options with a literal `PLUS()' or `tt(=)' to +appear, but that character must be quoted, for example `tt(-\+)'. -This function can be used to complete words on the line by simply -describing the arguments the command on the line gets. The description -is given as arguments to this function, with each var(spec) describing -one option or normal argument of the command. The descriptions -understood are: +Each var(optarg) following an var(optspec) must take one of the +following forms: startitem() -item(var(n)tt(:)var(message)tt(:)var(action))( -This describes the var(n)'th normal argument. The var(message) will be -printed above the matches generated and the var(action) says what can -be completed in this position (see below). If there are two colons -before the var(message), this describes an optional argument. -) -item(tt(:)var(message)tt(:)var(action))( -Like the previous one, but describing the em(next) argument. I.e. if -you want to describe all arguments a command can get, you can leave -out the numbers in the description and just use this form to describe -them one after another in the order they have to appear on the line. -) -item(tt(*:)var(message)tt(:)var(action))( -This describes how arguments are to be completed for which no -description with one of the first two forms was given. This also means -that any number of arguments can be completed. - -If there are two colons before the var(message) (as in -`tt(*::)var(message)tt(:)var(action)') the tt(words) special array and -the tt(CURRENT) special parameter will be restricted to only the -normal arguments when the var(action) is executed or evaluated. With -three colons before the var(message) they will be restricted to only -the normal arguments covered by this description. +xitem(tt(:)var(message)tt(:)var(action)) +item(tt(::)var(message)tt(:)var(action))( +An argument to the option; var(message) and var(action) are treated as +for ordinary arguments. In the first form, the argument is mandatory, +and in the second form it is optional. + +This group may be repeated for options which take multiple arguments. +In other words, +tt(:)var(message1)tt(:)var(action1)tt(:)var(message2)tt(:)var(action2) +specifies that the option takes two arguments. +) +xitem(tt(:*)var(pattern)tt(:)var(message)tt(:)var(action)) +xitem(tt(:*)var(pattern)tt(::)var(message)tt(:)var(action)) +item(tt(:*)var(pattern)tt(:::)var(message)tt(:)var(action))( +This describes multiple arguments. Only the last var(optarg) for +an option taking multiple arguments may be +given in this form. If the var(pattern) is empty (i.e., tt(:*:)), all +the remaining words on the line are to be completed as described by the +var(action); otherwise, all the words up to a word matching the +var(pattern) are to be completed using the var(action). + +Multiple colons are treated as for the `tt(*:)var(...)' forms for +ordinary arguments: when the var(message) is preceded by two colons, +the tt(words) special array and the tt(CURRENT) special parameter are +modified during the execution or evaluation of the var(action) to refer +only to the words after the option. When preceded by three colons, they +are modified to refer only to the words covered by this description. ) -item(var(opt-spec)[var(description) ...])( -This describes an option and (if at least one var(description) is -given) the arguments that have to come after the option. If no -var(description) is given, this will only be used to offer the option -name as a possible completion in the right places. Each -var(description) has to be of the form -`tt(:)var(message)tt(:)var(action)' or -`tt(::)var(message)tt(:)var(action)', where the second form describes -an optional argument and the first one describes a mandatory argument. -The last description may also be of the form -`tt(:*:)var(message)tt(:)var(action)' or -`tt(:*)var(pattern)tt(:)var(message)tt(:)var(action)'. These describe -multiple arguments. In the first form all following words on the line -are to be completed as described by the var(action), in the second -form all words up to a word matching the given var(pattern) are to be -completed using the var(action). The `tt(*)' or the var(pattern) may -also be separated from the var(message) by two or three colons. With -two colons the tt(words) special array and the tt(CURRENT) special -parameter are modified to refer only to the words after the option -(with two colons) or to the words covered by this description (with -three colons) during the execution or evaluation of the -var(action). Note that only one such `tt(:*)'-specification is useful -and no other argument specification may be given after it. - -In the simplest form the var(opt-spec) is just the option name -beginning with a minus or a plus sign, such as `tt(-foo)'. If the -command accepts the option both with a leading minus and a plus sign, -one can use either tt(-+foo) or tt(+-foo) to define both options at -once. In this -case, the first argument for the option (if any) has to come as a -separate word directly after the option and the option may appear only -once on the line (and if it is already on the line, the option name -will not be offered as a possible completion again). If the first -argument for the option has to come directly after the option name -em(in the same word), a minus sign should be added to the end of the -var(opt-spec), as in `tt(-foo-)'. If the first argument may be given -in one string with the option name, but may also be given as a -separate argument after the option, a plus sign should be used -instead. If the argument may be given as the next string or in same -string as the option name but separated from it by an equal sign, a -`tt(=)' should be used instead of the minus or plus sign. - -Note that this and the shortcut syntax with a leading tt(-+) or tt(+-) -means that for options like tt(-+) the second character has to be -quoted with a backslash. - -If the option may be given more than once, a star -(`tt(*)') has to be added in front of the var(opt-spec). - -Finally, the var(opt-spec) may contain a explanation string. This is -given in brackets at the end, as in `tt(-q[query operation])'. The -tt(verbose) style is used to decide if these -explanation strings should be printed when options are listed. If no -explanation string is given but the tt(auto-describe) style is -set and only one argument is described for this var(opt-spec), the -option will be described by the value of the style with any appearance -of the sequence `tt(%d)' in it replaced by the description for the -first argument. +enditem() ) enditem() -Every var(spec) may also contain a list of option names and argument -numbers with which the option or argument described is mutually -exclusive. Such a list is given in parentheses at the beginning, as in -`tt((-two -three 1)-one:...)' or `tt((-foo):...)'. In the first -example, the options `tt(-two)' and `tt(-three)' and the first -argument will not be offered as possible completions if the option -`tt(-one)' is on the line. Also, the list may contain a single star as -one of its elements to specify that the description for the rest -arguments should not be used and it may contain a colon to specify -that the descriptions for all normal (non-option-) arguments should -not be used. +Any literal colon in an var(optname), var(message), or var(action) +must be preceded by a backslash, `tt(\:)'. + +Each of the forms above may be preceded by a list in parentheses +of option names and argument numbers. If the given option is on +the command line, the options and arguments indicated in parentheses +will not be offered. For example, +`tt((-two -three 1)-one:...)' completes the option `tt(-one)'; if this +appears on the command line, the options tt(-two) and tt(-three) and the +first ordinary argument will not be completed after it. +`tt((-foo):)var(...)' specifies an ordinary argument completion; +tt(-foo) will not be completed if that argument is already present. + +Other items may appear in the list of excluded options to indicate +various other items that should not be applied when the current +specification is matched: a single star (tt(*)) for the rest arguments +(i.e. a specification of the form `tt(*:...)'); a colon (tt(:)) +for all normal (non-option-) arguments; and a hyphen (tt(-)) for all +options. For example, if `tt((*))' appears before an option and the +option appears on the command line, the list of remaining arguments +(those shown in the above table beginning with `tt(*:)') will not be +completed. + +To aid in reuse of specifications, it is possible to precede any of the +forms above with `tt(!)'; then the form will no longer be completed, +although if the option or argument appears on the command line they will +be skipped as normal. The main use for this is when the arguments are +given by an array, and tt(_arguments) is called repeatedly for more +specific contexts: on the first call `tt(_arguments $global_options)' is +used, and on subsequent calls `tt(_arguments !$^global_options)'. + +In each of the forms above the var(action) determines how +completions should be generated. Except for the `tt(->)var(string)' +form below, the var(action) will be executed by calling the +tt(_all_labels) function to process all tag labels. No special handling +of tags is needed unless a function call introduces a new one. + +The forms for var(action) are as follows. + +startitem() +item(tt( ) (single unquoted space))( +This is useful where an argument is required but it is not possible or +desirable to generate matches for it. The +var(message) will be displayed but no completions listed. Note +that even in this case the colon at the end of the var(message) is +needed; it may only be omitted when neither a var(message) +nor an var(action) is given. +) +item(tt(LPAR())var(item1) var(item2) var(...)tt(RPAR()))( +One of a list of possible matches, for example: + +example(tt(:foo:LPAR()foo bar baz)tt(RPAR())) +) +item(tt(((var(item1)\:var(desc1) var(...)))))( +Similar to the above, but with descriptions for each possible match. +Note the backslash before the colon. For example, + +example(tt(:foo:LPAR()LPAR()a\:bar b\:baz)tt(RPAR()RPAR())) + +The matches will be listed together with their descriptions if the +tt(description) style is set with the tt(values) tag in the context. +) +item(tt(->)var(string))( +vindex(context, use of) +vindex(line, use of) +vindex(opt_args, use of) +In this form, tt(_arguments) processes the arguments and options and then +returns control to the calling function with parameters set to indicate the +state of processing; the calling function then makes its own arrangements +for generating completions. For example, functions that implement a state +machine can use this type of action. + +Where tt(_arguments) encounters a `tt(->)var(string)', it will strip +all leading and trailing whitespace from var(string) and set the array +tt(state) to the set of all var(strings)s for which an action is to be +performed. + +By default and in common with all other well behaved completion +functions, _arguments returns status zero if it was able to add matches and +non-zero otherwise. However, if the tt(-R) option is given, +tt(_arguments) will instead return a status of 300 to indicate that +tt($state) is to be handled. + +In addition to tt($state), tt(_arguments) also sets the global +parameters `tt(context)', `tt(line)' and `tt(opt_args)' as described +below, and does not reset any changes made to the special parameters +such as tt(PREFIX) and tt(words). This gives the calling function the +choice of resetting these parameters or propagating changes in them. -In each of the cases above, the var(action) says how the possible -completions should be generated. In cases where only one of a fixed -set of strings can be completed, these strings can directly be given as -a list in parentheses, as in `tt(:foo:(foo bar baz))'. Such a list in -doubled parentheses, as in `tt(:foo:((a\:bar b\:baz)))' should contain -strings consisting of the string to complete followed by a colon -(which needs to be preceded by a backslash) and a description. The -matches will be listed together with their descriptions if the -tt(description) style for the tt(values) tag is set. - -An var(action) of the form `tt(->)var(string)' is used by functions -that implement a state machine. In this case, the `var(string)' (with -all leading and trailing spaces and tabs removed) will be stored in -the global parameter tt(state) and the function returns with a return -value of 300 (to make it distinguishable from other return values) -after setting the global `tt(context)', `tt(line)' and `tt(opt_args)' -parameters as described below and without resetting any changes made -to the special parameters such as tt(PREFIX) and tt(words). Note that -this means that a function calling tt(_arguments) with at least one -action containing such a `tt(->)var(string)' has to declare -appropriate local parameters as in: +A function calling tt(_arguments) with at least +one action containing a `tt(->)var(string)' therefore must declare +appropriate local parameters: example(local context state line typeset -A opt_args) -This will ensure that tt(_arguments) does not create unused global -parameters. - -A string in -braces will be evaluated to generate the matches and if the -var(action) does not begin with an opening parentheses or brace, it -will be split into separate words and executed. If the var(action) -starts with a space, this list of words will be invoked unchanged, -otherwise it will be invoked with some extra strings placed after the -first word which can be given as arguments to the tt(compadd) builtin -command and which make sure that the var(message) given -in the description will be shown above the matches. These arguments -are taken from the array parameter tt(expl) which will be set up -before executing the var(action) and hence may be used in it (normally -in an expansion like `tt($expl[@])'). - -Except for the `tt(->)var(string)' form, the var(action) will be -executed by calling the tt(_loop) function to process all tag aliases, -so one doesn't need to call that explicitly unless another tag is to -be used, for example in a function called in the var(action). - -In places where no sensible matches can be generated, the action -should consist of only a space. This will make the var(message) be -displayed but no possible completions listed. Note that even in this -case the colon at the end of the var(message) is needed. The only case -where it can be left is when neither a var(message), nor a var(action) -is given. - -To include a colon in the option name, the var(message) or the -var(action), it has to be preceded by a backslash. - -During the evaluation or execution of the action the array `tt(line)' +to avoid tt(_arguments) from altering the global environment. +) +item(tt({)var(eval-string)tt(}))( +vindex(expl, use of) +A string in braces is evaluated as shell code to generate matches. If the +var(eval-string) itself does not begin with an opening parenthesis or +brace it is split into separate words before execution. +) +item(tt(= )var(action))( +If the var(action) starts with `tt(= )' (an equals sign followed by a +space), tt(_arguments) will insert the contents of the var(argument) +field of the current context as the new first element in the tt(words) +special array and increment the value of the tt(CURRENT) special +parameter. This has the effect of inserting a dummy word onto the +completion command line while not changing the point at which completion is +taking place. + +This is most useful with one of the specifiers that restrict the words on +the command line on which the var(action) is to operate (the two- and +three-colon forms above). One particular use is when an var(action) itself +causes tt(_arguments) on a restricted range; it is necessary to use this +trick to insert an appropriate command name into the range for the second +call to tt(_arguments) to be able to parse the line. +) +xitem( var(word...)) +item(var(word...))( +This covers all forms other than those above. If the var(action) +starts with a space, the remaining list of words will be invoked unchanged. + +Otherwise it will be invoked with some extra strings placed after the +first word; these are to be passed down as options to the tt(compadd) +builtin. They ensure that the state specified by tt(_arguments), in +particular the descriptions of options and arguments, is correctly passed +to the completion command. These additional arguments +are taken from the array parameter `tt(expl)'; this will be set up +before executing the var(action) and hence may be referred to inside it, +typically in an expansion of the form `tt($expl[@])' which preserves empty +elements of the array. +) +enditem() + +During the performance of the action the array `tt(line)' will be set to the command name and normal arguments from the command -line, i.e. to the words from the command line excluding all options -and their arguments. These are stored in the associative array -`tt(opt_args)', using the option names as keys and their arguments as -the values. For options that have more than one argument these are -given as one string, separated by colons. All colons in the original -arguments are preceded with backslashes. The parameter `tt(context)' -will be set to the automatically created context name. This is either -a string of the form `var(-opt)tt(-)var(n)' for the var(n)'th argument -of the option var(-opt), or a string of the form `tt(argument-)var(n)' -for the var(n)'th argument (for rest arguments the var(n) is the -string `tt(rest)'). For example, when completing the argument of the tt(-o) -option, the name is `tt(-o-1)' and for the second normal (non-option-) -argument it is `tt(argument-2)'. - -Also, during the evaluation of the var(action), the context name in -the tt(curcontext) parameter will be changed by appending the same -string that is stored in the tt(context) parameter. - -Normally the option names are taken as multi-character names and a -word from the line is considered to contain only one option (or -none). By giving the tt(-s) option to this function (before the first -description), options are considered to be one-character options and the -strings from the line may contain more than one such option -letter. However, strings beginning with two hyphens (like -`tt(-)tt(-prefix)') are still considered to contain only one option -name. This allows the use of the `tt(-s)' option to describe -single-letter options together with such long option names. - -Another option supported is `tt(-O) var(name)'. The var(name) will be -taken as the name of an array and its elements will be given to -functions called to generate matches when executing the -var(actions). For example, this allows one to give options for the -tt(compadd) builtin that should be used for all var(action)s. - -Also, the tt(-M) option followed by a string may be given before the -first description. The string will be used as the match specification -when completing option names and values instead of the default -`tt(r:|[_-]=* r:|=*)'. - -Finally, the option tt(-C) can be given to make tt(_arguments) modify -the tt(curcontext) parameter when a action of the form -`tt(->)var(state)' is used. This parameter is used to keep track of -the current context and in this case it (and not the parameter -tt(context) as explained above) has to be made local to make sure that -calling functions don't use the modified value. Also, the local -version of tt(curcontext) has to be initialised with the old value as -in: +line, i.e. the words from the command line excluding all options +and their arguments. Options are stored in the associative array +`tt(opt_args)' with option names as keys and their arguments as +the values. For options that have more than one argument these are +given as one string, separated by colons. All colons in the original +arguments are preceded with backslashes. + +The parameter `tt(context)' is set when returning to the calling function +to perform an action of the form `tt(->)var(string)'. It is set to an +array of elements corresponding to the elements of tt($state). Each +element is a suitable name for the argument field of the context: either a +string of the form `tt(option)var(-opt)tt(-)var(n)' for the var(n)'th +argument of the option var(-opt), or a string of the form +`tt(argument-)var(n)' for the var(n)'th argument. For `rest' arguments, +that is those in the list at the end not handled by position, var(n) is the +string `tt(rest)'. For example, when completing the argument of the tt(-o) +option, the name is `tt(option-o-1)', while for the second normal +(non-option-) argument it is `tt(argument-2)'. + +Furthermore, during the evaluation of the var(action) the context name in +the tt(curcontext) parameter is altered to append the same string that is +stored in the tt(context) parameter. + +It is possible to specify multiple sets of options and +arguments with the sets separated by single hyphens. The specifications +before the first hyphen (if any) are shared by all the remaining sets. +The first word in every other set provides a name for the +set which may appear in exclusion lists in specifications, +either alone or before one of the possible values described above. +In the second case a `tt(-)' should appear between this name and the +remainder. + +For example: + +example(_arguments \ + -a \ + - set1 \ + -c \ + - set2 \ + -d \ + ':arg:(x2 y2)') + +This defines two sets. When the command line contains the option +`tt(-c)', the `tt(-d)' option and the argument will not be considered +possible completions. When it contains `tt(-d)' or an argument, the +option `tt(-c)' will not be considered. However, after `tt(-a)' +both sets will still be considered valid. + +If the name given for one of the mutually exclusive sets is of the form +`tt(LPAR())var(name)tt(RPAR())' then only one value from each set will ever +be completed; more formally, all specifications are mutually +exclusive to all other specifications in the same set. This is +useful for defining multiple sets of options which are mutually +exclusive and in which the options are aliases for each other. For +example: + +example(_arguments \ + -a -b \ + - '(compress)' \ + {-c,--compress}'[compress]' \ + - '(uncompress)' \ + {-d,--decompress}'[decompress]') + +As the completion code has to parse the command line separately for each +set this form of argument is slow and should only be used when necessary. +A useful alternative is often an option specification with rest-arguments +(as in `tt(-foo:*:...)'); here the option tt(-foo) swallows up all +remaining arguments as described by the var(optarg) definitions. + +The options tt(-S) and tt(-A) are available to simplify the specifications +for commands with standard option parsing. With tt(-S), no option will be +completed after a `tt(-)tt(-)' appearing on its own on the line; this +argument will otherwise be ignored; hence in the line + +example(foobar -a -- -b) + +the `tt(-a)' is considered an option but the `tt(-b)' is considered an +argument, while the `tt(-)tt(-)' is considered to be neither. + +With tt(-A), no options will be completed after the first non-option +argument on the line. The tt(-A) must be followed by a pattern matching +all strings which are not to be taken as arguments. For example, to make +tt(_arguments) stop completing options after the first normal argument, but +ignoring all strings starting with a hyphen even if they are not described +by one of the var(optspec)s, the form is `tt(-A "-*")'. + +The option `tt(-O) var(name)' specifies the name of an array whose elements +will be passed as arguments to functions called to execute var(actions). +For example, this can be used to pass the same set of options for the +tt(compadd) builtin to all var(action)s. + +The option `tt(-M) var(spec)' sets a match specification to use to +completion option names and values. It must appear before the first +argument specification. The default is `tt(r:|[_-]=* r:|=*)': this allows +partial word completion after `tt(_)' and `tt(-)', for example `-f-b' +can be completed to `tt(-foo-bar)'. + +The option tt(-C) tells tt(_arguments) to modify +the tt(curcontext) parameter for an action of the form +`tt(->)var(state)'. This is the standard parameter used to keep track of +the current context. Here it (and not the tt(context) array) should be +made local to the calling function +to avoid passing back the modified value and should be initialised to the +current value at the start of the function: example(local curcontext="$curcontext") -The function can also be made to automatically complete long options -for commands that support the `tt(-)tt(-help)' option as, for example, -most of the GNU commands do. For this, the string `tt(-)tt(-)' must be -given as one argument and if it is, the command from the line is -invoked with the `tt(-)tt(-help)' option and its output is parsed to find -possible option names. Note that this means that you should be careful -to make sure that this feature is not used for a command that does not -support this option. - -For such automatically found options that get an argument after a -`tt(=)', the function also tries -to automatically find out what should be completed as the argument. -The possible completions for option-arguments can be described with -the arguments after the `tt(-)tt(-)' (which are not used as described -above). Each argument contains one description of the form -`var(pattern)tt(:)var(message)tt(:)var(action)'. The var(message) and -the var(action) have the same format as for the normal option -descriptions described above. The var(action) will be executed to -complete arguments of options whose description in the output of the -command from the line with the `tt(-)tt(-help)' option matches the -var(pattern). For example: +This is useful where it is not possible for multiple states to be valid +together. + +The option `tt(-)tt(-)' allows tt(_arguments) to work out the names of long +options that support the `tt(-)tt(-help)' option which is standard in many +GNU commands. The command word is called with the argument +`tt(-)tt(-help)' and the output examined for option names. Clearly, it can +be dangerous to pass this to commands which may not support this option as +the behaviour of the command is unspecified. + +In addition to options, `tt(_arguments -)tt(-)' will try to deduce the +types of arguments available for options when the form +`tt(-)tt(-)var(opt)=var(val)' is valid. It is also possible to provide +hints by examining the help text of the command and adding specifiers of +the form `var(pattern)tt(:)var(message)tt(:)var(action)'; note that normal +tt(_arguments) specifiers are not used. The var(pattern) is matched +against the help text for an option, and if it matches the var(message) and +var(action) are used as for other argument specifiers. For example: example(_arguments -- '*\*:toggle:(yes no)' \ '*=FILE*:file:_files' \ - '*=DIR*:directory:_files -/') + '*=DIR*:directory:_files -/' \ + '*=PATH*:directory:_files -/') Here, `tt(yes)' and `tt(no)' will be completed as the argument of -options whose description ends in a star, file names for options that -contain the substring `tt(=FILE)' in the description, and paths for -options whose description contains `tt(=DIR)'. In fact, the last two -patterns are not needed since this function always completes files -for option descriptions containing `tt(=FILE)' and paths for option -descriptions that contain `tt(=DIR)' or `tt(=PATH)'. These builtin -patterns can be overridden by patterns given as arguments, however. +options whose description ends in a star; file names will be completed for +options that contain the substring `tt(=FILE)' in the description; and +directories will be completed for options whose description contains +`tt(=DIR)' or `tt(=PATH)'. The last three are in fact the default and so +need not be given explicitly, although it is possible to override the use +of these patterns. A typical help text which uses this feature is: + +example( -C, --directory=DIR change to directory DIR) + +so that the above specifications will cause directories to be completed +after `tt(-)tt(-directory)', though not after `tt(-C)'. Note also that tt(_arguments) tries to find out automatically if the -argument for an option is optional. If it fails to automatically -detect this, the colon before the var(message) can be doubled to tell -it about this as described for the normal option descriptions above. - -The option `tt(-i) var(patterns)' (which must be given after the -`tt(-)tt(-)') can be used to give patterns for options which should not be -completed. The patterns can be given as the name of an array parameter -or as a literal list in parentheses. E.g. `tt(-i -"LPAR()-)tt(-(en|dis)able-FEATURE*RPAR()")' will make the options -`tt(-)tt(-enable-FEATURE)' and `tt(-)tt(-disable-FEATURE)' be ignored. The -option `tt(-s) var(pairs)' (again, after the `tt(-)tt(-)') can be used to -describe option aliases. Each var(pair) consists of a pattern and a -replacement. E.g. some tt(configure)-scripts describe options only as -`tt(-)tt(-enable-foo)', but also accept `tt(-)tt(-disable-foo)'. To allow -completion of the second form, one would use `tt(-s "LPAR()#-)tt(-enable- --)tt(-disable-RPAR()")'. +argument for an option is optional. This can be specified explicitly by +doubling the colon before the var(message). -Example: +If the var(pattern) ends in `tt((-))', this will removed from the +pattern and the var(action) will be used only directly after the +`tt(=)', not in the next word. This is the behaviour of a normal +specification defined with the form `tt(=-)'. + +The `tt(_arguments -)tt(-)' can be followed by the option `tt(-i) +var(patterns)' to give patterns for options which are not to be +completed. The patterns can be given as the name of an array parameter +or as a literal list in parentheses. For example, + +example(_arguments -- -i \ + "LPAR()-tt(-(en|dis)able-FEATURE*RPAR()")) + +will cause completion to ignore the options +`tt(-)tt(-enable-FEATURE)' and `tt(-)tt(-disable-FEATURE)' (this example is +useful with GNU tt(configure)). + +The `tt(_arguments -)tt(-)' form can also be followed by the option `tt(-s) +var(pair)' to describe option aliases. Each var(pair) consists of a +pattern and a replacement. For example, some tt(configure)-scripts +describe options only as `tt(-)tt(-enable-foo)', but also accept +`tt(-)tt(-disable-foo)'. To allow completion of the second form: + +example(_arguments -- -s "LPAR()#-tt(-enable- -)tt(-disable-RPAR()")) + +Here is a more general example of the use of tt(_arguments): example(_arguments '-l+:left border:' \ '-format:paper size:(letter A4)' \ '*-copy:output file:_files::resolution:(300 600)' \ - ':postscript file:_files -g *.(ps|eps)' \ + ':postscript file:_files -g \*.\(ps\|eps\)' \ '*:page number:') This describes three options: `tt(-l)', `tt(-format)', and -`tt(-copy)'. The first one gets one argument described as `var(left +`tt(-copy)'. The first takes one argument described as `var(left border)' for which no completion will be offered because of the empty -action. The argument may come directly after the `tt(-l)' or it may be -given as the next word on the line. The `tt(-format)' option gets one -argument (in the next word) described as `var(paper size)' for which -only the strings `tt(letter)' and `tt(A4)' will be completed. The -`tt(-copy)' option differs from the first two in that it may appear -more than once on the command line and in that it accepts two -arguments. The first one is mandatory and will be completed as a -filename. The second one is optional (because of the second colon -before the description `var(resolution)') and will be completed from -the strings `tt(300)' and `tt(600)'. +action. Its argument may come directly after the `tt(-l)' or it may be +given as the next word on the line. + +The `tt(-format)' option takes one +argument in the next word, described as `var(paper size)' for which +only the strings `tt(letter)' and `tt(A4)' will be completed. + +The `tt(-copy)' option may appear more than once on the command line and +takes two arguments. The first is mandatory and will be completed as a +filename. The second is optional (because of the second colon before +the description `var(resolution)') and will be completed from the strings +`tt(300)' and `tt(600)'. The last two descriptions say what should be completed as -arguments. The first one describes the first argument as a +arguments. The first describes the first argument as a `var(postscript file)' and makes files ending in `tt(ps)' or `tt(eps)' -be completed. The last description says that all other arguments are -`var(page numbers)' but does not give possible completions. +be completed. The last description gives all other arguments the +description `var(page numbers)' but does not offer completions. ) -findex(_values) -item(tt(_values) var(specs) ...)( -This is used to complete values (strings) and their arguments or -lists of such values. +findex(_cache_invalid) +item(tt(_cache_invalid) var(cache_identifier))( +This function returns status zero if the completions cache corresponding to +the given cache identifier needs rebuilding. It determines this by +looking up the tt(cache-policy) style for the current context. +This should provide a function name which is run with the full path to the +relevant cache file as the only argument. + +Example: + +example(_example_caching_policy () { + # rebuild if cache is more than a week old + oldp=( "$1"(Nmw+1) ) + (( $#oldp )) +}) +) +findex(_call_function) +item(tt(_call_function) var(return) var(name) [ var(args) ... ])( +If a function var(name) exists, it is called with the arguments +var(args). The var(return) argument gives the name of a parameter in which +the return status from the function var(name); if var(return) is empty or a +single hyphen it is ignored. -If the first argument is the option `tt(-O) var(name)', this will be -used in the same way as by the tt(_arguments) function. I.e. the -elements of the var(name) array will be given to calls to tt(compadd) -and when executing an action. +The return status of tt(_call_function) itself is zero if the function +var(name) exists and was called and non-zero otherwise. +) +findex(_call_program) +item(tt(_call_program) var(tag) var(string) ...)( +This function provides a mechanism for the user to override the use of an +external command. It looks up the tt(command) style with the supplied +var(tag). If the style is set, its value is used as the command to +execute. The var(string)s from the call to tt(_call_program), or from the +style if set, are concatenated with spaces between them and the resulting +string is evaluated. The return status is the return status of the command +called. +) +findex(_combination) +item(tt(_combination) [ tt(-s) var(pattern) ] var(tag) var(style) var(spec) ... var(field) var(opts) ...)( +This function is used to complete combinations of values, for example +pairs of hostnames and usernames. The var(style) argument gives the style +which defines the pairs; it is looked up in a context with the var(tag) +specified. + +The style name consists of field names separated by hyphens, for example +`tt(users-hosts-ports)'. For each field for a value is already known, a +var(spec) of the form `var(field)tt(=)var(pattern)' is given. For example, +if the command line so far specifies a user `tt(pws)', the argument +`tt(users=pws)' should appear. + +The next argument with no equals sign is taken as the name of the field +for which completions should be generated (presumably not one of the +var(field)s for which the value is known). + +The matches generated will be taken from the value of the style. These +should contain the possible values for the combinations in the appropriate +order (users, hosts, ports in the example above). The different fields +the values for the different fields are separated by colons. This +can be altered with the option tt(-s) to tt(_combination) which specifies a +pattern. Typically this is a character class, as for example +`tt(-s "[:@]")' in the case of the tt(users-hosts) style. Each +`var(field)tt(=)var(pattern)' specification restricts the +completions which apply to elements of the style with appropriately +matching fields. + +If no style with the given name is defined for the given tag, +or if none of the strings in style's value match, but a +function name of the required field preceded by an +underscore is defined, that function will be called to generate the +matches. For example, if there is no `tt(users-hosts-ports)' or no +matching hostname when a host is required, the function `tt(_hosts)' will +automatically be called. -Otherwise, if the first argument (or the first argument after the -`tt(-O) var(name)' option if that is used) is the option `tt(-s)', the -next argument is used as the character that separates multiple values. +If the same name is used for more than one field, in both the +`var(field)tt(=)var(pattern)' and the argument that gives the name of the +field to be completed, the number of the field (starting with one) may +be given after the fieldname, separated from it by a colon. -The first argument (after the options and separator character if they -are given) is used as a string to print as a description before -listing the values. +All arguments after the required field name are passed to +tt(compadd) when generating matches from the style value, or to +the functions for the fields if they are called. +) +findex(_describe) +item(tt(_describe) [ tt(-oO) | tt(-t) var(tag) ] var(descr) var(name1) [ var(name2) ] var(opts) ... tt(-)tt(-) ...)( +This function associates completions with descriptions. +Multiple groups separated by tt(-)tt(-) can be supplied, potentially with +different completion options var(opts). + +The var(descr) is taken as a string to display above the matches if the +tt(format) style for the tt(descriptions) tag is set. This is followed by +one or two names of arrays followed by options to pass to tt(compadd). The +first array contains the possible completions with their descriptions in +the form `var(completion)tt(:)var(description)'. If a second array is +given, it should have the same number of elements as the first; in this +case the corresponding elements are added as possible completions instead +of the var(completion) strings from the first array. The completion list +will retain the descriptions from the first array. Finally, a set of +completion options can appear. + +If the option `tt(-o)' appears before the first argument, the matches added +will be treated as names of command options (N.B. not shell options), +typically following a `tt(-)', `tt(-)tt(-)' or `tt(+)' on the command +line. In this case tt(_describe) uses the tt(prefix-hidden), +tt(prefix-needed) and tt(verbose) styles to find out if the strings should +be added as completions and if the descriptions should be shown. Without +the `tt(-o)' option, only the tt(verbose) style is used to decide how +descriptions are shown. If `tt(-O)' is used instead of `tt(-O)', command +options are completed as above but tt(_describe) will not handle the +tt(prefix-needed) style. + +With the tt(-t) option a var(tag) can be specified. The default is +`tt(values)' or, if the tt(-o) option is given, `tt(options)'. + +If selected by the tt(list-grouped) style, strings with the same +description will appear together in the list. + +tt(_describe) uses the tt(_all_labels) function to generate the matches, so +it does not need to appear inside a loop over tag labels. +) +findex(_description) +item(tt(_description) [ tt(-x) ] [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(spec) ... ])( +This function is not to be confused with the previous one; it is used as +a helper function for creating options to tt(compadd). It is buried +inside many of the higher level completion functions and so often does +not need to be called directly. + +The styles listed below are tested in the current context using the +given var(tag). The resulting options for tt(compadd) are put into the +array named var(name) (this is traditionally `tt(expl)', but this +convention is not enforced). The description for the corresponding set +of matches is passed to the function in var(descr). + +The styles tested are: tt(format), tt(hidden), tt(matcher), +tt(ignored-patterns) and tt(group-name). The tt(format) style is first +tested for the given var(tag) and then for the tt(descriptions) tag if +no value was found, while the remainder are only tested for the tag +given as the first argument. The function also calls tt(_setup) +which tests some more styles. + +The string returned by the tt(format) style (if any) will be modified so +that the sequence `tt(%d)' is replaced by the var(descr) given as the third +argument without any leading or trailing white space. If, after +removing the white space, the var(descr) is the empty string, the format +style will not be used and the options put into the var(name) array will +not contain an explanation string to be displayed above the matches. + +If tt(_description) is called with more than three arguments, +the additional var(spec)s should be of the form `var(char)tt(:)var(str)'. +These supply escape sequence replacements for the tt(format) style: +every appearance of `tt(%)var(char)' will be +replaced by var(string). + +If the tt(-x) option is given, the description will be passed to +tt(compadd) using the tt(-x) option instead of the default tt(-X). This +means that the description will be displayed even if there are no +corresponding matches. + +The options placed in the array var(name) take account of the +tt(group-name) style, so matches are placed in a separate group where +necessary. The group normally has its elements sorted (by passing the +option tt(-J) to tt(compadd)), but if an option starting with `tt(-V)', +`tt(-J)', `tt(-1)', or `tt(-2)' is passed to tt(_description), that +option will be included in the array. Hence it is possible for the +completion group to be unsorted by giving the option `tt(-V)', +`tt(-1V)', or `tt(-2V)'. + +In most cases, the function will be used like this: -All other arguments describe the possible values and their -arguments in the same format used for the description of options by -the tt(_arguments) function (see above). The only difference is that -there is no required minus or plus sign at the beginning and that -values can have only one argument. +example(local expl +_description files expl file +compadd "$expl[@]" - "$files[@]") -Example: +Note the use of the parameter tt(expl), the hyphen, and the list of +matches. Almost all calls to tt(compadd) within the completion system use +a similar format; this ensures that user-specified styles are correctly +passed down to the builtins which implement the internals of completion. +) +findex(_dispatch) +item(tt(_dispatch) var(context string ...))( +This sets the current context to var(context) and looks for completion +functions to handle this context by hunting through the list of command +names or special contexts (as described above for tt(compdef)) +given as var(string ...). The first completion function to be defined +for one of the contexts in the list is used to generate matches. +Typically, the last var(string) is tt(-default-) to cause the function +for default completion to be used as a fallback. + +The function sets the parameter +tt($service) to the var(string) being tried, and sets +the var(context/command) field (the fourth) of the tt($curcontext) +parameter to the var(context) given as the first argument. +) +findex(_files) +item(tt(_files))( +The function tt(_files) calls tt(_path_files) with all the arguments it +was passed except for tt(-g) and tt(-/). The use of these two options +depends on the setting of the tt(file-patterns) style. + +This function accepts the full set of options allowed by +tt(_path_files), described below. +) +findex(_gnu_generic) +item(tt(_gnu_generic))( +This function is a simple wrapper around the tt(_arguments) function +described above. It can be used to determine automatically the long +options understood by commands that produce a list when passed the +option `tt(-)tt(-help)'. It is intended to be used as a top-level +completion function in its own right. For example, to enable option +completion for the commands tt(foo) and tt(bar), use + +example(compdef _gnu_generic foo bar) + +after the call to tt(compinit). + +The completion system as supplied is conservative in its use of this +function, since it is important to be sure the command understands the +option `tt(-)tt(-help)'. +) +findex(_guard) +item(tt(_guard) [ var(options) ] var(pattern descr))( +This function is intended to be used in the var(action) for +the specifications passed to tt(_arguments) and similar functions. It +returns immediately with a non-zero return status if +the string to be completed does not match the var(pattern). If the +pattern matches, the var(descr) is displayed; the function then returns +status zero if the word to complete is not empty, non-zero otherwise. + +The var(pattern) may be preceded by any of the options understood by +tt(compadd) that are passed down from tt(_description), namely tt(-M), +tt(-J), tt(-V), tt(-1), tt(-2), tt(-n), tt(-F) and tt(-X). All of these +options will be ignored. This fits in conveniently with the +argument-passing conventions of actions for tt(_arguments). + +As an example, consider a command taking the options tt(-n) and +tt(-none), where tt(-n) must be followed by a numeric value in the +same word. By using: + +example(_arguments '-n-: :_guard "[0-9]#" "numeric value"' '-none') + +tt(_arguments) can be made to both display the message `tt(numeric +value)' and complete options after `tt(-n<TAB>)'. If the `tt(-n)' is +already followed by one or more digits (the pattern passed to +tt(_guard)) only the message will be displayed; if the `tt(-n)' is +followed by another character, only options are completed. +) +findex(_message) +xitem(tt(_message) [ tt(-r12) ] [ tt(-VJ) var(group) ] var(descr)) +item(tt(_message -e) [ var(tag) ] var(descr))( +The var(descr) is used in the same way as the third +argument to the tt(_description) function, except that the resulting +string will always be shown whether or not matches were +generated. This is useful for displaying a help message in places where +no completions can be generated. -example(_values -s , 'description' \ - '*foo[bar]' \ - '(two)*one[number]:first count:' \ - 'two[another number]::second count:(1 2 3)') +The tt(format) style is examined with the tt(messages) tag to find a +message; the usual tag, tt(descriptions), is used only if the style is +not set with the former. -This describes three possible values: `tt(foo)', `tt(one)', and -`tt(two)'. The first one is described as `tt(bar)', gets no argument -and may appear more than once. The second one is described as -`tt(number)', may appear more than once, and gets one mandatory -argument described as `tt(first count)' for which no action is -specified so that it will not be completed automatically. The -`tt((two))' at the beginning says that if the value `tt(one)' is on -the line, the value `tt(two)' will not be considered to be a possible -completion anymore. Finally, the last value (`tt(two)') is described -as `tt(another number)' and gets an optional argument decribed as -`tt(second count)' which will be completed from the strings `tt(1)', -`tt(2)', and `tt(3)'. The tt(_values) function will complete lists of -these values separated by commas. - -Like tt(_arguments) this function temporarily adds another context -name component to the current context name while executing the -var(action). Here this name is just the name of the value for which -the argument is completed. - -To decide if the descriptions for the values (not those for the -arguments) should be printed, the tt(verbose) is used. - -One last difference to tt(_arguments) is that this function uses the -associative array -tt(val_args) to report values and their arguments (but otherwise this -is the same as the tt(opt_args) association used by -tt(_arguments)). This also means that the function calling tt(_values) -should declare the tt(state), tt(line), tt(context) and tt(val_args) -parameters as in: +If the tt(-r) option is given, no style is used; the var(descr) is +taken literally as the string to display. This is most useful +when the var(descr) comes from a pre-processed argument list +which already contains an expanded description. -example(local context state line -typeset -A val_args) +The tt(-12VJ) options and the var(group) are passed to tt(compadd) and +hence determine the group the message string is added to. -when using an action of the form `tt(->)var(string)'. With this -function the tt(context) parameter will be set to the name of the -value whose argument is to be completed. +The second form gives a description for completions with the tag +var(tag) to be shown even if there are no matches for that tag. The tag +can be omitted and if so the tag is taken from the parameter +tt($curtag); this is maintained by the completion system and so is +usually correct. +) +findex(_multi_parts) +item(tt(_multi_parts) var(sep) var(array))( +The argument var(sep) is a separator character. +The var(array) may be either the +name of an array parameter or a literal array in the form +`tt(LPAR()foo bar)tt(RPAR())', a parenthesised list of words separated +by whitespace. The possible completions are the +strings from the array. However, each chunk delimited by var(sep) will be +completed separately. For example, the tt(_tar) function uses +`tt(_multi_parts) tt(/) var(patharray)' to complete partial file paths +from the given array of complete file paths. + +The tt(-i) option causes tt(_multi_parts) to insert a unique match even +if that requires multiple separators to be inserted. This is not usually +the expected behaviour with filenames, but certain other types of +completion, for example those with a fixed set of possibilities, may be +more suited to this form. -Like tt(_arguments), tt(_values) also supports the tt(-C) option in -which case you have to make the parameter tt(curcontext) local instead -of tt(context) (as described above). +Like other utility functions, this function accepts the `tt(-V)', +`tt(-J)', `tt(-1)', `tt(-2)', `tt(-n)', `tt(-f)', `tt(-X)', `tt(-M)', +`tt(-P)', `tt(-S)', `tt(-r)', `tt(-R)', and `tt(-q)' options and passes +them to the tt(compadd) builtin. +) +findex(_next_label) +item(tt(_next_label) [ tt(-x) ] [ tt(-12VJ) ] var(tag) var(name) var(descr) [ var(options) ... ])( +This function is used to implement the loop over different tag +labels for a particular tag as described above for the tt(tag-order) +style. On each call it checks to see if there are any more tag labels; if +there is it returns status zero, otherwise non-zero. +As this function requires a current tag to be set, it must always follow +a call to tt(_tags) or tt(_requested). + +The tt(-x12VJ) options and the first three arguments are passed to the +tt(_description) function. Where appropriate the var(tag) will be +replaced by a tag label in this call. Any description given in +the tt(tag-order) style is preferred to the var(descr) passed to +tt(_next_label). + +The var(options) given after the var(descr) +are set in the parameter given by var(name), and hence are to be passed +to tt(compadd) or whatever function is called to add the matches. + +Here is a typical use of this function for the tag tt(foo). The call to +tt(_requested) determines if tag tt(foo) is required at all; the loop +over tt(_next_label) handles any labels defined for the tag in the +tt(tag-order) style. + +example(local expl ret=1 +... +if _requested foo; then + ... + while _next_label foo expl '...'; do + compadd "$expl[@]" ... && ret=0 + done + ... +fi +return ret) +) +findex(_normal) +item(tt(_normal))( +This is the standard function called to handle completion outside +any special var(-context-). It is called both to complete the command +word and also the arguments for a command. In the second case, +tt(_normal) looks for a special completion for that command, and if +there is none it uses the completion for the tt(-default-) context. + +A second use is to reexamine the command line specified by the tt($words) +array and the tt($CURRENT) parameter after those have been modified. +For example, the function tt(_precommand), which +completes after pre-command specifiers such as tt(nohup), removes the +first word from the tt(words) array, decrements the tt(CURRENT) parameter, +then calls tt(_normal) again. The effect is that `tt(nohup) var(cmd ...)' +is treated in the same way as `var(cmd ...)'. + +If the command name matches one of the patterns given by one of the +options tt(-p) or tt(-P) to tt(compdef), the corresponding completion +function is called and then the parameter tt(_compskip) is +checked. If it is set completion is terminated at that point even if +no matches have been found. This is the same effect as in the +tt(-first-) context. +) +findex(_options) +item(tt(_options))( +This can be used to complete the names of shell options. It provides a +matcher specification that ignores a leading `tt(no)', ignores +underscores and allows upper-case letters to +match their lower-case counterparts (for example, `tt(glob)', +`tt(noglob)', `tt(NO_GLOB)' are all completed). Any arguments +are propagated to the tt(compadd) builtin. +) +findex(_options_set) +findex(_options_unset) +item(tt(_options_set) and tt(_options_unset))( +These functions complete only set or unset options, with the same +matching specification used in the tt(_options) function. + +Note that you need to uncomment a few lines in the tt(_main_complete) +function for these functions to work properly. The lines in question +are used to store the option settings in effect before the completion +widget locally sets the options it needs. Hence these functions are not +generally used by the completion system. +) +findex(_parameters) +item(tt(_parameters))( +This is used to complete the names of shell parameters. + +The option `tt(-g var(pattern))' limits the completion to parameters +whose type matches the var(pattern). The type of a parameter is that +shown by `tt(print ${(t))var(param)tt(})', hence judicious use of +`tt(*)' in var(pattern) is probably necessary. + +All other arguments are passed to the tt(compadd) builtin. +) +findex(_path_files) +item(tt(_path_files))( +This function is used throughout the completion system +to complete filenames. It allows completion of partial paths. For +example, the string `tt(/u/i/s/sig)' may be completed to +`tt(/usr/include/sys/signal.h)'. + +The options accepted by both tt(_path_files) and tt(_files) are: + +startitem() +item(tt(-f))( +Complete all filenames. This is the default. +) +item(tt(-/))( +Specifies that only directories should be completed. +) +item(tt(-g) var(pattern))( +Specifies that only files matching the var(pattern) should be completed. +) +item(tt(-W) var(paths))( +Specifies path prefixes that are to be prepended to the string from the +command line to generate the filenames but that should not be inserted +as completions nor shown in completion listings. Here, var(paths) may be +the name of an array parameter, a literal list of paths enclosed in +parentheses or an absolute pathname. +) +item(tt(-F) var(ignored-files))( +This behaves as for the corresponding option to the tt(compadd) builtin. +It gives direct control over which +filenames should be ignored. If the option is not present, the +tt(ignored-patterns) style is used. +) +enditem() + +Both tt(_path_files) and tt(_files) also accept the following options +which are passed to tt(compadd): `tt(-J)', `tt(-V)', +`tt(-1)', `tt(-2)', `tt(-n)', `tt(-X)', `tt(-M)', `tt(-P)', `tt(-S)', +`tt(-q)', `tt(-r)', and `tt(-R)'. + +Finally, the tt(_path_files) function uses the styles tt(expand), +tt(ambiguous), tt(special-dirs), tt(list-suffixes) and tt(file-sort) +described above. +) +findex(_pick_variant) +item(tt(_pick_variant [ tt(-c) var(command) ] [ tt(-r) var(name) ] var(label)tt(=)var(pattern) ... var(label) [ var(args) ... ]))( +This function is used to resolve situations where a single command name +requires more than one type of handling, either because it +has more than one variant or because there is a name clash between two +different commands. + +The command to run is taken from the first element of the array +tt(words) unless this is overridden by the option tt(-c). This command +is run and its output is compared with a series of patterns. Arguments +to be passed to the command can be specified at the end after all the +other arguments. The patterns to try in order are given by the arguments +var(label)tt(=)var(pattern); if the output of `var(command) var(args) +tt(...)' contains var(pattern), then tt(label) is selected as the label +for the command variant. If none of the patterns match, the final +command label is selected and status 1 is returned. + +If the `tt(-r) var(name)' is given, the var(label) picked is stored in +the parameter named var(name). + +The results are also cached in the var(_cmd_variant) associative array +indexed by the name of the command run. ) findex(_regex_arguments) -item(tt(_regex_arguments) var(name) var(specs) ...)( -This function is a compiler to generate a completion function. The -first argument specifies the name of a generated function while the -remaining arguments specify a completion as a set of regular -expressions with actions. The generated function has the structure of a -finite-state machine whose state corresponds to the state (i.e. the -context) of the completion. This state machine uses a command line, -which comes from concatentating the tt(words) array up to the current -cursor position using null characters as a separator with no extra -quotation. This is analysed and at the end the appropriate action is -executed. +item(tt(_regex_arguments) var(name) var(spec) ...)( +This function generates a completion function var(name) which matches +the specifications var(spec) tt(...), a set of regular expressions as +described below. After running tt(_regex_arguments), the function +var(name) should be called at the appropriate point. +The pattern to be matched is given by the contents of +the tt(words) array up to the current cursor position joined together +with null characters; no quotation is applied. + +The arguments are grouped as sets of alternatives separated by `tt(|)', +which are tried one after the other until one matches. Each alternative +consists of a one or more specifications which are tried left to right, +with each pattern matched being stripped in turn from the command line +being tested, until all of the group succeeds or until one fails; in the +latter case, the next alternative is tried. This structure can be +repeated to arbitrary depth by using parentheses; matching proceeds from +inside to outside. + +COMMENT(I think I've got this wrong, but I can't think what else it +could mean. Actually, it still doesn't mean very much.)\ +A special procedure is applied if no test succeeds but the remaining +command line string contains no null character (implying the remaining +word is the one for which completions are to be generated). The +completion target is restricted to the remaining word and any +var(action)s for the corresponding patterns are executed. In this case, +nothing is stripped from the command line string. The order of +evaluation of the var(action)s can be determined by the tt(tag-order) +style; the various formats supported by tt(_alternative) can be used +in var(action). The var(descr) is used for setting up the array +parameter tt(expl). Specification arguments take one of following forms, in which metacharacters such as `tt(LPAR())', `tt(RPAR())', `tt(#)' and `tt(|)' should be quoted. startitem() -item(tt(/)var(pattern)tt(/) [tt(%)var(lookahead)tt(%)] [tt(-)var(guard)] [tt(:)var(action)])( -This is a primitive element, corresponding to one -state of the compiled state machine. The state is entered if the pattern -`tt((#b)LPAR()(#B))var(pattern)tt(RPAR()(#B))var(lookahead)tt(*)' matches -the command line string. If it is matched, `var(guard)' is evaluated and -its return status is examined; if this is successful, the state is entered, -else the test fails and other candidates are tried. The var(pattern) -string `tt([])' is guaranteed never to match. - -If the test succeeds and the state is entered, the left part of the -command line string matched as `var(pattern)' is removed and the -next state is tried, proceeding from inside to outside and from left to -right. - -If no test succeeds and the remaining command line string contains no null -character, the completion target is restricted to the remainder of the -command line string and `var(action)'s for the target are evaluated. -In this case, nothing is actually removed from the command line string -so that any previous or neighbouring state may also have `var(actions)'s. -) -item(tt(/)var(pattern)tt(/+) [tt(%)var(lookahead)tt(%)] [tt(-)var(guard)] [tt(:)var(action)])( -This is similar to `tt(/)var(pattern)tt(/) ...' but the left part of -command line string is also considered as part of the completion target. -) -item(tt(/)var(pattern)tt(/-) [tt(%)var(lookahead)tt(%)] [tt(-)var(guard)] [tt(:)var(action)])( -This is similar to `tt(/)var(pattern)tt(/) ...' but `var(action)'s of the -current and previous states are ignored even if the following state's -`var(pattern)' matches the empty string. +item(tt(/)var(pattern)tt(/) [tt(%)var(lookahead)tt(%)] [tt(-)var(guard)] [tt(:)var(tag)tt(:)var(descr)tt(:)var(action)])( +This is a single primitive component. +The function tests whether the combined pattern +`tt((#b)LPAR()(#B))var(pattern)tt(RPAR())var(lookahead)tt(*)' matches +the command line string. If so, `var(guard)' is evaluated and +its return status is examined to determine if the test has succeeded. +The var(pattern) string `tt([])' is guaranteed never to match. +The var(lookahead) is not stripped from the command line before the next +pattern is examined. +) +item(tt(/)var(pattern)tt(/+) [tt(%)var(lookahead)tt(%)] [tt(-)var(guard)] [tt(:)var(tag)tt(:)var(descr)tt(:)var(action)])( +This is similar to `tt(/)var(pattern)tt(/) ...' but the left part of the +command line string (i.e. the part already matched by previous patterns) +is also considered part of the completion target. +) +item(tt(/)var(pattern)tt(/-) [tt(%)var(lookahead)tt(%)] [tt(-)var(guard)] [tt(:)var(tag)tt(:)var(descr)tt(:)var(action)])( +This is similar to `tt(/)var(pattern)tt(/) ...' but the var(action)s of the +current and previously matched patterns are ignored even if the +following `var(pattern)' matches the empty string. ) item(tt(LPAR()) var(spec) tt(RPAR()))( -This groups `var(spec)'. +Parentheses may be used to groups var(spec)s; note each parenthesis +is a single argument to tt(_regex_arguments). ) item(var(spec) tt(#))( -This allows any number of repetitions of `var(spec)'. +This allows any number of repetitions of var(spec). ) item(var(spec) var(spec))( -This represents the concatenation of two `var(spec)'s. +The two var(spec)s are to be matched one after the other as described +above. ) item(var(spec) tt(|) var(spec))( -Either of two `var(spec)'s can be matched. +Either of the two var(spec)s can be matched. ) enditem() ) -findex(_combination) -item(tt(_combination) [ tt(-s) var(pattern) ] var(tag) var(style) var(specs) ... var(field) var(opts) ...)( -This function is used to complete combinations of values such as pairs -of hostnames and usernames. The possible values will be taken from the -var(style) whose name is given as the second argument. The first argument -is the var(tag) to use to do the lookup. - -The style name should consist of multiple parts separated by -hyphens which are then used as fieldnames. Known values for such -fields can be given after the second argument in arguments of the form -`var(field)tt(=)var(pattern)'. The first argument without a equal sign -is taken as the name of the field for which completions should be -generated. +findex(_requested) +item(tt(_requested) [ tt(-x) ] [ tt(-12VJ) ] var(tag) [ var(name) var(descr) [ var(command) var(args) ... ] ])( +This function is called to decide whether a tag already registered by a +call to tt(_tags) (see below) has been requested by the user and hence +completion should be performed for it. It returns status zero if the +tag is requested and non-zero otherwise. The function is typically used +as part of a loop over different tags as follows: -The matches generated will be taken from the value of the style. These -values should contain the possible values for the combinations where -the values for the different fields are separated by colons or -characters matching the pattern given after the tt(-s) option to -tt(_combination) (normally this is used to define character classes -like the `tt(-s "[:@]")' used for the tt(users-hosts) style). +example(_tags foo bar baz +while _tags; do + if _requested foo; then + ... # perform completion for foo + fi + ... # test the tags bar and baz in the same way + ... # exit loop if matches were generated +done) -Only the values for the requested fields for which the patterns given -in the `var(field)tt(=)var(pattern)' match the respective fields in -the strings from the style value are generated as possible matches. +Note that the test for whether matches were generated is not performed +until the end of the tt(_tags) loop. This is so that the user can set +the tt(tag-order) style to specify a set of tags to be completed at the +same time. -If no style with the given name is defined for the given tag but a -function named with the name of the requested field preceded by an -underscore is defined, that function will be called to generate the -matches. This is also done if none of the strings in the value of the -style match all the patterns given as arguments. +If var(name) and var(descr) are given, tt(_requested) calls the +tt(_description) function with these arguments together with the options +passed to tt(_requested). -If the same name is used for more than one field, in both the -`var(field)tt(=)var(pattern)' and the argument that gives the field -name to complete for, the number of the field (starting with one) may -be given after the fieldname, separated from it by a colon. +If var(command) is given, the tt(_all_labels) function will be called +immediately with the same arguments. In simple cases this makes it +possible to perform the test for the tag and the matching in one go. +For example: -All arguments after the requested fieldname are given to the -tt(compadd) used (when generating matches from the style value) and to -the functions for the fields if they are called. +example(local expl ret=1 +_tags foo bar baz +while _tags; do + _requested foo expl 'description' \ + compadd foobar foobaz && ret=0 + ... + (( ret )) || break +done) + +If the var(command) is not tt(compadd), it must nevertheless be prepared +to handle the same options. ) -findex(_sort_tags) -item(tt(_sort_tags) var(tag) ...)( -As described above for the tt(tag-order) style, this is only provided -to show how functions that sort tags can be implemented. - -Inside such functions the name of the current context can -be accessed using the tt(curcontext) parameter. For example, the -function generating file names (called tt(_files)) in the completion -system is often called to generate only filenames matching a given -glob pattern, in which case it uses the tags tt(globbed-files), -tt(directories), and tt(all-files). This means that the function -offers to generate filenames matching the pattern, names of -directories or all filenames as possible matches. Example: - -example(_sort_tags() { - case $curcontext in - (*::dvips:*) - comptry globbed-files directories - comptry all-files - ;; - (*) - comptry globbed-files - comptry directories - comptry all-files - ;; - esac -}) +findex(_retrieve_cache) +item(tt(_retrieve_cache) var(cache_identifier))( +This function retrieves completion information from the file given by +var(cache_identifier), stored in a directory specified by the +tt(cache-path) style which defaults to tt(~/.zcompcache). The return status +is zero if retrieval was successful. It will only attempt retrieval +if the tt(use-cache) style is set, so you can call this function +without worrying about whether the user wanted to use the caching +layer. -Every call to the tt(comptry) function (actually a builtin -command defined by the tt(zsh/computil) module) gives a -set of tags to use; as soon as tt(comptry) produces some matches, -subsequent calls have no effect. Hence in the example -this means that for the tt(dvips) command on the first attempt the -names of DVI files and directories will be generated (first call to -tt(comptry)). If none of those names match the string from the command -line the completion function will generate all filenames as -possible matches (second call to tt(comptry)). - -For all other context names the second case-pattern matches, so that -normally the completion functions will only try the filenames matching -the glob pattern (if any glob pattern is used). If that doesn't yield -any matches, names of directories are generated, and if that doesn't -yield any matching names either, all filenames will be generated. - -In every context the function may call tt(comptry) as -often as it wants. Also, every string may be given as argument, even -if no tag with such a name was offered by the completion -function. This allows one to give a preferred ordering for some common -tag sets without having to worry about sensible patterns for context -names. For example, many completion functions can generate both -arguments and option names for commands. These functions normally use -the tags tt(arguments) and tt(options). Depending on your preference -you may write in your sorting function: - -example(_sort_tags() { - comptry arguments options - case $curcontext in - ... - esac -}) +See tt(_store_cache) below for more details. +) +findex(_sep_parts) +item(tt(_sep_parts))( +This function is passed alternating arrays and separators as arguments. +The arrays specify completions for parts of strings to be separated by the +separators. The arrays may be the names of array parameters or +a quoted list of words in parentheses. For example, with the array +`tt(hosts=(ftp news))' the call `tt(_sep_parts '(foo bar)' @ hosts)' will +complete the string `tt(f)' to `tt(foo)' and the string `tt(b@n)' to +`tt(bar@news)'. -or +This function accepts the tt(compadd) options `tt(-V)', `tt(-J)', +`tt(-1)', `tt(-2)', `tt(-n)', `tt(-X)', `tt(-M)', `tt(-P)', `tt(-S)', +`tt(-r)', `tt(-R)', and `tt(-q)' and passes them on to the tt(compadd) +builtin used to add the matches. +) +findex(_setup) +item(tt(_setup) var(tag) [ var(group) ])( +This function sets up the special +parameters used by the completion system appropriately for the var(tag) +given as the first argument. It uses the styles tt(list-colors), +tt(list-packed), tt(list-rows-first), tt(last-prompt), tt(accept-exact), +tt(menu) and tt(force-list). + +The optional var(group) supplies the name of the group in which the +matches will be placed. If it is not given, the var(tag) is used as +the group name. + +This function is called automatically from tt(_description) +and hence is not normally called explicitly. +) +findex(_store_cache) +item(tt(_store_cache) var(cache_identifier) var(params) ...)( +This function, together with tt(_retrieve_cache) and +tt(_cache_invalid), implements a caching layer which can be used +in any completion function. Data obtained by +costly operations are stored in parameters; +this function then dumps the values of those parameters to a file. The +data can then be retrieved quickly from that file via tt(_retrieve_cache), +even in different instances of the shell. + +The var(cache_identifier) specifies the file which the data should be +dumped to. The file is stored in a directory specified by the +tt(cache-path) style which defaults to tt(~/.zcompcache). The remaining +var(params) arguments are the parameters to dump to the file. + +The return status is zero if storage was successful. The function will +only attempt storage if the tt(use-cache) style is set, so you can +call this function without worrying about whether the user wanted to +use the caching layer. + +The completion function may avoid calling tt(_retrieve_cache) when it +already has the completion data available as parameters. +However, in that case it should +call tt(_cache_invalid) to check whether the data in the parameters and +in the cache are still valid. + +See the _perl_modules completion function for a simple example of +the usage of the caching layer. +) +findex(_tags) +item(tt(_tags) [ [ tt(-C) var(name) ] var(tags) ... ])( +If called with arguments, these are taken to be the names of tags +valid for completions in the current context. These tags are stored +internally and sorted by using the tt(tag-order) style. + +Next, tt(_tags) is called repeatedly without arguments from the same +completion function. This successively selects the first, second, +etc. set of tags requested by the user. The return status is zero if at +least one of the tags is requested and non-zero otherwise. To test if a +particular tag is to be tried, the tt(_requested) function should be +called (see above). + +If `tt(-C) var(name)' is given, var(name) is temporarily stored in the +argument field (the fifth) of the context in the tt(curcontext) parameter +during the call to tt(_tags); the field is restored on exit. This +allows tt(_tags) to use a more +specific context without having to change and reset the +tt(curcontext) parameter (which has the same effect). +) +findex(_values) +item(tt(_values) [ tt(-O) var(name) ] [ tt(-s) var(sep) ] [ tt(-S) var(sep) ] [ tt(-wC) ] var(desc) var(spec) ...)( +This is used to complete arbitrary keywords (values) and their arguments, +or lists of such combinations. + +If the first argument is the option `tt(-O) var(name)', it will be used +in the same way as by the tt(_arguments) function. In other words, the +elements of the var(name) array will be passed to tt(compadd) +when executing an action. + +If the first argument (or the first argument after `tt(-O) var(name)') +is `tt(-s)', the next argument is used as the character that separates +multiple values. This character is automatically added after each value +in an auto-removable fashion (see below); all values completed by +`tt(_values -s)' appear in the same word on the command line, unlike +completion using tt(_arguments). If this option is not present, only a +single value will be completed per word. + +Normally, tt(_values) will only use the current word to determine +which values are already present on the command line and hence are not +to be completed again. If the tt(-w) option is given, other arguments +are examined as well. + +The first non-option argument is used as a string to print as a +description before listing the values. -example(_sort_tags() { - comptry arguments - comptry options - case $curcontext in - ... - esac -}) +All other arguments describe the possible values and their +arguments in the same format used for the description of options by +the tt(_arguments) function (see above). The only differences are that +no minus or plus sign is required at the beginning, +values can have only one argument, and the forms of action +beginning with an equal sign are not supported. -The former always adds both the matches for the argument and the -option names as possible matches. The latter forces matches for the -arguments to be preferred. In this case option names are only generated -as matches if the string on the line matches no possible completion -for the argument, which normally means that you have to type the -hyphen the option names start with yourself to see the list of option -names that can be completed. - -Since the completion functions are free to choose the tag names they -use, there can't be a complete list. So to make sure that all types of -matches are eventually tried as completions, one should use a call to -tt(comptry) with all arguments at the end of the sorting function. For -those contexts where one really wants to make sure that certain tags are -never used one can then use a call to tt(return) to circumvent that -last tt(comptry). For example: - -example(_sort_tags() { - ... - case $curcontext in - (*::kill:*) - comptry processes - return - ;; - esac - comptry "$@" -}) +The character separating a value from its argument can be set using the +option tt(-S) (like tt(-s), followed by the character to use as the +separator in the next argument). By default the equals +sign will be used as the separator between values and arguments. + +Example: -The completion function for the tt(kill) builtin command offers the -tags tt(jobs) and tt(processes) which represent job references -(e.g. `tt(%1)') and process identifiers respectively. The function -above makes sure that for this builtin command only process -identifiers are generated as possible matches by using only the -tt(processes) tag in a call to tt(comptry). The immediate call to -tt(return) then makes sure that the default tt(comptry) at the end is -not executed. +example(_values -s , 'description' \ + '*foo[bar]' \ + '(two)*one[number]:first count:' \ + 'two[another number]::second count:(1 2 3)') + +This describes three possible values: `tt(foo)', `tt(one)', and +`tt(two)'. The first is described as `tt(bar)', takes no argument +and may appear more than once. The second is described as +`tt(number)', may appear more than once, and takes one mandatory +argument described as `tt(first count)'; no action is +specified, so it will not be completed. The +`tt((two))' at the beginning says that if the value `tt(one)' is on +the line, the value `tt(two)' will no longer be considered a possible +completion. Finally, the last value (`tt(two)') is described +as `tt(another number)' and takes an optional argument described as +`tt(second count)' for which the completions (to appear after an +`tt(=)') are `tt(1)', `tt(2)', and `tt(3)'. The tt(_values) function +will complete lists of these values separated by commas. + +Like tt(_arguments), this function temporarily adds another context name +component to the arguments element (the fifth) of the current context +while executing the var(action). Here this name is just the name of the +value for which the argument is completed. + +The style tt(verbose) is used to decide if the descriptions for the +values (but not those for the arguments) should be printed. + +The associative array tt(val_args) is used to report values and their +arguments; this works similarly to the tt(opt_args) associative array +used by tt(_arguments). Hence the function calling tt(_values) should +declare the local parameters tt(state), tt(line), tt(context) and +tt(val_args): + +example(local context state line +typeset -A val_args) + +when using an action of the form `tt(->)var(string)'. With this +function the tt(context) parameter will be set to the name of the +value whose argument is to be completed. + +Note also that tt(_values) normally adds the character used as the +separator between values as an auto-removable suffix (similar to a +`tt(/)' after a directory). However, this is not possible for a +`tt(->)var(string)' action as the matches for the argument are +generated by the calling function. To get the usual behaviour, the +the calling function can add the separator var(x) as a suffix by +passing the options `tt(-qS) var(x)' either directly or indirectly to +tt(compadd). + +The option tt(-C) is treated in the same way as it is by tt(_arguments). +In that case the parameter tt(curcontext) should be made local instead +of tt(context) (as described above). ) +findex(_wanted) +item(tt(_wanted) [ tt(-x) ] [ tt(-C) var(name) ] [ tt(-12VJ) ] var(tag) var(name) var(descr) var(command) var(args) ...)( +In many contexts, completion can only generate one particular set of +matches, usually corresponding to a single tag. However, it is +still necessary to decide whether the user requires matches of this type. +This function is useful in such a case. + +The arguments to tt(_wanted) are the same as those to tt(_requested), +i.e. arguments to be passed to tt(_description). However, in this case +the var(command) is not optional; all the processing of tags, including +the loop over both tags and tag labels and the generation of matches, +is carried out automatically by tt(_wanted). + +Hence to offer only one tag and immediately add the corresponding +matches with the given description: + +example(_wanted tag expl 'description' \ + compadd matches...) + +Note that, as for tt(_requested), the var(command) must be able to +accept options to be passed down to tt(compadd). +Like tt(_tags) this function supports the tt(-C) option to give a +different name for the argument context field. The tt(-x) option has +the same meaning as for tt(_description). +) enditem() texinode(Completion Directories)()(Completion Functions)(Completion System) @@ -2985,26 +4395,29 @@ it to some directory which appears earlier in your tt(fpath) than the standard directory where it appears. startitem() -item(tt(Core))( -The core scripts and functions. You will certainly need these, though will -probably not need to alter them. Many of these are documented above. -) item(tt(Base))( -Other functions you will almost certainly want if you are going to use -any of the standard completion functions. You may want to edit some of -these files. +The core functions and special completion widgets automatically bound +to keys. You will certainly need most of these, though will +probably not need to alter them. Many of these are documented above. ) -item(tt(Builtins))( +item(tt(Zsh))( Functions for completing arguments of shell builtin commands and -utility functions for this (which are also used by functions from the -tt(User) directory). +utility functions for this. Some of these are also used by functions from +the tt(Unix) directory. ) -item(tt(User))( +item(tt(Unix))( Functions for completing arguments of external commands and suites of -commands. They may need modifying for your system. -) -item(tt(Commands))( -Functions which implement special types of completion to be bound to -keystrokes rather than called by context. +commands. They may need modifying for your system, although in many cases +some attempt is made to decide which version of a command is present. For +example, completion for the tt(mount) command tries to determine the system +it is running on, while completion for many other utilities try to decide +whether the GNU version of the command is in use, and hence whether the +tt(-)tt(-help) option is supported. +) +item(tt(X), tt(AIX), tt(BSD), ...)( +Completion and utility function for commands available only on some systems. +These are not arranged hierarchically, so, for example, both the +tt(Linux) and tt(Debian) directories, as well as the tt(X) directory, +may be useful on your system. ) enditem() |