The Z Shell — Zsh 5.9.999.3-test documentation

# The Z Shell

## Overview

Because zsh contains many features, the zsh manual has been split into a number of sections. This manual page includes all the separate manual pages in the following order:

- zsh Zsh overview

- zshroadmap Informal introduction to the manual

- zshmisc Anything not fitting into the other sections

- zshexpn Zsh command and parameter expansion

- zshparam Zsh parameters

- zshoptions Zsh options

- zshbuiltins Zsh built-in functions

- zshzle Zsh command line editing

- zshcompwid Zsh completion widgets

- zshcompsys Zsh completion system

- zshcompctl Zsh completion control

- zshmodules Zsh loadable modules

- zshcalsys Zsh built-in calendar functions

- zshtcpsys Zsh built-in TCP functions

- zshzftpsys Zsh built-in FTP client

- zshcontrib Additional zsh functions and utilities

## Description

Zsh is a UNIX command interpreter (shell) usable as an interactive login shell and as a shell script command processor. Of the standard shells, zsh most closely resembles ksh but includes many enhancements. It does not provide compatibility with POSIX or other shells in its default operating mode: see Compatibility.

Zsh has command line editing, builtin spelling correction, programmable command completion, shell functions (with autoloading), a history mechanism, and a host of other features.

## Author

Zsh was originally written by Paul Falstad. Zsh is now maintained by the members of the zsh-workers mailing list `<zsh-workers@zsh.org>`. The development is currently coordinated by Peter Stephenson `<pws@zsh.org>`. The coordinator can be contacted at `<coordinator@zsh.org>`, but matters relating to the code should generally go to the mailing list.

## Availability

Zsh is available from the following HTTP and anonymous FTP site.

    ftp://ftp.zsh.org/pub/
    https://www.zsh.org/pub/

The up-to-date source code is available via Git from Sourceforge. See https://sourceforge.net/projects/zsh/ for details. A summary of instructions for the archive can be found at https://zsh.sourceforge.io/.

## Mailing Lists

Zsh has several mailing lists:

`<zsh-announce@zsh.org>`

> Announcements about releases, major changes in the shell and the monthly posting of the Zsh FAQ. (moderated)

`<zsh-users@zsh.org>`

> User discussions.

`<zsh-workers@zsh.org>`

> Hacking, development, bug reports and patches.

`<zsh-security@zsh.org>`

> Private mailing list (the general public cannot subscribe to it) for discussing bug reports with security implications, i.e., potential vulnerabilities.

> If you find a security problem in zsh itself, please mail this address.

To subscribe or unsubscribe, send mail to the associated administrative address for the mailing list.

> - `<zsh-announce-subscribe@zsh.org>`

> - `<zsh-users-subscribe@zsh.org>`

> - `<zsh-workers-subscribe@zsh.org>`

> - `<zsh-announce-unsubscribe@zsh.org>`

> - `<zsh-users-unsubscribe@zsh.org>`

> - `<zsh-workers-unsubscribe@zsh.org>`

YOU ONLY NEED TO JOIN ONE OF THE MAILING LISTS AS THEY ARE NESTED. All submissions to zsh-announce are automatically forwarded to zsh-users. All submissions to zsh-users are automatically forwarded to zsh-workers.

If you have problems subscribing/unsubscribing to any of the mailing lists, send mail to `<listmaster@zsh.org>`.

The mailing lists are archived; the archives can be accessed via the administrative addresses listed above. There is also a hypertext archive available at https://www.zsh.org/mla/.

## The Zsh FAQ

Zsh has a list of Frequently Asked Questions (FAQ), maintained by Peter Stephenson `<pws@zsh.org>`. It is regularly posted to the newsgroup comp.unix.shell and the zsh-announce mailing list. The latest version can be found at any of the Zsh FTP sites, or at https://www.zsh.org/FAQ/. The contact address for FAQ-related matters is `<faqmaster@zsh.org>`.

## The Zsh Web Page

Zsh has a web page which is located at https://www.zsh.org/. The contact address for web-related matters is `<webmaster@zsh.org>`.

## The Zsh Userguide

