1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2025-07-01 22:09:25 +00: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.
This commit is contained in:
Indrajit Raychaudhuri
2021-05-05 12:59:01 -05:00
committed by Indrajit Raychaudhuri
parent 424d4cb779
commit 1ff9421f7b
46 changed files with 434 additions and 337 deletions

View File

@ -14,19 +14,19 @@ not defined, Zsh will use the user's home directory.
## File Descriptions
The configuration files are read in the following order:
The [configuration files][1] 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. *`${ZDOTDIR:-$HOME}/.zshenv`*
03. *`/etc/zprofile`*
04. *`${ZDOTDIR:-$HOME}/.zprofile`*
05. *`/etc/zshrc`*
06. *`${ZDOTDIR:-$HOME}/.zshrc`*
07. *`${ZDOTDIR:-$HOME}/.zpreztorc`*
08. *`/etc/zlogin`*
09. *`${ZDOTDIR:-$HOME}/.zlogin`*
10. *`${ZDOTDIR:-$HOME}/.zlogout`*
11. *`/etc/zlogout`*
### zshenv
@ -36,7 +36,7 @@ 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
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.
@ -54,7 +54,7 @@ This file configures Prezto.
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*][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.
@ -66,11 +66,12 @@ displaying messages and for deletion of files.
## Authors
*The authors of these files should be contacted via the [issue tracker][4].*
*The authors of these files should be contacted via the [issue tracker][5].*
- [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
[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

View File

@ -52,7 +52,7 @@ zstyle ':prezto:load' pmodule \
# Completions
#
# Set the entries to ignore in static */etc/hosts* for host completion.
# Set the entries to ignore in static '/etc/hosts' for host completion.
# zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \
# '0.0.0.0' '127.0.0.1'