1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-11-20 08:31:13 +00:00
prezto/runcoms/README.md
2021-07-07 09:56:22 -05:00

78 lines
2.3 KiB
Markdown

# 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][1] 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][2] 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`_][3], [_`msgs`_][4], 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][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: http://zsh.sourceforge.net/Intro/intro_3.html#SEC3
[2]: https://www.kornshell.com
[3]: https://en.wikipedia.org/wiki/Fortune_(Unix)
[4]: https://www.manpagez.com/man/1/msgs
[5]: https://github.com/sorin-ionescu/prezto/issues