summaryrefslogtreecommitdiff
path: root/plugins/profiles
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-11-06 19:55:59 -0700
committerTuowen Zhao <ztuowen@gmail.com>2019-11-06 19:55:59 -0700
commit1ffd2849fc056dced0c80a9ed8905f29ff9827a5 (patch)
tree41cff93f7b8d713d1500da68f0f670187ca86740 /plugins/profiles
parent2e9fe98b8a9fe21b982e719e129678dede63771e (diff)
parent107e512c9e62b140d8591c578527c901b1db9d37 (diff)
downloadzsh-1ffd2849fc056dced0c80a9ed8905f29ff9827a5.tar.gz
zsh-1ffd2849fc056dced0c80a9ed8905f29ff9827a5.tar.bz2
zsh-1ffd2849fc056dced0c80a9ed8905f29ff9827a5.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/profiles')
-rw-r--r--plugins/profiles/README.md25
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.