diff options
Diffstat (limited to 'Doc/Zsh/mod_complist.yo')
| -rw-r--r-- | Doc/Zsh/mod_complist.yo | 130 |
1 files changed, 65 insertions, 65 deletions
diff --git a/Doc/Zsh/mod_complist.yo b/Doc/Zsh/mod_complist.yo index 41e12196e..d75100247 100644 --- a/Doc/Zsh/mod_complist.yo +++ b/Doc/Zsh/mod_complist.yo @@ -18,13 +18,13 @@ dynamic loading, `tt(zmodload zsh/complist)' is required. vindex(ZLS_COLORS) vindex(ZLS_COLOURS) The parameters tt(ZLS_COLORS) and tt(ZLS_COLOURS) describe how matches -are highlighted. To turn on highlighting an empty value suffices, in -which case all the default values given below will be used. The format of the -value of these parameters is the same as used by the GNU version of the +are highlighted. To turn on highlighting an empty value suffices, in +which case all the default values given below will be used. The format of +the value of these parameters is the same as used by the GNU version of the tt(ls) command: a colon-separated list of specifications of the form -`var(name)=var(value)'. The var(name) may be one of the following strings, -most of which specify file types for which the var(value) will be used. The -strings and their default values are: +`var(name)=var(value)'. The var(name) may be one of the following strings, +most of which specify file types for which the var(value) will be used. +The strings and their default values are: startitem() item(tt(no 0))( @@ -55,7 +55,7 @@ item(tt(ex 35))( for executable files ) item(tt(mi) var(none))( -for non-existent file (default is the value defined for tt(fi)) +for a non-existent file (default is the value defined for tt(fi)) ) item(tt(lc \e[))( for the left code (see below) @@ -79,31 +79,31 @@ Apart from these strings, the var(name) may also be an asterisk (`tt(*)') followed by any string. The var(value) given for such a string will be used for all files whose name ends with the string. The var(name) may also be a equal sign (`tt(=)') followed by a -pattern. The var(value) given for this pattern will be used for all -matches (not only filenames) whose display string are matched by -the pattern. Definitions for both of these take precedence over the +pattern. The var(value) given for this pattern will be used for all +matches (not just filenames) whose display string are matched by +the pattern. Definitions for both of these take precedence over the values defined for file types and the form with the leading asterisk takes precedence over the form with the leading equal sign. -The last form also allows to color separate parts of the displayed -strings using different colors. For this, the pattern has to use the +The last form also allows different parts of the displayed +strings to be colored differently. For this, the pattern has to use the `tt((#b))' globbing flag and pairs of parentheses surrounding the -parts of the strings that are to be colored differently. In this case +parts of the strings that are to be colored differently. In this case the var(value) may consist of more than one color code separated by -equal signs. The first code will be used for all parts for which no +equal signs. The first code will be used for all parts for which no explicit code is specified and the following codes will be used for -the parts matched by the sub-patterns in parentheses. For example, +the parts matched by the sub-patterns in parentheses. For example, the specification `tt(=(#b)(?)*(?)=0=3=7)' will be used for all matches which are at least two characters long and will make the use the code `tt(3)' for the first character, `tt(7)' for the last character and `tt(0)' for the rest. All three forms of var(name) may be preceded by a pattern in -parentheses. If such a pattern is given, the var(value) will be used +parentheses. If this is given, the var(value) will be used only for matches in groups whose names are matched by the pattern -given in the parentheses. E.g. `tt((g*)m*=43)' says to highlight all +given in the parentheses. For example, `tt((g*)m*=43)' highlights all matches beginning with `tt(m)' in groups whose names begin with -`tt(g)' using the color code `tt(43)'. In case of the `tt(lc)', +`tt(g)' using the color code `tt(43)'. In case of the `tt(lc)', `tt(rc)', and `tt(ec)' codes, the group pattern is ignored. Note also that all patterns are tried in the order in which they @@ -117,38 +117,39 @@ then the value of tt(ec) if that is defined or the values of tt(lc), tt(no), and tt(rc) if tt(ec) is not defined. The default values are ISO 6429 (ANSI) compliant and can be used on -vt100 compatible terminals such as tt(xterm)s. On monochrome terminals -the default values will have no visual effect. +vt100 compatible terminals such as tt(xterm)s. On monochrome terminals +the default values will have no visible effect. -If the shell function based completion system is used, these +If the completion system based around shell functions is used, these parameters should not be set directly because the system controls them -itself. Instead, the tt(list-colors) style should be used (see +itself. Instead, the tt(list-colors) style should be used (see ifzman(the section `Completion System Configuration' in zmanref(zshcompsys))\ ifnzman(noderef(Completion System Configuration))\ ). subsect(Scrolling in completion listings) -To be able to scroll through a completion list, the tt(LISTPROMPT) -parameter has to be set. Its value will be used as the prompt, if it +To enable scrolling through a completion list, the tt(LISTPROMPT) +parameter must be set. Its value will be used as the prompt; if it is the empty string, a default prompt will be used. The value may -contain escapes of the form `tt(%x)'. It supports the escapes +contain escapes of the form `tt(%x)'. It supports the escapes `tt(%B)', `tt(%b)', `tt(%S)', `tt(%s)', `tt(%U)', `tt(%u)' and -`tt(%{...%})' known from the shell prompts and three pairs of -additional sequences. A `tt(%l)' or `tt(%L)' is replaced by the number +`tt(%{...%})' used also in shell prompts as well as three pairs of +additional sequences: a `tt(%l)' or `tt(%L)' is replaced by the number of the last line shown and the total number of lines in the form -`var(number)tt(/)var(total)'. A `tt(%m)' or `tt(%M)' is replaced with -the number of the last match shown and the total number of matches and +`var(number)tt(/)var(total)'; a `tt(%m)' or `tt(%M)' is replaced with +the number of the last match shown and the total number of matches; and `tt(%p)' or `tt(%P)' is replaced with `tt(Top)', `tt(Bottom)' or the position of the first line shown in percent of the total number of -lines, respectively. In each of these cases the one with the uppercase +lines, respectively. In each of these cases the form with the uppercase letter will be replaced with a string of fixed width, padded to the -right with spaces. +right with spaces, while the lowercase form will not be padded. -If tt(LISTPROMPT) is set, the completion code will not ask if the list -should be shown. Instead it immediately starts displaying the list, -stopping after the first screenful, showing the prompt at the bottom, -waiting for a keypress after temporarily switching to the -tt(listscroll) keymap. Some of the zle functions have special meaning: +If the option att(LISTPROMPT) is set, the completion code will not ask if +the list should be shown. Instead it immediately starts displaying the +list, stopping after the first screenful, showing the prompt at the bottom, +waiting for a keypress after temporarily switching to the tt(listscroll) +keymap. Some of the zle functions have a special meaning while scrolling +lists: startitem() item(tt(send-break))( @@ -165,13 +166,13 @@ scrolls forward one screenful enditem() Every other character stops listing and immediately processes the key -as usual. Any key that is not bound in the tt(listscroll) keymap or +as usual. Any key that is not bound in the tt(listscroll) keymap or that is bound to tt(undefined-key) is looked up in the keymap currently selected. As for the tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters, tt(LISTPROMPT) should not be set directly when using the shell -function based completion system. Instead, the tt(list-prompt) style +function based completion system. Instead, the tt(list-prompt) style should be used. subsect(Menu selection) @@ -184,7 +185,7 @@ shell is set up to return to the last prompt after showing a completion list (see the tt(ALWAYS_LAST_PROMPT) option in ifzman(zmanref(zshoptions))\ ifnzman(noderef(Options))\ -). It can be invoked directly by +). It can be invoked directly by the widget tt(menu-select) defined by the module. Alternatively, the parameter tt(MENUSELECT) can be set to an integer, which give the minimum number of matches that must be present before menu selection is @@ -194,58 +195,58 @@ to one of the options tt(MENU_COMPLETE) or tt(AUTO_MENU) being set. If tt(MENUSELECT) is set, but is 0, 1 or empty, menu selection will always be started during an ambiguous menu completion. -When using the shell function based completion system, the +When using the completion system based on shell functions, the tt(MENUSELECT) parameter should not be used (like the tt(ZLS_COLORS) -and tt(ZLS_COLOURS) parameters described above). Instead, the tt(menu) -style should be used. +and tt(ZLS_COLOURS) parameters described above). Instead, the tt(menu) +style should be used with the tt(select=)var(...) keyword. After menu-selection is started, the matches will be listed. If there are more matches than fit on the screen, only the first screenful is -shown. The +shown. The matches to insert into the command line can be selected from this -list. In the list one match is highlighted using the value for tt(ma) -from the tt(ZLS_COLORS) or tt(ZLS_COLOURS) parameter. The default +list. In the list one match is highlighted using the value for tt(ma) +from the tt(ZLS_COLORS) or tt(ZLS_COLOURS) parameter. The default value for this is `tt(7)' which forces the selected match to be -highlighted using standout mode on a vt100-compatible terminal. If +highlighted using standout mode on a vt100-compatible terminal. If neither tt(ZLS_COLORS) nor tt(ZLS_COLOURS) is set, the same terminal control sequence as for the `tt(%S)' escape in prompts is used. If there are more matches than fit on the screen and the parameter -tt(MENUPROMPT) is set, its value will be shown below the matches. It +tt(MENUPROMPT) is set, its value will be shown below the matches. It supports the same escape sequences as tt(LISTPROMPT), but the number of the match or line shown will be that of the one where the mark is -placed. If its value is the empty string, a default prompt will be +placed. If its value is the empty string, a default prompt will be used. The tt(MENUSCROLL) parameter can be used to specify how the list is -scrolled. If the parameter is unset, this is done line by line, if it +scrolled. If the parameter is unset, this is done line by line, if it is set to `tt(0)' (zero), the list will scrolled half the number of -lines of the screen. If the value is positive, it gives the number of +lines of the screen. If the value is positive, it gives the number of lines to scroll and if it is negative, the list will be scrolled the number of lines of the screen minus the (absolute) value. As for the tt(ZLS_COLORS), tt(ZLS_COLOURS) and tt(LISTPROMPT) parameters, neither tt(MENUPROMPT) nor tt(MENUSCROLL) should be set directly when using the shell function based completion -system. Instead, the tt(select-prompt) and tt(select-scroll) styles +system. Instead, the tt(select-prompt) and tt(select-scroll) styles should be used. The completion code sometimes decides not to show all of the matches -in the list. These hidden matches are either matches for which the +in the list. These hidden matches are either matches for which the completion function which added them explicitly requested that they not appear in the list (using the tt(-n) option of the tt(compadd) builtin command) or they are matches which duplicate a string already in the list (because they differ only in things like prefixes or -suffixes that are not displayed). In the list used for menu-selection, +suffixes that are not displayed). In the list used for menu-selection, however, even these matches are shown so that it is possible to select -them. To highlight such matches the tt(hi) and tt(du) capabilities in +them. To highlight such matches the tt(hi) and tt(du) capabilities in the tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters are supported for hidden matches of the first and second kind, respectively. Selecting matches is done by moving the mark around using the zle movement -functions. When not all matches can be shown on the screen at the same +functions. When not all matches can be shown on the screen at the same time, the list will scroll up and down when crossing the top or -bottom line. The following zle functions have special meaning during +bottom line. The following zle functions have special meaning during menu selection: startitem() @@ -322,18 +323,17 @@ moves the mark to the previous match ) enditem() -All movement function do wrap-around at the edges and -any other zle function leaves menu-selection and executes that function. -It is possible to make widgets in the above list do the same by using the -form of the widget with a `tt(.)' in front. For example, the widget -`tt(.accept-line)' has the effect of leaving menu selection and accepting -the entire command line. +All movement functions wrap around at the edges; any other zle function not +listed leaves menu-selection and executes that function. It is possible to +make widgets in the above list do the same by using the form of the widget +with a `tt(.)' in front. For example, the widget `tt(.accept-line)' has +the effect of leaving menu selection and accepting the entire command line. -During this selection the widget uses the keymap tt(menuselect). Any +During this selection the widget uses the keymap tt(menuselect). Any key that is not defined in this keymap or that is bound to -tt(undefined-key) is looked up in the keymap currently selected. This +tt(undefined-key) is looked up in the keymap currently selected. This is used to ensure that the most important keys used during selection -have sensible default (namely the cursor keys, return, and TAB). However, +(namely the cursor keys, return, and TAB) have sensible defaults. However, keys in the the tt(menuselect) keymap can be modified directly using the tt(bindkey) builtin command (see ifzman(zmanref(zshmodules))\ |