diff options
| author | Lukasz Chrzaszcz <lukasz.chrzaszcz@allegro.pl> | 2019-10-24 17:42:33 +0200 |
|---|---|---|
| committer | Lukasz Chrzaszcz <lukasz.chrzaszcz@allegro.pl> | 2019-10-24 17:42:33 +0200 |
| commit | eaa682c0a64daad3138e6f08e7b6c8825700049f (patch) | |
| tree | e4b576655024562e0dd2898cea27d7a83f7f5128 /plugins/profiles/README.md | |
| parent | 40df67bc3b9b51caa24df5d220487043040d1f9a (diff) | |
| download | zsh-eaa682c0a64daad3138e6f08e7b6c8825700049f.tar.gz zsh-eaa682c0a64daad3138e6f08e7b6c8825700049f.tar.bz2 zsh-eaa682c0a64daad3138e6f08e7b6c8825700049f.zip | |
Add profiles documentation
Diffstat (limited to 'plugins/profiles/README.md')
| -rw-r--r-- | plugins/profiles/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
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) +``` |