summaryrefslogtreecommitdiff
path: root/plugins/pyenv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/pyenv/README.md')
-rw-r--r--plugins/pyenv/README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/plugins/pyenv/README.md b/plugins/pyenv/README.md
index d063b55b9..b9ee937b7 100644
--- a/plugins/pyenv/README.md
+++ b/plugins/pyenv/README.md
@@ -1,4 +1,4 @@
-# pyenv
+# pyenv
This plugin looks for [pyenv](https://github.com/pyenv/pyenv), a Simple Python version
management system, and loads it if it's found. It also loads pyenv-virtualenv, a pyenv
@@ -10,6 +10,14 @@ To use it, add `pyenv` to the plugins array in your zshrc file:
plugins=(... pyenv)
```
+## Settings
+
+- `ZSH_PYENV_QUIET`: if set to `true`, the plugin will not print any messages if it
+ finds that `pyenv` is not properly configured.
+
+- `ZSH_PYENV_VIRTUALENV`: if set to `false`, the plugin will not load pyenv-virtualenv
+ when it finds it.
+
## Functions
- `pyenv_prompt_info`: displays the Python version in use by pyenv; or the global Python