1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 21:58:00 +00:00
prezto/runcoms/README.md
Indrajit Raychaudhuri d80e393f78 general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should
also make markdown linting happier.

Prefer back-ticks wherever useful and use `console` for code blocks to
be executed on terminal.

Also, update references links wherever possible (including update from
'http://' to 'https://').
2021-05-05 12:21:04 -05:00

77 lines
2.1 KiB
Markdown

# Configuration Files
Zsh has several system-wide and user-local configuration files.
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:
01. */etc/zshenv*
02. *~/.zshenv*
03. */etc/zprofile*
04. *~/.zprofile*
05. */etc/zshrc*
06. *~/.zshrc*
07. *~/.zpreztorc*
08. */etc/zlogin*
09. *~/.zlogin*
10. *~/.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][1] 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*][2], [*msgs*][3], 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][4].*
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://www.kornshell.com
[2]: https://en.wikipedia.org/wiki/Fortune_(Unix)
[3]: https://www.manpagez.com/man/1/msgs
[4]: https://github.com/sorin-ionescu/prezto/issues