prezto/runcoms/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][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
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-04 03:59:31 +02:00			`# Configuration Files`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`Zsh has several system-wide and user-local configuration files.`

general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			`Additionally, Prezto has one user-local configuration file.`
[Fix #253] Move Prezto settings into their own file 2012-09-03 22:38:18 +02:00
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00			`System-wide configuration files are installation-dependent but are installed`
general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			in _`/etc`_ by default.
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`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`
general: Miscellaneous documentation updates - Add missing documentation for options and environment variables - Rearrange definition and documentation of 'Options', 'Variables' and 'Aliases' in a consistent order 2018-10-12 10:55:55 +02:00			stored in the `$ZDOTDIR` environment variable. However, if said variable is
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00			`not defined, Zsh will use the user's home directory.`

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-04 03:59:31 +02:00			`## File Descriptions`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 2021-05-05 19:59:01 +02:00			`The [configuration files][1] are read in the following order:`

general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			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`_
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`### zshenv`

			`This file is sourced by all instances of Zsh, and thus, it should be kept as`
Correct spelling mistakes in READMEs 2012-06-12 21:13:21 +02:00			`small as possible and should only define environment variables.`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`### zprofile`

general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			`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`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00			`contain.`

general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			`_zprofile_ and _zlogin_ are not meant to be used together but can be done so.`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`### zshrc`

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-04 03:59:31 +02:00			`This file is sourced by interactive shells. It should define aliases, functions,`
			`shell options, and key bindings.`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
Fix heading level for "zpreztorc" 2013-11-29 23:34:34 +01:00			`### zpreztorc`
[Fix #253] Move Prezto settings into their own file 2012-09-03 22:38:18 +02:00
			`This file configures Prezto.`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`### zlogin`

general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			`This file is sourced by login shells after _zshrc_. Thus, it should contain`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00			`commands that need to execute at login. It is usually used for messages such as`
general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			[_`fortune`_][3], [_`msgs`_][4], or for the creation of files.
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
			`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`
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-04 03:59:31 +02:00			`displaying messages and for deletion of files.`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
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-04 03:59:31 +02:00			`## Authors`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
general: Reformat runcom documentation 2021-07-05 04:07:48 +02:00			`_The authors of these files should be contacted via the [issue tracker][5]._`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
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-04 03:59:31 +02:00			`- [Sorin Ionescu](https://github.com/sorin-ionescu)`
[#171] Add templates and README for all rc files 2012-05-22 18:49:45 +02:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements. 2021-05-05 19:59:01 +02:00			`[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`