README.md

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