README.md

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