mkdir ~/zsh_help
perl ~/zsh-5.8.1/Util/helpfiles ~/zsh_help

HELPDIR=~/zsh_help

unalias run-help
autoload run-help

In the first form, each name is the name of a compiled file or a directory containing *.zwc files that should be checked. If no arguments are given, the directories and *.zwc files in fpath are used.

When -t is given, no compilation is performed, but a return status of zero (true) is set if there are files that need to be re-compiled and non-zero (false) otherwise. The -q option quiets the chatty output that describes what zrecompile is doing.

Without the -t option, the return status is zero if all files that needed re-compilation could be compiled and non-zero if compilation for at least one of the files failed.

If the -p option is given, the args are interpreted as one or more sets of arguments for zcompile, separated by `--'. For example:

zrecompile -p \ 
           -R ~/.zshrc -- \ 
           -M ~/.zcompdump -- \ 
           ~/zsh/comp.zwc ~/zsh/Completion/*/_*

This compiles ~/.zshrc into ~/.zshrc.zwc if that doesn't exist or if it is older than ~/.zshrc. The compiled file will be marked for reading instead of mapping. The same is done for ~/.zcompdump and ~/.zcompdump.zwc, but this compiled file is marked for mapping. The last line re-creates the file ~/zsh/comp.zwc if any of the files matching the given pattern is newer than it.

Without the -p option, zrecompile does not create function digests that do not already exist, nor does it add new functions to the digest.

for ((i=1; i <= $#fpath; ++i)); do
  dir=$fpath[i]
  zwc=${dir:t}.zwc
  if [[ $dir == (.|..) || $dir == (.|..)/* ]]; then
    continue
  fi
  files=($dir/*(N-.))
  if [[ -w $dir:h && -n $files ]]; then
    files=(${${(M)files%/*/*}#/})
    if ( cd $dir:h &&
         zrecompile -p -U -z $zwc $files ); then
      fpath[i]=$fpath[i].zwc
    fi
  fi
done

zsh -f ~/zsh-5.8.1/Functions/Misc/zkbd

source ${ZDOTDIR:-$HOME}/.zkbd/$TERM-$VENDOR-$OSTYPE
[[ -n ${key[Left]} ]] && bindkey "${key[Left]}" backward-char
[[ -n ${key[Right]} ]] && bindkey "${key[Right]}" forward-char
# etc.

. ~/zsh-5.8.1/Util/reporter > zsh.report

all

Output everything listed below.

aliases

Output alias definitions.

bindings

Output ZLE key maps and bindings.

completion

Output old-style compctl commands. New completion is covered by functions and zstyles.

functions

Output autoloads and function definitions.

limits

Output limit commands.

options

Output setopt commands.

styles

Same as zstyles.

variables

Output shell parameter assignments, plus export commands for any environment variables.

zstyles

Output zstyle commands.

If the state is omitted, all is assumed.

hook is one of chpwd, periodic, precmd, preexec, zshaddhistory, zshexit, or zsh_directory_name, the special functions in question. Note that zsh_directory_name is called in a different way from the other functions, but may still be manipulated as a hook.

function is name of an ordinary shell function. If no options are given this will be added to the array of functions to be executed in the given context. Functions are invoked in the order they were added.

If the option -L is given, the current values for the hook arrays are listed with typeset.

If the option -d is given, the function is removed from the array of functions to be executed.

If the option -D is given, the function is treated as a pattern and any matching names of functions are removed from the array of functions to be executed.

The options -U, -z and -k are passed as arguments to autoload for function. For functions contributed with zsh, the options -Uz are appropriate.

hook is one of isearch-exit, isearch-update, line-pre-redraw, line-init, line-finish, history-line-set, or keymap-select, corresponding to each of the special widgets zle-isearch-exit, etc. The special widget names are also accepted as the hook argument.

widgetname is the name of a ZLE widget. If no options are given this is added to the array of widgets to be invoked in the given hook context. Widgets are invoked in the order they were added, with

zle widgetname -Nw -- "$@"

Note that this means that the `WIDGET' special parameter tracks the widgetname when the widget function is called, rather than tracking the name of the corresponding special hook widget.

If the option -d is given, the widgetname is removed from the array of widgets to be executed.

If the option -D is given, the widgetname is treated as a pattern and any matching names of widgets are removed from the array.

If widgetname does not name an existing widget when added to the array, it is assumed that a shell function also named widgetname is meant to provide the implementation of the widget. This name is therefore marked for autoloading, and the options -U, -z and -k are passed as arguments to autoload as with add-zsh-hook. The widget is also created with `zle -N widgetname' to cause the corresponding function to be loaded the first time the hook is called.

The arrays of widgetname are currently maintained in zstyle contexts, one for each hook context, with a style of `widgets'. If the -L option is given, this set of styles is listed with `zstyle -L'. This implementation may change, and the special widgets that refer to the styles are created only if add-zle-hook-widget is called to add at least one widget, so if this function is used for any hooks, then all hooks should be managed only via this function.

autoload -Uz chpwd_recent_dirs cdr add-zsh-hook
add-zsh-hook chpwd chpwd_recent_dirs

zstyle ':completion:*:*:cdr:*:*' menu selection

If output is to a terminal, then the function will print the new list after pruning and prompt for confirmation by the user. This output and confirmation step can be skipped by using -P instead of -p.

zstyle ':chpwd:*' recent-dirs-max 0

The value of this style may be an array. In this case, the first file in the list will always be used for saving directories while any other files are left untouched. When reading the recent directory list, if there are fewer than the maximum number of entries in the first file, the contents of later files in the array will be appended with duplicates removed from the list shown. The contents of the two files are not sorted together, i.e. all the entries in the first file are shown first. The special value + can appear in the list to indicate the default file should be read at that point. This allows effects like the following:

