summaryrefslogtreecommitdiff
path: root/plugins/profiles/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-25 13:14:36 +0200
committerGitHub <noreply@github.com>2019-10-25 13:14:36 +0200
commitc1e5cbed5bbefbe09608581d0b47774652221780 (patch)
tree2eea04fbdfa35b0ae09c21db71ac9e2fb71f549f /plugins/profiles/README.md
parenteaa682c0a64daad3138e6f08e7b6c8825700049f (diff)
downloadzsh-c1e5cbed5bbefbe09608581d0b47774652221780.tar.gz
zsh-c1e5cbed5bbefbe09608581d0b47774652221780.tar.bz2
zsh-c1e5cbed5bbefbe09608581d0b47774652221780.zip
Fix order and reword some things
Diffstat (limited to 'plugins/profiles/README.md')
-rw-r--r--plugins/profiles/README.md26
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.