mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-02 02:49:25 +00: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://').
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
8edc5e9323
commit
d80e393f78
@ -1,34 +1,32 @@
|
||||
Configuration Files
|
||||
===================
|
||||
# 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.
|
||||
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
|
||||
-----------------
|
||||
## 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
|
||||
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
|
||||
|
||||
@ -37,16 +35,16 @@ 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
|
||||
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 concurrently but can be done so.
|
||||
*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.
|
||||
This file is sourced by interactive shells. It should define aliases, functions,
|
||||
shell options, and key bindings.
|
||||
|
||||
### zpreztorc
|
||||
|
||||
@ -54,9 +52,9 @@ This file configures Prezto.
|
||||
|
||||
### zlogin
|
||||
|
||||
This file is sourced by login shells after zshrc, and thus, it should contain
|
||||
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.
|
||||
[*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.
|
||||
@ -64,16 +62,15 @@ 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 the deletion of files.
|
||||
displaying messages and for deletion of files.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of these files should be contacted via the [issue tracker][4].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: http://www.kornshell.com
|
||||
[2]: http://en.wikipedia.org/wiki/Fortune_(Unix)
|
||||
[3]: http://www.manpagez.com/man/1/msgs
|
||||
[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
|
||||
|
Reference in New Issue
Block a user