From 7ad01b2b485fb635d7a96daef33f6a733e5b1c80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 13 Mar 2015 01:14:24 -0700 Subject: [PATCH] Document rbenv environment variables Closes #699, fixes #666 [ci skip] --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 905cc02c..7cad9055 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ RVM?**](https://github.com/sstephenson/rbenv/wiki/Why-rbenv%3F) * [rbenv rehash](#rbenv-rehash) * [rbenv which](#rbenv-which) * [rbenv whence](#rbenv-whence) +* [Environment variables](#environment-variables) * [Development](#development) ## How It Works @@ -403,6 +404,18 @@ Lists all Ruby versions with the given command installed. jruby-1.7.1 ree-1.8.7-2011.03 +## Environment variables + +You can affect how rbenv operates with the following settings: + +name | default | description +-----|---------|------------ +`RBENV_VERSION` | | Specifies the Ruby version to be used.
Also see [`rbenv shell`](#rbenv-shell) +`RBENV_ROOT` | `~/.rbenv` | Defines the directory under which Ruby versions and shims reside.
Also see `rbenv root` +`RBENV_DEBUG` | | Outputs debug information.
Also as: `rbenv --debug ` +`RBENV_HOOK_PATH` | [_see wiki_][hooks] | Colon-separated list of paths searched for rbenv hooks. +`RBENV_DIR` | `$PWD` | Directory to start searching for `.ruby-version` files. + ## Development The rbenv source code is [hosted on @@ -419,3 +432,4 @@ tracker](https://github.com/sstephenson/rbenv/issues). [ruby-build]: https://github.com/sstephenson/ruby-build#readme + [hooks]: https://github.com/sstephenson/rbenv/wiki/Authoring-plugins#rbenv-hooks