You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alpha Chen 43a9d037dc
Merge remote-tracking branch 'upstream/master'
10 months ago
..
README.md general: Reformat runcom documentation 3 years ago
zlogin Fix zcompile race condition 2 years ago
zlogout Remove zlogout's Apu quote (#1583) 7 years ago
zpreztorc Merge remote-tracking branch 'upstream/master' 10 months ago
zprofile move orbstack configuration 10 months ago
zshenv PATH 1 year ago
zshrc profiling 10 months ago

README.md

Configuration Files

Zsh has several system-wide and user-local configuration files.

Additionally, Prezto has one user-local configuration file.

System-wide configuration files are installation-dependent but are installed in /etc by default.

User-local configuration files have the same name as their global counterparts but are prefixed with a dot (hidden). Zsh looks for these files in the path stored in the $ZDOTDIR environment variable. However, if said variable is not defined, Zsh will use the user's home directory.

File Descriptions

The configuration files are read in the following order:

  1. /etc/zshenv
  2. ${ZDOTDIR:-$HOME}/.zshenv
  3. /etc/zprofile
  4. ${ZDOTDIR:-$HOME}/.zprofile
  5. /etc/zshrc
  6. ${ZDOTDIR:-$HOME}/.zshrc
  7. ${ZDOTDIR:-$HOME}/.zpreztorc
  8. /etc/zlogin
  9. ${ZDOTDIR:-$HOME}/.zlogin
  10. ${ZDOTDIR:-$HOME}/.zlogout
  11. /etc/zlogout

zshenv

This file is sourced by all instances of Zsh, and thus, it should be kept as small as possible and should only define environment variables.

zprofile

This file is similar to zlogin, but it is sourced before zshrc. It was added for KornShell fans. See the description of zlogin below for what it may contain.

zprofile and zlogin are not meant to be used together but can be done so.

zshrc

This file is sourced by interactive shells. It should define aliases, functions, shell options, and key bindings.

zpreztorc

This file configures Prezto.

zlogin

This file is sourced by login shells after zshrc. Thus, it should contain commands that need to execute at login. It is usually used for messages such as fortune, msgs, or for the creation of files.

This is not the file to define aliases, functions, shell options, and key bindings. It should not change the shell environment.

zlogout

This file is sourced by login shells during logout. It should be used for displaying messages and for deletion of files.

Authors

The authors of these files should be contacted via the issue tracker.