diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-10-25 13:15:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-25 13:15:12 +0200 |
| commit | ce52ee0252fbdaa4f741bf63e245ff6f68ca6d71 (patch) | |
| tree | e10b103df492b046b913caf3e6b6b8a468417533 /plugins | |
| parent | 36092aac0c3e1979caf4afb9fa9bd2115f404fc4 (diff) | |
| parent | c1e5cbed5bbefbe09608581d0b47774652221780 (diff) | |
| download | zsh-ce52ee0252fbdaa4f741bf63e245ff6f68ca6d71.tar.gz zsh-ce52ee0252fbdaa4f741bf63e245ff6f68ca6d71.tar.bz2 zsh-ce52ee0252fbdaa4f741bf63e245ff6f68ca6d71.zip | |
Add profiles documentation (#8311)
* Add profiles documentation
* Fix order and reword some things
Diffstat (limited to 'plugins')
| -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. |