AX-ZSH is a modular configuration system for the Z shell (ZSH).
It provides sane defaults and is extendable by plugins.
-
Installation
------------
When using Git it is best to directly clone the AX-ZSH repository into the
`~/.axzsh` directory and call `install.sh` from this location.
-Clone repository from _GitHub_ (https://github.com/alexbarton/ax-zsh):
+Clone repository from _GitHub_ (<https://github.com/alexbarton/ax-zsh>):
- $ git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh
+ git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh
Then run the installer script:
- $ ~/.axzsh/install.sh
+ ~/.axzsh/install.sh
The `install.sh` script creates symbolic links for `~/.zprofile`, `~/.zshrc`,
`~/.zlogin`, and `~/.zlogout` (don't worry, already existing files are backed
To update AX-ZSH run `axzshctl upgrade`.
-
AX-ZSH & Local ZSH Configuration
--------------------------------
1. AX-ZSH doesn't use `~/.zshenv` in any way. So you can use this file for your
own purposes (for example, to set up some environment variables that AX-ZSH
- relays on).
+ relies on).
2. AX-ZSH reads the optional files `~/.zprofile.local`, `~/.zshrc.local`,
`~/.zlogin.local`, and `~/.zlogout.local` after its own core initialization
files when present.
-
Customization
-------------
In addition you can set the `AXZSH_PLUGIN_D` variable (and `ZSH_CUSTOM` like
"OhMyZsh") to specify additional plugin search directories.
-
Environment Variables
---------------------
* `PS1`
* `SHORT_HOST`
* `TERM`
-* `XDG_RUNTIME_DIR`
+* `TMPDIR` (set and always ends with a "/")
* `XDG_CACHE_HOME`
+* `XDG_RUNTIME_DIR`
* `ZSH_CACHE_DIR`