zstyle ':chpwd:*' recent-dirs-file \ 
~/.chpwd-recent-dirs-${TTY##*/} +

Recent directories are read from a file numbered according to the terminal. If there are insufficient entries the list is supplemented from the default file.

It is possible to use zstyle -e to make the directory configurable at run time:

zstyle -e ':chpwd:*' recent-dirs-file pick-recent-dirs-file
pick-recent-dirs-file() {
  if [[ $PWD = ~/text/writing(|/*) ]]; then
    reply=(~/.chpwd-recent-dirs-writing)
  else
    reply=(+)
  fi
}

In this example, if the current directory is ~/text/writing or a directory under it, then use a special file for saving recent directories, else use the default.

If the value of the style is always, then only recent directories will be completed; in that case, use the cd command when you want to complete other directories.

If the value is fallback, recent directories will be tried first, then normal directory completion is performed if recent directory completion failed to find a match.

Finally, if the value is both then both sets of completions are presented; the usual tag mechanism can be used to distinguish results, with recent directories tagged as recent-dirs. Note that the recent directories inserted are abbreviated with directory names where appropriate.

parent

Prune parents (more accurately, ancestors) from the recent list. If present, changing directly down by any number of directories causes the current directory to be overwritten. For example, changing from ~pws to ~pws/some/other/dir causes ~pws not to be left on the recent directory stack. This only applies to direct changes to descendant directories; earlier directories on the list are not pruned. For example, changing from ~pws/yet/another to ~pws/some/other/dir does not cause ~pws to be pruned.

pattern:pattern

Gives a zsh pattern for directories that should not be added to the recent list (if not already there). This element can be repeated to add different patterns. For example, 'pattern:/tmp(|/*)' stops /tmp or its descendants from being added. The EXTENDED_GLOB option is always turned on for these patterns.

autoload -Uz add-zsh-hook
add-zsh-hook -Uz zsh_directory_name zsh_directory_name_cdr

autoload -Uz add-zsh-hook zsh_diretory_name_generic zdn_mywrapper
add-zsh-hook -U zsh_directory_name zdn_mywrapper

zstyle :zdn:zdn_mywrapper: mapping zdn_mywrapper_top

local -A zdn_top=(
  g   ~/git
  ga  ~/alternate/git
  gs  /scratch/$USER/git/:second2
  :default: /:second1
)

local -A second1=(
  p   myproject
  s   somproject
  os  otherproject/subproject/:third
)

local -A zdn_top=(
  g   ~/git
  ga  ~/alternate/git
  gs  /scratch/$USER/git/:second2
  :default: /:second1
)
local -A second1=(
  p   myproject
  s   somproject
  os  otherproject/subproject/:third
)
local -A second2=(
  p   myscratchproject
  s   somescratchproject
)
local -A third=(
  s   top/srcdir
  d   top/documentation
)
# autoload not needed if you did this at initialisation...
autoload -Uz zsh_directory_name_generic
zsh_directory_name_generic "$@

typeset -A zdn_mywrapper_top=(...)
# ... and so on for other associative arrays ...
zstyle ':zdn:zdn_mywrapper:' mapping zdn_mywrapper_top
autoload -Uz add-zsh-hook zsh_directory_name_generic zdn_mywrapper
add-zsh-hook -U zsh_directory_name zdn_mywrapper

zsh_directory_name_generic "$@"

zstyle ':vcs_info:*' actionformats \ 
    '%F{5}(%f%s%F{5})%F{3}-%F{5}[%F{2}%b%F{3}|%F{1}%a%F{5}]%f '
zstyle ':vcs_info:*' formats       \ 
    '%F{5}(%f%s%F{5})%F{3}-%F{5}[%F{2}%b%F{5}]%f '
zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat '%b%F{1}:%F{3}%r'
precmd () { vcs_info }
PS1='%F{5}[%F{2}%n%F{5}] %F{3}%3~ ${vcs_info_msg_0_}%f%# '

% vcs_info_printsys
## list of supported version control backends:
## disabled systems are prefixed by a hash sign (#)
bzr
cdv
cvs
darcs
fossil
git
hg
mtn
p4
svk
svn
tla
## flavours (cannot be used in the enable or disable styles; they
## are enabled and disabled with their master [git-svn -> git])
## they *can* be used in contexts: ':vcs_info:git-svn:*'.
git-p4
git-svn
hg-git
hg-hgsubversion
hg-hgsvn

zstyle ':vcs_info:*' disable bzr cdv darcs mtn svk tla

zstyle ':vcs_info:*' enable git cvs svn

:vcs_info:vcs-string:user-context:repo-root-name

Currently, hooks in quilt mode don't add the `.quilt-quilt-mode' information. This may change in the future.

Say, ~/.zsh is a directory under version control, in which you do not want vcs_info to be active, do:

zstyle ':vcs_info:*' disable-patterns "${(b)HOME}/.zsh(|/*)"

For this style to be evaluated with the hg backend, the get-revision style needs to be set and the use-simple style needs to be unset. The latter is the default; the former is not.

With the bzr backend, lightweight checkouts only honor this style if the use-server style is set.

Note, the actions taken if this style is enabled are potentially expensive (read: they may be slow, depending on how big the current repository is). Therefore, it is disabled by default.

In the git backend, this style checks for changes in the index. Other backends do not currently implement this style.

This style is disabled by default.

If the value of this style is empty (which is the default), the used binary name is the name of the backend in use (e.g. svn is used in an svn repository).

The repo-root-name part in the context is always the default -all- when this style is looked up.

For example, this style can be used to use binaries from non-default installation directories. Assume, git is installed in /usr/bin but your sysadmin installed a newer version in /usr/local/bin. Instead of changing the order of your $PATH parameter, you can do this:

zstyle ':vcs_info:git:*:-all-' command /usr/local/bin/git

The Bazaar backend (bzr) uses this to permit contacting the server about lightweight checkouts, see the check-for-changes style.

The default is to generate a comma-separated list of all bookmark names that refer to the currently checked out revision. If a bookmark is active, its name is suffixed an asterisk and placed first in the list.

Used by the quilt and hg backends.

The hg and git backends use this expando to display patch information. hg sources patch information from the mq extensions; git from in-progress rebase and cherry-pick operations and from the stgit extension. The patch-format and nopatch-format styles control the generated string. The former is used when at least one patch from the patch queue has been applied, and the latter otherwise.

The hg backend displays bookmark information in this expando (in addition to mq information). See the get-mq and get-bookmarks styles. Both of these styles may be enabled at the same time. If both are enabled, both resulting strings will be shown separated by a semicolon (that cannot currently be customized).

The quilt `standalone' backend sets this expando to the same value as the %Q expando.

See Quilt Support below for details.

zstyle ':vcs_info:*' use-quilt true

:vcs_info:vcs-string+hook-name:user-context:repo-root-name

zstyle ':vcs_info:*+foo:*' hooks bar baz

+vi-git-myfirsthook(){
    user_data[myval]=$myval
}
+vi-git-mysecondhook(){
    # do something with ${user_data[myval]}
}

This hook gets the names of the Mercurial bookmarks that vcs_info collected from `hg'.

If a bookmark is active, the key ${hook_com[hg-active-bookmark]} is set to its name. The key is otherwise unset.

When setting ret to non-zero, the string in ${hook_com[hg-bookmark-string]} will be used in the %m escape in formats and actionformats and will be available in the global backend_misc array as ${backend_misc[bookmarks]}.

This hook gets the names of all applied patches which vcs_info collected so far in the opposite order, which means that the first argument is the top-most patch and so forth.

When setting ret to non-zero, the string in ${hook_com[applied-string]} will be available as %p in the patch-format and nopatch-format styles. This hook is, in concert with set-patch-format, responsible for %-escaping that value for use in the prompt. (See the Oddities section.)

This hook gets the names of all unapplied patches which vcs_info collected so far in order, which means that the first argument is the patch next-in-line to be applied and so forth.

When setting ret to non-zero, the string in ${hook_com[unapplied-string]} will be available as %u in the patch-format and nopatch-format styles. This hook is, in concert with set-patch-format, responsible for %-escaping that value for use in the prompt. (See the Oddities section.)

This hook gets the names of any active mq guards.

When setting ret to non-zero, the string in ${hook_com[guards-string]} will be used in the %g escape in the patch-format and nopatch-format styles.

The `hook_com' parameter is not used.

The `hook_com' keys available are as for the set-message hook.

The `hook_com' parameter is not used.

The `hook_com' keys considered are `branch' and `revision'. They are set to the values figured out so far by vcs_info and any change will be used directly when the actual replacement is done.

If ret is set to non-zero, the string in ${hook_com[branch-replace]} will be used unchanged as the `%b' replacement in the variables set by vcs_info.

The `hook_com' keys considered are `hash' and `localrev'. They are set to the values figured out so far by vcs_info and any change will be used directly when the actual replacement is done.

If ret is set to non-zero, the string in ${hook_com[rev-replace]} will be used unchanged as the `%i' replacement in the variables set by vcs_info.

Setting the `ret' variable in this hook to a non-zero value avoids any quilt specific actions from being run at all.

This hook is used in the git, hg and quilt backends.

The hook allows the control of the %p (${hook_com[applied]}) and %u (${hook_com[unapplied]}) expansion in all backends that use the hook. With the mercurial backend, the %g (${hook_com[guards]}) expansion is controllable in addition to that.

If ret is set to non-zero, the string in ${hook_com[patch-replace]} will be used unchanged instead of an expanded format from patch-format or nopatch-format.

This hook is, in concert with the gen-applied-string or gen-unapplied-string hooks if they are defined, responsible for %-escaping the final patch-format value for use in the prompt. (See the Oddities section.)

There are a number of `hook_com' keys, that are used here: `action', `branch', `base', `base-name', `subdir', `staged', `unstaged', `revision', `misc', `vcs' and one `miscN' entry for each backend-specific data field (N starting at zero). They are set to the values figured out so far by vcs_info and any change will be used directly when the actual replacement is done.

Since this hook is triggered multiple times (once for each configured formats or actionformats), each of the `hook_com' keys mentioned above (except for the miscN entries) has an `_orig' counterpart, so even if you changed a value to your liking you can still get the original value in the next run. Changing the `_orig' values is probably not a good idea.

If ret is set to non-zero, the string in ${hook_com[message]} will be used unchanged as the message by vcs_info.

zstyle ':vcs_info:*' enable NONE

zstyle ':vcs_info:*' disable bzr svk

zstyle ':vcs_info:*' enable bzr svk

zstyle ':vcs_info:git:*' formats       ' GIT, BABY! [%b]'
zstyle ':vcs_info:git:*' actionformats ' GIT ACTION! [%b|%a]'

zstyle ':vcs_info:bzr:*' use-simple true

zstyle ':vcs_info:(svn|bzr):*' \ 
       branchformat '%b%{'${fg[yellow]}'%}:%r'

alias vcsi='vcs_info command; vcs_info_lastmsg'

zstyle ':vcs_info:*+set-message:*' hooks svn2subversion

zstyle ':vcs_info:*+*:*' debug true

zstyle ':vcs_info:*+*:*' debug false

function +vi-svn2subversion() {
    [[ ${hook_com[vcs_orig]} == svn ]] && hook_com[vcs]=subversion
}

zstyle ':vcs_info:svn+set-message:*' hooks svn2subversion

function +vi-svn2subversion() {
    hook_com[vcs]=subversion
}

zstyle ':vcs_info:hg+gen-hg-bookmark-string:*' hooks hgbookmarks

function +vi-hgbookmarks() {
    # The default is to connect all bookmark names by
    # commas. This mixes things up a little.
    # Imagine, there's one type of bookmarks that is
    # special to you. Say, because it's *your* work.
    # Those bookmarks look always like this: "sh/*"
    # (because your initials are sh, for example).
    # This makes the bookmarks string use only those
    # bookmarks. If there's more than one, it
    # concatenates them using commas.
    # The bookmarks returned by `hg' are available in
    # the function's positional parameters.
    local s="${(Mj:,:)@:#sh/*}"
    # Now, the communication with the code that calls
    # the hook functions is done via the hook_com[]
    # hash. The key at which the `gen-hg-bookmark-string'
    # hook looks is `hg-bookmark-string'. So:
    hook_com[hg-bookmark-string]=$s
    # And to signal that we want to use the string we
    # just generated, set the special variable `ret' to
    # something other than the default zero:
    ret=1
    return 0
}

fpath=(~/myfns $fpath)
autoload -U promptinit
promptinit

In some cases the theme may be modified by one or more arguments, which should be given after the theme name. See the help for each theme for descriptions of these arguments.

Options are:

-c

Show the currently selected theme and its parameters, if any.

-l

List all available prompt themes.

-p

Preview the theme named by theme, or all themes if no theme is given.

-h

Show help for the theme named by theme, or for the prompt function if no theme is given.

-s

Set theme as the current theme and save state.

Note that you can undo `prompt off' and `prompt default' with `prompt restore', but a second restore does not undo the first.

prompt_cleanup command

autoload function
zle -N function

The simplest way of configuring the functions is to use select-word-style, which can either be called as a normal function with the appropriate argument, or invoked as a user-defined widget that will prompt for the first character of the word style to be used. The first time it is invoked, the first eight -match functions will automatically replace the builtin versions, so they do not need to be loaded explicitly.

The word styles available are as follows. Only the first character is examined.

bash

Word characters are alphanumeric characters only.

normal

As in normal shell operation: word characters are alphanumeric characters plus any characters present in the string given by the parameter $WORDCHARS.

shell

Words are complete shell command arguments, possibly including complete quoted strings, or any tokens special to the shell.

whitespace

Words are any set of characters delimited by whitespace.

default

Restore the default settings; this is usually the same as `normal'.

All but `default' can be input as an upper case character, which has the same effect but with subword matching turned on. In this case, words with upper case characters are treated specially: each separate run of upper case characters, or an upper case character followed by any number of other characters, is considered a word. The style subword-range can supply an alternative character range to the default `[:upper:]'; the value of the style is treated as the contents of a `[...]' pattern (note that the outer brackets should not be supplied, only those surrounding named ranges).

More control can be obtained using the zstyle command, as described in zshmodules(1). Each style is looked up in the context :zle:widget where widget is the name of the user-defined widget, not the name of the function implementing it, so in the case of the definitions supplied by select-word-style the appropriate contexts are :zle:forward-word, and so on. The function select-word-style itself always defines styles for the context `:zle:*' which can be overridden by more specific (longer) patterns as well as explicit contexts.

The style word-style specifies the rules to use. This may have the following values.

normal

Use the standard shell rules, i.e. alphanumerics and $WORDCHARS, unless overridden by the styles word-chars or word-class.

specified

Similar to normal, but only the specified characters, and not also alphanumerics, are considered word characters.

unspecified

The negation of specified. The given characters are those which will not be considered part of a word.

shell

Words are obtained by using the syntactic rules for generating shell command arguments. In addition, special tokens which are never command arguments such as `()' are also treated as words.

whitespace

Words are whitespace-delimited strings of characters.

The first three of those rules usually use $WORDCHARS, but the value in the parameter can be overridden by the style word-chars, which works in exactly the same way as $WORDCHARS. In addition, the style word-class uses character class syntax to group characters and takes precedence over word-chars if both are set. The word-class style does not include the surrounding brackets of the character class; for example, `-:[:alnum:]' is a valid word-class to include all alphanumerics plus the characters `-' and `:'. Be careful including `]', `^' and `-' as these are special inside character classes.

word-style may also have `-subword' appended to its value to turn on subword matching, as described above.

The style skip-chars is mostly useful for transpose-words and similar functions. If set, it gives a count of characters starting at the cursor position which will not be considered part of the word and are treated as space, regardless of what they actually are. For example, if

zstyle ':zle:transpose-words' skip-chars 1

has been set, and transpose-words-match is called with the cursor on the X of fooXbar, where X can be any character, then the resulting expression is barXfoo.

Finer grained control can be obtained by setting the style word-context to an array of pairs of entries. Each pair of entries consists of a pattern and a subcontext. The shell argument the cursor is on is matched against each pattern in turn until one matches; if it does, the context is extended by a colon and the corresponding subcontext. Note that the test is made against the original word on the line, with no stripping of quotes. Special handling is done between words: the current context is examined and if it contains the string between the word is set to a single space; else if it is contains the string back, the word before the cursor is considered, else the word after cursor is considered. Some examples are given below.

The style skip-whitespace-first is only used with the forward-word widget. If it is set to true, then forward-word skips any non-word-characters, followed by any non-word-characters: this is similar to the behaviour of other word-orientated widgets, and also that used by other editors, however it differs from the standard zsh behaviour. When using select-word-style the widget is set in the context :zle:* to true if the word style is bash and false otherwise. It may be overridden by setting it in the more specific context :zle:forward-word*.

It is possible to create widgets with specific behaviour by defining a new widget implemented by the appropriate generic function, then setting a style for the context of the specific widget. For example, the following defines a widget backward-kill-space-word using backward-kill-word-match, the generic widget implementing backward-kill-word behaviour, and ensures that the new widget always implements space-delimited behaviour.

zle -N backward-kill-space-word backward-kill-word-match
zstyle :zle:backward-kill-space-word word-style space

The widget backward-kill-space-word can now be bound to a key.

Here are some further examples of use of the styles, actually taken from the simplified interface in select-word-style:

zstyle ':zle:*' word-style standard
zstyle ':zle:*' word-chars ''

Implements bash-style word handling for all widgets, i.e. only alphanumerics are word characters; equivalent to setting the parameter WORDCHARS empty for the given context.

style ':zle:*kill*' word-style space

Uses space-delimited words for widgets with the word `kill' in the name. Neither of the styles word-chars nor word-class is used in this case.

Here are some examples of use of the word-context style to extend the context.

zstyle ':zle:*' word-context \ 
       "*/*" filename "[[:space:]]" whitespace
zstyle ':zle:transpose-words:whitespace' word-style shell
zstyle ':zle:transpose-words:filename' word-style normal
zstyle ':zle:transpose-words:filename' word-chars ''

This provides two different ways of using transpose-words depending on whether the cursor is on whitespace between words or on a filename, here any word containing a /. On whitespace, complete arguments as defined by standard shell rules will be transposed. In a filename, only alphanumerics will be transposed. Elsewhere, words will be transposed using the default style for :zle:transpose-words.

The word matching and all the handling of zstyle settings is actually implemented by the function match-words-by-style. This can be used to create new user-defined widgets. The calling function should set the local parameter curcontext to :zle:widget, create the local parameter matched_words and call match-words-by-style with no arguments. On return, matched_words will be set to an array with the elements: (1) the start of the line (2) the word before the cursor (3) any non-word characters between that word and the cursor (4) any non-word character at the cursor position plus any remaining non-word characters before the next word, including all characters specified by the skip-chars style, (5) the word at or following the cursor (6) any non-word characters following that word (7) the remainder of the line. Any of the elements may be an empty string; the calling function should test for this to decide whether it can perform its function.

If the variable matched_words is defined by the caller to match-words-by-style as an associative array (local -A matched_words), then the seven values given above should be retrieved from it as elements named start, word-before-cursor, ws-before-cursor, ws-after-cursor, word-after-cursor, ws-after-word, and end. In addition the element is-word-start is 1 if the cursor is on the start of a word or subword, or on white space before it (the cases can be distinguished by testing the ws-after-cursor element) and 0 otherwise. This form is recommended for future compatibility.

It is possible to pass options with arguments to match-words-by-style to override the use of styles. The options are:

-w

word-style

-s

skip-chars

-c

word-class

-C

word-chars

-r

subword-range

For example, match-words-by-style -w shell -c 0 may be used to extract the command argument around the cursor.

The word-context style is implemented by the function match-word-context. This should not usually need to be called directly.

The bracketed-paste-magic widget is meant to replace bracketed-paste with a wrapper that re-enables these self-insert actions, and other actions as selected by zstyles. Therefore this widget is installed with

autoload -Uz bracketed-paste-magic
zle -N bracketed-paste bracketed-paste-magic

Other than enabling some widget processing, bracketed-paste-magic attempts to replicate bracketed-paste as faithfully as possible.

The following zstyles may be set to control processing of pasted text. All are looked up in the context `:bracketed-paste-magic'.

active-widgets

A list of patterns matching widget names that should be activated during the paste. All other key sequences are processed as self-insert-unmeta. The default is `self-*' so any user-defined widgets named with that prefix are active along with the builtin self-insert.

inactive-keys

The inverse of active-widgets, a list of key sequences that always use self-insert-unmeta even when bound to an active widget. Note that this is a list of literal key sequences, not patterns.

paste-init

A list of function names, called in widget context (but not as widgets). The functions are called in order until one of them returns a non-zero status. The parameter `PASTED' contains the initial state of the pasted text. All other ZLE parameters such as `BUFFER' have their normal values and side-effects, and full history is available, so for example paste-init functions may move words from BUFFER into PASTED to make those words visible to the active-widgets.

zstyle :bracketed-paste-magic paste-init \ 
       backward-extend-paste

paste-finish

Another list of function names called in order until one returns non-zero. These functions are called after the pasted text has been processed by the active-widgets, but before it is inserted into `BUFFER'. ZLE parameters have their normal values and side-effects.

zstyle :bracketed-paste-magic paste-finish \ 
       quote-paste
zstyle :bracketed-paste-magic:finish quote-style \ 
       qqq

zstyle :bracketed-paste-magic:finish quote-style \ 
       none

Important: During active-widgets processing of the paste (after paste-init and before paste-finish), BUFFER starts empty and history is restricted, so cursor motions, etc., may not pass outside of the pasted content. Text assigned to BUFFER by the active widgets is copied back into PASTED before paste-finish.

If insert-last-word has been used to retrieve the last word on a previous history line, repeated invocations will replace that word with earlier words from the same line.

Otherwise, the widget applies to words on the line currently being edited. The widget style can be set to the name of another widget that should be called to retrieve words. This widget must accept the same three arguments as insert-last-word.

This widget allows the cursor to be easily moved to the other interesting spots. It can be invoked repeatedly to cycle between all positions reported by the completion system.

The basic behaviour is to delete the word around the cursor. There is no numeric argument handling; only the single word around the cursor is considered. If the widget contains the string kill, the removed text will be placed in the cutbuffer for future yanking. This can be obtained by defining kill-whole-word-match as follows:

zle -N kill-whole-word-match delete-whole-word-match

and then binding the widget kill-whole-word-match.

Although you autoload only one function, the commands to use it are slightly different because it implements two widgets.

zle -N history-beginning-search-backward-end \ 
       history-search-end
zle -N history-beginning-search-forward-end \ 
       history-search-end
bindkey '\e^P' history-beginning-search-backward-end
bindkey '\e^N' history-beginning-search-forward-end

With a numeric argument, the search is not anchored to the start of the line; the string typed by the use may appear anywhere in the line in the history.

If the widget name contains `-end' the cursor is moved to the end of the line inserted. If the widget name contains `-space' any space in the text typed is treated as a wildcard and can match anything (hence a leading space is equivalent to giving a numeric argument). Both forms can be combined, for example:

zle -N history-beginning-search-menu-space-end \ 
       history-beginning-search-menu

The commands to create bindable widgets are similar to those in the example immediately above:

autoload -U history-pattern-search
zle -N history-pattern-search-backward history-pattern-search
zle -N history-pattern-search-forward history-pattern-search

This works only with the new function based completion system.

bindkey '^Xi' incremental-complete-word

The function may optionally be followed by up to two characters which replace one or both of the characters read from the keyboard; if both characters are supplied, no input is read. For example, insert-composed-char a: can be used within a widget to insert an a with umlaut into the command line. This has the advantages over use of a literal character that it is more portable.

For best results zsh should have been built with support for multibyte characters (configured with --enable-multibyte); however, the function works for the limited range of characters available in single-byte character sets such as ISO-8859-1.

The character is converted into the local representation and inserted into the command line at the cursor position. (The conversion is done within the shell, using whatever facilities the C library provides.) With a numeric argument, the character and its code are previewed in the status line

The function may be run outside zle in which case it prints the character (together with a newline) to standard output. Input is still read from keystrokes.

See insert-unicode-char for an alternative way of inserting Unicode characters using their hexadecimal character number.

The set of accented characters is reasonably complete up to Unicode character U+0180, the set of special characters less so. However, it is very sporadic from that point. Adding new characters is easy, however; see the function define-composed-chars. Please send any additions to zsh-workers@zsh.org.

The codes for the second character when used to accent the first are as follows. Note that not every character can take every accent.

!

Grave.

'

Acute.

>

Circumflex.

?

Tilde. (This is not ~ as RFC 1345 does not assume that character is present on the keyboard.)

-

Macron. (A horizontal bar over the base character.)

(

Breve. (A shallow dish shape over the base character.)

.

Dot above the base character, or in the case of i no dot, or in the case of L and l a centered dot.

:

Diaeresis (Umlaut).

c

Cedilla.

_

Underline, however there are currently no underlined characters.

/

Stroke through the base character.

"

Double acute (only supported on a few letters).

;

Ogonek. (A little forward facing hook at the bottom right of the character.)

<

Caron. (A little v over the letter.)

0

Circle over the base character.

2

Hook over the base character.

9

Horn over the base character.

The most common characters from the Arabic, Cyrillic, Greek and Hebrew alphabets are available; consult RFC 1345 for the appropriate sequences. In addition, a set of two letter codes not in RFC 1345 are available for the double-width characters corresponding to ASCII characters from ! to ~ (0x21 to 0x7e) by preceding the character with ^, for example ^A for a double-width A.

The following other two-character sequences are understood.

ASCII characters

These are already present on most keyboards:

<(

Left square bracket

//

Backslash (solidus)

)>

Right square bracket

(!

Left brace (curly bracket)

!!

Vertical bar (pipe symbol)

!)

Right brace (curly bracket)

'?

Tilde

Special letters

Characters found in various variants of the Latin alphabet:

ss

Eszett (scharfes S)

D-, d-

Eth

TH, th

Thorn

kk

Kra

'n

'n

NG, ng

Ng

OI, oi

Oi

yr

yr

ED

ezh

Currency symbols

Ct

Cent

Pd

Pound sterling (also lira and others)

Cu

Currency

Ye

Yen

Eu

Euro (N.B. not in RFC 1345)

Punctuation characters

References to "right" quotes indicate the shape (like a 9 rather than 6) rather than their grammatical use. (For example, a "right" low double quote is used to open quotations in German.)

!I

Inverted exclamation mark

BB

Broken vertical bar

SE

Section

Co

Copyright

-a

Spanish feminine ordinal indicator

<<

Left guillemet

--

Soft hyphen

Rg

Registered trade mark

PI

Pilcrow (paragraph)

-o

Spanish masculine ordinal indicator

>>

Right guillemet

?I

Inverted question mark

-1

Hyphen

-N

En dash

-M

Em dash

-3

Horizontal bar

:3

Vertical ellipsis

.3

Horizontal midline ellipsis

!2

Double vertical line

=2

Double low line

'6

Left single quote

'9

Right single quote

.9

"Right" low quote

9'

Reversed "right" quote

"6

Left double quote

"9

Right double quote

:9

"Right" low double quote

9"

Reversed "right" double quote

/-

Dagger

/=

Double dagger

Mathematical symbols

DG

Degree

-2, +-, -+

- sign, +/- sign, -/+ sign

2S

Superscript 2

3S

Superscript 3

1S

Superscript 1

My

Micro

.M

Middle dot

14

Quarter

12

Half

34

Three quarters

*X

Multiplication

-:

Division

%0

Per mille

FA, TE, /0

For all, there exists, empty set

dP, DE, NB

Partial derivative, delta (increment), del (nabla)

(-, -)

Element of, contains

*P, +Z

Product, sum

*-, Ob, Sb

Asterisk, ring, bullet

RT, 0(, 00

Root sign, proportional to, infinity

Other symbols

cS, cH, cD, cC

Card suits: spades, hearts, diamonds, clubs

Md, M8, M2, Mb, Mx, MX

Musical notation: crotchet (quarter note), quaver (eighth note), semiquavers (sixteenth notes), flag sign, natural sign, sharp sign

Fm, Ml

Female, male

Accents on their own

'>

Circumflex (same as caret, ^)

'!

Grave (same as backtick, `)

',

Cedilla

':

Diaeresis (Umlaut)

'm

Macron

''

Acute

See insert-composed-char for a way of inserting characters using a two-character mnemonic.

narrow-to-region may be used as a widget or called as a function from a user-defined widget; by default, the text outside the editable area remains visible. A recursive-edit is performed and the original widening status is then restored. Various options and arguments are available when it is called as a function.

The options -p pretext and -P posttext may be used to replace the text before and after the display for the duration of the function; either or both may be an empty string.

If the option -n is also given, pretext or posttext will only be inserted if there is text before or after the region respectively which will be made invisible.

Two numeric arguments may be given which will be used instead of the cursor and mark positions.

The option -S statepm is used to narrow according to the other options while saving the original state in the parameter with name statepm, while the option -R statepm is used to restore the state from the parameter; note in both cases the name of the parameter is required. In the second case, other options and arguments are irrelevant. When this method is used, no recursive-edit is performed; the calling widget should call this function with the option -S, perform its own editing on the command line or pass control to the user via `zle recursive-edit', then call this function with the option -R. The argument statepm must be a suitable name for an ordinary parameter, except that parameters beginning with the prefix _ntr_ are reserved for use within narrow-to-region. Typically the parameter will be local to the calling function.

The options -l lbufvar and -r rbufvar may be used to specify parameters where the widget will store the resulting text from the operation. The parameter lbufvar will contain LBUFFER and rbufvar will contain RBUFFER. Neither of these two options may be used with -S or -R.

narrow-to-region-invisible is a simple widget which calls narrow-to-region with arguments which replace any text outside the region with `...'. It does not take any arguments.

The display is restored (and the widget returns) upon any zle command which would usually cause the line to be accepted or aborted. Hence an additional such command is required to accept or abort the current line.

The return status of both widgets is zero if the line was accepted, else non-zero.

Here is a trivial example of a widget using this feature.

local state
narrow-to-region -p $'Editing restricted region\n' \ 
  -P '' -S state
zle recursive-edit
narrow-to-region -R state

With the function based completion system (which is needed for this), you should be able to type TAB at almost any point to advance the cursor to the next ``interesting'' character position (usually the end of the current word, but sometimes somewhere in the middle of the word). And of course as soon as the entire line is what you want, you can accept with return, without needing to move the cursor to the end first.

The first time predict-on is used, it creates several additional widget functions:

delete-backward-and-predict

Replaces the backward-delete-char widget. You do not need to bind this yourself.

insert-and-predict

Implements predictive typing by replacing the self-insert widget. You do not need to bind this yourself.

predict-off

Turns off predictive typing.

Although you autoload only the predict-on function, it is necessary to create a keybinding for predict-off as well.

zle -N predict-on
zle -N predict-off
bindkey '^X^Z' predict-on
bindkey '^Z' predict-off

If one argument is supplied to the function it is taken as a prompt, otherwise `? ' is used. If two arguments are supplied, they are the prompt and the initial value of $LBUFFER, and if a third argument is given it is the initial value of $RBUFFER. This provides a default value and starting cursor placement. Upon return the entire buffer is the value of $REPLY.

One option is available: `-k num' specifies that num characters are to be read instead of a whole line. The line editor is not invoked recursively in this case, so depending on the terminal settings the input may not be visible, and only the input keys are placed in $REPLY, not the entire buffer. Note that unlike the read builtin num must be given; there is no default.

The name is a slight misnomer, as in fact the shell's own minibuffer is not used. Hence it is still possible to call executed-named-cmd and similar functions while reading a value.

If a numeric argument is given, that specifies the argument to be replaced. 0 means the command name, as in history expansion. A negative numeric argument counts backward from the last word.

If no numeric argument is given, the current argument is replaced; this is the last argument if the previous history line is being used.

The function prompts for a replacement argument.

If the widget contains the string edit, for example is defined as

zle -N replace-argument-edit replace-argument

then the function presents the current value of the argument for editing, otherwise the editing buffer for the replacement is initially empty.

If the widget name contains the word `pattern', for example by defining the widget using the command `zle -N replace-pattern replace-string', then the matching is performed using zsh patterns. All zsh extended globbing patterns can be used in the source string; note that unlike filename generation the pattern does not need to match an entire word, nor do glob qualifiers have any effect. In addition, the replacement string can contain parameter or command substitutions. Furthermore, a `&' in the replacement string will be replaced with the matched source string, and a backquoted digit `\N' will be replaced by the Nth parenthesised expression matched. The form `\{N}' may be used to protect the digit from following digits.

If the widget instead contains the word `regex' (or `regexp'), then the matching is performed using regular expressions, respecting the setting of the option RE_MATCH_PCRE (see the description of the function regexp-replace below). The special replacement facilities described above for pattern matching are available.

By default the previous source or replacement string will not be offered for editing. However, this feature can be activated by setting the style edit-previous in the context :zle:widget (for example, :zle:replace-string) to true. In addition, a positive numeric argument forces the previous values to be offered, a negative or zero argument forces them not to be.

The function replace-string-again can be used to repeat the previous replacement; no prompting is done. As with replace-string, if the name of the widget contains the word `pattern' or `regex', pattern or regular expression matching is performed, else a literal string replacement. Note that the previous source and replacement text are the same whether pattern, regular expression or string matching is used.

In addition, replace-string shows the previous replacement above the prompt, so long as there was one during the current session; if the source string is empty, that replacement will be repeated without the widget prompting for a replacement string.

For example, starting from the line:

print This line contains fan and fond

and invoking replace-pattern with the source string `f(?)n' and the replacement string `c\1r' produces the not very useful line:

print This line contains car and cord

The range of the replacement string can be limited by using the narrow-to-region-invisible widget. One limitation of the current version is that undo will cycle through changes to the replacement and source strings before undoing the replacement itself.

If one argument is supplied to the function it is taken as a prompt, otherwise `Non-echoed text: ' is used (as in emacs). If a second and third argument are supplied they are used to begin and end the reference to $INVISIBLE that is inserted into the buffer. The default is to open with ${, then INVISIBLE, and close with }, but many other effects are possible.

zle -N insert-last-word smart-insert-last-word

With a numeric argument, or when passed command line arguments in a call from another widget, it behaves like insert-last-word, except that words in comments are ignored when INTERACTIVE_COMMENTS is set.

Otherwise, the rightmost ``interesting'' word from the previous command is found and inserted. The default definition of ``interesting'' is that the word contains at least one alphabetic character, slash, or backslash. This definition may be overridden by use of the match style. The context used to look up the style is the widget name, so usually the context is :insert-last-word. However, you can bind this function to different widgets to use different patterns:

zle -N insert-last-assignment smart-insert-last-word
zstyle :insert-last-assignment match '[[:alpha:]][][[:alnum:]]#=*'
bindkey '\e=' insert-last-assignment

If no interesting word is found and the auto-previous style is set to a true value, the search continues upward through the history. When auto-previous is unset or false (the default), the widget must be invoked repeatedly in order to search earlier history lines.

Transpose the current line with the previous line and move the cursor to the start of the next line. Repeating this (which can be done by providing a positive numeric argument) has the effect of moving the line above the cursor down by a number of lines.

With a negative numeric argument, requires two lines above the cursor. These two lines are transposed and the cursor moved to the start of the previous line. Using a numeric argument less than -1 has the effect of moving the line above the cursor up by minus that number of lines.

Styles to control quoting behavior:

url-metas

This style is looked up in the context `:url-quote-magic:scheme' (where scheme is that of the current URL, e.g. "ftp"). The value is a string listing the characters to be treated as globbing metacharacters when appearing in a URL using that scheme. The default is to quote all zsh extended globbing characters, excluding '<' and '>' but including braces (as in brace expansion). See also url-seps.

url-seps

Like url-metas, but lists characters that should be considered command separators, redirections, history references, etc. The default is to quote the standard set of shell separators, excluding those that overlap with the extended globbing characters, but including '<' and '>' and the first character of $histchars.

url-globbers

This style is looked up in the context `:url-quote-magic'. The values form a list of command names that are expected to do their own globbing on the URL string. This implies that they are aliased to use the `noglob' modifier. When the first word on the line matches one of the values and the URL refers to a local file (see url-local-schema), only the url-seps characters are quoted; the url-metas are left alone, allowing them to affect command-line parsing, completion, etc. The default values are a literal `noglob' plus (when the zsh/parameter module is available) any commands aliased to the helper function `urlglobber' or its alias `globurl'.

url-local-schema

This style is always looked up in the context `:urlglobber', even though it is used by both url-quote-magic and urlglobber. The values form a list of URI schema that should be treated as referring to local files by their real local path names, as opposed to files which are specified relative to a web-server-defined document root. The defaults are "ftp" and "file".

url-other-schema

Like url-local-schema, but lists all other URI schema upon which urlglobber and url-quote-magic should act. If the URI on the command line does not have a scheme appearing either in this list or in url-local-schema, it is not magically quoted. The default values are "http", "https", and "ftp". When a scheme appears both here and in url-local-schema, it is quoted differently depending on whether the command name appears in url-globbers.

Loading url-quote-magic also defines a helper function `urlglobber' and aliases `globurl' to `noglob urlglobber'. This function takes a local URL apart, attempts to pattern-match the local file portion of the URL path, and then puts the results back into URL format again.

The function serves as an example for reading a vi movement command from within a user-defined widget.

The style whence is available in the context :zle:$WIDGET; this may be set to an array to give the command and options that will be used to investigate the command word found. The default is whence -c.

Hence, for example, typing `+12' followed by return adds 12 to the previous result.

If zcalc is in RPN mode (-r option) the effect of this binding is automatically suppressed as operators alone on a line are meaningful.

When not in zcalc, the key simply inserts the symbol itself.

The parameter REPLY is set to the index of the word in reply which contains the character after the cursor, where the first element has index 1. The parameter REPLY2 is set to the index of the character under the cursor in that word, where the first character has index 1.

Hence reply, REPLY and REPLY2 should all be made local to the enclosing function.

See the function modify-current-argument, described below, for an example of how to call this function.

The argument can be an expression which when evaluated operates on the shell parameter ARG, which will have been set to the command line argument under the cursor. The expression should be suitably quoted to prevent it being evaluated too early.

Alternatively, if the argument does not contain the string ARG, it is assumed to be a shell function, to which the current command line argument is passed as the only argument. The function should set the variable REPLY to the new value for the command line argument. If the function returns non-zero status, so does the calling function.

For example, a user-defined widget containing the following code converts the characters in the argument under the cursor into all upper case:

modify-current-argument '${(U)ARG}'

The following strips any quoting from the current word (whether backslashes or one of the styles of quotes), and replaces it with single quoting throughout:

modify-current-argument '${(qq)${(Q)ARG}}'

The following performs directory expansion on the command line argument and replaces it by the absolute path:

expand-dir() {
  REPLY=${~1}
  REPLY=${REPLY:a}
}
modify-current-argument expand-dir

In practice the function expand-dir would probably not be defined within the widget where modify-current-argument is called.

zstyle ':completion:*' completer \ 
        _complete _correct _approximate
zstyle ':completion:incremental:*' completer \ 
        _complete _correct
zstyle ':completion:predict:*' completer \ 
        _complete

It is a good idea to restrict the completers used in prediction, because they may be automatically invoked as you type. The _list and _menu completers should never be used with prediction. The _approximate, _correct, _expand, and _match completers may be used, but be aware that they may change characters anywhere in the word behind the cursor, so you need to watch carefully that the result is what you intended.

complete

The cursor is left where it was when completion finished, but only if it is after a character equal to the one just inserted by the user. If it is after another character, this value is the same as `key'.

key

The cursor is left after the nth occurrence of the character just inserted, where 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.

Any other value for this style unconditionally leaves the cursor at the position where the completion code left it.

The insert-and-predict 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 always. In this case the context is `:predict' (not `:completion:predict').

zstyle :insert-last-word match '*[[:alpha:]/\\]*'

However, you might want to include words that contain spaces:

zstyle :insert-last-word match '*[[:alpha:][:space:]/\\]*'

Or include numbers as long as the word is at least two characters long:

zstyle :insert-last-word match '*([[:digit:]]?|[[:alpha:]/\\])*'

The above example causes redirections like "2>" to be included.

%c

Replaced by the name of the completer function that generated the matches (without the leading underscore).

%l

When the list style is set, replaced by `...' if the list of matches is too long to fit on the screen and with an empty string otherwise. If the list style is `false' or not set, `%l' is always removed.

%n

Replaced by the number of matches generated.

%s

Replaced by `-no match-', `-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.

%u

Replaced by the unambiguous part of all matches, if there is any, and if it is different from the word on the line.

Like `break-keys', this uses the `:incremental' context.

zstyle :copy-earlier-word widget smart-insert-last-word

Check the documentation for the calling widget or function to determine whether the widget style is used.

The eight base colors are: black, red, green, yellow, blue, magenta, cyan, and white. Each of these has codes for foreground and background. In addition there are seven intensity attributes: bold, faint, standout, underline, blink, reverse, and conceal. Finally, there are seven codes used to negate attributes: none (reset all attributes to the defaults), normal (neither bold nor faint), no-standout, no-underline, no-blink, no-reverse, and no-conceal.

Some terminals do not support all combinations of colors and intensities.

The associative arrays are:

color

colour

Map all the color names to their integer codes, and integer codes to the color names. The eight base names map to the foreground color codes, as do names prefixed with `fg-', such as `fg-red'. Names prefixed with `bg-', such as `bg-blue', refer to the background codes. The reverse mapping from code to color yields base name for foreground codes and the bg- form for backgrounds.

fg

fg_bold

fg_no_bold

Map the eight basic color names to ANSI terminal escape sequences that set the corresponding foreground text properties. The fg sequences change the color without changing the eight intensity attributes.

bg

bg_bold

bg_no_bold

Map the eight basic color names to ANSI terminal escape sequences that set the corresponding background properties. The bg sequences change the color without changing the eight intensity attributes.

In addition, the scalar parameters reset_color and bold_color are set to the ANSI terminal escapes that turn off all attributes and turn on bold intensity, respectively.

This is useful in startup files to set options and other state that are not available in all versions of zsh.

is-at-least 3.1.6-15 && setopt NO_GLOBAL_RCS
is-at-least 3.1.0 && setopt HIST_REDUCE_BLANKS
is-at-least 2.6-17 || print "You can't use is-at-least here."

See also the pager, prompt and rprompt styles below.

var is the name of the variable containing the string to be matched. The variable will be modified directly by the function. The variables MATCH, MBEGIN, MEND, match, mbegin, mend should be avoided as these are used by the regular expression code.

regexp is the regular expression to match against the string.

replace is the replacement text. This can contain parameter, command and arithmetic expressions which will be replaced: in particular, a reference to $MATCH will be replaced by the text matched by the pattern.

The return status is 0 if at least one match was performed, else 1.

In the discussion which follows, if cmd is a file system path, it is first reduced to its rightmost component (the file name).

Help is first sought by looking for a file named cmd in the directory named by the HELPDIR parameter. If no file is found, an assistant function, alias, or command named run-help-cmd is sought. If found, the assistant is executed with the rest of the current command line (everything after the command name cmd) as its arguments. When neither file nor assistant is found, the external command `man cmd' is run.

An example assistant for the "ssh" command:

run-help-ssh() {
    emulate -LR zsh
    local -a args
    # Delete the "-l username" option
    zparseopts -D -E -a args l:
    # Delete other options, leaving: host command
    args=(${@:#-*})
    if [[ ${#args} -lt 2 ]]; then
        man ssh
    else
        run-help $args[2]
    fi
}

Several of these assistants are provided in the Functions/Misc directory. These must be autoloaded, or placed as executable scripts in your search path, in order to be found and used by run-help.

run-help-git

run-help-ip

run-help-openssl

run-help-p4

run-help-sudo

run-help-svk

run-help-svn

Assistant functions for the git, ip, openssl, p4, sudo, svk, and svn, commands.

This function must be used as a ZLE widget:

autoload -U tetris
zle -N tetris
bindkey keys tetris

To start a game, execute the widget by typing the keys. Whatever command line you were editing disappears temporarily, and your keymap is also temporarily replaced by the Tetris control keys. The previous editor state is restored when you quit the game (by pressing `q') or when you lose.

If you quit in the middle of a game, the next invocation of the tetris widget will continue where you left off. If you lost, it will start a new game.

This version does not save the game state between invocations, and is not invoked as a widget, but rather as:

autoload -U tetriscurses
tetriscurses

The option list represents options of the zargs command itself, which are the same as those of xargs. The input list is the collection of strings (often file names) that become the arguments of the command, analogous to the standard input of xargs. Finally, the arg list consists of those arguments (usually options) that are passed to the command each time it runs. The arg list precedes the elements from the input list in each run. If no command is provided, then no arg list may be provided, and in that event the default command is `print' with arguments `-r --'.

For example, to get a long ls listing of all non-hidden plain files in the current directory or its subdirectories:

autoload -U zargs
zargs -- **/*(.) -- ls -ld --

The first and third occurrences of `--' are used to mark the end of options for zargs and ls respectively to guard against filenames starting with `-', while the second is used to separate the list of files from the command to run (`ls -ld --').

The first `--' would also be needed if there was a chance the list might be empty as in:

zargs -r -- ./*.back(#qN) -- rm -f

In the event that the string `--' is or may be an input, the -e option may be used to change the end-of-inputs marker. Note that this does not change the end-of-options marker. For example, to use `..' as the marker:

zargs -e.. -- **/*(.) .. ls -ld --

This is a good choice in that example because no plain file can be named `..', but the best end-marker depends on the circumstances.

The options -i, -I, -l, -L, and -n differ slightly from their usage in xargs. There are no input lines for zargs to count, so -l and -L count through the input list, and -n counts the number of arguments passed to each execution of command, including any arg list. Also, any time -i or -I is used, each input is processed separately as if by `-L 1'.

For details of the other zargs options, see xargs(1) (but note the difference in function between zargs and xargs) or run zargs with the --help option.

Only one name argument is allowed. If the -f option is given, the name is taken to be that of a function; if the function is marked for autoloading, zed searches for it in the fpath and loads it. Note that functions edited this way are installed into the current shell, but not written back to the autoload file. In this case the -x option specifies that leading tabs indenting the function according to syntax should be converted into the given number of spaces; `-x 2' is consistent with the layout of functions distributed with the shell.

Without -f, name is the path name of the file to edit, which need not exist; it is created on write, if necessary.

While editing, the function sets the main keymap to zed and the vi command keymap to zed-vicmd. These will be copied from the existing main and vicmd keymaps if they do not exist the first time zed is run. They can be used to provide special key bindings used only in zed.

If it creates the keymap, zed rebinds the return key to insert a line break and `^X^W' to accept the edit in the zed keymap, and binds `ZZ' to accept the edit in the zed-vicmd keymap.

The bindings alone can be installed by running `zed -b'. This is suitable for putting into a startup file. Note that, if rerun, this will overwrite the existing zed and zed-vicmd keymaps.

Completion is available, and styles may be set with the context prefix `:completion:zed'.

A zle widget zed-set-file-name is available. This can be called by name from within zed using `\ex zed-set-file-name' (note, however, that because of zed's rebindings you will have to type ^j at the end instead of the return key), or can be bound to a key in either of the zed or zed-vicmd keymaps after `zed -b' has been run. When the widget is called, it prompts for a new name for the file being edited. When zed exits the file will be written under that name and the original file will be left alone. The widget has no effect with `zed -f'.

While zed-set-file-name is running, zed uses the keymap zed-normal-keymap, which is linked from the main keymap in effect at the time zed initialised its bindings. (This is to make the return key operate normally.) The result is that if the main keymap has been changed, the widget won't notice. This is not a concern for most users.

zmv '(*).lis' '$1.txt'

renames `foo.lis' to `foo.txt', `my.old.stuff.lis' to `my.old.stuff.txt', and so on.

The pattern is always treated as an EXTENDED_GLOB pattern. Any file whose name is not changed by the substitution is simply ignored. Any error (a substitution resulted in an empty string, two substitutions gave the same result, the destination was an existing regular file and -f was not given) causes the entire function to abort without doing anything.

In addition to pattern replacement, the variable $f can be referrred to in the second (replacement) argument. This makes it possible to use variable substitution to alter the argument; see examples below.

Options:

-f

Force overwriting of destination files. Not currently passed down to the mv/cp/ln command due to vagaries of implementations (but you can use -o-f to do that).

-i

Interactive: show each line to be executed and ask the user whether to execute it. `Y' or `y' will execute it, anything else will skip it. Note that you just need to type one character.

-n

No execution: print what would happen, but don't do it.

-q

Turn bare glob qualifiers off: now assumed by default, so this has no effect.

-Q

Force bare glob qualifiers on. Don't turn this on unless you are actually using glob qualifiers in a pattern.

-s

Symbolic, passed down to ln; only works with -L.

-v

Verbose: print each command as it's being executed.

-w

Pick out wildcard parts of the pattern, as described above, and implicitly add parentheses for referring to them.

-W

Just like -w, with the addition of turning wildcards in the replacement pattern into sequential ${1} .. ${N} references.

-C

-L

-M

Force cp, ln or mv, respectively, regardless of the name of the function.

-p program

Call program instead of cp, ln or mv. Whatever it does, it should at least understand the form `program -- oldname newname' where oldname and newname are filenames generated by zmv. program will be split into words, so might be e.g. the name of an archive tool plus a copy or rename subcommand.

-P program

As -p program, except that program does not accept a following -- to indicate the end of options. In this case filenames must already be in a sane form for the program in question.

-o optstring

The optstring is split into words and passed down verbatim to the cp, ln or mv command called to perform the work. It should probably begin with a `-'.

Further examples:

zmv -v '(* *)' '${1// /_}'

For any file in the current directory with at least one space in the name, replace every space by an underscore and display the commands executed.

zmv -v '* *' '${f// /_}'

This does exactly the same by referring to the file name stored in $f.

For more complete examples and other implementation details, see the zmv source file, usually located in one of the directories named in your fpath, or in Functions/Misc/zmv in the zsh distribution.

zstyle+ ':foo:bar' style1 value1 \ 
       +':baz'     style2 value2 \ 
       +':frob'    style3 value3

This defines style1 with value1 for the context :foo:bar as usual, but it also defines style2 with value2 for the context :foo:bar:baz and style3 with value3 for :foo:bar:frob. Any subcontext may be the empty string to re-use the first context unchanged.