diff options
Diffstat (limited to 'plugins/profiles')
| -rw-r--r-- | plugins/profiles/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/plugins/profiles/README.md b/plugins/profiles/README.md new file mode 100644 index 000000000..5aa1918e2 --- /dev/null +++ b/plugins/profiles/README.md @@ -0,0 +1,25 @@ +# profiles plugin + +This plugin allows you to create separate configuration files for zsh based +on your long hostname (including the domain). + +To use it, add profiles to the plugins array of your zshrc file: + +```sh +plugins=(... profiles) +``` + +It takes your `$HOST` variable and looks for files named according to the +domain parts in `$ZSH_CUSTOM/profiles/` directory. + +For example, for `HOST=host.domain.com`, it will try to load the following files, +in this order: + +```text +$ZSH_CUSTOM/profiles/com +$ZSH_CUSTOM/profiles/domain.com +$ZSH_CUSTOM/profiles/host.domain.com +``` + +This means that if there are conflicting settings on those files, the one to take +precedence will be the last applied, i.e. the one in host.domain.com. |