A userguide is currently in preparation. It is intended to complement the manual, with explanations and hints on issues where the manual can be cabbalistic, hierographic, or downright mystifying (for example, the word `hierographic’ does not exist). It can be viewed in its current state at https://zsh.sourceforge.io/Guide/. At the time of writing, chapters dealing with startup files and their contents and the new completion system were essentially complete.

# Invocation

The following flags are interpreted by the shell when invoked to determine where the shell will read commands from:

`-c`

> Take the first argument as a command to execute, rather than reading commands from a script or standard input. If any further arguments are given, the first one is assigned to `$0`, rather than being used as a positional parameter.

`-i`

> Force shell to be interactive. It is still possible to specify a script to execute.

`-s`

> Force shell to read commands from the standard input. If the `-s` flag is not present and an argument is given, the first argument is taken to be the pathname of a script to execute.

If there are any remaining arguments after option processing, and neither of the options `-c` or `-s` was supplied, the first argument is taken as the file name of a script containing shell commands to be executed. If the option `PATH_SCRIPT` is set, and the file name does not contain a directory path (i.e. there is no `/` in the name), first the current directory and then the command path given by the variable `PATH` are searched for the script. If the option is not set or the file name contains a `/` it is used directly.

After the first one or two arguments have been appropriated as described above, the remaining arguments are assigned to the positional parameters.

For further options, which are common to invocation and the `set` builtin, see zshoptions.

The long option `--emulate` followed (in a separate word) by an emulation mode may be passed to the shell. The emulation modes are those described for the `emulate` builtin, see zshbuiltins. The `--emulate` option must precede any other options (which might otherwise be overridden), but following options are honoured, so may be used to modify the requested emulation mode. Note that certain extra steps are taken to ensure a smooth emulation when this option is used compared with the `emulate` command within the shell: for example, variables that conflict with POSIX usage such as `path` are not defined within the shell.

Options may be specified by name using the `-o` option. `-o` acts like a single-letter option, but takes a following string as the option name. For example,

     zsh -x -o shwordsplit scr

runs the script `scr`, setting the `XTRACE` option by the corresponding letter `-x` and the `SH_WORD_SPLIT` option by name. Options may be turned off by name by using `+o` instead of `-o`. `-o` can be stacked up with preceding single-letter options, so for example `-xo shwordsplit` or `-xoshwordsplit` is equivalent to `-x -o shwordsplit`.

Options may also be specified by name in GNU long option style, `--`option-name. When this is done, `-` characters in the option name are permitted: they are translated into `_`, and thus ignored. So, for example, `zsh --sh-word-split` invokes zsh with the `SH_WORD_SPLIT` option turned on. Like other option syntaxes, options can be turned off by replacing the initial `-` with a `+`; thus `+-sh-word-split` is equivalent to `--no-sh-word-split`. Unlike other option syntaxes, GNU-style long options cannot be stacked with any other options, so for example `-x-shwordsplit` is an error, rather than being treated like `-x --shwordsplit`.

The special GNU-style option `--version` is handled; it sends to standard output the shell’s version information, then exits successfully. `--help` is also handled; it sends to standard output a list of options that can be used when invoking the shell, then exits successfully.

Option processing may be finished, allowing following arguments that start with `-` or `+` to be treated as normal arguments, in two ways. Firstly, a lone `-` (or `+`) as an argument by itself ends option processing. Secondly, a special option `--` (or `+-`), which may be specified on its own (which is the standard POSIX usage) or may be stacked with preceding options (so `-x-` is equivalent to `-x --`). Options are not permitted to be stacked after `--` (so `-x-f` is an error), but note the GNU-style option form discussed above, where `--shwordsplit` is permitted and does not end option processing.

Except when the sh/ksh emulation single-letter options are in effect, the option `-b` (or `+b`) ends option processing. `-b` is like `--`, except that further single-letter options can be stacked after the `-b` and will take effect as normal.

## Compatibility

Zsh tries to emulate sh or ksh when it is invoked as `sh` or `ksh` respectively; more precisely, it looks at the first letter of the name by which it was invoked, and if that is `b`, `s` or `k` it will emulate sh or ksh. Furthermore, if invoked as `su` (which happens on certain systems when the shell is executed by the `su` command), the shell will try to find an alternative name from the `SHELL` environment variable and perform emulation based on that.

In sh and ksh compatibility modes the following parameters are not special and not initialized by the shell: `ARGC`, `argv`, `cdpath`, `fignore`, `fpath`, `HISTCHARS`, `mailpath`, `MANPATH`, `manpath`, `path`, `prompt`, `PROMPT`, `PROMPT2`, `PROMPT3`, `PROMPT4`, `psvar`, `status`.

The usual zsh startup/shutdown scripts are not executed. Login shells source `/etc/profile` followed by `$HOME/.profile`. If the `ENV` environment variable is set on invocation, `$ENV` is sourced after the profile scripts. The value of `ENV` is subjected to parameter expansion, command substitution, and arithmetic expansion before being interpreted as a pathname. Note that the `PRIVILEGED` option also affects the execution of startup files.

The following options are set if the shell is invoked as `sh` or `ksh`: `NO_BAD_PATTERN`, `NO_BANG_HIST`, `NO_BG_NICE`, `NO_EQUALS`, `NO_FUNCTION_ARGZERO`, `GLOB_SUBST`, `NO_GLOBAL_EXPORT`, `NO_HUP`, `INTERACTIVE_COMMENTS`, `KSH_ARRAYS`, `NO_MULTIOS`, `NO_NOMATCH`, `NO_NOTIFY`, `POSIX_BUILTINS`, `NO_PROMPT_PERCENT`, `RM_STAR_SILENT`, `SH_FILE_EXPANSION`, `SH_GLOB`, `SH_OPTION_LETTERS`, `SH_WORD_SPLIT`. Additionally the `BSD_ECHO` and `IGNORE_BRACES` options are set if zsh is invoked as `sh`. Also, the `KSH_OPTION_PRINT`, `LOCAL_OPTIONS`, `PROMPT_BANG`, `PROMPT_SUBST` and `SINGLE_LINE_ZLE` options are set if zsh is invoked as `ksh`.

Please note that, whilst reasonable efforts are taken to address incompatibilities when they arise, zsh does not guarantee complete emulation of other shells, nor POSIX compliance. For more information on the differences between zsh and other shells, please refer to chapter 2 of the shell FAQ, https://www.zsh.org/FAQ/.

## Files

## See Also

sh(1), csh(1), tcsh(1), rc(1), bash(1), ksh(1).

IEEE Standard for information Technology - Portable Operating System Interface (POSIX) - Part 2: Shell and Utilities, IEEE Inc, 1993, ISBN 1-55937-255-9.