{
    "content": [
        {
            "type": "text",
            "text": "# zshcontrib (man)\n\n## NAME\n\nzshcontrib - user contributions to zsh\n\n## DESCRIPTION\n\nThe  Zsh  source  distribution  includes a number of items contributed by the user community.\nThese are not inherently a part of the shell, and some may not be available in every zsh  in‐\nstallation.   The  most significant of these are documented here.  For documentation on other\ncontributed items such as shell functions, look for comments in the function source files.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **UTILITIES** (5 subsections)\n- **REMEMBERING RECENT DIRECTORIES** (16 subsections)\n- **ABBREVIATED DYNAMIC REFERENCES TO DIRECTORIES** (3 subsections)\n- **GATHERING INFORMATION FROM VERSION CONTROL SYSTEMS** (73 subsections)\n- **PROMPT THEMES** (7 subsections)\n- **ZLE FUNCTIONS** (31 subsections)\n- **EXCEPTION HANDLING**\n- **MIME FUNCTIONS** (1 subsections)\n- **MATHEMATICAL FUNCTIONS** (1 subsections)\n- **USER CONFIGURATION FUNCTIONS**\n- **OTHER FUNCTIONS** (7 subsections)\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "zshcontrib",
        "section": "",
        "mode": "man",
        "summary": "zshcontrib - user contributions to zsh",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "-l",
                "long": null,
                "arg": null,
                "description": "substitution reapplied), one per line. The directories here are not quoted (this would only be an issue if a directory name contained a newline). This is used by the completion system."
            },
            {
                "flag": "-r",
                "long": null,
                "arg": null,
                "description": "directory is not changed."
            },
            {
                "flag": "-e",
                "long": null,
                "arg": null,
                "description": "any extent you like; no sanity checking is performed. Completion is available. No quoting is necessary (except for newlines, where I have in any case no sympathy); di‐ rectories are in unabbreviated from and contain an absolute path, i.e. they start with /. Usually the first entry should be left as the current directory."
            },
            {
                "flag": "-p",
                "long": null,
                "arg": null,
                "description": "Prunes any items in the directory list that match the given extended glob pattern; the pattern needs to be quoted from immediate expansion on the command line. The pattern is matched against each completely expanded file name in the list; the full string must match, so wildcards at the end (e.g. '*removeme*') are needed to remove entries with a given substring. 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."
            }
        ],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "UTILITIES",
                "lines": 1,
                "subsections": [
                    {
                        "name": "Accessing On-Line Help",
                        "lines": 39
                    },
                    {
                        "name": "Recompiling Functions",
                        "lines": 71
                    },
                    {
                        "name": "Keyboard Definition",
                        "lines": 32
                    },
                    {
                        "name": "Dumping Shell State",
                        "lines": 61
                    },
                    {
                        "name": "Manipulating Hook Functions",
                        "lines": 68
                    }
                ]
            },
            {
                "name": "REMEMBERING RECENT DIRECTORIES",
                "lines": 10,
                "subsections": [
                    {
                        "name": "Installation",
                        "lines": 10
                    },
                    {
                        "name": "Use",
                        "lines": 25
                    },
                    {
                        "name": "Options",
                        "lines": 2
                    },
                    {
                        "name": "-l",
                        "lines": 4,
                        "flag": "-l"
                    },
                    {
                        "name": "-r",
                        "lines": 2,
                        "flag": "-r"
                    },
                    {
                        "name": "-e",
                        "lines": 5,
                        "flag": "-e"
                    },
                    {
                        "name": "-p",
                        "lines": 10,
                        "flag": "-p"
                    },
                    {
                        "name": "Configuration",
                        "lines": 14
                    },
                    {
                        "name": "recent-dirs-default",
                        "lines": 6
                    },
                    {
                        "name": "recent-dirs-file",
                        "lines": 35
                    },
                    {
                        "name": "recent-dirs-insert",
                        "lines": 19
                    },
                    {
                        "name": "recent-dirs-max",
                        "lines": 5
                    },
                    {
                        "name": "recent-dirs-prune",
                        "lines": 17
                    },
                    {
                        "name": "recent-dirs-pushd",
                        "lines": 5
                    },
                    {
                        "name": "Use with dynamic directory naming",
                        "lines": 9
                    },
                    {
                        "name": "Details of directory handling",
                        "lines": 16
                    }
                ]
            },
            {
                "name": "ABBREVIATED DYNAMIC REFERENCES TO DIRECTORIES",
                "lines": 25,
                "subsections": [
                    {
                        "name": "Usage",
                        "lines": 10
                    },
                    {
                        "name": "Configuration",
                        "lines": 59
                    },
                    {
                        "name": "Complete example",
                        "lines": 45
                    }
                ]
            },
            {
                "name": "GATHERING INFORMATION FROM VERSION CONTROL SYSTEMS",
                "lines": 44,
                "subsections": [
                    {
                        "name": "Quickstart",
                        "lines": 58
                    },
                    {
                        "name": "Configuration",
                        "lines": 34
                    },
                    {
                        "name": "default",
                        "lines": 1
                    },
                    {
                        "name": "command",
                        "lines": 6
                    },
                    {
                        "name": "formats",
                        "lines": 2
                    },
                    {
                        "name": "actionformats",
                        "lines": 3
                    },
                    {
                        "name": "branchformat",
                        "lines": 4
                    },
                    {
                        "name": "nvcsformats",
                        "lines": 5
                    },
                    {
                        "name": "hgrevformat",
                        "lines": 7
                    },
                    {
                        "name": "max-exports",
                        "lines": 7
                    },
                    {
                        "name": "disable",
                        "lines": 3
                    },
                    {
                        "name": "disable-patterns",
                        "lines": 7
                    },
                    {
                        "name": "use-quilt",
                        "lines": 3
                    },
                    {
                        "name": "quilt-standalone",
                        "lines": 3
                    },
                    {
                        "name": "quilt-patch-dir",
                        "lines": 3
                    },
                    {
                        "name": "quiltcommand",
                        "lines": 3
                    },
                    {
                        "name": "check-for-changes",
                        "lines": 16
                    },
                    {
                        "name": "check-for-staged-changes",
                        "lines": 9
                    },
                    {
                        "name": "stagedstr",
                        "lines": 3
                    },
                    {
                        "name": "unstagedstr",
                        "lines": 3
                    },
                    {
                        "name": "command",
                        "lines": 15
                    },
                    {
                        "name": "use-server",
                        "lines": 13
                    },
                    {
                        "name": "use-simple",
                        "lines": 7
                    },
                    {
                        "name": "get-revision",
                        "lines": 9
                    },
                    {
                        "name": "get-bookmarks",
                        "lines": 7
                    },
                    {
                        "name": "use-prompt-escapes",
                        "lines": 9
                    },
                    {
                        "name": "patch-format",
                        "lines": 1
                    },
                    {
                        "name": "nopatch-format",
                        "lines": 5
                    },
                    {
                        "name": "get-unapplied",
                        "lines": 7
                    },
                    {
                        "name": "formats",
                        "lines": 1
                    },
                    {
                        "name": "actionformats",
                        "lines": 1
                    },
                    {
                        "name": "branchformat",
                        "lines": 1
                    },
                    {
                        "name": "nvcsformats",
                        "lines": 1
                    },
                    {
                        "name": "hgrevformat",
                        "lines": 1
                    },
                    {
                        "name": "max-exports",
                        "lines": 2
                    },
                    {
                        "name": "disable",
                        "lines": 1
                    },
                    {
                        "name": "disable-patterns",
                        "lines": 1
                    },
                    {
                        "name": "check-for-changes",
                        "lines": 1
                    },
                    {
                        "name": "check-for-staged-changes",
                        "lines": 1
                    },
                    {
                        "name": "stagedstr",
                        "lines": 1
                    },
                    {
                        "name": "unstagedstr",
                        "lines": 1
                    },
                    {
                        "name": "command",
                        "lines": 1
                    },
                    {
                        "name": "use-server",
                        "lines": 1
                    },
                    {
                        "name": "use-simple",
                        "lines": 1
                    },
                    {
                        "name": "get-revision",
                        "lines": 2
                    },
                    {
                        "name": "get-bookmarks",
                        "lines": 1
                    },
                    {
                        "name": "use-prompt-escapes",
                        "lines": 3
                    },
                    {
                        "name": "use-quilt",
                        "lines": 1
                    },
                    {
                        "name": "quilt-standalone",
                        "lines": 1
                    },
                    {
                        "name": "quilt-patch-dir",
                        "lines": 1
                    },
                    {
                        "name": "quiltcommand",
                        "lines": 1
                    },
                    {
                        "name": "patch-format",
                        "lines": 1
                    },
                    {
                        "name": "nopatch-format",
                        "lines": 1
                    },
                    {
                        "name": "get-unapplied",
                        "lines": 60
                    },
                    {
                        "name": "Oddities",
                        "lines": 12
                    },
                    {
                        "name": "Quilt Support",
                        "lines": 82
                    },
                    {
                        "name": "Function Descriptions (Public API)",
                        "lines": 36
                    },
                    {
                        "name": "Variable Description",
                        "lines": 58
                    },
                    {
                        "name": "context",
                        "lines": 8
                    },
                    {
                        "name": "start-up",
                        "lines": 5
                    },
                    {
                        "name": "pre-get-data",
                        "lines": 2
                    },
                    {
                        "name": "gen-hg-bookmark-string",
                        "lines": 12
                    },
                    {
                        "name": "gen-applied-string",
                        "lines": 13
                    },
                    {
                        "name": "gen-unapplied-string",
                        "lines": 12
                    },
                    {
                        "name": "gen-mqguards-string",
                        "lines": 12
                    },
                    {
                        "name": "post-backend",
                        "lines": 4
                    },
                    {
                        "name": "post-quilt",
                        "lines": 7
                    },
                    {
                        "name": "set-branch-format",
                        "lines": 10
                    },
                    {
                        "name": "set-hgrev-format",
                        "lines": 10
                    },
                    {
                        "name": "pre-addon-quilt",
                        "lines": 7
                    },
                    {
                        "name": "set-patch-format",
                        "lines": 16
                    },
                    {
                        "name": "set-message",
                        "lines": 22
                    },
                    {
                        "name": "Examples",
                        "lines": 105
                    }
                ]
            },
            {
                "name": "PROMPT THEMES",
                "lines": 1,
                "subsections": [
                    {
                        "name": "Installation",
                        "lines": 14
                    },
                    {
                        "name": "Theme Selection",
                        "lines": 30
                    },
                    {
                        "name": "Utility Themes",
                        "lines": 1
                    },
                    {
                        "name": "prompt off",
                        "lines": 3
                    },
                    {
                        "name": "prompt default",
                        "lines": 3
                    },
                    {
                        "name": "prompt restore",
                        "lines": 7
                    },
                    {
                        "name": "Writing Themes",
                        "lines": 36
                    }
                ]
            },
            {
                "name": "ZLE FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "Widgets",
                        "lines": 203
                    },
                    {
                        "name": "bracketed-paste-magic",
                        "lines": 86
                    },
                    {
                        "name": "copy-earlier-word",
                        "lines": 13
                    },
                    {
                        "name": "cycle-completion-positions",
                        "lines": 11
                    },
                    {
                        "name": "delete-whole-word-match",
                        "lines": 21
                    },
                    {
                        "name": "edit-command-line",
                        "lines": 4
                    },
                    {
                        "name": "expand-absolute-path",
                        "lines": 4
                    },
                    {
                        "name": "history-search-end",
                        "lines": 17
                    },
                    {
                        "name": "history-beginning-search-menu",
                        "lines": 18
                    },
                    {
                        "name": "history-pattern-search",
                        "lines": 22
                    },
                    {
                        "name": "incremental-complete-word",
                        "lines": 11
                    },
                    {
                        "name": "insert-composed-char",
                        "lines": 170
                    },
                    {
                        "name": "insert-files",
                        "lines": 5
                    },
                    {
                        "name": "insert-unicode-char",
                        "lines": 12
                    },
                    {
                        "name": "narrow-to-region-invisible",
                        "lines": 51
                    },
                    {
                        "name": "predict-on",
                        "lines": 34
                    },
                    {
                        "name": "read-from-minibuffer",
                        "lines": 96
                    },
                    {
                        "name": "send-invisible",
                        "lines": 14
                    },
                    {
                        "name": "smart-insert-last-word",
                        "lines": 24
                    },
                    {
                        "name": "transpose-lines",
                        "lines": 13
                    },
                    {
                        "name": "url-quote-magic",
                        "lines": 54
                    },
                    {
                        "name": "vi-pipe",
                        "lines": 8
                    },
                    {
                        "name": "which-command",
                        "lines": 9
                    },
                    {
                        "name": "zcalc-auto-insert",
                        "lines": 15
                    },
                    {
                        "name": "Utility Functions",
                        "lines": 3
                    },
                    {
                        "name": "split-shell-arguments",
                        "lines": 54
                    },
                    {
                        "name": "Styles",
                        "lines": 4
                    },
                    {
                        "name": "break-keys",
                        "lines": 5
                    },
                    {
                        "name": "completer",
                        "lines": 85
                    },
                    {
                        "name": "stop-keys",
                        "lines": 12
                    },
                    {
                        "name": "verbose",
                        "lines": 15
                    }
                ]
            },
            {
                "name": "EXCEPTION HANDLING",
                "lines": 68,
                "subsections": []
            },
            {
                "name": "MIME FUNCTIONS",
                "lines": 220,
                "subsections": [
                    {
                        "name": "pick-web-browser",
                        "lines": 65
                    }
                ]
            },
            {
                "name": "MATHEMATICAL FUNCTIONS",
                "lines": 176,
                "subsections": [
                    {
                        "name": "zmathfunc",
                        "lines": 25
                    }
                ]
            },
            {
                "name": "USER CONFIGURATION FUNCTIONS",
                "lines": 35,
                "subsections": []
            },
            {
                "name": "OTHER FUNCTIONS",
                "lines": 4,
                "subsections": [
                    {
                        "name": "Descriptions",
                        "lines": 147
                    },
                    {
                        "name": "tetriscurses",
                        "lines": 178
                    },
                    {
                        "name": "zrecompile",
                        "lines": 15
                    },
                    {
                        "name": "Styles",
                        "lines": 1
                    },
                    {
                        "name": "insert-tab",
                        "lines": 7
                    },
                    {
                        "name": "prompt",
                        "lines": 1
                    },
                    {
                        "name": "rprompt",
                        "lines": 7
                    }
                ]
            }
        ],
        "sections": {
            "NAME": {
                "content": "zshcontrib - user contributions to zsh\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The  Zsh  source  distribution  includes a number of items contributed by the user community.\nThese are not inherently a part of the shell, and some may not be available in every zsh  in‐\nstallation.   The  most significant of these are documented here.  For documentation on other\ncontributed items such as shell functions, look for comments in the function source files.\n",
                "subsections": []
            },
            "UTILITIES": {
                "content": "",
                "subsections": [
                    {
                        "name": "Accessing On-Line Help",
                        "content": "The key sequence ESC h is normally bound by ZLE to execute  the  run-help  widget  (see  zsh‐\nzle(1)).  This invokes the run-help command with the command word from the current input line\nas its argument.  By default, run-help is an alias for the man command, so this  often  fails\nwhen  the  command  word  is  a  shell builtin or a user-defined function.  By redefining the\nrun-help alias, one can improve the on-line help provided by the shell.\n\nThe helpfiles utility, found in the Util directory of the distribution,  is  a  Perl  program\nthat  can  be  used  to process the zsh manual to produce a separate help file for each shell\nbuiltin and for many other shell features as well.  The autoloadable run-help function, found\nin  Functions/Misc,  searches for these helpfiles and performs several other tests to produce\nthe most complete help possible for the command.\n\nHelp files are  installed  by  default  to  a  subdirectory  of  /usr/share/zsh  or  /usr/lo‐‐\ncal/share/zsh.\n\nTo create your own help files with helpfiles, choose or create a directory where the individ‐\nual command help files will reside.  For example, you might choose ~/zshhelp.   If  you  un‐\npacked the zsh distribution in your home directory, you would use the commands:\n\nmkdir ~/zshhelp\nperl ~/zsh-5.8.1/Util/helpfiles ~/zshhelp\n\nThe  HELPDIR  parameter  tells run-help where to look for the help files. When unset, it uses\nthe default installation path.  To use your own set of help files, set this to the  appropri‐\nate path in one of your startup files:\n\nHELPDIR=~/zshhelp\n\nTo  use  the  run-help  function,  you need to add lines something like the following to your\n.zshrc or equivalent startup file:\n\nunalias run-help\nautoload run-help\n\nNote that in order for `autoload run-help' to work, the run-help file must be in one  of  the\ndirectories  named in your fpath array (see zshparam(1)).  This should already be the case if\nyou have a standard zsh installation; if it is not, copy Functions/Misc/run-help to an appro‐\npriate directory.\n"
                    },
                    {
                        "name": "Recompiling Functions",
                        "content": "If  you  frequently  edit your zsh functions, or periodically update your zsh installation to\ntrack the latest developments, you may find that function digests compiled with the  zcompile\nbuiltin  are  frequently  out of date with respect to the function source files.  This is not\nusually a problem, because zsh always looks for the newest file when loading a function,  but\nit may cause slower shell startup and function loading.  Also, if a digest file is explicitly\nused as an element of fpath, zsh won't check whether any of its source files has changed.\n\nThe zrecompile autoloadable function, found in Functions/Misc, can be used to  keep  function\ndigests up to date.\n\nzrecompile [ -qt ] [ name ... ]\nzrecompile [ -qt ] -p arg ... [ -- arg ... ]\nThis  tries  to  find *.zwc files and automatically re-compile them if at least one of\nthe original files is newer than the compiled file.  This  works  only  if  the  names\nstored in the compiled files are full paths or are relative to the directory that con‐\ntains the .zwc file.\n\nIn the first form, each name is the name of a compiled file or a directory  containing\n*.zwc  files  that  should be checked.  If no arguments are given, the directories and\n*.zwc files in fpath are used.\n\nWhen -t is given, no compilation is performed, but a return status of zero  (true)  is\nset  if  there  are  files that need to be re-compiled and non-zero (false) otherwise.\nThe -q option quiets the chatty output that describes what zrecompile is doing.\n\nWithout the -t option, the return status is zero if all files that needed  re-compila‐\ntion  could  be  compiled  and  non-zero  if compilation for at least one of the files\nfailed.\n\nIf the -p option is given, the args are interpreted as one or more sets  of  arguments\nfor zcompile, separated by `--'.  For example:\n\nzrecompile -p \\\n-R ~/.zshrc -- \\\n-M ~/.zcompdump -- \\\n~/zsh/comp.zwc ~/zsh/Completion/*/*\n\nThis  compiles ~/.zshrc into ~/.zshrc.zwc if that doesn't exist or if it is older than\n~/.zshrc. The compiled file will be marked for reading instead of mapping. The same is\ndone  for ~/.zcompdump and ~/.zcompdump.zwc, but this compiled file is marked for map‐\nping. The last line re-creates the file ~/zsh/comp.zwc if any of  the  files  matching\nthe given pattern is newer than it.\n\nWithout the -p option, zrecompile does not create function digests that do not already\nexist, nor does it add new functions to the digest.\n\nThe following shell loop is an example of a method for  creating  function  digests  for  all\nfunctions in your fpath, assuming that you have write permission to the directories:\n\nfor ((i=1; i <= $#fpath; ++i)); do\ndir=$fpath[i]\nzwc=${dir:t}.zwc\nif [[ $dir == (.|..) || $dir == (.|..)/* ]]; then\ncontinue\nfi\nfiles=($dir/*(N-.))\nif [[ -w $dir:h && -n $files ]]; then\nfiles=(${${(M)files%/*/*}#/})\nif ( cd $dir:h &&\nzrecompile -p -U -z $zwc $files ); then\nfpath[i]=$fpath[i].zwc\nfi\nfi\ndone\n\nThe  -U  and  -z options are appropriate for functions in the default zsh installation fpath;\nyou may need to use different options for your personal function directories.\n\nOnce the digests have been created and your fpath modified to refer to  them,  you  can  keep\nthem up to date by running zrecompile with no arguments.\n"
                    },
                    {
                        "name": "Keyboard Definition",
                        "content": "The  large  number of possible combinations of keyboards, workstations, terminals, emulators,\nand window systems makes it impossible for zsh to have built-in key bindings for every situa‐\ntion.   The  zkbd  utility, found in Functions/Misc, can help you quickly create key bindings\nfor your configuration.\n\nRun zkbd either as an autoloaded function, or as a shell script:\n\nzsh -f ~/zsh-5.8.1/Functions/Misc/zkbd\n\nWhen you run zkbd, it first asks you to enter your terminal type; if the default it offers is\ncorrect,  just  press return.  It then asks you to press a number of different keys to deter‐\nmine characteristics of your keyboard and terminal; zkbd warns you if it finds  anything  out\nof the ordinary, such as a Delete key that sends neither ^H nor ^?.\n\nThe  keystrokes read by zkbd are recorded as a definition for an associative array named key,\nwritten to a file in the subdirectory .zkbd within either your  HOME  or  ZDOTDIR  directory.\nThe  name  of the file is composed from the TERM, VENDOR and OSTYPE parameters, joined by hy‐\nphens.\n\nYou may read this file into your .zshrc or another startup file with the `source' or `.' com‐\nmands, then reference the key parameter in bindkey commands, like this:\n\nsource ${ZDOTDIR:-$HOME}/.zkbd/$TERM-$VENDOR-$OSTYPE\n[[ -n ${key[Left]} ]] && bindkey \"${key[Left]}\" backward-char\n[[ -n ${key[Right]} ]] && bindkey \"${key[Right]}\" forward-char\n# etc.\n\nNote  that in order for `autoload zkbd' to work, the zkdb file must be in one of the directo‐\nries named in your fpath array (see zshparam(1)).  This should already be  the  case  if  you\nhave  a  standard  zsh installation; if it is not, copy Functions/Misc/zkbd to an appropriate\ndirectory.\n"
                    },
                    {
                        "name": "Dumping Shell State",
                        "content": "Occasionally you may encounter what appears to be a bug in the shell, particularly if you are\nusing a beta version of zsh or a development release.  Usually it is sufficient to send a de‐\nscription of the problem to one of the zsh mailing lists (see zsh(1)), but sometimes  one  of\nthe zsh developers will need to recreate your environment in order to track the problem down.\n\nThe  script  named reporter, found in the Util directory of the distribution, is provided for\nthis purpose.  (It is also possible to autoload reporter, but reporter is  not  installed  in\nfpath  by  default.)   This script outputs a detailed dump of the shell state, in the form of\nanother script that can be read with `zsh -f' to recreate that state.\n\nTo use reporter, read the script into your shell with the `.' command and redirect the output\ninto a file:\n\n. ~/zsh-5.8.1/Util/reporter > zsh.report\n\nYou  should  check  the  zsh.report  file for any sensitive information such as passwords and\ndelete them by hand before sending the script to the developers.  Also, as the output can  be\nvoluminous,  it's  best to wait for the developers to ask for this information before sending\nit.\n\nYou can also use reporter to dump only a subset of the shell state.  This is sometimes useful\nfor  creating startup files for the first time.  Most of the output from reporter is far more\ndetailed than usually is necessary for a startup file, but the aliases, options, and  zstyles\nstates may be useful because they include only changes from the defaults.  The bindings state\nmay be useful if you have created any of your own keymaps, because reporter arranges to  dump\nthe keymap creation commands as well as the bindings for every keymap.\n\nAs is usual with automated tools, if you create a startup file with reporter, you should edit\nthe results to remove unnecessary commands.  Note that if you're  using  the  new  completion\nsystem,  you should not dump the functions state to your startup files with reporter; use the\ncompdump function instead (see zshcompsys(1)).\n\nreporter [ state ... ]\nPrint to standard output the indicated subset of the current shell state.   The  state\narguments may be one or more of:\n\nall    Output everything listed below.\naliases\nOutput alias definitions.\nbindings\nOutput ZLE key maps and bindings.\ncompletion\nOutput  old-style compctl commands.  New completion is covered by functions and\nzstyles.\nfunctions\nOutput autoloads and function definitions.\nlimits Output limit commands.\noptions\nOutput setopt commands.\nstyles Same as zstyles.\nvariables\nOutput shell parameter assignments, plus export commands  for  any  environment\nvariables.\nzstyles\nOutput zstyle commands.\n\nIf the state is omitted, all is assumed.\n\nWith the exception of `all', every state can be abbreviated by any prefix, even a single let‐\nter; thus a is the same as aliases, z is the same as zstyles, etc.\n"
                    },
                    {
                        "name": "Manipulating Hook Functions",
                        "content": "add-zsh-hook [ -L | -dD ] [ -Uzk ] hook function\nSeveral functions are special to the shell, as described in the section SPECIAL  FUNC‐\nTIONS, see zshmisc(1), in that they are automatically called at specific points during\nshell execution.  Each has an associated array consisting of names of functions to  be\ncalled  at  the  same point; these are so-called `hook functions'.  The shell function\nadd-zsh-hook provides a simple way of adding or removing functions from the array.\n\nhook is one of chpwd, periodic, precmd, preexec, zshaddhistory, zshexit, or zshdirec‐‐\ntoryname,  the special functions in question.  Note that zshdirectoryname is called\nin a different way from the other functions, but may still be manipulated as a hook.\n\nfunction is name of an ordinary shell function.  If no options are given this will  be\nadded  to  the  array of functions to be executed in the given context.  Functions are\ninvoked in the order they were added.\n\nIf the option -L is given, the current values for the  hook  arrays  are  listed  with\ntypeset.\n\nIf  the  option -d is given, the function is removed from the array of functions to be\nexecuted.\n\nIf the option -D is given, the function is treated as a pattern and any matching names\nof functions are removed from the array of functions to be executed.\n\nThe options -U, -z and -k are passed as arguments to autoload for function.  For func‐\ntions contributed with zsh, the options -Uz are appropriate.\n\nadd-zle-hook-widget [ -L | -dD ] [ -Uzk ] hook widgetname\nSeveral widget names are special to the line editor, as described in the section  Spe‐\ncial  Widgets, see zshzle(1), in that they are automatically called at specific points\nduring editing.  Unlike function hooks, these do not use a predefined array  of  other\nnames  to  call  at the same point; the shell function add-zle-hook-widget maintains a\nsimilar array and arranges for the special widget to invoke those additional widgets.\n\nhook is one of isearch-exit, isearch-update, line-pre-redraw, line-init,  line-finish,\nhistory-line-set,  or  keymap-select,  corresponding  to  each  of the special widgets\nzle-isearch-exit, etc.  The special widget names are also accepted as the  hook  argu‐\nment.\n\nwidgetname  is the name of a ZLE widget.  If no options are given this is added to the\narray of widgets to be invoked in the given hook context.  Widgets are invoked in  the\norder they were added, with\nzle widgetname -Nw -- \"$@\"\n\nNote  that  this  means that the `WIDGET' special parameter tracks the widgetname when\nthe widget function is called, rather than tracking the name of the corresponding spe‐\ncial hook widget.\n\nIf  the  option -d is given, the widgetname is removed from the array of widgets to be\nexecuted.\n\nIf the option -D is given, the widgetname is treated as a  pattern  and  any  matching\nnames of widgets are removed from the array.\n\nIf  widgetname does not name an existing widget when added to the array, it is assumed\nthat a shell function also named widgetname is meant to provide the implementation  of\nthe widget.  This name is therefore marked for autoloading, and the options -U, -z and\n-k are passed as arguments to autoload as with add-zsh-hook.  The widget is also  cre‐\nated  with  `zle  -N  widgetname' to cause the corresponding function to be loaded the\nfirst time the hook is called.\n\nThe arrays of widgetname are currently maintained in zstyle  contexts,  one  for  each\nhook  context,  with  a  style  of  `widgets'.  If the -L option is given, this set of\nstyles is listed with `zstyle -L'.  This implementation may change,  and  the  special\nwidgets  that refer to the styles are created only if add-zle-hook-widget is called to\nadd at least one widget, so if this function is used for any  hooks,  then  all  hooks\nshould be managed only via this function.\n"
                    }
                ]
            },
            "REMEMBERING RECENT DIRECTORIES": {
                "content": "The  function  cdr allows you to change the working directory to a previous working directory\nfrom a list maintained automatically.  It is similar in concept to the directory  stack  con‐\ntrolled  by the pushd, popd and dirs builtins, but is more configurable, and as it stores all\nentries in files it is maintained across sessions and (by default) between terminal emulators\nin  the current session.  Duplicates are automatically removed, so that the list reflects the\nsingle most recent use of each directory.\n\nNote that the pushd directory stack is not actually modified or used by cdr unless  you  con‐\nfigure it to do so as described in the configuration section below.\n",
                "subsections": [
                    {
                        "name": "Installation",
                        "content": "The system works by means of a hook function that is called every time the directory changes.\nTo install the system, autoload the required functions and use the add-zsh-hook function  de‐\nscribed above:\n\nautoload -Uz chpwdrecentdirs cdr add-zsh-hook\nadd-zsh-hook chpwd chpwdrecentdirs\n\nNow every time you change directly interactively, no matter which command you use, the direc‐\ntory to which you change will be remembered in most-recent-first order.\n"
                    },
                    {
                        "name": "Use",
                        "content": "All direct user interaction is via the cdr function.\n\nThe argument to cdr is a number N corresponding to the Nth most  recently  changed-to  direc‐\ntory.   1  is the immediately preceding directory; the current directory is remembered but is\nnot offered as a destination.  Note that if you have multiple windows open 1 may refer  to  a\ndirectory  changed  to in another window; you can avoid this by having per-terminal files for\nstoring directory as described for the recent-dirs-file style below.\n\nIf you set the recent-dirs-default style described below cdr will behave the same  as  cd  if\ngiven  a  non-numeric  argument, or more than one argument.  The recent directory list is up‐\ndated just the same however you change directory.\n\nIf the argument is omitted, 1 is assumed.  This is similar to pushd's behaviour  of  swapping\nthe two most recent directories on the stack.\n\nCompletion  for  the argument to cdr is available if compinit has been run; menu selection is\nrecommended, using:\n\nzstyle ':completion:*:*:cdr:*:*' menu selection\n\nto allow you to cycle through recent directories; the order is preserved, so the first choice\nis  the  most recent directory before the current one.  The verbose style is also recommended\nto ensure the directory is shown; this style is on by default so no action is required unless\nyou have changed it.\n"
                    },
                    {
                        "name": "Options",
                        "content": "The behaviour of cdr may be modified by the following options.\n"
                    },
                    {
                        "name": "-l",
                        "content": "substitution reapplied), one per line.  The directories  here  are  not  quoted  (this\nwould  only be an issue if a directory name contained a newline).  This is used by the\ncompletion system.\n",
                        "flag": "-l"
                    },
                    {
                        "name": "-r",
                        "content": "directory is not changed.\n",
                        "flag": "-r"
                    },
                    {
                        "name": "-e",
                        "content": "any extent you like; no sanity checking is performed.  Completion  is  available.   No\nquoting  is necessary (except for newlines, where I have in any case no sympathy); di‐\nrectories are in unabbreviated from and contain an absolute path, i.e. they start with\n/.  Usually the first entry should be left as the current directory.\n",
                        "flag": "-e"
                    },
                    {
                        "name": "-p",
                        "content": "Prunes any items in the directory list that match the given extended glob pattern; the\npattern needs to be quoted from immediate expansion on the command line.  The  pattern\nis  matched  against  each  completely expanded file name in the list; the full string\nmust match, so wildcards at the end (e.g. '*removeme*') are needed to  remove  entries\nwith a given substring.\n\nIf  output  is  to a terminal, then the function will print the new list after pruning\nand prompt for confirmation by the user.  This output and  confirmation  step  can  be\nskipped by using -P instead of -p.\n",
                        "flag": "-p"
                    },
                    {
                        "name": "Configuration",
                        "content": "Configuration is by means of the styles mechanism that should be familiar from completion; if\nnot, see the description of the zstyle command in see zshmodules(1).  The context for setting\nstyles should be ':chpwd:*' in case the meaning of the context is extended in future, for ex‐\nample:\n\nzstyle ':chpwd:*' recent-dirs-max 0\n\nsets the value of the recent-dirs-max style to 0.  In practice the  style  name  is  specific\nenough that a context of '*' should be fine.\n\nAn exception is recent-dirs-insert, which is used exclusively by the completion system and so\nhas the usual completion system context (':completion:*' if nothing more specific is needed),\nthough again '*' should be fine in practice.\n"
                    },
                    {
                        "name": "recent-dirs-default",
                        "content": "If  true,  and  the command is expecting a recent directory index, and either there is\nmore than one argument or the argument is not an integer, then fall through  to  \"cd\".\nThis  allows  the  lazy  to  use  only one command for directory changing.  Completion\nrecognises this, too; see recent-dirs-insert for how to control completion  when  this\noption is in use.\n"
                    },
                    {
                        "name": "recent-dirs-file",
                        "content": "The   file   where  the  list  of  directories  is  saved.   The  default  is  ${ZDOT‐‐\nDIR:-$HOME}/.chpwd-recent-dirs, i.e. this is in your home directory  unless  you  have\nset the variable ZDOTDIR to point somewhere else.  Directory names are saved in $'...'\nquoted form, so each line in the file can be supplied directly to the shell as an  ar‐\ngument.\n\nThe  value  of  this  style may be an array.  In this case, the first file in the list\nwill always be used for saving directories while any other files are  left  untouched.\nWhen  reading the recent directory list, if there are fewer than the maximum number of\nentries in the first file, the contents of later files in the array will  be  appended\nwith  duplicates  removed  from the list shown.  The contents of the two files are not\nsorted together, i.e. all the entries in the first file are shown first.  The  special\nvalue  +  can  appear  in the list to indicate the default file should be read at that\npoint.  This allows effects like the following:\n\nzstyle ':chpwd:*' recent-dirs-file \\\n~/.chpwd-recent-dirs-${TTY##*/} +\n\nRecent directories are read from a file numbered according to the terminal.  If  there\nare insufficient entries the list is supplemented from the default file.\n\nIt is possible to use zstyle -e to make the directory configurable at run time:\n\nzstyle -e ':chpwd:*' recent-dirs-file pick-recent-dirs-file\npick-recent-dirs-file() {\nif [[ $PWD = ~/text/writing(|/*) ]]; then\nreply=(~/.chpwd-recent-dirs-writing)\nelse\nreply=(+)\nfi\n}\n\nIn  this  example, if the current directory is ~/text/writing or a directory under it,\nthen use a special file for saving recent directories, else use the default.\n"
                    },
                    {
                        "name": "recent-dirs-insert",
                        "content": "Used by completion.  If recent-dirs-default is true, then setting this to true  causes\nthe  actual directory, rather than its index, to be inserted on the command line; this\nhas the same effect as using the corresponding index, but makes  the  history  clearer\nand  the  line  easier to edit.  With this setting, if part of an argument was already\ntyped, normal directory completion rather than recent directory  completion  is  done;\nthis  is because recent directory completion is expected to be done by cycling through\nentries menu fashion.\n\nIf the value of the style is always, then only recent directories will  be  completed;\nin that case, use the cd command when you want to complete other directories.\n\nIf  the  value is fallback, recent directories will be tried first, then normal direc‐\ntory completion is performed if recent directory completion failed to find a match.\n\nFinally, if the value is both then both sets of completions are presented;  the  usual\ntag  mechanism  can  be used to distinguish results, with recent directories tagged as\nrecent-dirs.  Note that the recent directories inserted are abbreviated with directory\nnames where appropriate.\n"
                    },
                    {
                        "name": "recent-dirs-max",
                        "content": "The  maximum  number  of directories to save to the file.  If this is zero or negative\nthere is no maximum.  The default is 20.  Note this includes  the  current  directory,\nwhich  isn't  offered, so the highest number of directories you will be offered is one\nless than the maximum.\n"
                    },
                    {
                        "name": "recent-dirs-prune",
                        "content": "This style is an array determining what directories should (or should not) be added to\nthe recent list.  Elements of the array can include:\n\nparent Prune  parents  (more accurately, ancestors) from the recent list.  If present,\nchanging directly down by any number of directories causes the  current  direc‐\ntory to be overwritten.  For example, changing from ~pws to ~pws/some/other/dir\ncauses ~pws not to be left on the recent directory stack.  This only applies to\ndirect  changes  to descendant directories; earlier directories on the list are\nnot pruned.  For example, changing from ~pws/yet/another to ~pws/some/other/dir\ndoes not cause ~pws to be pruned.\n\npattern:pattern\nGives a zsh pattern for directories that should not be added to the recent list\n(if not already there).  This element can be repeated  to  add  different  pat‐\nterns.  For example, 'pattern:/tmp(|/*)' stops /tmp or its descendants from be‐\ning added.  The EXTENDEDGLOB option is always turned on for these patterns.\n"
                    },
                    {
                        "name": "recent-dirs-pushd",
                        "content": "If set to true, cdr will use pushd instead of cd to change the directory, so  the  di‐\nrectory  is  saved on the directory stack.  As the directory stack is completely sepa‐\nrate from the list of files saved by the mechanism used in this file there is no obvi‐\nous reason to do this.\n"
                    },
                    {
                        "name": "Use with dynamic directory naming",
                        "content": "It  is possible to refer to recent directories using the dynamic directory name syntax by us‐\ning the supplied function zshdirectorynamecdr a hook:\n\nautoload -Uz add-zsh-hook\nadd-zsh-hook -Uz zshdirectoryname zshdirectorynamecdr\n\nWhen this is done, ~[1] will refer to the most recent directory other than $PWD, and  so  on.\nCompletion after ~[...  also works.\n"
                    },
                    {
                        "name": "Details of directory handling",
                        "content": "This  section  is for the curious or confused; most users will not need to know this informa‐\ntion.\n\nRecent directories are saved to a file immediately and hence are preserved  across  sessions.\nNote  currently  no  file  locking is applied: the list is updated immediately on interactive\ncommands and nowhere else (unlike history), and it is assumed you are only  going  to  change\ndirectory  in  one  window at once.  This is not safe on shared accounts, but in any case the\nsystem has limited utility when someone else is changing to a different  set  of  directories\nbehind your back.\n\nTo  make this a little safer, only directory changes instituted from the command line, either\ndirectly or indirectly through shell function calls (but not through subshells, evals, traps,\ncompletion  functions  and the like) are saved.  Shell functions should use cd -q or pushd -q\nto avoid side effects if the change to the directory is to be invisible at the command  line.\nSee the contents of the function chpwdrecentdirs for more details.\n"
                    }
                ]
            },
            "ABBREVIATED DYNAMIC REFERENCES TO DIRECTORIES": {
                "content": "The  dynamic directory naming system is described in the subsection Dynamic named directories\nof the section Filename Expansion in expn(1).  In this, a reference to ~[...] is expanded  by\na function found by the hooks mechanism.\n\nThe  contributed  function  zshdirectorynamegeneric provides a system allowing the user to\nrefer to directories with only a limited amount of new code.  It supports all  three  of  the\nstandard  interfaces  for directory naming: converting from a name to a directory, converting\nin the reverse direction to find a short name, and completion of names.\n\nThe main feature of this function is a path-like syntax, combining abbreviations at  multiple\nlevels separated by \":\".  As an example, ~[g:p:s] might specify:\ng      The  top level directory for your git area.  This first component has to match, or the\nfunction will return indicating another directory name hook function should be tried.\n\np      The name of a project within your git area.\n\ns      The source area within that project.  This allows you to collapse references  to  long\nhierarchies to a very compact form, particularly if the hierarchies are similar across\ndifferent areas of the disk.\n\nName components may be completed: if a description is shown at the top of the list of comple‐\ntions, it includes the path to which previous components expand, while the description for an\nindividual completion shows the path segment it would add.  No  additional  configuration  is\nneeded for this as the completion system is aware of the dynamic directory name mechanism.\n",
                "subsections": [
                    {
                        "name": "Usage",
                        "content": "To  use  the  function, first define a wrapper function for your specific case.  We'll assume\nit's to be autoloaded.  This can have any name but we'll refer to it as zdnmywrapper.   This\nwrapper  function will define various variables and then call this function with the same ar‐\nguments that the wrapper function gets.  This configuration is described below.\n\nThen arrange for the wrapper to be run as a zshdirectoryname hook:\n\nautoload -Uz add-zsh-hook zshdiretorynamegeneric zdnmywrapper\nadd-zsh-hook -U zshdirectoryname zdnmywrapper\n"
                    },
                    {
                        "name": "Configuration",
                        "content": "The wrapper function should define a local associative array  zdntop.   Alternatively,  this\ncan be set with a style called mapping.  The context for the style is :zdn:wrapper-name where\nwrapper-name is the function calling zshdirectorynamegeneric; for example:\n\nzstyle :zdn:zdnmywrapper: mapping zdnmywrappertop\n\nThe keys in this associative array correspond to the first component of the name.  The values\nare  matching directories.  They may have an optional suffix with a slash followed by a colon\nand the name of a variable in the same format to give the next component.  (The slash  before\nthe colon is to disambiguate the case where a colon is needed in the path for a drive.  There\nis otherwise no syntax for escaping this, so path components whose names start with  a  colon\nare  not  supported.)   A  special component :default: specifies a variable in the form /:var\n(the path section is ignored and so is usually empty) that will be used for the  next  compo‐\nnent  if  no  variable  is given for the path.  Variables referred to within zdntop have the\nsame format as zdntop itself, but contain relative paths.\n\nFor example,\n\nlocal -A zdntop=(\ng   ~/git\nga  ~/alternate/git\ngs  /scratch/$USER/git/:second2\n:default: /:second1\n)\n\nThis specifies the behaviour of  a  directory  referred  to  as  ~[g:...]   or  ~[ga:...]  or\n~[gs:...].   Later  path  components are optional; in that case ~[g] expands to ~/git, and so\non.  gs expands to /scratch/$USER/git and uses the associative array  second2  to  match  the\nsecond component; g and ga use the associative array second1 to match the second component.\n\nWhen  expanding a name to a directory, if the first component is not g or ga or gs, it is not\nan error; the function simply returns 1 so that a later hook function can be tried.  However,\nmatching the first component commits the function, so if a later component does not match, an\nerror is printed (though this still does not stop later hooks from being executed).\n\nFor components after the first, a relative path is expected, but note  that  multiple  levels\nmay still appear.  Here is an example of second1:\n\nlocal -A second1=(\np   myproject\ns   somproject\nos  otherproject/subproject/:third\n)\n\nThe  path  as  found  from zdntop is extended with the matching directory, so ~[g:p] becomes\n~/git/myproject.  The slash between is added automatically (it's not possible to have a later\ncomponent  modify the name of a directory already matched).  Only os specifies a variable for\na third component, and there's no :default:, so it's an error to use a name like ~[g:p:x]  or\n~[ga:s:y] because there's nowhere to look up the x or y.\n\nThe  associative  arrays need to be visible within this function; the generic function there‐\nfore uses internal variable names beginning zdn in order to avoid clashes.  Note  that  the\nvariable  reply  needs  to be passed back to the shell, so should not be local in the calling\nfunction.\n\nThe function does not test whether directories assembled by component  actually  exist;  this\nallows the system to work across automounted file systems.  The error from the command trying\nto use a non-existent directory should be sufficient to indicate the problem.\n"
                    },
                    {
                        "name": "Complete example",
                        "content": "Here is a full fictitious but usable autoloadable definition of the example function  defined\nby  the  code  above.  So ~[gs:p:s] expands to /scratch/$USER/git/myscratchproject/top/srcdir\n(with $USER also expanded).\n\nlocal -A zdntop=(\ng   ~/git\nga  ~/alternate/git\ngs  /scratch/$USER/git/:second2\n:default: /:second1\n)\n\nlocal -A second1=(\np   myproject\ns   somproject\nos  otherproject/subproject/:third\n)\n\nlocal -A second2=(\np   myscratchproject\ns   somescratchproject\n)\n\nlocal -A third=(\ns   top/srcdir\nd   top/documentation\n)\n\n# autoload not needed if you did this at initialisation...\nautoload -Uz zshdirectorynamegeneric\nzshdirectorynamegeneric \"$@\n\nIt is also possible to use global associative arrays, suitably named, and set the  style  for\nthe  context  of your wrapper function to refer to this.  Then your set up code would contain\nthe following:\n\ntypeset -A zdnmywrappertop=(...)\n# ... and so on for other associative arrays ...\nzstyle ':zdn:zdnmywrapper:' mapping zdnmywrappertop\nautoload -Uz add-zsh-hook zshdirectorynamegeneric zdnmywrapper\nadd-zsh-hook -U zshdirectoryname zdnmywrapper\n\nand the function zdnmywrapper would contain only the following:\n\nzshdirectorynamegeneric \"$@\"\n"
                    }
                ]
            },
            "GATHERING INFORMATION FROM VERSION CONTROL SYSTEMS": {
                "content": "In a lot of cases, it is nice to automatically retrieve information from version control sys‐\ntems  (VCSs),  such as subversion, CVS or git, to be able to provide it to the user; possibly\nin the user's prompt. So that you can instantly tell which branch you are currently  on,  for\nexample.\n\nIn order to do that, you may use the vcsinfo function.\n\nThe  following VCSs are supported, showing the abbreviated name by which they are referred to\nwithin the system:\nBazaar (bzr)\nhttps://bazaar.canonical.com/\nCodeville (cdv)\nhttp://freecode.com/projects/codeville/\nConcurrent Versioning System (cvs)\nhttps://www.nongnu.org/cvs/\nDarcs (darcs)\nhttp://darcs.net/\nFossil (fossil)\nhttps://fossil-scm.org/\nGit (git)\nhttps://git-scm.com/\nGNU arch (tla)\nhttps://www.gnu.org/software/gnu-arch/\nMercurial (hg)\nhttps://www.mercurial-scm.org/\nMonotone (mtn)\nhttps://monotone.ca/\nPerforce (p4)\nhttps://www.perforce.com/\nSubversion (svn)\nhttps://subversion.apache.org/\nSVK (svk)\nhttps://svk.bestpractical.com/\n\nThere  is  also   support   for   the   patch   management   system   quilt   (https://savan‐‐\nnah.nongnu.org/projects/quilt). See Quilt Support below for details.\n\nTo load vcsinfo:\n\nautoload -Uz vcsinfo\n\nIt  can  be  used in any existing prompt, because it does not require any specific $psvar en‐\ntries to be available.\n",
                "subsections": [
                    {
                        "name": "Quickstart",
                        "content": "To get this feature working quickly (including colors), you can do the  following  (assuming,\nyou loaded vcsinfo properly - see above):\n\nzstyle ':vcsinfo:*' actionformats \\\n'%F{5}(%f%s%F{5})%F{3}-%F{5}[%F{2}%b%F{3}|%F{1}%a%F{5}]%f '\nzstyle ':vcsinfo:*' formats       \\\n'%F{5}(%f%s%F{5})%F{3}-%F{5}[%F{2}%b%F{5}]%f '\nzstyle ':vcsinfo:(sv[nk]|bzr):*' branchformat '%b%F{1}:%F{3}%r'\nprecmd () { vcsinfo }\nPS1='%F{5}[%F{2}%n%F{5}] %F{3}%3~ ${vcsinfomsg0}%f%# '\n\nObviously,  the  last  two  lines are there for demonstration. You need to call vcsinfo from\nyour precmd function. Once that is done you need a single quoted '${vcsinfomsg0}' in your\nprompt.\n\nTo  be  able  to use '${vcsinfomsg0}' directly in your prompt like this, you will need to\nhave the PROMPTSUBST option enabled.\n\nNow call the vcsinfoprintsys utility from the command line:\n\n% vcsinfoprintsys\n## list of supported version control backends:\n## disabled systems are prefixed by a hash sign (#)\nbzr\ncdv\ncvs\ndarcs\nfossil\ngit\nhg\nmtn\np4\nsvk\nsvn\ntla\n## flavours (cannot be used in the enable or disable styles; they\n## are enabled and disabled with their master [git-svn -> git])\n## they *can* be used in contexts: ':vcsinfo:git-svn:*'.\ngit-p4\ngit-svn\nhg-git\nhg-hgsubversion\nhg-hgsvn\n\nYou may not want all of these because there is no point in running the code to detect systems\nyou do not use.  So there is a way to disable some backends altogether:\n\nzstyle ':vcsinfo:*' disable bzr cdv darcs mtn svk tla\n\nYou may also pick a few from that list and enable only those:\n\nzstyle ':vcsinfo:*' enable git cvs svn\n\nIf  you rerun vcsinfoprintsys after one of these commands, you will see the backends listed\nin the disable style (or backends not in the enable style - if you used that) marked as  dis‐\nabled  by  a  hash sign.  That means the detection of these systems is skipped completely. No\nwasted time there.\n"
                    },
                    {
                        "name": "Configuration",
                        "content": "The vcsinfo feature can be configured via zstyle.\n\nFirst, the context in which we are working:\n:vcsinfo:vcs-string:user-context:repo-root-name\n\nvcs-string\nis one of: git, git-svn, git-p4, hg, hg-git, hg-hgsubversion,  hg-hgsvn,  darcs,  bzr,\ncdv,  mtn,  svn, cvs, svk, tla, p4 or fossil.  This is followed by `.quilt-quilt-mode'\nin Quilt mode (see Quilt Support for details) and by `+hook-name' while hooks are  ac‐\ntive (see Hooks in vcsinfo for details).\n\nCurrently,  hooks  in  quilt mode don't add the `.quilt-quilt-mode' information.  This\nmay change in the future.\n\nuser-context\nis a freely configurable string, assignable by the  user  as  the  first  argument  to\nvcsinfo (see its description below).\n\nrepo-root-name\nis the name of a repository in which you want a style to match. So, if you want a set‐\nting  specific  to  /usr/src/zsh,  with  that  being  a  CVS  checkout,  you  can  set\nrepo-root-name to zsh to make it so.\n\nThere  are  three special values for vcs-string: The first is named -init-, that is in effect\nas long as there was no decision what VCS backend to use. The second is -preinit-; it is used\nbefore  vcsinfo  is  run,  when initializing the data exporting variables. The third special\nvalue is formats and is used by the vcsinfolastmsg for looking up its styles.\n\nThe initial value of repo-root-name is -all- and it is replaced with the actual name, as soon\nas  it is known. Only use this part of the context for defining the formats, actionformats or\nbranchformat styles, as it is guaranteed that repo-root-name is set up  correctly  for  these\nonly. For all other styles, just use '*' instead.\n\nThere are two pre-defined values for user-context:"
                    },
                    {
                        "name": "default",
                        "content": "the one used if none is specified"
                    },
                    {
                        "name": "command",
                        "content": "used by vcsinfolastmsg to lookup its styles\n\nYou can of course use ':vcsinfo:*' to match all VCSs in all user-contexts at once.\n\nThis is a description of all styles that are looked up.\n"
                    },
                    {
                        "name": "formats",
                        "content": "A list of formats, used when actionformats is not used (which is most of the time).\n"
                    },
                    {
                        "name": "actionformats",
                        "content": "A  list of formats, used if there is a special action going on in your current reposi‐\ntory; like an interactive rebase or a merge conflict.\n"
                    },
                    {
                        "name": "branchformat",
                        "content": "Some backends replace %b in the formats and actionformats styles above, not only by  a\nbranch  name but also by a revision number. This style lets you modify how that string\nshould look.\n"
                    },
                    {
                        "name": "nvcsformats",
                        "content": "These \"formats\" are set when we didn't detect a version control system for the current\ndirectory  or vcsinfo was disabled. This is useful if you want vcsinfo to completely\ntake  over  the  generation  of   your   prompt.   You   would   do   something   like\nPS1='${vcsinfomsg0}' to accomplish that.\n"
                    },
                    {
                        "name": "hgrevformat",
                        "content": "hg  uses  both  a  hash  and  a revision number to reference a specific changeset in a\nrepository. With this style you can format the revision string (see  branchformat)  to\ninclude  either  or  both.  It's only useful when get-revision is true. Note, the full\n40-character revision id is not available (except when using  the  use-simple  option)\nbecause executing hg more than once per prompt is too slow; you may customize this be‐\nhavior using hooks.\n"
                    },
                    {
                        "name": "max-exports",
                        "content": "Defines the maximum number of vcsinfomsg* variables vcsinfo will set.\n\nenable A list of backends you want to use. Checked in the -init- context. If this  list  con‐\ntains  an  item called NONE no backend is used at all and vcsinfo will do nothing. If\nthis list contains ALL, vcsinfo will use all known backends. Only with ALL in  enable\nwill the disable style have any effect. ALL and NONE are case insensitive.\n"
                    },
                    {
                        "name": "disable",
                        "content": "A list of VCSs you don't want vcsinfo to test for repositories (checked in the -init-\ncontext, too). Only used if enable contains ALL.\n"
                    },
                    {
                        "name": "disable-patterns",
                        "content": "A list of patterns that are checked against $PWD. If a pattern matches, vcsinfo  will\nbe disabled. This style is checked in the :vcsinfo:-init-:*:-all- context.\n\nSay, ~/.zsh is a directory under version control, in which you do not want vcsinfo to\nbe active, do:\nzstyle ':vcsinfo:*' disable-patterns \"${(b)HOME}/.zsh(|/*)\"\n"
                    },
                    {
                        "name": "use-quilt",
                        "content": "If enabled, the quilt support code is active in `addon' mode.  See Quilt  Support  for\ndetails.\n"
                    },
                    {
                        "name": "quilt-standalone",
                        "content": "If  enabled,  `standalone'  mode detection is attempted if no VCS is active in a given\ndirectory. See Quilt Support for details.\n"
                    },
                    {
                        "name": "quilt-patch-dir",
                        "content": "Overwrite the value of the $QUILTPATCHES environment variable. See Quilt Support  for\ndetails.\n"
                    },
                    {
                        "name": "quiltcommand",
                        "content": "When  quilt  itself is called in quilt support, the value of this style is used as the\ncommand name.\n"
                    },
                    {
                        "name": "check-for-changes",
                        "content": "If enabled, this style causes the %c and %u format escapes to show  when  the  working\ndirectory  has uncommitted changes. The strings displayed by these escapes can be con‐\ntrolled via the stagedstr and unstagedstr styles. The  only  backends  that  currently\nsupport this option are git, hg, and bzr (the latter two only support unstaged).\n\nFor this style to be evaluated with the hg backend, the get-revision style needs to be\nset and the use-simple style needs to be unset. The latter is the default; the  former\nis not.\n\nWith  the  bzr  backend, lightweight checkouts only honor this style if the use-server\nstyle is set.\n\nNote, the actions taken if this style is enabled are potentially expensive (read: they\nmay  be  slow, depending on how big the current repository is).  Therefore, it is dis‐\nabled by default.\n"
                    },
                    {
                        "name": "check-for-staged-changes",
                        "content": "This style is like check-for-changes, but it never checks the worktree files, only the\nmetadata  in  the  .${vcs}  dir.  Therefore, this style initializes only the %c escape\n(with stagedstr) but not the %u escape.  This style is faster than check-for-changes.\n\nIn the git backend, this style checks for changes in the index.  Other backends do not\ncurrently implement this style.\n\nThis style is disabled by default.\n"
                    },
                    {
                        "name": "stagedstr",
                        "content": "This  string  will be used in the %c escape if there are staged changes in the reposi‐\ntory.\n"
                    },
                    {
                        "name": "unstagedstr",
                        "content": "This string will be used in the %u escape if there are unstaged changes in the reposi‐\ntory.\n"
                    },
                    {
                        "name": "command",
                        "content": "This  style  causes  vcsinfo  to use the supplied string as the command to use as the\nVCS's binary. Note, that setting this in ':vcsinfo:*' is not a good idea.\n\nIf the value of this style is empty (which is the default), the used  binary  name  is\nthe name of the backend in use (e.g. svn is used in an svn repository).\n\nThe  repo-root-name part in the context is always the default -all- when this style is\nlooked up.\n\nFor example, this style can be used to use binaries from non-default installation  di‐\nrectories.  Assume,  git  is installed in /usr/bin but your sysadmin installed a newer\nversion in /usr/local/bin. Instead of changing the order of your $PATH parameter,  you\ncan do this:\nzstyle ':vcsinfo:git:*:-all-' command /usr/local/bin/git\n"
                    },
                    {
                        "name": "use-server",
                        "content": "This  is used by the Perforce backend (p4) to decide if it should contact the Perforce\nserver to find out if a directory is managed by Perforce.  This is the  only  reliable\nway  of  doing  this, but runs the risk of a delay if the server name cannot be found.\nIf the server (more specifically, the host:port pair describing the server) cannot  be\ncontacted,  its name is put into the associative array vcsinfop4deadservers and is\nnot contacted again during the session until it is removed by hand.  If you do not set\nthis  style,  the  p4  backend is only usable if you have set the environment variable\nP4CONFIG to a file name and have corresponding files in the root directories  of  each\nPerforce client.  See comments in the function VCSINFOdetectp4 for more detail.\n\nThe  Bazaar  backend (bzr) uses this to permit contacting the server about lightweight\ncheckouts, see the check-for-changes style.\n"
                    },
                    {
                        "name": "use-simple",
                        "content": "If there are two different ways of gathering information, you can select  the  simpler\none  by  setting  this  style to true; the default is to use the not-that-simple code,\nwhich is potentially a lot slower but might be more accurate in  all  possible  cases.\nThis  style  is  used by the bzr and hg backends. In the case of hg it will invoke the\nexternal hexdump program to parse the binary dirstate cache file; this method will not\nreturn the local revision number.\n"
                    },
                    {
                        "name": "get-revision",
                        "content": "If  set  to true, vcsinfo goes the extra mile to figure out the revision of a reposi‐\ntory's work tree (currently for the git and hg backends, where this kind  of  informa‐\ntion is not always vital). For git, the hash value of the currently checked out commit\nis available via the %i expansion. With hg, the local revision number and  the  corre‐\nsponding global hash are available via %i.\n\nget-mq If  set  to true, the hg backend will look for a Mercurial Queue (mq) patch directory.\nInformation will be available via the `%m' replacement.\n"
                    },
                    {
                        "name": "get-bookmarks",
                        "content": "If set to true, the hg backend will try to get a list of current bookmarks. They  will\nbe available via the `%m' replacement.\n\nThe  default is to generate a comma-separated list of all bookmark names that refer to\nthe currently checked out revision.  If a bookmark is active, its name is suffixed  an\nasterisk and placed first in the list.\n"
                    },
                    {
                        "name": "use-prompt-escapes",
                        "content": "Determines  if  we  assume that the assembled string from vcsinfo includes prompt es‐\ncapes. (Used by vcsinfolastmsg.)\n\ndebug  Enable debugging output to track possible problems. Currently this style is only  used\nby vcsinfo's hooks system.\n\nhooks  A  list  style  that  defines hook-function names. See Hooks in vcsinfo below for de‐\ntails.\n"
                    },
                    {
                        "name": "patch-format",
                        "content": ""
                    },
                    {
                        "name": "nopatch-format",
                        "content": "This pair of styles format the patch information used by the %m expando in formats and\nactionformats  for  the git and hg backends.  The value is subject to certain %-expan‐\nsions described below.  The expanded value is  made  available  in  the  global  back‐‐\nendmisc array as ${backendmisc[patches]} (also if a set-patch-format hook is used).\n"
                    },
                    {
                        "name": "get-unapplied",
                        "content": "This boolean style controls whether a backend should attempt to gather a list of unap‐\nplied patches (for example with Mercurial Queue patches).\n\nUsed by the quilt and hg backends.\n\nThe default values for these styles in all contexts are:\n"
                    },
                    {
                        "name": "formats",
                        "content": "\" (%s)-[%b]%u%c-\""
                    },
                    {
                        "name": "actionformats",
                        "content": "\" (%s)-[%b|%a]%u%c-\""
                    },
                    {
                        "name": "branchformat",
                        "content": "\"%b:%r\" (for bzr, svn, svk and hg)"
                    },
                    {
                        "name": "nvcsformats",
                        "content": "\"\""
                    },
                    {
                        "name": "hgrevformat",
                        "content": "\"%r:%h\""
                    },
                    {
                        "name": "max-exports",
                        "content": "2\nenable ALL"
                    },
                    {
                        "name": "disable",
                        "content": "(empty list)"
                    },
                    {
                        "name": "disable-patterns",
                        "content": "(empty list)"
                    },
                    {
                        "name": "check-for-changes",
                        "content": "false"
                    },
                    {
                        "name": "check-for-staged-changes",
                        "content": "false"
                    },
                    {
                        "name": "stagedstr",
                        "content": "(string: \"S\")"
                    },
                    {
                        "name": "unstagedstr",
                        "content": "(string: \"U\")"
                    },
                    {
                        "name": "command",
                        "content": "(empty string)"
                    },
                    {
                        "name": "use-server",
                        "content": "false"
                    },
                    {
                        "name": "use-simple",
                        "content": "false"
                    },
                    {
                        "name": "get-revision",
                        "content": "false\nget-mq true"
                    },
                    {
                        "name": "get-bookmarks",
                        "content": "false"
                    },
                    {
                        "name": "use-prompt-escapes",
                        "content": "true\ndebug  false\nhooks  (empty list)"
                    },
                    {
                        "name": "use-quilt",
                        "content": "false"
                    },
                    {
                        "name": "quilt-standalone",
                        "content": "false"
                    },
                    {
                        "name": "quilt-patch-dir",
                        "content": "empty - use $QUILTPATCHES"
                    },
                    {
                        "name": "quiltcommand",
                        "content": "quilt"
                    },
                    {
                        "name": "patch-format",
                        "content": "backend dependent"
                    },
                    {
                        "name": "nopatch-format",
                        "content": "backend dependent"
                    },
                    {
                        "name": "get-unapplied",
                        "content": "false\n\nIn normal formats and actionformats the following replacements are done:\n\n%s     The VCS in use (git, hg, svn, etc.).\n%b     Information about the current branch.\n%a     An identifier that describes the action. Only makes sense in actionformats.\n%i     The current revision number or identifier. For hg the hgrevformat style may be used to\ncustomize the output.\n%c     The string from the stagedstr style if there are staged changes in the repository.\n%u     The string from the unstagedstr style if there are unstaged changes in the repository.\n%R     The base directory of the repository.\n%r     The repository name. If %R is /foo/bar/repoXY, %r is repoXY.\n%S     A  subdirectory  within  a  repository.  If  $PWD is /foo/bar/repoXY/beer/tasty, %S is\nbeer/tasty.\n%m     A \"misc\" replacement. It is at the discretion of the backend to decide what  this  re‐\nplacement expands to.\n\nThe  hg  and  git  backends use this expando to display patch information.  hg sources\npatch information from the mq extensions; git from in-progress rebase and  cherry-pick\noperations  and  from the stgit extension.  The patch-format and nopatch-format styles\ncontrol the generated string.  The former is used when at least  one  patch  from  the\npatch queue has been applied, and the latter otherwise.\n\nThe hg backend displays bookmark information in this expando (in addition to mq infor‐\nmation).  See the get-mq and get-bookmarks styles.  Both of these styles  may  be  en‐\nabled  at  the  same  time.  If both are enabled, both resulting strings will be shown\nseparated by a semicolon (that cannot currently be customized).\n\nThe quilt `standalone' backend sets this expando to the same value as the %Q expando.\n\n%Q     Quilt series information.  When quilt is used (either in `addon' mode or as a  `stand‐\nalone'  backend),  this  expando  is  set  to  quilt series' patch-format string.  The\nset-patch-format hook and nopatch-format style are honoured.\n\nSee Quilt Support below for details.\n\nIn branchformat these replacements are done:\n\n%b     The branch name.\n%r     The current revision number or the hgrevformat style for hg.\n\nIn hgrevformat these replacements are done:\n\n%r     The current local revision number.\n%h     The current global revision identifier.\n\nIn patch-format and nopatch-format these replacements are done:\n\n%p     The name of the top-most applied patch; may be overridden by the applied-string hook.\n%u     The number of unapplied patches; may be overridden by the unapplied-string hook.\n%n     The number of applied patches.\n%c     The number of unapplied patches.\n%a     The number of all patches (%a = %n + %c).\n%g     The names of active mq guards (hg backend).\n%G     The number of active mq guards (hg backend).\n\nNot all VCS backends have to support all replacements. For nvcsformats  no  replacements  are\nperformed at all, it is just a string.\n"
                    },
                    {
                        "name": "Oddities",
                        "content": "If  you  want  to use the %b (bold off) prompt expansion in formats, which expands %b itself,\nuse %%b. That will cause the vcsinfo expansion to replace %%b with %b, so that zsh's  prompt\nexpansion  mechanism  can handle it. Similarly, to hand down %b from branchformat, use %%%%b.\nSorry for this inconvenience, but it cannot be easily avoided. Luckily we do not clash with a\nlot of prompt expansions and this only needs to be done for those.\n\nWhen  one  of the gen-applied-string, gen-unapplied-string, and set-patch-format hooks is de‐\nfined, applying %-escaping (`foo=${foo//'%'/%%}') to the interpolated values for use  in  the\nprompt  is  the  responsibility  of those hooks (jointly); when neither of those hooks is de‐\nfined, vcsinfo handles escaping by itself.  We regret this coupling, but it was required for\nbackwards compatibility.\n"
                    },
                    {
                        "name": "Quilt Support",
                        "content": "Quilt is not a version control system, therefore this is not implemented as a backend. It can\nhelp keeping track of a series of patches. People use it to keep a set of changes  they  want\nto  use  on  top  of  software  packages  (which is tightly integrated into the package build\nprocess - the Debian project does this for a large number of packages). Quilt can  also  help\nindividual developers keep track of their own patches on top of real version control systems.\n\nThe  vcsinfo  integration  tries  to support both ways of using quilt by having two slightly\ndifferent modes of operation: `addon' mode and `standalone' mode).\n\nQuilt integration is off by default; to enable it, set the use-quilt style,  and  add  %Q  to\nyour formats or actionformats style:\nzstyle ':vcsinfo:*' use-quilt true\n\nStyles  looked  up  from the Quilt support code include `.quilt-quilt-mode' in the vcs-string\npart  of  the  context,  where  quilt-mode  is  either   addon   or   standalone.    Example:\n:vcsinfo:git.quilt-addon:default:repo-root-name.\n\nFor  `addon' mode to become active vcsinfo must have already detected a real version control\nsystem controlling the directory. If that is the case, a directory that holds quilt's patches\nneeds  to  be found. That directory is configurable via the `QUILTPATCHES' environment vari‐\nable. If that variable exists its value is used, otherwise the value  `patches'  is  assumed.\nThe  value from $QUILTPATCHES can be overwritten using the `quilt-patches' style. (Note: you\ncan use vcsinfo to keep the value of $QUILTPATCHES correct all the time via the  post-quilt\nhook).\n\nWhen the directory in question is found, quilt is assumed to be active. To gather more infor‐\nmation, vcsinfo looks for a directory called `.pc'; Quilt uses that directory to  track  its\ncurrent  state.  If this directory does not exist we know that quilt has not done anything to\nthe working directory (read: no patches have been applied yet).\n\nIf patches are applied, vcsinfo will try to find out  which.  If  you  want  to  know  which\npatches  of a series are not yet applied, you need to activate the get-unapplied style in the\nappropriate context.\n\nvcsinfo allows for very detailed control over how the gathered information is presented (see\nthe  Configuration  and  Hooks in vcsinfo sections), all of which are documented below. Note\nthere are a number of other patch tracking systems that work on top of a certain version con‐\ntrol  system  (like stgit for git, or mq for hg); the configuration for systems like that are\ngenerally configured the same way as the quilt support.\n\nIf the quilt support is working in `addon' mode, the produced string is available as a simple\nformat  replacement  (%Q  to be precise), which can be used in formats and actionformats; see\nbelow for details).\n\nIf, on the other hand, the support code is working in `standalone' mode, vcsinfo  will  pre‐\ntend  as  if quilt were an actual version control system. That means that the version control\nsystem identifier (which otherwise would be something like `svn' or `cvs')  will  be  set  to\n`-quilt-'.  This has implications on the used style context where this identifier is the sec‐\nond element. vcsinfo will have filled in a proper value for the \"repository's\"  root  direc‐\ntory  and  the string containing the information about quilt's state will be available as the\n`misc' replacement (and %Q for compatibility with `addon' mode).\n\nWhat is left to discuss is how `standalone' mode is detected. The detection itself is  a  se‐\nries  of  searches for directories. You can have this detection enabled all the time in every\ndirectory that is not otherwise under version control. If you know there is  only  a  limited\nset  of trees where you would like vcsinfo to try and look for Quilt in `standalone' mode to\nminimise the amount of searching on every call to vcsinfo, there are a number of ways to  do\nthat:\n\nEssentially,  `standalone' mode detection is controlled by a style called `quilt-standalone'.\nIt is a string style and its value can have different effects. The simplest values are:  `al‐‐\nways'  to run detection every time vcsinfo is run, and `never' to turn the detection off en‐\ntirely.\n\nIf the value of quilt-standalone is something else, it is  interpreted  differently.  If  the\nvalue  is  the name of a scalar variable the value of that variable is checked and that value\nis used in the same `always'/`never' way as described above.\n\nIf the value of quilt-standalone is an array, the elements of that array are used  as  direc‐\ntory names under which you want the detection to be active.\n\nIf  quilt-standalone  is  an  associative  array, the keys are taken as directory names under\nwhich you want the detection to be active, but only if the corresponding value is the  string\n`true'.\n\nLast, but not least, if the value of quilt-standalone is the name of a function, the function\nis called without arguments and the return value decides whether detection should be  active.\nA `0' return value is true; a non-zero return value is interpreted as false.\n\nNote,  if  there is both a function and a variable by the name of quilt-standalone, the func‐\ntion will take precedence.\n"
                    },
                    {
                        "name": "Function Descriptions (Public API)",
                        "content": "vcsinfo [user-context]\nThe  main  function,  that  runs  all   backends   and   assembles   all   data   into\n${vcsinfomsg*}.  This  is the function you want to call from precmd if you want to\ninclude up-to-date information in your prompt (see Variable Description below).  If an\nargument  is  given,  that  string will be used instead of default in the user-context\nfield of the style context.\n\nvcsinfohookadd\nStatically registers a number of functions to a given hook. The hook needs to be given\nas  the  first  argument; what follows is a list of hook-function names to register to\nthe hook. The `+vi-' prefix needs to be left out here. See Hooks in vcsinfo below for\ndetails.\n\nvcsinfohookdel\nRemove  hook-functions  from  a  given  hook.  The hook needs to be given as the first\nnon-option argument; what follows is a list of hook-function names to un-register from\nthe  hook. If `-a' is used as the first argument, all occurrences of the functions are\nunregistered. Otherwise only the last occurrence is removed (if a function was  regis‐\ntered  to  a  hook  more than once). The `+vi-' prefix needs to be left out here.  See\nHooks in vcsinfo below for details.\n\nvcsinfolastmsg\nOutputs the last ${vcsinfomsg*} value.   Takes  into  account  the  value  of  the\nuse-prompt-escapes  style  in  ':vcsinfo:formats:command:-all-'.  It also only prints\nmax-exports values.\n\nvcsinfoprintsys [user-context]\nPrints a list of all supported version control systems. Useful to  find  out  possible\ncontexts (and which of them are enabled) or values for the disable style.\n\nvcsinfosetsys\nInitializes  vcsinfo's  internal  list of available backends. With this function, you\ncan add support for new VCSs without restarting the shell.\n\nAll functions named VCSINFO* are for internal use only.\n"
                    },
                    {
                        "name": "Variable Description",
                        "content": "${vcsinfomsgN} (Note the trailing underscore)\nWhere N is an integer, e.g., vcsinfomsg0. These variables are the storage for  the\ninformational  message  the  last vcsinfo call has assembled. These are strongly con‐\nnected to the formats, actionformats and nvcsformats  styles  described  above.  Those\nstyles are lists. The first member of that list gets expanded into ${vcsinfomsg0},\nthe second into ${vcsinfomsg1} and the Nth  into  ${vcsinfomsgN-1}.  (See  the\nmax-exports style above.)\n\nAll variables named VCSINFO* are for internal use only.\n\nHooks in vcsinfo\nHooks  are places in vcsinfo where you can run your own code. That code can communicate with\nthe code that called it and through that, change the system's behaviour.\n\nFor configuration, hooks change the style context:\n:vcsinfo:vcs-string+hook-name:user-context:repo-root-name\n\nTo register functions to a hook, you need to list them in the hooks style in the  appropriate\ncontext.\n\nExample:\nzstyle ':vcsinfo:*+foo:*' hooks bar baz\n\nThis  registers  functions  to  the  hook `foo' for all backends. In order to avoid namespace\nproblems, all registered function names are prepended by a `+vi-', so  the  actual  functions\ncalled for the `foo' hook are `+vi-bar' and `+vi-baz'.\n\nIf you would like to register a function to a hook regardless of the current context, you may\nuse the vcsinfohookadd function. To remove  a  function  that  was  added  like  that,  the\nvcsinfohookdel function can be used.\n\nIf  something seems weird, you can enable the `debug' boolean style in the proper context and\nthe hook-calling code will print what it tried to execute and whether the function  in  ques‐\ntion existed.\n\nWhen  you register more than one function to a hook, all functions are executed one after an‐\nother until one function returns non-zero or until  all  functions  have  been  called.  Con‐\ntext-sensitive  hook functions are executed before statically registered ones (the ones added\nby vcsinfohookadd).\n\nYou may pass data between functions via an associative array, userdata.  For example:\n+vi-git-myfirsthook(){\nuserdata[myval]=$myval\n}\n+vi-git-mysecondhook(){\n# do something with ${userdata[myval]}\n}\n\nThere are a number of variables that are special in hook contexts:\n\nret    The return value that the hooks system will return to the caller. The  default  is  an\ninteger `zero'. If and how a changed ret value changes the execution of the caller de‐\npends on the specific hook. See the hook documentation below for details.\n\nhookcom\nAn associated array which is used for bidirectional communication from the  caller  to\nhook functions. The used keys depend on the specific hook.\n"
                    },
                    {
                        "name": "context",
                        "content": "The  active  context  of  the hook. Functions that wish to change this variable should\nmake it local scope first.\n\nvcs    The current VCS after it was detected. The same values as in the enable/disable  style\nare used. Available in all hooks except start-up.\n\nFinally, the full list of currently available hooks:\n"
                    },
                    {
                        "name": "start-up",
                        "content": "Called  after starting vcsinfo but before the VCS in this directory is determined. It\ncan be used to deactivate vcsinfo temporarily if necessary. When ret  is  set  to  1,\nvcsinfo  aborts and does nothing; when set to 2, vcsinfo sets up everything as if no\nversion control were active and exits.\n"
                    },
                    {
                        "name": "pre-get-data",
                        "content": "Same as start-up but after the VCS was detected.\n"
                    },
                    {
                        "name": "gen-hg-bookmark-string",
                        "content": "Called in the Mercurial backend when a bookmark string is generated; the  get-revision\nand get-bookmarks styles must be true.\n\nThis hook gets the names of the Mercurial bookmarks that vcsinfo collected from `hg'.\n\nIf  a  bookmark is active, the key ${hookcom[hg-active-bookmark]} is set to its name.\nThe key is otherwise unset.\n\nWhen setting ret to non-zero, the string in  ${hookcom[hg-bookmark-string]}  will  be\nused in the %m escape in formats and actionformats and will be available in the global\nbackendmisc array as ${backendmisc[bookmarks]}.\n"
                    },
                    {
                        "name": "gen-applied-string",
                        "content": "Called in the git (with stgit or during rebase or merge), and hg  (with  mq)  backends\nand  in  quilt support when the applied-string is generated; the use-quilt zstyle must\nbe true for quilt (the mq and stgit backends are active by default).\n\nThis hook gets the names of all applied patches which vcsinfo collected so far in the\nopposite  order,  which  means  that  the  first argument is the top-most patch and so\nforth.\n\nWhen setting ret to non-zero, the string in ${hookcom[applied-string]} will be avail‐\nable  as  %p  in the patch-format and nopatch-format styles.  This hook is, in concert\nwith set-patch-format, responsible for %-escaping that value for use  in  the  prompt.\n(See the Oddities section.)\n"
                    },
                    {
                        "name": "gen-unapplied-string",
                        "content": "Called in the git (with stgit or during rebase), and hg (with mq) backend and in quilt\nsupport when the unapplied-string is generated; the get-unapplied style must be true.\n\nThis hook gets the names of all unapplied patches which vcsinfo collected so  far  in\norder, which means that the first argument is the patch next-in-line to be applied and\nso forth.\n\nWhen setting ret to non-zero, the  string  in  ${hookcom[unapplied-string]}  will  be\navailable  as %u in the patch-format and nopatch-format styles.  This hook is, in con‐\ncert with set-patch-format, responsible for %-escaping  that  value  for  use  in  the\nprompt.  (See the Oddities section.)\n"
                    },
                    {
                        "name": "gen-mqguards-string",
                        "content": "Called  in  the  hg  backend when guards-string is generated; the get-mq style must be\ntrue (default).\n\nThis hook gets the names of any active mq guards.\n\nWhen setting ret to non-zero, the string in ${hookcom[guards-string]} will be used in\nthe %g escape in the patch-format and nopatch-format styles.\n\nno-vcs This hooks is called when no version control system was detected.\n\nThe `hookcom' parameter is not used.\n"
                    },
                    {
                        "name": "post-backend",
                        "content": "Called as soon as the backend has finished collecting information.\n\nThe `hookcom' keys available are as for the set-message hook.\n"
                    },
                    {
                        "name": "post-quilt",
                        "content": "Called  after  the quilt support is done. The following information is passed as argu‐\nments to the hook: 1. the quilt-support mode (`addon' or `standalone'); 2. the  direc‐\ntory that contains the patch series; 3. the directory that holds quilt's status infor‐\nmation (the `.pc' directory) or the string \"-nopc-\" if that directory wasn't found.\n\nThe `hookcom' parameter is not used.\n"
                    },
                    {
                        "name": "set-branch-format",
                        "content": "Called before `branchformat' is set. The only argument to the hook is the format  that\nis configured at this point.\n\nThe  `hookcom' keys considered are `branch' and `revision'.  They are set to the val‐\nues figured out so far by vcsinfo and any change will be used directly when  the  ac‐\ntual replacement is done.\n\nIf  ret is set to non-zero, the string in ${hookcom[branch-replace]} will be used un‐\nchanged as the `%b' replacement in the variables set by vcsinfo.\n"
                    },
                    {
                        "name": "set-hgrev-format",
                        "content": "Called before a `hgrevformat' is set. The only argument to the hook is the format that\nis configured at this point.\n\nThe  `hookcom' keys considered are `hash' and `localrev'.  They are set to the values\nfigured out so far by vcsinfo and any change will be used directly  when  the  actual\nreplacement is done.\n\nIf  ret  is  set  to non-zero, the string in ${hookcom[rev-replace]} will be used un‐\nchanged as the `%i' replacement in the variables set by vcsinfo.\n"
                    },
                    {
                        "name": "pre-addon-quilt",
                        "content": "This hook is used when vcsinfo's quilt functionality is active in \"addon\" mode (quilt\nused  on top of a real version control system). It is activated right before any quilt\nspecific action is taken.\n\nSetting the `ret' variable in this hook to a non-zero value avoids any quilt  specific\nactions from being run at all.\n"
                    },
                    {
                        "name": "set-patch-format",
                        "content": "This  hook  is  used  to  control  some of the possible expansions in patch-format and\nnopatch-format styles with patch queue systems such as quilt, mqueue and the like.\n\nThis hook is used in the git, hg and quilt backends.\n\nThe hook allows the control of the %p (${hookcom[applied]}) and %u  (${hookcom[unap‐‐\nplied]})  expansion in all backends that use the hook. With the mercurial backend, the\n%g (${hookcom[guards]}) expansion is controllable in addition to that.\n\nIf ret is set to non-zero, the string in ${hookcom[patch-replace]} will be  used  un‐\nchanged instead of an expanded format from patch-format or nopatch-format.\n\nThis  hook is, in concert with the gen-applied-string or gen-unapplied-string hooks if\nthey are defined, responsible for %-escaping the final patch-format value for  use  in\nthe prompt.  (See the Oddities section.)\n"
                    },
                    {
                        "name": "set-message",
                        "content": "Called  each  time before a `vcsinfomsgN' message is set.  It takes two arguments;\nthe first being the `N' in the message variable name, the second is the currently con‐\nfigured formats or actionformats.\n\nThere are a number of `hookcom' keys, that are used here: `action', `branch', `base',\n`base-name', `subdir', `staged', `unstaged', `revision', `misc', `vcs' and one `miscN'\nentry  for  each backend-specific data field (N starting at zero). They are set to the\nvalues figured out so far by vcsinfo and any change will be used  directly  when  the\nactual replacement is done.\n\nSince  this  hook is triggered multiple times (once for each configured formats or ac‐‐\ntionformats), each of the `hookcom' keys mentioned above (except for  the  miscN  en‐\ntries)  has  an `orig' counterpart, so even if you changed a value to your liking you\ncan still get the original value in the next run. Changing the `orig' values is prob‐\nably not a good idea.\n\nIf  ret  is set to non-zero, the string in ${hookcom[message]} will be used unchanged\nas the message by vcsinfo.\n\nIf all of this sounds rather confusing, take a look at the Examples section below and also in\nthe Misc/vcsinfo-examples file in the Zsh source.  They contain some explanatory code.\n"
                    },
                    {
                        "name": "Examples",
                        "content": "Don't use vcsinfo at all (even though it's in your prompt):\nzstyle ':vcsinfo:*' enable NONE\n\nDisable the backends for bzr and svk:\nzstyle ':vcsinfo:*' disable bzr svk\n\nDisable everything but bzr and svk:\nzstyle ':vcsinfo:*' enable bzr svk\n\nProvide a special formats for git:\nzstyle ':vcsinfo:git:*' formats       ' GIT, BABY! [%b]'\nzstyle ':vcsinfo:git:*' actionformats ' GIT ACTION! [%b|%a]'\n\nAll  %x expansion in all sorts of formats (formats, actionformats, branchformat, you name it)\nare done using the `zformat' builtin from the `zsh/zutil' module. That means you can  do  ev‐\nerything with these %x items what zformat supports. In particular, if you want something that\nis really long to have a fixed width, like a hash in a mercurial  branchformat,  you  can  do\nthis: %12.12i. That'll shrink the 40 character hash to its 12 leading characters. The form is\nactually `%min.maxx'. More is possible.  See the section `The zsh/zutil  Module'  in  zshmod‐\nules(1) for details.\n\nUse the quicker bzr backend\nzstyle ':vcsinfo:bzr:*' use-simple true\n\nIf you do use use-simple, please report if it does `the-right-thing[tm]'.\n\nDisplay the revision number in yellow for bzr and svn:\nzstyle ':vcsinfo:(svn|bzr):*' \\\nbranchformat '%b%{'${fg[yellow]}'%}:%r'\n\nIf  you  want colors, make sure you enclose the color codes in %{...%} if you want to use the\nstring provided by vcsinfo in prompts.\n\nHere is how to print the VCS information as a command (not in a prompt):\nalias vcsi='vcsinfo command; vcsinfolastmsg'\n\nThis way, you can even define different  formats  for  output  via  vcsinfolastmsg  in  the\n':vcsinfo:*:command:*' namespace.\n\nNow  as  promised,  some code that uses hooks: say, you'd like to replace the string `svn' by\n`subversion' in vcsinfo's %s formats replacement.\n\nFirst, we will tell vcsinfo to call a function when populating the  message  variables  with\nthe gathered information:\nzstyle ':vcsinfo:*+set-message:*' hooks svn2subversion\n\nNothing  happens. Which is reasonable, since we didn't define the actual function yet. To see\nwhat the hooks subsystem is trying to do, enable the `debug' style:\nzstyle ':vcsinfo:*+*:*' debug true\n\nThat should give you an idea what is going on. Specifically, the function that we are looking\nfor  is  `+vi-svn2subversion'.  Note,  the `+vi-' prefix. So, everything is in order, just as\ndocumented. When you are done checking out the debugging output, disable it again:\nzstyle ':vcsinfo:*+*:*' debug false\n\nNow, let's define the function:\nfunction +vi-svn2subversion() {\n[[ ${hookcom[vcsorig]} == svn ]] && hookcom[vcs]=subversion\n}\n\nSimple enough. And it could have even been simpler, if only we had registered our function in\na  less  generic  context.  If we do it only in the `svn' backend's context, we don't need to\ntest which the active backend is:\nzstyle ':vcsinfo:svn+set-message:*' hooks svn2subversion\nfunction +vi-svn2subversion() {\nhookcom[vcs]=subversion\n}\n\nAnd finally a little more elaborate example, that uses a hook to create a customised bookmark\nstring for the hg backend.\n\nAgain, we start off by registering a function:\nzstyle ':vcsinfo:hg+gen-hg-bookmark-string:*' hooks hgbookmarks\n\nAnd then we define the `+vi-hgbookmarks' function:\nfunction +vi-hgbookmarks() {\n# The default is to connect all bookmark names by\n# commas. This mixes things up a little.\n# Imagine, there's one type of bookmarks that is\n# special to you. Say, because it's *your* work.\n# Those bookmarks look always like this: \"sh/*\"\n# (because your initials are sh, for example).\n# This makes the bookmarks string use only those\n# bookmarks. If there's more than one, it\n# concatenates them using commas.\n# The bookmarks returned by `hg' are available in\n# the function's positional parameters.\nlocal s=\"${(Mj:,:)@:#sh/*}\"\n# Now, the communication with the code that calls\n# the hook functions is done via the hookcom[]\n# hash. The key at which the `gen-hg-bookmark-string'\n# hook looks is `hg-bookmark-string'. So:\nhookcom[hg-bookmark-string]=$s\n# And to signal that we want to use the string we\n# just generated, set the special variable `ret' to\n# something other than the default zero:\nret=1\nreturn 0\n}\n\nSome  longer  examples  and code snippets which might be useful are available in the examples\nfile located at Misc/vcsinfo-examples in the Zsh source directory.\n\nThis concludes our guided tour through zsh's vcsinfo.\n"
                    }
                ]
            },
            "PROMPT THEMES": {
                "content": "",
                "subsections": [
                    {
                        "name": "Installation",
                        "content": "You should make sure all the functions from the Functions/Prompts  directory  of  the  source\ndistribution  are  available; they all begin with the string `prompt' except for the special\nfunction`promptinit'.  You also need the `colors' and  `add-zsh-hook'  functions  from  Func‐‐\ntions/Misc.   All  these  functions may already be installed on your system; if not, you will\nneed to find them and copy them.  The directory should appear as one of the elements  of  the\nfpath  array (this should already be the case if they were installed), and at least the func‐\ntion promptinit should be autoloaded; it will autoload the rest.  Finally, to initialize  the\nuse  of  the  system  you  need  to call the promptinit function.  The following code in your\n.zshrc will arrange for this; assume the functions are stored in the directory ~/myfns:\n\nfpath=(~/myfns $fpath)\nautoload -U promptinit\npromptinit\n"
                    },
                    {
                        "name": "Theme Selection",
                        "content": "Use the prompt command to select your preferred theme.  This command may  be  added  to  your\n.zshrc following the call to promptinit in order to start zsh with a theme already selected.\n\nprompt [ -c | -l ]\nprompt [ -p | -h ] [ theme ... ]\nprompt [ -s ] theme [ arg ... ]\nSet or examine the prompt theme.  With no options and a theme argument, the theme with\nthat name is set as the current theme.  The available themes  are  determined  at  run\ntime;  use  the -l option to see a list.  The special theme `random' selects at random\none of the available themes and sets your prompt to that.\n\nIn some cases the theme may be modified by one or  more  arguments,  which  should  be\ngiven after the theme name.  See the help for each theme for descriptions of these ar‐\nguments.\n\nOptions are:\n\n-c     Show the currently selected theme and its parameters, if any.\n-l     List all available prompt themes.\n-p     Preview the theme named by theme, or all themes if no theme is given.\n-h     Show help for the theme named by theme, or for the prompt function if no  theme\nis given.\n-s     Set theme as the current theme and save state.\n\npromptthemesetup\nEach  available  theme  has a setup function which is called by the prompt function to\ninstall that theme.  This function may define other functions as necessary to maintain\nthe  prompt,  including  functions  used to preview the prompt or provide help for its\nuse.  You should not normally call a theme's setup function directly.\n"
                    },
                    {
                        "name": "Utility Themes",
                        "content": ""
                    },
                    {
                        "name": "prompt off",
                        "content": "The theme `off' sets all the prompt variables to minimal values with  no  special  ef‐\nfects.\n"
                    },
                    {
                        "name": "prompt default",
                        "content": "The  theme  `default' sets all prompt variables to the same state as if an interactive\nzsh was started with no initialization files.\n"
                    },
                    {
                        "name": "prompt restore",
                        "content": "The special theme `restore' erases all theme settings and  sets  prompt  variables  to\ntheir  state  before the first time the `prompt' function was run, provided each theme\nhas properly defined its cleanup (see below).\n\nNote that you can undo `prompt off' and `prompt default' with `prompt restore', but  a\nsecond restore does not undo the first.\n"
                    },
                    {
                        "name": "Writing Themes",
                        "content": "The  first  step  for  adding  your  own  theme is to choose a name for it, and create a file\n`promptnamesetup' in a directory in your fpath, such as ~/myfns in the example above.   The\nfile should at minimum contain assignments for the prompt variables that your theme wishes to\nmodify.  By convention, themes use PS1, PS2, RPS1, etc., rather than the  longer  PROMPT  and\nRPROMPT.\n\nThe file is autoloaded as a function in the current shell context, so it may contain any nec‐\nessary commands to customize your theme, including defining additional  functions.   To  make\nsome complex tasks easier, your setup function may also do any of the following:\n\nAssign promptopts\nThe  array  promptopts  may  be assigned any of \"bang\", \"cr\", \"percent\", \"sp\", and/or\n\"subst\" as values.  The corresponding setopts (promptbang, etc.) are  turned  on,  all\nother  prompt-related options are turned off.  The promptopts array preserves setopts\neven beyond the scope of localoptions, should your function need that.\n\nModify precmd and preexec\nUse of add-zsh-hook is recommended.  The precmd and preexec  hooks  are  automatically\nadjusted if the prompt theme changes or is disabled.\n\nDeclare cleanup\nIf  your function makes any other changes that should be undone when the theme is dis‐\nabled, your setup function may call\npromptcleanup command\nwhere command should be suitably quoted.  If your theme is ever disabled or replaced  by  an‐\nother, command is executed with eval.  You may declare more than one such cleanup hook.\n\nDefine preview\nDefine  or  autoload  a function promptnamepreview to display a simulated version of\nyour prompt.  A simple default previewer is defined by promptinit for themes  that  do\nnot define their own.  This preview function is called by `prompt -p'.\n\nProvide help\nDefine  or  autoload a function promptnamehelp to display documentation or help text\nfor your theme.  This help function is called by `prompt -h'.\n"
                    }
                ]
            },
            "ZLE FUNCTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "Widgets",
                        "content": "These functions all implement user-defined ZLE widgets (see zshzle(1)) which can be bound  to\nkeystrokes in interactive shells.  To use them, your .zshrc should contain lines of the form\n\nautoload function\nzle -N function\n\nfollowed  by  an  appropriate  bindkey command to associate the function with a key sequence.\nSuggested bindings are described below.\n\nbash-style word functions\nIf you are looking for functions to implement moving over and  editing  words  in  the\nmanner of bash, where only alphanumeric characters are considered word characters, you\ncan use the functions described in the next section.  The following is sufficient:\n\nautoload -U select-word-style\nselect-word-style bash\n\nforward-word-match, backward-word-match\nkill-word-match, backward-kill-word-match\ntranspose-words-match, capitalize-word-match\nup-case-word-match, down-case-word-match\ndelete-whole-word-match, select-word-match\nselect-word-style, match-word-context, match-words-by-style\nThe first eight `-match' functions are drop-in replacements for  the  builtin  widgets\nwithout  the suffix.  By default they behave in a similar way.  However, by the use of\nstyles and the function select-word-style, the way words are matched can  be  altered.\nselect-word-match  is  intended to be used as a text object in vi mode but with custom\nword styles. For comparison, the widgets described in zshzle(1) under Text Objects use\nfixed definitions of words, compatible with the vim editor.\n\nThe  simplest  way of configuring the functions is to use select-word-style, which can\neither be called as a normal function with the appropriate argument, or invoked  as  a\nuser-defined  widget  that will prompt for the first character of the word style to be\nused.  The first time it is invoked, the first eight -match functions  will  automati‐\ncally replace the builtin versions, so they do not need to be loaded explicitly.\n\nThe word styles available are as follows.  Only the first character is examined.\n\nbash   Word characters are alphanumeric characters only.\n\nnormal As in normal shell operation:  word characters are alphanumeric characters plus\nany characters present in the string given by the parameter $WORDCHARS.\n\nshell  Words are complete shell command arguments, possibly including complete  quoted\nstrings, or any tokens special to the shell.\n\nwhitespace\nWords are any set of characters delimited by whitespace.\n\ndefault\nRestore the default settings; this is usually the same as `normal'.\n\nAll  but  `default' can be input as an upper case character, which has the same effect\nbut with subword matching turned on.  In this case, words with upper  case  characters\nare  treated  specially:  each separate run of upper case characters, or an upper case\ncharacter followed by any number of other characters, is considered a word.  The style\nsubword-range  can  supply  an alternative character range to the default `[:upper:]';\nthe value of the style is treated as the contents of a `[...]' pattern (note that  the\nouter brackets should not be supplied, only those surrounding named ranges).\n\nMore  control can be obtained using the zstyle command, as described in zshmodules(1).\nEach style is looked up in the context :zle:widget where widget is  the  name  of  the\nuser-defined  widget,  not the name of the function implementing it, so in the case of\nthe definitions supplied by select-word-style the appropriate contexts  are  :zle:for‐‐\nward-word, and so on.  The function select-word-style itself always defines styles for\nthe context `:zle:*' which can be overridden by more  specific  (longer)  patterns  as\nwell as explicit contexts.\n\nThe style word-style specifies the rules to use.  This may have the following values.\n\nnormal Use  the  standard shell rules, i.e. alphanumerics and $WORDCHARS, unless over‐\nridden by the styles word-chars or word-class.\n\nspecified\nSimilar to normal, but only the specified characters, and not also  alphanumer‐\nics, are considered word characters.\n\nunspecified\nThe  negation  of  specified.  The given characters are those which will not be\nconsidered part of a word.\n\nshell  Words are obtained by using the syntactic rules for  generating  shell  command\narguments.   In addition, special tokens which are never command arguments such\nas `()' are also treated as words.\n\nwhitespace\nWords are whitespace-delimited strings of characters.\n\nThe first three of those rules usually use $WORDCHARS, but the value in the  parameter\ncan  be  overridden  by  the  style word-chars, which works in exactly the same way as\n$WORDCHARS.  In addition, the style word-class uses character class  syntax  to  group\ncharacters and takes precedence over word-chars if both are set.  The word-class style\ndoes not include the  surrounding  brackets  of  the  character  class;  for  example,\n`-:[:alnum:]'  is  a valid word-class to include all alphanumerics plus the characters\n`-' and `:'.  Be careful including `]', `^' and `-' as these are special inside  char‐\nacter classes.\n\nword-style may also have `-subword' appended to its value to turn on subword matching,\nas described above.\n\nThe style skip-chars is mostly useful for transpose-words and similar  functions.   If\nset,  it gives a count of characters starting at the cursor position which will not be\nconsidered part of the word and are treated as space, regardless of what they actually\nare.  For example, if\n\nzstyle ':zle:transpose-words' skip-chars 1\n\nhas been set, and transpose-words-match is called with the cursor on the X of fooXbar,\nwhere X can be any character, then the resulting expression is barXfoo.\n\nFiner grained control can be obtained by setting the style word-context to an array of\npairs  of  entries.  Each pair of entries consists of a pattern and a subcontext.  The\nshell argument the cursor is on is matched against each  pattern  in  turn  until  one\nmatches;  if it does, the context is extended by a colon and the corresponding subcon‐\ntext.  Note that the test is made against the original  word  on  the  line,  with  no\nstripping  of  quotes.  Special handling is done between words: the current context is\nexamined and if it contains the string between the word is set to a single space; else\nif  it is contains the string back, the word before the cursor is considered, else the\nword after cursor is considered. Some examples are given below.\n\nThe style skip-whitespace-first is only used with the forward-word widget.  If  it  is\nset  to  true,  then  forward-word  skips  any  non-word-characters,  followed  by any\nnon-word-characters: this is similar to the behaviour of  other  word-orientated  wid‐\ngets,  and  also  that used by other editors, however it differs from the standard zsh\nbehaviour.  When using select-word-style the widget is set in the  context  :zle:*  to\ntrue  if  the word style is bash and false otherwise.  It may be overridden by setting\nit in the more specific context :zle:forward-word*.\n\nIt is possible to create widgets with specific behaviour by defining a new widget  im‐\nplemented by the appropriate generic function, then setting a style for the context of\nthe  specific  widget.   For  example,  the   following   defines   a   widget   back‐‐\nward-kill-space-word  using  backward-kill-word-match, the generic widget implementing\nbackward-kill-word behaviour, and  ensures  that  the  new  widget  always  implements\nspace-delimited behaviour.\n\nzle -N backward-kill-space-word backward-kill-word-match\nzstyle :zle:backward-kill-space-word word-style space\n\nThe widget backward-kill-space-word can now be bound to a key.\n\nHere  are  some further examples of use of the styles, actually taken from the simpli‐\nfied interface in select-word-style:\n\nzstyle ':zle:*' word-style standard\nzstyle ':zle:*' word-chars ''\n\nImplements bash-style word handling for all widgets, i.e. only alphanumerics are  word\ncharacters; equivalent to setting the parameter WORDCHARS empty for the given context.\n\nstyle ':zle:*kill*' word-style space\n\nUses  space-delimited  words for widgets with the word `kill' in the name.  Neither of\nthe styles word-chars nor word-class is used in this case.\n\nHere are some examples of use of the word-context style to extend the context.\n\nzstyle ':zle:*' word-context \\\n\"*/*\" filename \"[[:space:]]\" whitespace\nzstyle ':zle:transpose-words:whitespace' word-style shell\nzstyle ':zle:transpose-words:filename' word-style normal\nzstyle ':zle:transpose-words:filename' word-chars ''\n\nThis provides two different ways of using transpose-words  depending  on  whether  the\ncursor  is on whitespace between words or on a filename, here any word containing a /.\nOn whitespace, complete arguments as defined by standard shell rules  will  be  trans‐\nposed.   In  a filename, only alphanumerics will be transposed.  Elsewhere, words will\nbe transposed using the default style for :zle:transpose-words.\n\nThe word matching and all the handling of zstyle settings is actually  implemented  by\nthe  function  match-words-by-style.  This can be used to create new user-defined wid‐\ngets.  The calling function should set the local parameter curcontext to  :zle:widget,\ncreate  the  local parameter matchedwords and call match-words-by-style with no argu‐\nments.  On return, matchedwords will be set to an array with the  elements:  (1)  the\nstart  of  the line (2) the word before the cursor (3) any non-word characters between\nthat word and the cursor (4) any non-word character at the cursor  position  plus  any\nremaining non-word characters before the next word, including all characters specified\nby the skip-chars style, (5) the word at or following  the  cursor  (6)  any  non-word\ncharacters following that word (7) the remainder of the line.  Any of the elements may\nbe an empty string; the calling function should test for this to decide whether it can\nperform its function.\n\nIf  the  variable matchedwords is defined by the caller to match-words-by-style as an\nassociative array (local -A matchedwords), then the seven values given  above  should\nbe  retrieved  from  it as elements named start, word-before-cursor, ws-before-cursor,\nws-after-cursor, word-after-cursor, ws-after-word, and end.  In addition  the  element\nis-word-start  is  1  if  the cursor is on the start of a word or subword, or on white\nspace before it (the cases can be distinguished by testing  the  ws-after-cursor  ele‐\nment) and 0 otherwise.  This form is recommended for future compatibility.\n\nIt  is possible to pass options with arguments to match-words-by-style to override the\nuse of styles.  The options are:\n-w     word-style\n-s     skip-chars\n-c     word-class\n-C     word-chars\n-r     subword-range\n\nFor example, match-words-by-style -w shell -c 0 may be used to extract the command ar‐\ngument around the cursor.\n\nThe word-context style is implemented by the function match-word-context.  This should\nnot usually need to be called directly.\n"
                    },
                    {
                        "name": "bracketed-paste-magic",
                        "content": "The bracketed-paste widget (see subsection Miscellaneous in zshzle(1)) inserts  pasted\ntext  literally  into  the editor buffer rather than interpret it as keystrokes.  This\ndisables some common usages where the self-insert widget is replaced in order  to  ac‐\ncomplish  some extra processing.  An example is the contributed url-quote-magic widget\ndescribed below.\n\nThe bracketed-paste-magic widget is meant to replace bracketed-paste  with  a  wrapper\nthat  re-enables  these self-insert actions, and other actions as selected by zstyles.\nTherefore this widget is installed with\n\nautoload -Uz bracketed-paste-magic\nzle -N bracketed-paste bracketed-paste-magic\n\nOther than enabling some widget processing, bracketed-paste-magic attempts  to  repli‐\ncate bracketed-paste as faithfully as possible.\n\nThe following zstyles may be set to control processing of pasted text.  All are looked\nup in the context `:bracketed-paste-magic'.\n\nactive-widgets\nA list of patterns matching widget names that should be  activated  during  the\npaste.   All  other key sequences are processed as self-insert-unmeta.  The de‐\nfault is `self-*' so any user-defined widgets named with that prefix are active\nalong with the builtin self-insert.\n\nIf this style is not set (explicitly deleted) or set to an empty value, no wid‐\ngets are active and the pasted text is inserted literally.  If  the  value  in‐\ncludes  `undefined-key',  any  unknown  sequences are discarded from the pasted\ntext.\n\ninactive-keys\nThe inverse of active-widgets, a list of key sequences that always use self-in‐‐\nsert-unmeta  even  when bound to an active widget.  Note that this is a list of\nliteral key sequences, not patterns.\n\npaste-init\nA list of function names, called in widget context (but not as  widgets).   The\nfunctions are called in order until one of them returns a non-zero status.  The\nparameter `PASTED' contains the initial state of the pasted  text.   All  other\nZLE  parameters such as `BUFFER' have their normal values and side-effects, and\nfull history is available, so for example paste-init functions may  move  words\nfrom BUFFER into PASTED to make those words visible to the active-widgets.\n\nA  non-zero return from a paste-init function does not prevent the paste itself\nfrom proceeding.\n\nLoading bracketed-paste-magic defines backward-extend-paste, a helper  function\nfor use in paste-init.\n\nzstyle :bracketed-paste-magic paste-init \\\nbackward-extend-paste\n\nWhen  a  paste  would insert into the middle of a word or append text to a word\nalready on the line, backward-extend-paste moves the prefix from  LBUFFER  into\nPASTED so that the active-widgets see the full word so far.  This may be useful\nwith url-quote-magic.\n\npaste-finish\nAnother list of function names called in  order  until  one  returns  non-zero.\nThese  functions are called after the pasted text has been processed by the ac‐‐\ntive-widgets, but before it is inserted into  `BUFFER'.   ZLE  parameters  have\ntheir normal values and side-effects.\n\nA  non-zero  return from a paste-finish function does not prevent the paste it‐\nself from proceeding.\n\nLoading bracketed-paste-magic also defines quote-paste, a helper  function  for\nuse in paste-finish.\n\nzstyle :bracketed-paste-magic paste-finish \\\nquote-paste\nzstyle :bracketed-paste-magic:finish quote-style \\\nqqq\n\nWhen  the pasted text is inserted into BUFFER, it is quoted per the quote-style\nvalue.  To forcibly turn off the built-in  numeric  prefix  quoting  of  brack‐‐\neted-paste, use:\n\nzstyle :bracketed-paste-magic:finish quote-style \\\nnone\n\nImportant:  During active-widgets processing of the paste (after paste-init and before\npaste-finish), BUFFER starts empty and history is restricted, so cursor motions, etc.,\nmay  not  pass  outside  of the pasted content.  Text assigned to BUFFER by the active\nwidgets is copied back into PASTED before paste-finish.\n"
                    },
                    {
                        "name": "copy-earlier-word",
                        "content": "This widget works like a combination  of  insert-last-word  and  copy-prev-shell-word.\nRepeated  invocations  of  the  widget  retrieve earlier words on the relevant history\nline.  With a numeric argument N, insert the Nth word from the history line; N may  be\nnegative to count from the end of the line.\n\nIf  insert-last-word  has  been  used  to retrieve the last word on a previous history\nline, repeated invocations will replace that word with earlier  words  from  the  same\nline.\n\nOtherwise, the widget applies to words on the line currently being edited.  The widget\nstyle can be set to the name of another widget  that  should  be  called  to  retrieve\nwords.  This widget must accept the same three arguments as insert-last-word.\n"
                    },
                    {
                        "name": "cycle-completion-positions",
                        "content": "After  inserting  an  unambiguous string into the command line, the new function based\ncompletion system may know about multiple places in this string where  characters  are\nmissing  or  differ from at least one of the possible matches.  It will then place the\ncursor on the position it considers to be the most interesting one, i.e. the one where\none can disambiguate between as many matches as possible with as little typing as pos‐\nsible.\n\nThis widget allows the cursor to be easily moved to the other interesting  spots.   It\ncan  be  invoked  repeatedly to cycle between all positions reported by the completion\nsystem.\n"
                    },
                    {
                        "name": "delete-whole-word-match",
                        "content": "This is another function which works like the -match functions  described  immediately\nabove, i.e. using styles to decide the word boundaries.  However, it is not a replace‐\nment for any existing function.\n\nThe basic behaviour is to delete the word around the cursor.  There is no numeric  ar‐\ngument  handling; only the single word around the cursor is considered.  If the widget\ncontains the string kill, the removed text will be placed in the cutbuffer for  future\nyanking.  This can be obtained by defining kill-whole-word-match as follows:\n\nzle -N kill-whole-word-match delete-whole-word-match\n\nand then binding the widget kill-whole-word-match.\n\nup-line-or-beginning-search, down-line-or-beginning-search\nThese   widgets   are   similar   to   the  builtin  functions  up-line-or-search  and\ndown-line-or-search:  if in a multiline buffer they move up or down within the buffer,\notherwise  they  search for a history line matching the start of the current line.  In\nthis case, however, they search for a line which matches the current line  up  to  the\ncurrent  cursor position, in the manner of history-beginning-search-backward and -for‐‐\nward, rather than the first word on the line.\n"
                    },
                    {
                        "name": "edit-command-line",
                        "content": "Edit the command line using your visual editor, as in ksh.\n\nbindkey -M vicmd v edit-command-line\n"
                    },
                    {
                        "name": "expand-absolute-path",
                        "content": "Expand the file name under the cursor to an absolute path, resolving  symbolic  links.\nWhere possible, the initial path segment is turned into a named directory or reference\nto a user's home directory.\n"
                    },
                    {
                        "name": "history-search-end",
                        "content": "This function implements the widgets  history-beginning-search-backward-end  and  his‐‐\ntory-beginning-search-forward-end.   These  commands  work by first calling the corre‐\nsponding builtin widget (see `History Control' in zshzle(1)) and then moving the  cur‐\nsor  to  the end of the line.  The original cursor position is remembered and restored\nbefore calling the builtin widget a second time, so that the same search  is  repeated\nto look farther through the history.\n\nAlthough you autoload only one function, the commands to use it are slightly different\nbecause it implements two widgets.\n\nzle -N history-beginning-search-backward-end \\\nhistory-search-end\nzle -N history-beginning-search-forward-end \\\nhistory-search-end\nbindkey '\\e^P' history-beginning-search-backward-end\nbindkey '\\e^N' history-beginning-search-forward-end\n"
                    },
                    {
                        "name": "history-beginning-search-menu",
                        "content": "This function implements yet another form of history searching.  The text  before  the\ncursor is used to select lines from the history, as for history-beginning-search-back‐‐\nward except that all matches are shown in a numbered  menu.   Typing  the  appropriate\ndigits  inserts  the  full history line.  Note that leading zeroes must be typed (they\nare only shown  when  necessary  for  removing  ambiguity).   The  entire  history  is\nsearched; there is no distinction between forwards and backwards.\n\nWith  a  numeric  argument,  the  search is not anchored to the start of the line; the\nstring typed by the use may appear anywhere in the line in the history.\n\nIf the widget name contains `-end' the cursor is moved to the  end  of  the  line  in‐\nserted.   If  the widget name contains `-space' any space in the text typed is treated\nas a wildcard and can match anything (hence a leading space is equivalent to giving  a\nnumeric argument).  Both forms can be combined, for example:\n\nzle -N history-beginning-search-menu-space-end \\\nhistory-beginning-search-menu\n"
                    },
                    {
                        "name": "history-pattern-search",
                        "content": "The function history-pattern-search implements widgets which prompt for a pattern with\nwhich to search the history backwards or forwards.  The pattern is in  the  usual  zsh\nformat,  however the first character may be ^ to anchor the search to the start of the\nline, and the last character may be $ to anchor the search to the end of the line.  If\nthe search was not anchored to the end of the line the cursor is positioned just after\nthe pattern found.\n\nThe commands to create bindable widgets are similar to those in  the  example  immedi‐\nately above:\n\nautoload -U history-pattern-search\nzle -N history-pattern-search-backward history-pattern-search\nzle -N history-pattern-search-forward history-pattern-search\n\nincarg Typing  the  keystrokes for this widget with the cursor placed on or to the left of an\ninteger causes that integer to be incremented by one.  With a  numeric  argument,  the\nnumber  is incremented by the amount of the argument (decremented if the numeric argu‐\nment is negative).  The shell parameter incarg may be set to change the default incre‐\nment to something other than one.\n\nbindkey '^X+' incarg\n"
                    },
                    {
                        "name": "incremental-complete-word",
                        "content": "This  allows incremental completion of a word.  After starting this command, a list of\ncompletion choices can be shown after every character you type, which you  can  delete\nwith ^H or DEL.  Pressing return accepts the completion so far and returns you to nor‐\nmal editing (that is, the command line is not immediately executed).  You can hit  TAB\nto  do  normal  completion,  ^G to abort back to the state when you started, and ^D to\nlist the matches.\n\nThis works only with the new function based completion system.\n\nbindkey '^Xi' incremental-complete-word\n"
                    },
                    {
                        "name": "insert-composed-char",
                        "content": "This function allows you to compose characters that don't appear on the keyboard to be\ninserted  into the command line.  The command is followed by two keys corresponding to\nASCII characters (there is no prompt).  For accented characters, the two  keys  are  a\nbase  character  followed by a code for the accent, while for other special characters\nthe two characters together form a mnemonic for the character  to  be  inserted.   The\ntwo-character  codes  are  a  subset  of  those  given  by  RFC  1345 (see for example\nhttp://www.faqs.org/rfcs/rfc1345.html).\n\nThe function may optionally be followed by up to two characters which replace  one  or\nboth of the characters read from the keyboard; if both characters are supplied, no in‐\nput is read.  For example, insert-composed-char a: can be used within a widget to  in‐\nsert  an  a  with umlaut into the command line.  This has the advantages over use of a\nliteral character that it is more portable.\n\nFor best results zsh should have been built  with  support  for  multibyte  characters\n(configured  with  --enable-multibyte);  however,  the  function works for the limited\nrange of characters available in single-byte character sets such as ISO-8859-1.\n\nThe character is converted into the local representation and inserted into the command\nline at the cursor position.  (The conversion is done within the shell, using whatever\nfacilities the C library provides.)  With a numeric argument, the  character  and  its\ncode are previewed in the status line\n\nThe  function  may  be run outside zle in which case it prints the character (together\nwith a newline) to standard output.  Input is still read from keystrokes.\n\nSee insert-unicode-char for an alternative way of inserting Unicode  characters  using\ntheir hexadecimal character number.\n\nThe  set of accented characters is reasonably complete up to Unicode character U+0180,\nthe set of special characters less so.  However, it is very sporadic from that  point.\nAdding  new  characters  is  easy,  however;  see  the function define-composed-chars.\nPlease send any additions to zsh-workers@zsh.org.\n\nThe codes for the second character when used to accent the first are as follows.  Note\nthat not every character can take every accent.\n!      Grave.\n'      Acute.\n>      Circumflex.\n?      Tilde.  (This is not ~ as RFC 1345 does not assume that character is present on\nthe keyboard.)\n-      Macron.  (A horizontal bar over the base character.)\n(      Breve.  (A shallow dish shape over the base character.)\n.      Dot above the base character, or in the case of i no dot, or in the case  of  L\nand l a centered dot.\n:      Diaeresis (Umlaut).\nc      Cedilla.\nUnderline, however there are currently no underlined characters.\n/      Stroke through the base character.\n\"      Double acute (only supported on a few letters).\n;      Ogonek.  (A little forward facing hook at the bottom right of the character.)\n<      Caron.  (A little v over the letter.)\n0      Circle over the base character.\n2      Hook over the base character.\n9      Horn over the base character.\n\nThe  most  common characters from the Arabic, Cyrillic, Greek and Hebrew alphabets are\navailable; consult RFC 1345 for the appropriate sequences.  In addition, a set of  two\nletter codes not in RFC 1345 are available for the double-width characters correspond‐\ning to ASCII characters from !  to ~ (0x21 to 0x7e) by preceding the character with ^,\nfor example ^A for a double-width A.\n\nThe following other two-character sequences are understood.\n\nASCII characters\nThese are already present on most keyboards:\n<(     Left square bracket\n//     Backslash (solidus)\n)>     Right square bracket\n(!     Left brace (curly bracket)\n!!     Vertical bar (pipe symbol)\n!)     Right brace (curly bracket)\n'?     Tilde\n\nSpecial letters\nCharacters found in various variants of the Latin alphabet:\nss     Eszett (scharfes S)\nD-, d- Eth\nTH, th Thorn\nkk     Kra\n'n     'n\nNG, ng Ng\nOI, oi Oi\nyr     yr\nED     ezh\n\nCurrency symbols\nCt     Cent\nPd     Pound sterling (also lira and others)\nCu     Currency\nYe     Yen\nEu     Euro (N.B. not in RFC 1345)\n\nPunctuation characters\nReferences to \"right\" quotes indicate the shape (like a 9 rather than 6) rather\nthan their grammatical use.  (For example, a \"right\" low double quote  is  used\nto open quotations in German.)\n!I     Inverted exclamation mark\nBB     Broken vertical bar\nSE     Section\nCo     Copyright\n-a     Spanish feminine ordinal indicator\n<<     Left guillemet\n--     Soft hyphen\nRg     Registered trade mark\nPI     Pilcrow (paragraph)\n-o     Spanish masculine ordinal indicator\n>>     Right guillemet\n?I     Inverted question mark\n-1     Hyphen\n-N     En dash\n-M     Em dash\n-3     Horizontal bar\n:3     Vertical ellipsis\n.3     Horizontal midline ellipsis\n!2     Double vertical line\n=2     Double low line\n'6     Left single quote\n'9     Right single quote\n.9     \"Right\" low quote\n9'     Reversed \"right\" quote\n\"6     Left double quote\n\"9     Right double quote\n:9     \"Right\" low double quote\n9\"     Reversed \"right\" double quote\n/-     Dagger\n/=     Double dagger\n\nMathematical symbols\nDG     Degree\n-2, +-, -+\n- sign, +/- sign, -/+ sign\n2S     Superscript 2\n3S     Superscript 3\n1S     Superscript 1\nMy     Micro\n.M     Middle dot\n14     Quarter\n12     Half\n34     Three quarters\n*X     Multiplication\n-:     Division\n%0     Per mille\nFA, TE, /0\nFor all, there exists, empty set\ndP, DE, NB\nPartial derivative, delta (increment), del (nabla)\n(-, -) Element of, contains\n*P, +Z Product, sum\n*-, Ob, Sb\nAsterisk, ring, bullet\nRT, 0(, 00\nRoot sign, proportional to, infinity\n\nOther symbols\ncS, cH, cD, cC\nCard suits: spades, hearts, diamonds, clubs\nMd, M8, M2, Mb, Mx, MX\nMusical  notation:  crotchet  (quarter note), quaver (eighth note), semiquavers\n(sixteenth notes), flag sign, natural sign, sharp sign\nFm, Ml Female, male\n\nAccents on their own\n'>     Circumflex (same as caret, ^)\n'!     Grave (same as backtick, `)\n',     Cedilla\n':     Diaeresis (Umlaut)\n'm     Macron\n''     Acute\n"
                    },
                    {
                        "name": "insert-files",
                        "content": "This function allows you type a file pattern, and see the results of the expansion  at\neach step.  When you hit return, all expansions are inserted into the command line.\n\nbindkey '^Xf' insert-files\n"
                    },
                    {
                        "name": "insert-unicode-char",
                        "content": "When  first executed, the user inputs a set of hexadecimal digits.  This is terminated\nwith another call to insert-unicode-char.  The digits are then turned into the  corre‐\nsponding Unicode character.  For example, if the widget is bound to ^XU, the character\nsequence `^XU 4 c ^XU' inserts L (Unicode U+004c).\n\nSee insert-composed-char for a way of inserting characters using a two-character  mne‐\nmonic.\n\n\nnarrow-to-region [ -p pre ] [ -P post ]\n[ -S statepm | -R statepm | [ -l lbufvar ] [ -r rbufvar ] ]\n[ -n ] [ start end ]"
                    },
                    {
                        "name": "narrow-to-region-invisible",
                        "content": "Narrow  the  editable  portion  of the buffer to the region between the cursor and the\nmark, which may be in either order.  The region may not be empty.\n\nnarrow-to-region may be used as a widget or called as a function from  a  user-defined\nwidget;  by  default,  the  text  outside the editable area remains visible.  A recur‐‐\nsive-edit is performed and the original widening status is then restored.  Various op‐\ntions and arguments are available when it is called as a function.\n\nThe  options -p pretext and -P posttext may be used to replace the text before and af‐\nter the display for the duration of the function; either  or  both  may  be  an  empty\nstring.\n\nIf  the option -n is also given, pretext or posttext will only be inserted if there is\ntext before or after the region respectively which will be made invisible.\n\nTwo numeric arguments may be given which will be used instead of the cursor  and  mark\npositions.\n\nThe  option  -S  statepm is used to narrow according to the other options while saving\nthe original state in the parameter with name statepm, while the option -R statepm  is\nused  to  restore the state from the parameter; note in both cases the name of the pa‐\nrameter is required.  In the second case, other options and arguments are  irrelevant.\nWhen  this  method  is used, no recursive-edit is performed; the calling widget should\ncall this function with the option -S, perform its own editing on the command line  or\npass  control  to  the user via `zle recursive-edit', then call this function with the\noption -R.  The argument statepm must be a suitable name for  an  ordinary  parameter,\nexcept  that  parameters  beginning  with the prefix ntr are reserved for use within\nnarrow-to-region.  Typically the parameter will be local to the calling function.\n\nThe options -l lbufvar and -r rbufvar may be used to specify parameters where the wid‐\nget will store the resulting text from the operation.  The parameter lbufvar will con‐\ntain LBUFFER and rbufvar will contain RBUFFER.  Neither of these two  options  may  be\nused with -S or -R.\n\nnarrow-to-region-invisible  is a simple widget which calls narrow-to-region with argu‐\nments which replace any text outside the region with `...'.  It does not take any  ar‐\nguments.\n\nThe display is restored (and the widget returns) upon any zle command which would usu‐\nally cause the line to be accepted or aborted.  Hence an additional  such  command  is\nrequired to accept or abort the current line.\n\nThe return status of both widgets is zero if the line was accepted, else non-zero.\n\nHere is a trivial example of a widget using this feature.\nlocal state\nnarrow-to-region -p $'Editing restricted region\\n' \\\n-P '' -S state\nzle recursive-edit\nnarrow-to-region -R state\n"
                    },
                    {
                        "name": "predict-on",
                        "content": "This  set  of functions implements predictive typing using history search.  After pre‐‐\ndict-on, typing characters causes the editor to look backward in the history  for  the\nfirst  line beginning with what you have typed so far.  After predict-off, editing re‐\nturns to normal for the line found.  In fact, you often don't even need  to  use  pre‐‐\ndict-off,  because  if  the  line doesn't match something in the history, adding a key\nperforms standard completion, and then inserts itself if no  completions  were  found.\nHowever, editing in the middle of a line is liable to confuse prediction; see the tog‐‐\ngle style below.\n\nWith the function based completion system (which is needed for this),  you  should  be\nable to type TAB at almost any point to advance the cursor to the next ``interesting''\ncharacter position (usually the end of the current word, but  sometimes  somewhere  in\nthe  middle  of the word).  And of course as soon as the entire line is what you want,\nyou can accept with return, without needing to move the cursor to the end first.\n\nThe first time predict-on is used, it creates several additional widget functions:\n\ndelete-backward-and-predict\nReplaces the backward-delete-char widget.  You do not need to bind  this  your‐\nself.\ninsert-and-predict\nImplements  predictive  typing by replacing the self-insert widget.  You do not\nneed to bind this yourself.\npredict-off\nTurns off predictive typing.\n\nAlthough you autoload only the predict-on function, it is necessary to create  a  key‐\nbinding for predict-off as well.\n\nzle -N predict-on\nzle -N predict-off\nbindkey '^X^Z' predict-on\nbindkey '^Z' predict-off\n"
                    },
                    {
                        "name": "read-from-minibuffer",
                        "content": "This is most useful when called as a function from inside a widget, but will work cor‐\nrectly as a widget in its own right.  It prompts for a value below the current command\nline;  a  value  may be input using all of the standard zle operations (and not merely\nthe restricted set available when executing,  for  example,  execute-named-cmd).   The\nvalue is then returned to the calling function in the parameter $REPLY and the editing\nbuffer restored to its previous state.  If the read was aborted by  a  keyboard  break\n(typically ^G), the function returns status 1 and $REPLY is not set.\n\nIf one argument is supplied to the function it is taken as a prompt, otherwise `? ' is\nused.  If two arguments are supplied, they are the prompt and  the  initial  value  of\n$LBUFFER,  and if a third argument is given it is the initial value of $RBUFFER.  This\nprovides a default value and starting cursor placement.  Upon return the entire buffer\nis the value of $REPLY.\n\nOne option is available: `-k num' specifies that num characters are to be read instead\nof a whole line.  The line editor is not invoked recursively in this case, so  depend‐\ning on the terminal settings the input may not be visible, and only the input keys are\nplaced in $REPLY, not the entire buffer.  Note that unlike the read builtin  num  must\nbe given; there is no default.\n\nThe  name  is  a  slight  misnomer, as in fact the shell's own minibuffer is not used.\nHence it is still possible to call  executed-named-cmd  and  similar  functions  while\nreading a value.\n\nreplace-argument, replace-argument-edit\nThe  function  replace-argument  can be used to replace a command line argument in the\ncurrent command line or, if the current command line is empty,  in  the  last  command\nline  executed  (the new command line is not executed).  Arguments are as delimited by\nstandard shell syntax,\n\nIf a numeric argument is given, that specifies the argument to be replaced.   0  means\nthe  command  name, as in history expansion.  A negative numeric argument counts back‐\nward from the last word.\n\nIf no numeric argument is given, the current argument is replaced; this  is  the  last\nargument if the previous history line is being used.\n\nThe function prompts for a replacement argument.\n\nIf the widget contains the string edit, for example is defined as\n\nzle -N replace-argument-edit replace-argument\n\nthen  the  function  presents the current value of the argument for editing, otherwise\nthe editing buffer for the replacement is initially empty.\n\nreplace-string, replace-pattern\nreplace-string-again, replace-pattern-again\nThe function replace-string implements three widgets.  If defined under the same  name\nas  the  function,  it  prompts for two strings; the first (source) string will be re‐\nplaced by the second everywhere it occurs in the line editing buffer.\n\nIf the widget name contains the word `pattern', for example by defining the widget us‐\ning  the  command  `zle  -N replace-pattern replace-string', then the matching is per‐\nformed using zsh patterns.  All zsh extended globbing patterns  can  be  used  in  the\nsource string; note that unlike filename generation the pattern does not need to match\nan entire word, nor do glob qualifiers have any effect.  In addition, the  replacement\nstring  can contain parameter or command substitutions.  Furthermore, a `&' in the re‐\nplacement string will be replaced with the matched source  string,  and  a  backquoted\ndigit  `\\N'  will  be  replaced by the Nth parenthesised expression matched.  The form\n`\\{N}' may be used to protect the digit from following digits.\n\nIf the widget instead contains the word `regex' (or `regexp'), then  the  matching  is\nperformed   using   regular   expressions,   respecting  the  setting  of  the  option\nREMATCHPCRE (see the description of the function regexp-replace below).  The special\nreplacement facilities described above for pattern matching are available.\n\nBy  default the previous source or replacement string will not be offered for editing.\nHowever, this feature can be activated by setting the style edit-previous in the  con‐\ntext  :zle:widget (for example, :zle:replace-string) to true.  In addition, a positive\nnumeric argument forces the previous values to be offered, a negative or zero argument\nforces them not to be.\n\nThe  function  replace-string-again can be used to repeat the previous replacement; no\nprompting is done.  As with replace-string, if the name of  the  widget  contains  the\nword `pattern' or `regex', pattern or regular expression matching is performed, else a\nliteral string replacement.  Note that the previous source and  replacement  text  are\nthe same whether pattern, regular expression or string matching is used.\n\nIn  addition,  replace-string shows the previous replacement above the prompt, so long\nas there was one during the current session; if the source string is empty,  that  re‐\nplacement will be repeated without the widget prompting for a replacement string.\n\nFor example, starting from the line:\n\nprint This line contains fan and fond\n\nand invoking replace-pattern with the source string `f(?)n' and the replacement string\n`c\\1r' produces the not very useful line:\n\nprint This line contains car and cord\n\nThe range of the replacement string can be limited by using  the  narrow-to-region-in‐‐\nvisible widget.  One limitation of the current version is that undo will cycle through\nchanges to the replacement and source strings before undoing the replacement itself.\n"
                    },
                    {
                        "name": "send-invisible",
                        "content": "This is similar to read-from-minibuffer in that it may be called as a function from  a\nwidget  or  as  a  widget of its own, and interactively reads input from the keyboard.\nHowever, the input being typed is concealed and a string of asterisks (`*')  is  shown\ninstead.   The  value is saved in the parameter $INVISIBLE to which a reference is in‐\nserted into the editing buffer at the restored  cursor  position.   If  the  read  was\naborted  by  a  keyboard  break  (typically ^G) or another escape from editing such as\npush-line, $INVISIBLE is set to empty and the original buffer is restored unchanged.\n\nIf one argument is supplied to the  function  it  is  taken  as  a  prompt,  otherwise\n`Non-echoed  text:  '  is used (as in emacs).  If a second and third argument are sup‐\nplied they are used to begin and end the reference to $INVISIBLE that is inserted into\nthe  buffer.   The  default  is to open with ${, then INVISIBLE, and close with }, but\nmany other effects are possible.\n"
                    },
                    {
                        "name": "smart-insert-last-word",
                        "content": "This function may replace the insert-last-word widget, like so:\n\nzle -N insert-last-word smart-insert-last-word\n\nWith a numeric argument, or when passed command line arguments in a call from  another\nwidget,  it  behaves  like insert-last-word, except that words in comments are ignored\nwhen INTERACTIVECOMMENTS is set.\n\nOtherwise, the rightmost ``interesting'' word from the previous command is  found  and\ninserted.   The  default  definition  of  ``interesting'' is that the word contains at\nleast one alphabetic character, slash, or backslash.  This definition may be  overrid‐\nden  by  use  of the match style.  The context used to look up the style is the widget\nname, so usually the context is :insert-last-word.  However, you can bind  this  func‐\ntion to different widgets to use different patterns:\n\nzle -N insert-last-assignment smart-insert-last-word\nzstyle :insert-last-assignment match '[[:alpha:]][][[:alnum:]]#=*'\nbindkey '\\e=' insert-last-assignment\n\nIf  no  interesting  word is found and the auto-previous style is set to a true value,\nthe search continues upward through the history.  When auto-previous is unset or false\n(the  default),  the widget must be invoked repeatedly in order to search earlier his‐\ntory lines.\n"
                    },
                    {
                        "name": "transpose-lines",
                        "content": "Only useful with a multi-line editing buffer; the lines here are lines within the cur‐\nrent  on-screen  buffer,  not history lines.  The effect is similar to the function of\nthe same name in Emacs.\n\nTranspose the current line with the previous line and move the cursor to the start  of\nthe  next line.  Repeating this (which can be done by providing a positive numeric ar‐\ngument) has the effect of moving the line above the cursor down by a number of lines.\n\nWith a negative numeric argument, requires two lines  above  the  cursor.   These  two\nlines  are transposed and the cursor moved to the start of the previous line.  Using a\nnumeric argument less than -1 has the effect of moving the line above the cursor up by\nminus that number of lines.\n"
                    },
                    {
                        "name": "url-quote-magic",
                        "content": "This  widget  replaces the built-in self-insert to make it easier to type URLs as com‐\nmand line arguments.  As you type, the input character is analyzed and, if it may need\nquoting,  the  current word is checked for a URI scheme.  If one is found and the cur‐\nrent word is not already in quotes, a backslash is inserted before the  input  charac‐\nter.\n\nStyles to control quoting behavior:\n\nurl-metas\nThis  style is looked up in the context `:url-quote-magic:scheme' (where scheme\nis that of the current URL, e.g. \"ftp\").  The value is  a  string  listing  the\ncharacters to be treated as globbing metacharacters when appearing in a URL us‐\ning that scheme.  The default is to quote all zsh extended globbing characters,\nexcluding  '<'  and '>' but including braces (as in brace expansion).  See also\nurl-seps.\n\nurl-seps\nLike url-metas, but lists characters that should be considered command  separa‐\ntors, redirections, history references, etc.  The default is to quote the stan‐\ndard set of shell separators, excluding those that overlap  with  the  extended\nglobbing  characters,  but  including  '<'  and  '>' and the first character of\n$histchars.\n\nurl-globbers\nThis style is looked up in the context `:url-quote-magic'.  The values  form  a\nlist  of  command  names  that are expected to do their own globbing on the URL\nstring.  This implies that they are aliased to use the `noglob' modifier.  When\nthe  first  word  on the line matches one of the values and the URL refers to a\nlocal file (see url-local-schema), only the url-seps characters are quoted; the\nurl-metas are left alone, allowing them to affect command-line parsing, comple‐\ntion, etc.  The default values are a literal `noglob' plus (when the zsh/param‐‐\neter module is available) any commands aliased to the helper function `urlglob‐‐\nber' or its alias `globurl'.\n\nurl-local-schema\nThis style is always looked up in the context `:urlglobber', even though it  is\nused  by  both  url-quote-magic  and urlglobber.  The values form a list of URI\nschema that should be treated as referring to local files by their  real  local\npath   names,   as   opposed  to  files  which  are  specified  relative  to  a\nweb-server-defined document root.  The defaults are \"ftp\" and \"file\".\n\nurl-other-schema\nLike url-local-schema, but lists all other URI schema upon which urlglobber and\nurl-quote-magic  should  act.   If  the URI on the command line does not have a\nscheme appearing either in this list or in url-local-schema, it  is  not  magi‐\ncally  quoted.   The  default  values  are  \"http\", \"https\", and \"ftp\".  When a\nscheme appears both here and in url-local-schema, it is quoted differently  de‐\npending on whether the command name appears in url-globbers.\n\nLoading  url-quote-magic  also  defines  a  helper  function  `urlglobber' and aliases\n`globurl' to `noglob urlglobber'.  This function takes a local URL apart, attempts  to\npattern-match  the  local file portion of the URL path, and then puts the results back\ninto URL format again.\n"
                    },
                    {
                        "name": "vi-pipe",
                        "content": "This function reads a movement command from the keyboard and then prompts for  an  ex‐\nternal  command. The part of the buffer covered by the movement is piped to the exter‐\nnal command and then replaced by the command's output.  If  the  movement  command  is\nbound to vi-pipe, the current line is used.\n\nThe  function  serves  as  an  example for reading a vi movement command from within a\nuser-defined widget.\n"
                    },
                    {
                        "name": "which-command",
                        "content": "This function is a drop-in replacement for the builtin widget which-command.   It  has\nenhanced behaviour, in that it correctly detects whether or not the command word needs\nto be expanded as an alias; if so, it continues tracing the command word from the  ex‐\npanded alias until it reaches the command that will be executed.\n\nThe style whence is available in the context :zle:$WIDGET; this may be set to an array\nto give the command and options that will be used  to  investigate  the  command  word\nfound.  The default is whence -c.\n"
                    },
                    {
                        "name": "zcalc-auto-insert",
                        "content": "This  function  is  useful  together  with the zcalc function described in the section\nMathematical Functions.  It should be bound to a key representing  a  binary  operator\nsuch  as  `+', `-', `*' or `/'.  When running in zcalc, if the key occurs at the start\nof the line or immediately following an open parenthesis, the text \"ans \" is  inserted\nbefore  the representation of the key itself.  This allows easy use of the answer from\nthe previous calculation in the current line.  The text to be inserted before the sym‐\nbol typed can be modified by setting the variable ZCALCAUTOINSERTPREFIX.\n\nHence, for example, typing `+12' followed by return adds 12 to the previous result.\n\nIf  zcalc  is in RPN mode (-r option) the effect of this binding is automatically sup‐\npressed as operators alone on a line are meaningful.\n\nWhen not in zcalc, the key simply inserts the symbol itself.\n"
                    },
                    {
                        "name": "Utility Functions",
                        "content": "These functions are useful in constructing widgets.  They should be loaded with `autoload  -U\nfunction' and called as indicated from user-defined widgets.\n"
                    },
                    {
                        "name": "split-shell-arguments",
                        "content": "This  function  splits the line currently being edited into shell arguments and white‐\nspace.  The result is stored in the array reply.  The array contains all the parts  of\nthe line in order, starting with any whitespace before the first argument, and finish‐\ning with any whitespace after the last argument.  Hence (so long as the option KSHAR‐‐\nRAYS is not set) whitespace is given by odd indices in the array and arguments by even\nindices.  Note that no stripping of quotes is done; joining together all the  elements\nof reply in order is guaranteed to produce the original line.\n\nThe  parameter REPLY is set to the index of the word in reply which contains the char‐\nacter after the cursor, where the first element has index 1.  The parameter REPLY2  is\nset to the index of the character under the cursor in that word, where the first char‐\nacter has index 1.\n\nHence reply, REPLY and REPLY2 should all be made local to the enclosing function.\n\nSee the function modify-current-argument, described below, for an example  of  how  to\ncall this function.\n\nmodify-current-argument [ expr-using-$ARG | func ]\nThis  function provides a simple method of allowing user-defined widgets to modify the\ncommand line argument under the cursor (or immediately to the left of  the  cursor  if\nthe cursor is between arguments).\n\nThe argument can be an expression which when evaluated operates on the shell parameter\nARG, which will have been set to the command line argument under the cursor.  The  ex‐\npression should be suitably quoted to prevent it being evaluated too early.\n\nAlternatively,  if the argument does not contain the string ARG, it is assumed to be a\nshell function, to which the current command line argument is passed as the only argu‐\nment.   The  function  should  set the variable REPLY to the new value for the command\nline argument.  If the function returns non-zero status, so does the calling function.\n\nFor example, a user-defined widget containing the following code converts the  charac‐\nters in the argument under the cursor into all upper case:\n\nmodify-current-argument '${(U)ARG}'\n\nThe  following strips any quoting from the current word (whether backslashes or one of\nthe styles of quotes), and replaces it with single quoting throughout:\n\nmodify-current-argument '${(qq)${(Q)ARG}}'\n\nThe following performs directory expansion on the command line argument  and  replaces\nit by the absolute path:\n\nexpand-dir() {\nREPLY=${~1}\nREPLY=${REPLY:a}\n}\nmodify-current-argument expand-dir\n\nIn  practice  the  function expand-dir would probably not be defined within the widget\nwhere modify-current-argument is called.\n"
                    },
                    {
                        "name": "Styles",
                        "content": "The behavior of several of the above widgets can be controlled by the use of the zstyle mech‐\nanism.  In particular, widgets that interact with the completion system pass along their con‐\ntext to any completions that they invoke.\n"
                    },
                    {
                        "name": "break-keys",
                        "content": "This style is used by the incremental-complete-word widget. Its value should be a pat‐\ntern,  and  all  keys  matching this pattern will cause the widget to stop incremental\ncompletion without the key having any further effect. Like all styles used directly by\nincremental-complete-word, this style is looked up using the context `:incremental'.\n"
                    },
                    {
                        "name": "completer",
                        "content": "The  incremental-complete-word  and  insert-and-predict widgets set up their top-level\ncontext name before calling completion.  This allows one to define different  sets  of\ncompleter  functions for normal completion and for these widgets.  For example, to use\ncompletion, approximation and correction for normal completion, completion and correc‐\ntion for incremental completion and only completion for prediction one could use:\n\nzstyle ':completion:*' completer \\\ncomplete correct approximate\nzstyle ':completion:incremental:*' completer \\\ncomplete correct\nzstyle ':completion:predict:*' completer \\\ncomplete\n\nIt  is  a good idea to restrict the completers used in prediction, because they may be\nautomatically invoked as you type.  The list and menu  completers  should  never  be\nused  with prediction.  The approximate, correct, expand, and match completers may\nbe used, but be aware that they may change characters anywhere in the word behind  the\ncursor, so you need to watch carefully that the result is what you intended.\n\ncursor The  insert-and-predict  widget  uses this style, in the context `:predict', to decide\nwhere to place the cursor after completion has been tried.  Values are:\n\ncomplete\nThe cursor is left where it was when completion finished, but only if it is af‐\nter a character equal to the one just inserted by the user.  If it is after an‐\nother character, this value is the same as `key'.\n\nkey    The cursor is left after the nth occurrence of  the  character  just  inserted,\nwhere  n is the number of times that character appeared in the word before com‐\npletion was attempted.  In short, this has the effect of leaving the cursor af‐\nter  the  character  just  typed  even if the completion code found out that no\nother characters need to be inserted at that position.\n\nAny other value for this style unconditionally leaves the cursor at the position where\nthe completion code left it.\n\nlist   When using the incremental-complete-word widget, this style says if the matches should\nbe listed on every key press (if they fit on the  screen).   Use  the  context  prefix\n`:completion:incremental'.\n\nThe  insert-and-predict  widget  uses this style to decide if the completion should be\nshown even if there is only one possible completion.  This is done  if  the  value  of\nthis  style  is the string always.  In this case the context is `:predict' (not `:com‐‐\npletion:predict').\n\nmatch  This style is used by smart-insert-last-word to provide  a  pattern  (using  full  EX‐‐\nTENDEDGLOB  syntax) that matches an interesting word.  The context is the name of the\nwidget to which smart-insert-last-word is bound (see above).  The default behavior  of\nsmart-insert-last-word is equivalent to:\n\nzstyle :insert-last-word match '*[[:alpha:]/\\\\]*'\n\nHowever, you might want to include words that contain spaces:\n\nzstyle :insert-last-word match '*[[:alpha:][:space:]/\\\\]*'\n\nOr include numbers as long as the word is at least two characters long:\n\nzstyle :insert-last-word match '*([[:digit:]]?|[[:alpha:]/\\\\])*'\n\nThe above example causes redirections like \"2>\" to be included.\n\nprompt The  incremental-complete-word widget shows the value of this style in the status line\nduring incremental completion.  The string value may contain any of the following sub‐\nstrings in the manner of the PS1 and other prompt parameters:\n\n%c     Replaced  by  the  name  of  the  completer function that generated the matches\n(without the leading underscore).\n\n%l     When the list style is set, replaced by `...' if the list  of  matches  is  too\nlong  to  fit  on  the  screen and with an empty string otherwise.  If the list\nstyle is `false' or not set, `%l' is always removed.\n\n%n     Replaced by the number of matches generated.\n\n%s     Replaced by `-no match-', `-no prefix-', or an empty string if there is no com‐\npletion  matching  the  word  on the line, if the matches have no common prefix\ndifferent from the word on the line, or if there is such a common  prefix,  re‐\nspectively.\n\n%u     Replaced  by the unambiguous part of all matches, if there is any, and if it is\ndifferent from the word on the line.\n\nLike `break-keys', this uses the `:incremental' context.\n"
                    },
                    {
                        "name": "stop-keys",
                        "content": "This style is used by the incremental-complete-word widget.  Its value is treated sim‐\nilarly  to  the  one  for the break-keys style (and uses the same context: `:incremen‐‐\ntal').  However, in this case all keys matching the pattern given as  its  value  will\nstop incremental completion and will then execute their usual function.\n\ntoggle This boolean style is used by predict-on and its related widgets in the context `:pre‐‐\ndict'.  If set to one of the standard `true' values, predictive  typing  is  automati‐\ncally  toggled off in situations where it is unlikely to be useful, such as when edit‐\ning a multi-line buffer or after moving into the middle of a line and then deleting  a\ncharacter.   The  default  is  to leave prediction turned on until an explicit call to\npredict-off.\n"
                    },
                    {
                        "name": "verbose",
                        "content": "This boolean style is used by predict-on and its related widgets in the context `:pre‐‐\ndict'.   If  set to one of the standard `true' values, these widgets display a message\nbelow the prompt when the predictive state is toggled.  This is most useful in  combi‐\nnation with the toggle style.  The default does not display these messages.\n\nwidget This  style is similar to the command style: For widget functions that use zle to call\nother widgets, this style can sometimes be  used  to  override  the  widget  which  is\ncalled.  The context for this style is the name of the calling widget (not the name of\nthe calling function, because one function may be bound to multiple widget names).\n\nzstyle :copy-earlier-word widget smart-insert-last-word\n\nCheck the documentation for the calling widget or function to  determine  whether  the\nwidget style is used.\n"
                    }
                ]
            },
            "EXCEPTION HANDLING": {
                "content": "Two  functions are provided to enable zsh to provide exception handling in a form that should\nbe familiar from other languages.\n\nthrow exception\nThe function throw throws the named exception.  The name is an arbitrary string and is\nonly used by the throw and catch functions.  An exception is for the most part treated\nthe same as a shell error, i.e. an unhandled exception will cause the shell  to  abort\nall  processing  in a function or script and to return to the top level in an interac‐\ntive shell.\n\ncatch exception-pattern\nThe function catch returns status zero if an exception was thrown and the pattern  ex‐\nception-pattern  matches  its name.  Otherwise it returns status 1.  exception-pattern\nis a standard shell pattern, respecting the current setting of the  EXTENDEDGLOB  op‐\ntion.   An  alias  catch  is also defined to prevent the argument to the function from\nmatching filenames, so patterns may be used unquoted.  Note that as exceptions are not\nfundamentally  different  from other shell errors it is possible to catch shell errors\nby using an empty string as the exception name.  The shell variable CAUGHT is  set  by\ncatch  to the name of the exception caught.  It is possible to rethrow an exception by\ncalling the throw function again once an exception has been caught.\n\nThe functions are designed to be used together with the always construct  described  in  zsh‐\nmisc(1).   This  is important as only this construct provides the required support for excep‐\ntions.  A typical example is as follows.\n\n{\n# \"try\" block\n# ... nested code here calls \"throw MyExcept\"\n} always {\n# \"always\" block\nif catch MyExcept; then\nprint \"Caught exception MyExcept\"\nelif catch ''; then\nprint \"Caught a shell error.  Propagating...\"\nthrow ''\nfi\n# Other exceptions are not handled but may be caught further\n# up the call stack.\n}\n\nIf all exceptions should be caught, the following idiom might be preferable.\n\n{\n# ... nested code here throws an exception\n} always {\nif catch *; then\ncase $CAUGHT in\n(MyExcept)\nprint \"Caught my own exception\"\n;;\n(*)\nprint \"Caught some other exception\"\n;;\nesac\nfi\n}\n\nIn common with exception handling in other languages, the exception may  be  thrown  by  code\ndeeply  nested  inside the `try' block.  However, note that it must be thrown inside the cur‐\nrent shell, not in a subshell forked for a pipeline, parenthesised  current-shell  construct,\nor some form of command or process substitution.\n\nThe  system  internally uses the shell variable EXCEPTION to record the name of the exception\nbetween throwing and catching.  One drawback of this scheme is that if the exception  is  not\nhandled  the  variable EXCEPTION remains set and may be incorrectly recognised as the name of\nan exception if a shell error subsequently occurs.  Adding unset EXCEPTION at  the  start  of\nthe outermost layer of any code that uses exception handling will eliminate this problem.\n",
                "subsections": []
            },
            "MIME FUNCTIONS": {
                "content": "Three functions are available to provide handling of files recognised by extension, for exam‐\nple to dispatch a file text.ps when executed as a command to an appropriate viewer.\n\nzsh-mime-setup [ -fv ] [ -l [ suffix ... ] ]\nzsh-mime-handler [ -l ] command argument ...\nThese two functions use the files ~/.mime.types and /etc/mime.types,  which  associate\ntypes  and  extensions,  as well as ~/.mailcap and /etc/mailcap files, which associate\ntypes and the programs that handle them.  These are provided on many systems with  the\nMultimedia Internet Mail Extensions.\n\nTo  enable the system, the function zsh-mime-setup should be autoloaded and run.  This\nallows files with extensions to be treated as executable; such files be  completed  by\nthe  function  completion system.  The function zsh-mime-handler should not need to be\ncalled by the user.\n\nThe system works by setting up suffix aliases with `alias -s'.  Suffix aliases already\ninstalled by the user will not be overwritten.\n\nFor  suffixes  defined  in  lower case, upper case variants will also automatically be\nhandled (e.g. PDF is automatically handled if handling for the suffix pdf is defined),\nbut not vice versa.\n\nRepeated calls to zsh-mime-setup do not override the existing mapping between suffixes\nand executable files unless the option -f is given.  Note, however, that this does not\noverride existing suffix aliases assigned to handlers other than zsh-mime-handler.\n\nCalling zsh-mime-setup with the option -l lists the existing mappings without altering\nthem.  Suffixes to list (which may contain pattern characters that  should  be  quoted\nfrom  immediate  interpretation  on the command line) may be given as additional argu‐\nments, otherwise all suffixes are listed.\n\nCalling zsh-mime-setup with the option -v causes verbose output to be shown during the\nsetup operation.\n\nThe system respects the mailcap flags needsterminal and copiousoutput, see mailcap(4).\n\nThe functions use the following styles, which are defined with the zstyle builtin com‐\nmand (see zshmodules(1)).  They should be defined before zsh-mime-setup is  run.   The\ncontexts  used all start with :mime:, with additional components in some cases.  It is\nrecommended that a trailing * (suitably quoted) be appended to style patterns in  case\nthe system is extended in future.  Some examples are given below.\n\nFor  files  that  have multiple suffixes, e.g. .pdf.gz, where the context includes the\nsuffix it will be looked up starting with the longest possible suffix  until  a  match\nfor  the  style  is  found.  For example, if .pdf.gz produces a match for the handler,\nthat will be used; otherwise the handler for .gz will be used.  Note  that,  owing  to\nthe  way  suffix  aliases  work, it is always required that there be a handler for the\nshortest possible suffix, so in this example .pdf.gz can only be  handled  if  .gz  is\nalso  handled (though not necessarily in the same way).  Alternatively, if no handling\nfor .gz on its own is needed, simply adding the command\n\nalias -s gz=zsh-mime-handler\n\nto the initialisation code is sufficient; .gz will not be handled on its own, but  may\nbe in combination with other suffixes.\n\ncurrent-shell\nIf  this boolean style is true, the mailcap handler for the context in question\nis run using the eval builtin instead of by starting a new sh process.  This is\nmore efficient, but may not work in the occasional cases where the mailcap han‐\ndler uses strict POSIX syntax.\n\ndisown If this boolean style is true, mailcap handlers started in the background  will\nbe  disowned,  i.e.  not  subject to job control within the parent shell.  Such\nhandlers nearly always produce their own windows, so the  only  likely  harmful\nside  effect  of  setting the style is that it becomes harder to kill jobs from\nwithin the shell.\n\nexecute-as-is\nThis style gives a list of patterns to be matched against files passed for exe‐\ncution  with  a  handler  program.  If the file matches the pattern, the entire\ncommand line is executed in its current form, with no handler.  This is  useful\nfor  files which might have suffixes but nonetheless be executable in their own\nright.  If the style is not set, the pattern *(*)  *(/)  is  used;  hence  exe‐\ncutable files are executed directly and not passed to a handler, and the option\nAUTOCD may be used to change to directories that happen to have MIME suffixes.\n\nexecute-never\nThis style is useful in combination with execute-as-is.  It is set to an  array\nof  patterns  corresponding to full paths to files that should never be treated\nas executable, even if the  file  passed  to  the  MIME  handler  matches  exe‐‐\ncute-as-is.   This is useful for file systems that don't handle execute permis‐\nsion or that contain executables from another operating system.   For  example,\nif /mnt/windows is a Windows mount, then\n\nzstyle ':mime:*' execute-never '/mnt/windows/*'\n\nwill  ensure  that  any files found in that area will be executed as MIME types\neven if they are executable.  As this example shows, the complete file name  is\nmatched  against the pattern, regardless of how the file was passed to the han‐\ndler.  The file is resolved to a full path using the :P modifier  described  in\nthe  subsection Modifiers in zshexpn(1); this means that symbolic links are re‐\nsolved where possible, so that links into other file systems behave in the cor‐\nrect fashion.\n\nfile-path\nUsed  if  the  style find-file-in-path is true for the same context.  Set to an\narray of directories that are used for searching for the file  to  be  handled;\nthe default is the command path given by the special parameter path.  The shell\noption PATHDIRS is respected; if that is set, the  appropriate  path  will  be\nsearched  even  if the name of the file to be handled as it appears on the com‐\nmand line contains a `/'.  The full context is :mime:.suffix:, as described for\nthe style handler.\n\nfind-file-in-path\nIf  set,  allows files whose names do not contain absolute paths to be searched\nfor in the command path or the path specified by the file-path style.   If  the\nfile  is  not  found  in the path, it is looked for locally (whether or not the\ncurrent directory is in the path); if it is not found locally, the handler will\nabort  unless the handle-nonexistent style is set.  Files found in the path are\ntested  as  described  for  the  style  execute-as-is.   The  full  context  is\n:mime:.suffix:, as described for the style handler.\n\nflags  Defines  flags  to  go with a handler; the context is as for the handler style,\nand the format is as for the flags in mailcap.\n\nhandle-nonexistent\nBy default, arguments that don't correspond to files are not passed to the MIME\nhandler  in  order  to  prevent it from intercepting commands found in the path\nthat happen to have suffixes.  This style may be set to an  array  of  extended\nglob  patterns  for  arguments  that will be passed to the handler even if they\ndon't exist.  If it is not explicitly set it defaults to [[:alpha:]]#:/*  which\nallows  URLs  to  be passed to the MIME handler even though they don't exist in\nthat format in the file system.  The full context  is  :mime:.suffix:,  as  de‐\nscribed for the style handler.\n\nhandler\nSpecifies  a  handler  for  a  suffix;  the  suffix  is given by the context as\n:mime:.suffix:, and the format of the handler is exactly that in mailcap.  Note\nin  particular  the  `.' and trailing colon to distinguish this use of the con‐\ntext.  This overrides any handler specified by the mailcap files.  If the  han‐\ndler  requires  a  terminal,  the flags style should be set to include the word\nneedsterminal, or if the output is to be displayed through a pager (but not  if\nthe handler is itself a pager), it should include copiousoutput.\n\nmailcap\nA  list of files in the format of ~/.mailcap and /etc/mailcap to be read during\nsetup, replacing the default list which consists of those two files.  The  con‐\ntext is :mime:.  A + in the list will be replaced by the default files.\n\nmailcap-priorities\nThis  style is used to resolve multiple mailcap entries for the same MIME type.\nIt consists of an array of the following elements, in descending order of  pri‐\nority;  later entries will be used if earlier entries are unable to resolve the\nentries being compared.  If none of the tests resolve the  entries,  the  first\nentry encountered is retained.\n\nfiles  The  order  of files (entries in the mailcap style) read.  Earlier files\nare preferred.  (Note this does not resolve entries in the same file.)\n\npriority\nThe priority flag from the mailcap entry.  The priority  is  an  integer\nfrom 0 to 9 with the default value being 5.\n\nflags  The  test  given by the mailcap-prio-flags option is used to resolve en‐\ntries.\n\nplace  Later entries are preferred; as the entries are strictly  ordered,  this\ntest always succeeds.\n\nNote that as this style is handled during initialisation, the context is always\n:mime:, with no discrimination by suffix.\n\nmailcap-prio-flags\nThis style is used when the keyword flags is encountered in the list  of  tests\nspecified  by the mailcap-priorities style.  It should be set to a list of pat‐\nterns, each of which is tested against the flags specified in the mailcap entry\n(in other words, the sets of assignments found with some entries in the mailcap\nfile).  Earlier patterns in the list are preferred to later ones,  and  matched\npatterns are preferred to unmatched ones.\n\nmime-types\nA  list  of files in the format of ~/.mime.types and /etc/mime.types to be read\nduring setup, replacing the default list which consists  of  those  two  files.\nThe context is :mime:.  A + in the list will be replaced by the default files.\n\nnever-background\nIf  this  boolean style is set, the handler for the given context is always run\nin the foreground, even if the flags provided in the mailcap entry  suggest  it\nneed not be (for example, it doesn't require a terminal).\n\npager  If set, will be used instead of $PAGER or more to handle suffixes where the co‐‐\npiousoutput flag is set.  The context is as for  handler,  i.e.  :mime:.suffix:\nfor handling a file with the given suffix.\n\nExamples:\n\nzstyle ':mime:*' mailcap ~/.mailcap /usr/local/etc/mailcap\nzstyle ':mime:.txt:' handler less %s\nzstyle ':mime:.txt:' flags needsterminal\n\nWhen  zsh-mime-setup  is subsequently run, it will look for mailcap entries in the two\nfiles given.  Files of suffix .txt will be handled by running  `less  file.txt'.   The\nflag needsterminal is set to show that this program must run attached to a terminal.\n\nAs  there  are several steps to dispatching a command, the following should be checked\nif attempting to execute a file by extension .ext does not have the expected effect.\n\nThe command `alias -s ext' should show `ps=zsh-mime-handler'.  If it  shows  something\nelse, another suffix alias was already installed and was not overwritten.  If it shows\nnothing, no handler was installed:  this is most likely because no handler  was  found\nin  the .mime.types and mailcap combination for .ext files.  In that case, appropriate\nhandling should be added to ~/.mime.types and mailcap.\n\nIf the extension is handled by zsh-mime-handler but the file is not opened  correctly,\neither  the handler defined for the type is incorrect, or the flags associated with it\nare in appropriate.  Running zsh-mime-setup -l will show the handler and, if there are\nany,  the flags.  A %s in the handler is replaced by the file (suitably quoted if nec‐\nessary).  Check that the handler program listed lists and can be run in the way shown.\nAlso  check that the flags needsterminal or copiousoutput are set if the handler needs\nto be run under a terminal; the second flag is used if the output should be sent to  a\npager.  An example of a suitable mailcap entry for such a program is:\n\ntext/html; /usr/bin/lynx '%s'; needsterminal\n\nRunning  `zsh-mime-handler -l command line' prints the command line that would be exe‐\ncuted, simplified to remove the effect of any flags, and quoted so that the output can\nbe  run  as a complete zsh command line.  This is used by the completion system to de‐\ncide how to complete after a file handled by zsh-mime-setup.\n",
                "subsections": [
                    {
                        "name": "pick-web-browser",
                        "content": "This function is separate from the two MIME functions described above and can  be  as‐\nsigned directly to a suffix:\n\nautoload -U pick-web-browser\nalias -s html=pick-web-browser\n\nIt  is  provided as an intelligent front end to dispatch a web browser.  It may be run\nas either a function or a shell script.  The status 255  is  returned  if  no  browser\ncould be started.\n\nVarious styles are available to customize the choice of browsers:\n\nbrowser-style\nThe  value  of the style is an array giving preferences in decreasing order for\nthe type of browser to use.  The values of elements may be\n\nrunning\nUse a GUI browser that is already running when an X  Window  display  is\navailable.  The browsers listed in the x-browsers style are tried in or‐\nder until one is found; if it is, the file will  be  displayed  in  that\nbrowser,  so  the user may need to check whether it has appeared.  If no\nrunning browser is found, one is not started.  Browsers other than Fire‐\nfox,  Opera  and  Konqueror are assumed to understand the Mozilla syntax\nfor opening a URL remotely.\n\nx      Start a new GUI browser when an X Window display is  available.   Search\nfor  the  availability  of  one of the browsers listed in the x-browsers\nstyle and start the first one that is found.  No check is  made  for  an\nalready running browser.\n\ntty    Start  a  terminal-based browser.  Search for the availability of one of\nthe browsers listed in the tty-browsers style and start  the  first  one\nthat is found.\n\nIf the style is not set the default running x tty is used.\n\nx-browsers\nAn  array in decreasing order of preference of browsers to use when running un‐\nder the X Window System.  The array consists of the command name under which to\nstart  the browser.  They are looked up in the context :mime: (which may be ex‐\ntended in future, so appending `*' is recommended).  For example,\n\nzstyle ':mime:*' x-browsers opera konqueror firefox\n\nspecifies that pick-web-browser should first look for  a  running  instance  of\nOpera,  Konqueror or Firefox, in that order, and if it fails to find any should\nattempt to start Opera.  The default is firefox  mozilla  netscape  opera  kon‐‐\nqueror.\n\ntty-browsers\nAn  array similar to x-browsers, except that it gives browsers to use when no X\nWindow display is available.  The default is elinks links lynx.\n\ncommand\nIf it is set this style is used to pick the command used to open a page  for  a\nbrowser.   The context is :mime:browser:new:$browser: to start a new browser or\n:mime:browser:running:$browser: to open a URL in a browser already  running  on\nthe current X display, where $browser is the value matched in the x-browsers or\ntty-browsers style.  The escape sequence %b in the style's value  will  be  re‐\nplaced  by  the browser, while %u will be replaced by the URL.  If the style is\nnot set, the default for all new instances is equivalent to %b %u and  the  de‐\nfaults  for  using  running  browsers  are  equivalent  to the values kfmclient\nopenURL %u for Konqueror, firefox -new-tab %u for Firefox,  opera  -newpage  %u\nfor Opera, and %b -remote \"openUrl(%u)\" for all others.\n"
                    }
                ]
            },
            "MATHEMATICAL FUNCTIONS": {
                "content": "zcalc [ -erf ] [ expression ... ]\nA  reasonably  powerful calculator based on zsh's arithmetic evaluation facility.  The\nsyntax is similar to that of formulae in most programming languages; see  the  section\n`Arithmetic Evaluation' in zshmisc(1) for details.\n\nNon-programmers  should note that, as in many other programming languages, expressions\ninvolving only integers (whether constants without a `.',  variables  containing  such\nconstants  as  strings, or variables declared to be integers) are by default evaluated\nusing integer arithmetic, which is not how an ordinary desk calculator  operates.   To\nforce floating point operation, pass the option -f; see further notes below.\n\nIf the file ~/.zcalcrc exists it will be sourced inside the function once it is set up\nand about to process the command line.  This can be used, for example,  to  set  shell\noptions;  emulate  -L  zsh  and  setopt extendedglob are in effect at this point.  Any\nfailure to source the file if it exists is treated as fatal.  As with other  initiali‐\nsation files, the directory $ZDOTDIR is used instead of $HOME if it is set.\n\nThe  mathematical library zsh/mathfunc will be loaded if it is available; see the sec‐\ntion `The zsh/mathfunc Module' in zshmodules(1).  The  mathematical  functions  corre‐\nspond  to the raw system libraries, so trigonometric functions are evaluated using ra‐\ndians, and so on.\n\nEach line typed is evaluated as an expression.  The prompt shows a number, which  cor‐\nresponds  to  a  positional  parameter where the result of that calculation is stored.\nFor example, the result of the calculation on the line preceded by `4> ' is  available\nas $4.  The last value calculated is available as ans.  Full command line editing, in‐\ncluding the history of previous calculations, is available; the history  is  saved  in\nthe  file  ~/.zcalchistory.  To exit, enter a blank line or type `:q' on its own (`q'\nis allowed for historical compatibility).\n\nA line ending with a single backslash is treated in the same fashion as it is in  com‐\nmand line editing:  the backslash is removed, the function prompts for more input (the\nprompt is preceded by `...' to indicate this), and the lines are combined into one  to\nget  the final result.  In addition, if the input so far contains more open than close\nparentheses zcalc will prompt for more input.\n\nIf arguments are given to zcalc on start up, they are used to prime the first few  po‐\nsitional parameters.  A visual indication of this is given when the calculator starts.\n\nThe  constants  PI (3.14159...) and E (2.71828...) are provided.  Parameter assignment\nis possible, but note that all parameters will be put into the global namespace unless\nthe  :local special command is used.  The function creates local variables whose names\nstart with , so users should avoid doing so.  The variables ans (the last answer) and\nstack  (the stack in RPN mode) may be referred to directly; stack is an array but ele‐\nments of it are numeric.  Various other special variables are used locally with  their\nstandard meaning, for example compcontext, match, mbegin, mend, psvar.\n\nThe  output base can be initialised by passing the option `-#base', for example `zcalc\n-#16' (the `#' may have to be quoted, depending on the globbing options set).\n\nIf the option `-e' is set, the function  runs  non-interactively:  the  arguments  are\ntreated as expressions to be evaluated as if entered interactively line by line.\n\nIf  the option `-f' is set, all numbers are treated as floating point, hence for exam‐\nple the expression `3/4' evaluates to 0.75 rather than 0.  Options must appear in sep‐\narate words.\n\nIf  the  option  `-r' is set, RPN (Reverse Polish Notation) mode is entered.  This has\nvarious additional properties:\nStack  Evaluated values are maintained in a stack; this is contained in an array named\nstack with the most recent value in ${stack[1]}.\n\nOperators and functions\nIf  the line entered matches an operator (+, -, *, /, , ^, | or &) or a func‐\ntion supplied by the zsh/mathfunc library, the bottom element  or  elements  of\nthe  stack are popped to use as the argument or arguments.  The higher elements\nof stack (least recent) are used as earlier  arguments.   The  result  is  then\npushed into ${stack[1]}.\n\nExpressions\nOther  expressions  are  evaluated normally, printed, and added to the stack as\nnumeric values.  The syntax within expressions on a single line is normal shell\narithmetic (not RPN).\n\nStack listing\nIf  an  integer  follows  the option -r with no space, then on every evaluation\nthat many elements of the stack, where available, are printed instead  of  just\nthe  most  recent  result.   Hence,  for  example, zcalc -r4 shows $stack[4] to\n$stack[1] each time results are printed.\n\nDuplication: =\nThe pseudo-operator = causes the most recent element of the stack to be  dupli‐\ncated onto the stack.\n\npop    The  pseudo-function  pop  causes  the  most  recent element of the stack to be\npopped.  A `>' on its own has the same effect.\n\n>ident The expression > followed (with no space) by a shell identifier causes the most\nrecent element of the stack to be popped and assigned to the variable with that\nname.  The variable is local to the zcalc function.\n\n<ident The expression < followed (with no space) by  a  shell  identifier  causes  the\nvalue of the variable with that name to be pushed onto the stack.  ident may be\nan integer, in which case the previous result with that number (as shown before\nthe > in the standard zcalc prompt) is put on the stack.\n\nExchange: xy\nThe  pseudo-function  xy causes the most recent two elements of the stack to be\nexchanged.  `<>' has the same effect.\n\nThe prompt is configurable via the parameter  ZCALCPROMPT,  which  undergoes  standard\nprompt  expansion.  The index of the current entry is stored locally in the first ele‐\nment of the array psvar, which can be referred to in ZCALCPROMPT as  `%1v'.   The  de‐\nfault prompt is `%1v> '.\n\nThe variable ZCALCACTIVE is set within the function and can be tested by nested func‐\ntions; it has the value rpn if RPN mode is active, else 1.\n\nA few special commands are available; these are introduced by a colon.   For  backward\ncompatibility, the colon may be omitted for certain commands.  Completion is available\nif compinit has been run.\n\nThe output precision may be specified within zcalc by special commands  familiar  from\nmany calculators.\n:norm  The  default  output  format.   It  corresponds to the printf %g specification.\nTypically this shows six decimal digits.\n\n:sci digits\nScientific notation, corresponding to the printf %g output format with the pre‐\ncision  given by digits.  This produces either fixed point or exponential nota‐\ntion depending on the value output.\n\n:fix digits\nFixed point notation, corresponding to the printf %f  output  format  with  the\nprecision given by digits.\n\n:eng digits\nExponential  notation,  corresponding  to  the printf %E output format with the\nprecision given by digits.\n\n:raw   Raw output:  this is the default form of the output  from  a  math  evaluation.\nThis may show more precision than the number actually possesses.\n\nOther special commands:\n:!line...\nExecute  line...  as  a normal shell command line.  Note that it is executed in\nthe context of the function, i.e. with local variables.  Space is optional  af‐\nter :!.\n\n:local arg ...\nDeclare variables local to the function.  Other variables may be used, too, but\nthey will be taken from or put into the global scope.\n\n:function name [ body ]\nDefine a mathematical function or (with no body) delete it.  :function  may  be\nabbreviated to :func or simply :f.  The name may contain the same characters as\na shell function name.  The function is defined using zmathfuncdef, see below.\n\nNote that zcalc takes care of all quoting.  Hence for example:\n\n:f cube $1 * $1 * $1\n\ndefines a function to cube the sole argument.  Functions so defined, or  indeed\nany  functions defined directly or indirectly using functions -M, are available\nto execute by typing only the name on the line in RPN mode; this pops  the  ap‐\npropriate  number of arguments off the stack to pass to the function, i.e. 1 in\nthe case of the example cube function.  If there are  optional  arguments  only\nthe mandatory arguments are supplied by this means.\n\n[#base]\nThis  is  not  a special command, rather part of normal arithmetic syntax; how‐\never, when this form appears on a line by itself the default  output  radix  is\nset  to base.  Use, for example, `[#16]' to display hexadecimal output preceded\nby an indication of the base, or `[##16]' just to display the raw number in the\ngiven  base.   Bases themselves are always specified in decimal. `[#]' restores\nthe normal output format.  Note that setting an output base suppresses floating\npoint output; use `[#]' to return to normal operation.\n\n$var   Print  out the value of var literally; does not affect the calculation.  To use\nthe value of var, omit the leading `$'.\n\nSee the comments in the function for a few extra tips.\n\nmin(arg, ...)\nmax(arg, ...)\nsum(arg, ...)",
                "subsections": [
                    {
                        "name": "zmathfunc",
                        "content": "The function zmathfunc defines the three mathematical functions  min,  max,  and  sum.\nThe  functions min and max take one or more arguments.  The function sum takes zero or\nmore arguments.  Arguments can be of different types (ints and floats).\n\nNot to be confused with  the  zsh/mathfunc  module,  described  in  the  section  `The\nzsh/mathfunc Module' in zshmodules(1).\n\nzmathfuncdef [ mathfunc [ body ] ]\nA convenient front end to functions -M.\n\nWith two arguments, define a mathematical function named mathfunc which can be used in\nany form of arithmetic evaluation.  body is a mathematical expression to implement the\nfunction.   It  may contain references to position parameters $1, $2, ...  to refer to\nmandatory parameters and ${1:-defvalue} ...  to refer to  optional  parameters.   Note\nthat  the  forms must be strictly adhered to for the function to calculate the correct\nnumber  of  arguments.   The  implementation  is  held  in  a  shell  function   named\nzshmathfuncmathfunc;  usually the user will not need to refer to the shell function\ndirectly.  Any existing function of the same name is silently replaced.\n\nWith one argument, remove the mathematical function mathfunc  as  well  as  the  shell\nfunction implementation.\n\nWith  no  arguments,  list all mathfunc functions in a form suitable for restoring the\ndefinition.  The functions have not necessarily been defined by zmathfuncdef.\n"
                    }
                ]
            },
            "USER CONFIGURATION FUNCTIONS": {
                "content": "The zsh/newuser module comes with a function to aid in  configuring  shell  options  for  new\nusers.   If  the module is installed, this function can also be run by hand.  It is available\neven if the module's default behaviour, namely running the function for a new user logging in\nwithout startup files, is inhibited.\n\nzsh-newuser-install [ -f ]\nThe  function presents the user with various options for customizing their initializa‐\ntion scripts.  Currently only ~/.zshrc is handled.  $ZDOTDIR/.zshrc is used instead if\nthe  parameter  ZDOTDIR  is  set; this provides a way for the user to configure a file\nwithout altering an existing .zshrc.\n\nBy default the function exits immediately if it finds any of the files .zshenv, .zpro‐‐\nfile,  .zshrc,  or .zlogin in the appropriate directory.  The option -f is required in\norder to force the function to continue.  Note this may happen even if  .zshrc  itself\ndoes not exist.\n\nAs currently configured, the function will exit immediately if the user has root priv‐\nileges; this behaviour cannot be overridden.\n\nOnce activated, the function's behaviour is supposed to  be  self-explanatory.   Menus\nare  present  allowing the user to alter the value of options and parameters.  Sugges‐\ntions for improvements are always welcome.\n\nWhen the script exits, the user is given the opportunity to save the new file or  not;\nchanges  are not irreversible until this point.  However, the script is careful to re‐\nstrict changes to the file only to a group marked by the lines `# Lines configured  by\nzsh-newuser-install' and `# End of lines configured by zsh-newuser-install'.  In addi‐\ntion, the old version of .zshrc is saved to a file with the suffix .zni appended.\n\nIf the function edits an existing .zshrc, it is up to the  user  to  ensure  that  the\nchanges made will take effect.  For example, if control usually returns early from the\nexisting .zshrc the lines will not be executed; or a  later  initialization  file  may\noverride  options  or  parameters, and so on.  The function itself does not attempt to\ndetect any such conflicts.\n",
                "subsections": []
            },
            "OTHER FUNCTIONS": {
                "content": "There are a large number of helpful functions in the Functions/Misc directory of the zsh dis‐\ntribution.   Most are very simple and do not require documentation here, but a few are worthy\nof special mention.\n",
                "subsections": [
                    {
                        "name": "Descriptions",
                        "content": "colors This function initializes several associative arrays to map color names to (and  from)\nthe ANSI standard eight-color terminal codes.  These are used by the prompt theme sys‐\ntem (see above).  You seldom should need to run colors more than once.\n\nThe eight base colors are: black, red, green, yellow, blue, magenta, cyan, and  white.\nEach  of  these  has codes for foreground and background.  In addition there are seven\nintensity attributes: bold, faint, standout, underline, blink, reverse,  and  conceal.\nFinally,  there  are seven codes used to negate attributes: none (reset all attributes\nto  the  defaults),  normal  (neither  bold  nor  faint),  no-standout,  no-underline,\nno-blink, no-reverse, and no-conceal.\n\nSome terminals do not support all combinations of colors and intensities.\n\nThe associative arrays are:\n\ncolor\ncolour Map  all the color names to their integer codes, and integer codes to the color\nnames.  The eight base names map to the foreground color  codes,  as  do  names\nprefixed  with  `fg-',  such  as  `fg-red'.  Names prefixed with `bg-', such as\n`bg-blue', refer to the background codes.  The reverse  mapping  from  code  to\ncolor yields base name for foreground codes and the bg- form for backgrounds.\n\nAlthough  it  is  a  misnomer  to call them `colors', these arrays also map the\nother fourteen attributes from names to codes and codes to names.\n\nfg\nfgbold\nfgnobold\nMap the eight basic color names to ANSI terminal escape sequences that set  the\ncorresponding  foreground  text  properties.  The fg sequences change the color\nwithout changing the eight intensity attributes.\n\nbg\nbgbold\nbgnobold\nMap the eight basic color names to ANSI terminal escape sequences that set  the\ncorresponding background properties.  The bg sequences change the color without\nchanging the eight intensity attributes.\n\nIn addition, the scalar parameters resetcolor and boldcolor are set to the ANSI ter‐\nminal escapes that turn off all attributes and turn on bold intensity, respectively.\n\nfned [ -x num ] name\nSame  as  zed  -f.   This function does not appear in the zsh distribution, but can be\ncreated by linking zed to the name fned in some directory in your fpath.\n\nis-at-least needed [ present ]\nPerform a greater-than-or-equal-to comparison of two strings having the  format  of  a\nzsh  version  number; that is, a string of numbers and text with segments separated by\ndots or dashes.  If the present string is not provided, $ZSHVERSION  is  used.   Seg‐\nments  are  paired  left-to-right in the two strings with leading non-number parts ig‐\nnored.  If one string has fewer segments than the other, the missing segments are con‐\nsidered zero.\n\nThis  is useful in startup files to set options and other state that are not available\nin all versions of zsh.\n\nis-at-least 3.1.6-15 && setopt NOGLOBALRCS\nis-at-least 3.1.0 && setopt HISTREDUCEBLANKS\nis-at-least 2.6-17 || print \"You can't use is-at-least here.\"\n\nnslookup [ arg ... ]\nThis wrapper function for the nslookup command requires the zsh/zpty module (see  zsh‐\nmodules(1)).   It  behaves  exactly like the standard nslookup except that it provides\ncustomizable prompts (including a right-side prompt) and completion of  nslookup  com‐\nmands, host names, etc. (if you use the function-based completion system).  Completion\nstyles may be set with the context prefix `:completion:nslookup'.\n\nSee also the pager, prompt and rprompt styles below.\n\nregexp-replace var regexp replace\nUse regular expressions to perform a global search and replace operation  on  a  vari‐\nable.   POSIX  extended  regular expressions are used, unless the option REMATCHPCRE\nhas been set, in which case Perl-compatible regular expressions  are  used  (this  re‐\nquires the shell to be linked against the pcre library).\n\nvar  is  the  name  of the variable containing the string to be matched.  The variable\nwill be modified directly by the function.  The variables MATCH, MBEGIN, MEND,  match,\nmbegin, mend should be avoided as these are used by the regular expression code.\n\nregexp is the regular expression to match against the string.\n\nreplace  is  the replacement text.  This can contain parameter, command and arithmetic\nexpressions which will be replaced:  in particular, a reference to $MATCH will be  re‐\nplaced by the text matched by the pattern.\n\nThe return status is 0 if at least one match was performed, else 1.\n\nrun-help cmd\nThis  function  is  designed to be invoked by the run-help ZLE widget, in place of the\ndefault alias.  See `Accessing On-Line Help' above for setup instructions.\n\nIn the discussion which follows, if cmd is a file system path, it is first reduced  to\nits rightmost component (the file name).\n\nHelp  is  first  sought  by looking for a file named cmd in the directory named by the\nHELPDIR parameter.  If no file is found, an  assistant  function,  alias,  or  command\nnamed  run-help-cmd  is  sought.  If found, the assistant is executed with the rest of\nthe current command line (everything after the command name  cmd)  as  its  arguments.\nWhen neither file nor assistant is found, the external command `man cmd' is run.\n\nAn example assistant for the \"ssh\" command:\n\nrun-help-ssh() {\nemulate -LR zsh\nlocal -a args\n# Delete the \"-l username\" option\nzparseopts -D -E -a args l:\n# Delete other options, leaving: host command\nargs=(${@:#-*})\nif [[ ${#args} -lt 2 ]]; then\nman ssh\nelse\nrun-help $args[2]\nfi\n}\n\nSeveral  of these assistants are provided in the Functions/Misc directory.  These must\nbe autoloaded, or placed as executable scripts in your search path,  in  order  to  be\nfound and used by run-help.\n\nrun-help-git\nrun-help-ip\nrun-help-openssl\nrun-help-p4\nrun-help-sudo\nrun-help-svk\nrun-help-svn\nAssistant functions for the git, ip, openssl, p4, sudo, svk, and svn, commands.\n\ntetris Zsh  was  once  accused  of not being as complete as Emacs, because it lacked a Tetris\ngame.  This function was written to refute this vicious slander.\n\nThis function must be used as a ZLE widget:\n\nautoload -U tetris\nzle -N tetris\nbindkey keys tetris\n\nTo start a game, execute the widget by typing the keys.   Whatever  command  line  you\nwere  editing  disappears temporarily, and your keymap is also temporarily replaced by\nthe Tetris control keys.  The previous editor state is restored when you quit the game\n(by pressing `q') or when you lose.\n\nIf  you  quit  in  the middle of a game, the next invocation of the tetris widget will\ncontinue where you left off.  If you lost, it will start a new game.\n"
                    },
                    {
                        "name": "tetriscurses",
                        "content": "This is a port of the above to zcurses.  The input handling is improved a bit so  that\nmoving a block sideways doesn't automatically advance a timestep, and the graphics use\nunicode block graphics.\n\nThis version does not save the game state between invocations, and is not invoked as a\nwidget, but rather as:\n\nautoload -U tetriscurses\ntetriscurses\n\nzargs [ option ... -- ] [ input ... ] [ -- command [ arg ... ] ]\nThis  function  has a similar purpose to GNU xargs.  Instead of reading lines of argu‐\nments from the standard input, it takes them from the command line.   This  is  useful\nbecause  zsh,  especially with recursive glob operators, often can construct a command\nline for a shell function that is longer than can be accepted by an external command.\n\nThe option list represents options of the zargs command itself, which are the same  as\nthose  of  xargs.  The input list is the collection of strings (often file names) that\nbecome the arguments of the command, analogous to the standard input  of  xargs.   Fi‐\nnally,  the  arg list consists of those arguments (usually options) that are passed to\nthe command each time it runs.  The arg list precedes the elements from the input list\nin each run.  If no command is provided, then no arg list may be provided, and in that\nevent the default command is `print' with arguments `-r --'.\n\nFor example, to get a long ls listing of all non-hidden plain files in the current di‐\nrectory or its subdirectories:\n\nautoload -U zargs\nzargs -- /*(.) -- ls -ld --\n\nThe  first and third occurrences of `--' are used to mark the end of options for zargs\nand ls respectively to guard against filenames starting with `-', while the second  is\nused to separate the list of files from the command to run (`ls -ld --').\n\nThe  first  `--' would also be needed if there was a chance the list might be empty as\nin:\n\nzargs -r -- ./*.back(#qN) -- rm -f\n\nIn the event that the string `--' is or may be an input, the -e option may be used  to\nchange  the  end-of-inputs  marker.  Note that this does not change the end-of-options\nmarker.  For example, to use `..' as the marker:\n\nzargs -e.. -- /*(.) .. ls -ld --\n\nThis is a good choice in that example because no plain file can be named `..', but the\nbest end-marker depends on the circumstances.\n\nThe  options  -i, -I, -l, -L, and -n differ slightly from their usage in xargs.  There\nare no input lines for zargs to count, so -l and -L count through the input list,  and\n-n  counts  the number of arguments passed to each execution of command, including any\narg list.  Also, any time -i or -I is used, each input is processed separately  as  if\nby `-L 1'.\n\nFor details of the other zargs options, see xargs(1) (but note the difference in func‐\ntion between zargs and xargs) or run zargs with the --help option.\n\nzed [ -f [ -x num ] ] name\nzed -b This function uses the ZLE editor to edit a file or function.\n\nOnly one name argument is allowed.  If the -f option is given, the name is taken to be\nthat  of a function; if the function is marked for autoloading, zed searches for it in\nthe fpath and loads it.  Note that functions edited this way are  installed  into  the\ncurrent  shell, but not written back to the autoload file.  In this case the -x option\nspecifies that leading tabs indenting the function according to syntax should be  con‐\nverted  into the given number of spaces; `-x 2' is consistent with the layout of func‐\ntions distributed with the shell.\n\nWithout -f, name is the path name of the file to edit, which need  not  exist;  it  is\ncreated on write, if necessary.\n\nWhile  editing,  the function sets the main keymap to zed and the vi command keymap to\nzed-vicmd.  These will be copied from the existing main and vicmd keymaps if  they  do\nnot exist the first time zed is run.  They can be used to provide special key bindings\nused only in zed.\n\nIf it creates the keymap, zed rebinds the return key to insert a line break and `^X^W'\nto  accept  the  edit  in  the  zed  keymap,  and binds `ZZ' to accept the edit in the\nzed-vicmd keymap.\n\nThe bindings alone can be installed by running `zed -b'.  This is suitable for putting\ninto  a  startup  file.  Note that, if rerun, this will overwrite the existing zed and\nzed-vicmd keymaps.\n\nCompletion is available, and styles may be  set  with  the  context  prefix  `:comple‐‐\ntion:zed'.\n\nA  zle  widget zed-set-file-name is available.  This can be called by name from within\nzed using `\\ex zed-set-file-name' (note, however, that because of zed's rebindings you\nwill  have  to type ^j at the end instead of the return key), or can be bound to a key\nin either of the zed or zed-vicmd keymaps after `zed -b' has been run.  When the  wid‐\nget  is  called,  it prompts for a new name for the file being edited.  When zed exits\nthe file will be written under that name and the original file  will  be  left  alone.\nThe widget has no effect with `zed -f'.\n\nWhile  zed-set-file-name  is  running, zed uses the keymap zed-normal-keymap, which is\nlinked from the main keymap in effect at the time zed initialised its bindings.  (This\nis  to  make  the return key operate normally.)  The result is that if the main keymap\nhas been changed, the widget won't notice.  This is not a concern for most users.\n\nzcp [ -finqQvwW ] srcpat dest\nzln [ -finqQsvwW ] srcpat dest\nSame as zmv -C and zmv -L, respectively.  These functions do not  appear  in  the  zsh\ndistribution,  but  can be created by linking zmv to the names zcp and zln in some di‐\nrectory in your fpath.\n\nzkbd   See `Keyboard Definition' above.\n\n\nzmv [ -finqQsvwW ] [ -C | -L | -M | -{p|P} program ] [ -o optstring ]\nsrcpat dest\nMove (usually, rename) files matching the pattern srcpat to corresponding files having\nnames  of  the  form given by dest, where srcpat contains parentheses surrounding pat‐\nterns which will be replaced in turn by $1, $2, ... in dest.  For example,\n\nzmv '(*).lis' '$1.txt'\n\nrenames `foo.lis' to `foo.txt', `my.old.stuff.lis' to `my.old.stuff.txt', and so on.\n\nThe pattern is always treated as an EXTENDEDGLOB pattern.  Any file whose name is not\nchanged  by the substitution is simply ignored.  Any error (a substitution resulted in\nan empty string, two substitutions gave the same result, the destination was an exist‐\ning regular file and -f was not given) causes the entire function to abort without do‐\ning anything.\n\nIn addition to pattern replacement, the variable $f can be referrred to in the  second\n(replacement)  argument.  This makes it possible to use variable substitution to alter\nthe argument; see examples below.\n\nOptions:\n\n-f     Force overwriting of destination files.   Not  currently  passed  down  to  the\nmv/cp/ln command due to vagaries of implementations (but you can use -o-f to do\nthat).\n-i     Interactive: show each line to be executed and ask the user whether to  execute\nit.   `Y'  or  `y'  will execute it, anything else will skip it.  Note that you\njust need to type one character.\n-n     No execution: print what would happen, but don't do it.\n-q     Turn bare glob qualifiers off: now assumed by default, so this has no effect.\n-Q     Force bare glob qualifiers on.  Don't turn this on unless you are actually  us‐\ning glob qualifiers in a pattern.\n-s     Symbolic, passed down to ln; only works with -L.\n-v     Verbose: print each command as it's being executed.\n-w     Pick  out wildcard parts of the pattern, as described above, and implicitly add\nparentheses for referring to them.\n-W     Just like -w, with the addition of turning wildcards in the replacement pattern\ninto sequential ${1} .. ${N} references.\n-C\n-L\n-M     Force cp, ln or mv, respectively, regardless of the name of the function.\n-p program\nCall program instead of cp, ln or mv.  Whatever it does, it should at least un‐\nderstand the form `program -- oldname newname' where oldname  and  newname  are\nfilenames generated by zmv.  program will be split into words, so might be e.g.\nthe name of an archive tool plus a copy or rename subcommand.\n-P program\nAs -p program, except that program does not accept a following --  to  indicate\nthe  end of options.  In this case filenames must already be in a sane form for\nthe program in question.\n-o optstring\nThe optstring is split into words and passed down verbatim to the cp, ln or  mv\ncommand called to perform the work.  It should probably begin with a `-'.\n\nFurther examples:\n\nzmv -v '(* *)' '${1// /}'\n\nFor any file in the current directory with at least one space in the name, replace ev‐\nery space by an underscore and display the commands executed.\n\nzmv -v '* *' '${f// /}'\n\nThis does exactly the same by referring to the file name stored in $f.\n\nFor more complete examples and other implementation details, see the zmv source  file,\nusually  located  in  one  of  the  directories  named  in  your  fpath,  or  in Func‐‐\ntions/Misc/zmv in the zsh distribution.\n"
                    },
                    {
                        "name": "zrecompile",
                        "content": "See `Recompiling Functions' above.\n\nzstyle+ context style value [ + subcontext style value ... ]\nThis makes defining styles a bit simpler by using a single `+' as a special token that\nallows you to append a context name to the previously used context name.  Like this:\n\nzstyle+ ':foo:bar' style1 value1 \\\n+':baz'     style2 value2 \\\n+':frob'    style3 value3\n\nThis defines style1 with value1 for the context :foo:bar as usual, but it also defines\nstyle2  with  value2  for  the  context  :foo:bar:baz  and  style3  with  value3   for\n:foo:bar:frob.  Any subcontext may be the empty string to re-use the first context un‐\nchanged.\n"
                    },
                    {
                        "name": "Styles",
                        "content": ""
                    },
                    {
                        "name": "insert-tab",
                        "content": "The zed function sets this style in context `:completion:zed:*' to turn off completion\nwhen  TAB  is typed at the beginning of a line.  You may override this by setting your\nown value for this context and style.\n\npager  The nslookup function looks up this style in the context `:nslookup' to determine  the\nprogram used to display output that does not fit on a single screen.\n"
                    },
                    {
                        "name": "prompt",
                        "content": ""
                    },
                    {
                        "name": "rprompt",
                        "content": "The nslookup function looks up this style in the context `:nslookup' to set the prompt\nand the right-side prompt, respectively.  The usual expansions for the  PS1  and  RPS1\nparameters may be used (see EXPANSION OF PROMPT SEQUENCES in zshmisc(1)).\n\n\n\nzsh 5.8.1                                 February 12, 2022                            ZSHCONTRIB(1)"
                    }
                ]
            }
        }
    }
}