diff options
| -rw-r--r-- | plugins/profiles/README.md | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/plugins/profiles/README.md b/plugins/profiles/README.md index b590a370f..5aa1918e2 100644 --- a/plugins/profiles/README.md +++ b/plugins/profiles/README.md @@ -1,21 +1,25 @@ # profiles plugin This plugin allows you to create separate configuration files for zsh based -on a domain of your host. +on your long hostname (including the domain). -It takes your `HOST` and looks for files named according to the domain parts -in `$ZSH_CUSTOM/profiles/` directory. +To use it, add profiles to the plugins array of your zshrc file: -For example, for `HOST=my.domain.com`, it will try to load the following files: +```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/my.domain.com -$ZSH_CUSTOM/profiles/domain.com $ZSH_CUSTOM/profiles/com +$ZSH_CUSTOM/profiles/domain.com +$ZSH_CUSTOM/profiles/host.domain.com ``` -To use it, add profiles to the plugins array of your zshrc file: - -```sh -plugins=(... profiles) -``` +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. |