From eaa682c0a64daad3138e6f08e7b6c8825700049f Mon Sep 17 00:00:00 2001 From: Lukasz Chrzaszcz Date: Thu, 24 Oct 2019 17:42:33 +0200 Subject: [PATCH 1/2] Add profiles documentation --- plugins/profiles/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 plugins/profiles/README.md diff --git a/plugins/profiles/README.md b/plugins/profiles/README.md new file mode 100644 index 000000000..b590a370f --- /dev/null +++ b/plugins/profiles/README.md @@ -0,0 +1,21 @@ +# profiles plugin + +This plugin allows you to create separate configuration files for zsh based +on a domain of your host. + +It takes your `HOST` and looks for files named according to the domain parts +in `$ZSH_CUSTOM/profiles/` directory. + +For example, for `HOST=my.domain.com`, it will try to load the following files: + +```text +$ZSH_CUSTOM/profiles/my.domain.com +$ZSH_CUSTOM/profiles/domain.com +$ZSH_CUSTOM/profiles/com +``` + +To use it, add profiles to the plugins array of your zshrc file: + +```sh +plugins=(... profiles) +``` From c1e5cbed5bbefbe09608581d0b47774652221780 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= Date: Fri, 25 Oct 2019 13:14:36 +0200 Subject: [PATCH 2/2] Fix order and reword some things --- plugins/profiles/README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 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. - -It takes your `HOST` and looks for files named according to the domain parts -in `$ZSH_CUSTOM/profiles/` directory. - -For example, for `HOST=my.domain.com`, it will try to load the following files: - -```text -$ZSH_CUSTOM/profiles/my.domain.com -$ZSH_CUSTOM/profiles/domain.com -$ZSH_CUSTOM/profiles/com -``` +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.