The Z Shell

https://zsh.sourceforge.io/Doc/Release/
Admin
Zsh is a freely available UNIX command interpreter (shell) that closely resembles the Korn shell and...
Tokens:344,357
Snippets:2,780
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### file-patterns style examples

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Examples of setting the file-patterns style for different completion behaviors.

```zsh
zstyle ':completion:*:*:rm:*:*' file-patterns \ 
    '*.o:object-files' '%p:all-files'

```

```zsh
zstyle ':completion:*' file-patterns \ 
    '%p:globbed-files' '*(-/):directories' '*:all-files'

```

```zsh
zstyle ':completion:*' file-patterns \ 
    '%p(^-/):globbed-files *(-/):directories:location'

```

--------------------------------

### Example help text for directory completion

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

A typical help text snippet that triggers the directory completion specification defined in the previous example.

```text
  -C, --directory=DIR          change to directory DIR
```

--------------------------------

### Simplified process substitution example

Source: https://zsh.sourceforge.io/Doc/Release/Expansion.html

A basic example of using process substitution with paste, cut, and a process.

```shell
paste <(cut -f1 file1) <(cut -f3 file2) > >(process)
```

--------------------------------

### Quickstart vcs_info prompt configuration

Source: https://zsh.sourceforge.io/Doc/Release/User-Contributions.html

Quickstart configuration for vcs_info: sets actionformats, formats, and branchformat styles, defines a precmd hook that calls vcs_info, and sets PS1 to include ${vcs_info_msg_0_}. Requires PROMPT_SUBST to be enabled for the prompt substitution to work.

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

```

--------------------------------

### after and before glob qualifiers: equivalent examples

Source: https://zsh.sourceforge.io/Doc/Release/Calendar-Function-System.html

The after and before functions take a single argument; if a time only is given, the date is today. The two examples are equivalent.

```zsh
print *(e-after 12:00-)
print *(e-after today:12:00-)
```

--------------------------------

### emulate command example

Source: https://zsh.sourceforge.io/Doc/Release/Shell-Builtin-Commands.html

Example of sticky emulation: defines functions within an emulated shell and calls one outside.

```shell
emulate sh -c 'fni() { setopt cshnullglob; }
fno() { fni; }'
fno

```

--------------------------------

### _description usage example

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Example of calling _description with a formatted description string containing units, range, and default value.

```zsh
_description times expl 'timeout (seconds) (0-60) [20]'
```

--------------------------------

### #compdef -K widget definition example

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Defines two widgets, _foo_complete and _foo_list, bound to key sequences. The widget-name must be distinct in each set and will be prefixed with an underscore if not present. The example is shown on one line in the source.

```zsh
#compdef -K _foo_complete complete-word "^X^C" \ 
  _foo_list list-choices "^X^D"
```

--------------------------------

### Example context string for dvips option -o

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Shows the format of a completion context string with fields separated by colons. The example is for the dvips command's -o option, with the tag 'files'.

```text
:completion::complete:dvips:option-o-1:files
```

--------------------------------

### _values function example

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

An example of using the _values function to define multiple values with specific arguments, separators, and exclusion rules.

```zsh
_values -s , 'description' \ 
        '*foo[bar]' \ 
        '(two)*one[number]:first count:' \ 
        'two[another number]::second count:(1 2 3)'
```

--------------------------------

### Example usage of _numbers for unit-based completion

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

This example shows how to use _numbers to complete an age value, specifying seconds as the default unit and providing additional time unit suffixes.

```zsh
_numbers -u seconds age :s:seconds m:minutes h:hours d:days
```

--------------------------------

### Using _alternative for multiple tags

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Example of using _alternative to offer usernames and hostnames as possible matches.

```zsh
_alternative \ 
    'users:user:_users' \ 
    'hosts:host:_hosts'
```

--------------------------------

### Configure _complete_debug_generic widget

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Example of creating a debug-enabled generic completion widget and binding it to a key sequence.

```zsh
zle -N _complete_debug_generic _complete_help_generic
bindkey '^x:' _complete_debug_generic
```

--------------------------------

### Using _all_labels for completion

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Example of using _all_labels to complete strings from a matches parameter with custom options.

```zsh
local expl
...
if _requested foo; then
  ...
  _all_labels foo expl '...' compadd ... - $matches
fi
```

--------------------------------

### Using _requested for tag and matching

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

An example of using _requested to perform tag testing and matching in a single loop.

```zsh
local expl ret=1
_tags foo bar baz
while _tags; do
  _requested foo expl 'description' \
      compadd foobar foobaz && ret=0
  ...
  (( ret )) || break
done
```

--------------------------------

### Configure global completer style for _prefix

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

Example of setting the global completer style to include multiple invocations of the _prefix completer.

```zsh
zstyle ':completion:*' completer \ 
    _complete _prefix _correct _prefix:foo
```

--------------------------------

### Configure unit-suffixes format with zstyle

Source: https://zsh.sourceforge.io/Doc/Release/Completion-System.html

This example demonstrates how to join unit suffixes into a comma-separated list using the format style with the unit-suffixes tag.

```zsh
zstyle ':completion:*:unit-suffixes' format '%x%(r::,)'
```

--------------------------------

### Calendar entry with UID

Source: https://zsh.sourceforge.io/Doc/Release/Calendar-Function-System.html

Example calendar entry with a UID hidden on an indented continuation line starting with '#'. The second line is not shown by the calendar function.

```text
Aug 31, 2007 09:30  Celebrate the end of the holidays
  # UID 045B78A0

```

--------------------------------

### Install and initialize prompt themes in .zshrc

Source: https://zsh.sourceforge.io/Doc/Release/User-Contributions.html

Adds the prompt functions directory to fpath, autoloads promptinit, and initializes the prompt system. Place this in your .zshrc, assuming functions are in ~/myfns.

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

```

--------------------------------

### Install and initialize Zftp functions in .zshrc

Source: https://zsh.sourceforge.io/Doc/Release/Zftp-Function-System.html

Adds the directory containing the Zftp functions to fpath, autoloads zfinit, and calls it to initialize the system. Assumes functions are stored in ~/myfns. If zftp is built into the shell, use zfinit -n instead. Place after completion system initialization to avoid unnecessary compctl commands.

```zsh
fpath=(~/myfns $fpath)
autoload -U zfinit
zfinit

```
Tokens:
Raw