AX-ZSH: Alex' Modular ZSH Configuration
=======================================
-AX-ZSH is a modular configuration system for the Z shell. If provides sane
-defaults and is extendable by plugins.
+AX-ZSH is a modular configuration system for the Z shell (ZSH).
+It provides sane defaults and is extendable by plugins.
+Installation
+------------
-Configuration
--------------
+To install AX-ZSH, either download a source archive or use Git to clone it.
+Afterwards use the `install.sh` script inside of the source directory to set
+up the `~/.axzsh` directory.
+
+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>):
+
+ git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh
+
+Then run the installer script:
+
+ ~/.axzsh/install.sh
-AX-ZSH can be configured using settings in a `$HOME/.zshenv` file.
+The `install.sh` script creates symbolic links for `~/.zprofile`, `~/.zshrc`,
+`~/.zlogin`, and `~/.zlogout` (don't worry, already existing files are backed
+up).
-The following configuration variables are supported:
+Now close and restart all your running ZSH session to activate AX-ZSH.
-* `AXZSH_PLUGIN_D`: Optional directory for additional plugins.
-* `axzsh_default_plugins`: Array of default plugins, that will be loaded in
- addition to the core plugins. You can reset this array to disable(!) loading
- of these default plugins. Currently these plugins are loaded by default:
- * byebye
- * correction
- * grep
- * history
- * less
- * ls
- * prompt
- * ssh
- * std_aliases
- * std_env
- * std_options
-* `axzsh_plugins`: Optional array of addiutional (non-core and non-default)
- plugins to load.
+To update AX-ZSH run `axzshctl upgrade`.
-Example for a `$HOME/.zshenv` file:
+AX-ZSH & Local ZSH Configuration
+--------------------------------
-```
-# Add additinal custom plugin search path
-export AXZSH_PLUGIN_D="/opt/ax-zsh-plugins"
+Plugins are loaded when they are linked into the `$AXZSH/active_plugins/`
+directory; see the _Customization_ section below for how to activate them.
+
+Don't modify `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, or `~/.zlogout`! These
+are links to "AX-ZSH"-private files that can become overwritten when updating.
+
+You can use the following files for 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
+ 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
+-------------
-# Disable all default plugins
-axzsh_default_plugins=()
+Use the `axzshctl` tool to enable, disable, and reset plugins. AXZSH
+initializes an alias which points to the actual location in `~/.axzsh/bin/`.
-# Add additional plugins
-axzsh_plugins=(
- editor_select
- homebrew
-)
-```
+See `axzshctl --help` for details.
-Note: it should *not* be necessary to disable the default plugins! The above
-is an example only!
+You can link custom plugins stored in arbitrary directories using `axzshctl`
+by specifying the complete path name. Or you can place additional plugins into
+the `~/.axzsh/custom_plugins` folder which is searched by the `axzshctl` tool
+by default.
+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`
* `XDG_CACHE_HOME`
* `ZSH_CACHE_DIR`
projects / ax-zsh.git / blobdiff