README.md

   1 AX-ZSH: Alex' Modular ZSH Configuration
   2 =======================================
   3
   4 AX-ZSH is a modular configuration system for the Z shell. If provides sane
   5 defaults and is extendable by plugins.
   6
   7
   8 Configuration
   9 -------------
  10
  11 AX-ZSH can be configured using settings in a `$HOME/.zshenv` file.
  12
  13 The following configuration variables are supported:
  14
  15 * `AXZSH_PLUGIN_D`: Optional directory for additional plugins.
  16 * `axzsh_default_plugins`: Array of default plugins, that will be loaded in
  17   addition to the core plugins. You can reset this array to disable(!) loading
  18   of these default plugins. Currently these plugins are loaded by default:
  19    * byebye
  20    * completion
  21    * correction
  22    * history
  23    * ls
  24    * prompt
  25    * ssh
  26    * std_aliases
  27    * std_env
  28 * `axzsh_plugins`: Optional array of addiutional (non-core and non-default)
  29   plugins to load.
  30
  31 Example for a `$HOME/.zshenv` file:
  32
  33 ```
  34 # Add additinal custom plugin search path
  35 export AXZSH_PLUGIN_D="/opt/ax-zsh-plugins"
  36
  37 # Disable all default plugins
  38 typedef -U axzsh_default_plugins
  39 axzsh_default_plugins=()
  40
  41 # Add additional plugins
  42 typedef -U axzsh_plugins
  43 axzsh_plugins=(
  44         editor_select
  45         homebrew
  46 )
  47 ```
  48
  49 Note: it should *not* be necessary to disable the default plugins! The above
  50 is an example only!
  51
  52
  53 Environment Variables
  54 ---------------------
  55
  56 Expected to be already set:
  57
  58 * `HOME`
  59 * `LOGNAME`
  60
  61 Validated and/or set up by core plugins:
  62
  63 * `AXZSH`
  64 * `HOST`
  65 * `HOSTNAME` (same as HOST, deprecated)
  66 * `LOCAL_HOME`
  67 * `PS1`
  68 * `SHORT_HOST`
  69 * `TERM`
  70 * `XDG_CACHE_HOME`
  71 * `ZSH_CACHE_DIR`