Skip to content

Commit

Permalink
README.md to include the named dirs description.
Browse files Browse the repository at this point in the history
  • Loading branch information
psprint committed Sep 29, 2022
1 parent f74b030 commit c7e1ef0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1077,6 +1077,25 @@ zi as'null' lucid sbin wait'1' for \

Target directory for installed files is `$ZPFX` (`~/.local/share/zinit/polaris` by default).

# Named directories for frequently used paths

Named directories are shorthands in the form of `~NAMED_DIR`
(upper case not required). Zinit provides a set of such
names for its frequently used paths:

- *~ZIDIR* β†’ `$ZINIT[HOME_DIR]` – the home directory for others, like `plugins`, `snippets`, etc.
- *~ZIPLUGS* β†’ `$ZINIT[PLUGINS_DIR]` – the `plugins` dir,
- *~ZISNIPS* β†’ `$ZINIT[SNIPPETS_DIR]` – the `snippets` dir,
- *~ZICOMPS* β†’ `$ZINIT[COMPLETIONS_DIR]` – the `completions` dir, where all
completion functions reside`
- *~ZISERV* β†’ `$ZINIT[SERVICES_DIR]` – the `services` work dir for all loaded
services,
- *~ZICACHE* β†’ `$ZSH_CACHE_DIR` – the cache dir, usually `~/.cache/zinit`,
- *~ZIBIN* β†’ `$ZINIT[BIN_DIR]` – the directory with Zinit's binary scripts,
- *~ZPFX* β†’ the standard prefix for all `configure` and `make` commands, usually
`~ZIDIR/polaris`.


## Changelog<a name="changelog"></a>

Link to the [CHANGELOG](doc/CHANGELOG.md).
Expand Down

0 comments on commit c7e1ef0

Please sign in to comment.