github/pyenv
1
0
Fork 0
mirror of https://github.com/pyenv/pyenv.git synced 2025-02-17 21:23:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Style

Browse source
This commit is contained in:
Sam Stephenson 2011-09-28 13:35:17 -05:00
parent dc1f583903
commit 4965a1d1f7
2 changed files with 24 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -177,12 +177,10 @@ profile is doing.
`rbenv init` is the only command that crosses the line of loading `rbenv init` is the only command that crosses the line of loading
extra commands into your shell. Coming from rvm, some of you might be extra commands into your shell. Coming from rvm, some of you might be
opposed to this idea. opposed to this idea. Here's what `rbenv init` actually does:
Heres what `rbenv init` actually does:
1. Sets up your shims path. This is the only requirement for rbenv to 1. Sets up your shims path. This is the only requirement for rbenv to
functional properly. You can do this by hand by prepending function properly. You can do this by hand by prepending
`~/.rbenv/shims` to your `$PATH`. `~/.rbenv/shims` to your `$PATH`.
2. Installs autocompletion. This is entirely optional but pretty 2. Installs autocompletion. This is entirely optional but pretty
@ -190,18 +188,19 @@ Heres what `rbenv init` actually does:
up. There is also a `~/.rbenv/completions/rbenv.zsh` for Zsh up. There is also a `~/.rbenv/completions/rbenv.zsh` for Zsh
users. users.
3. Initial rehash. From time to time you'll need to rebuild you're 3. Rehashes shims. From time to time you'll need to rebuild your
shim files. Doing this on init makes sure everything is up to shim files. Doing this on init makes sure everything is up to
date. `rbenv rehash` can always be ran manually. date. You can always run `rbenv rehash` manually.
4. Install sh dispatcher. This bit is also optional but allows rbenv 4. Installs the sh dispatcher. This bit is also optional, but allows
and plugins to change variables in your current shell. This makes rbenv and plugins to change variables in your current shell, making
commands like `rbenv shell` possible. This doesn't do anything commands like `rbenv shell` possible. The sh dispatcher doesn't do
crazy like override `cd` or hack your shell prompt. But for some anything crazy like override `cd` or hack your shell prompt, but if
reason you may need `rbenv` to be a real script rather than a shell for some reason you need `rbenv` to be a real script rather than a
function. shell function, you can safely skip it.
Run `rbenv init -` for yourself to see exactly whats its doing. Run `rbenv init -` for yourself to see exactly what happens under the
hood.
## <a name="section_3"></a> 3 Usage ## <a name="section_3"></a> 3 Usage

25
doc/README.mdtoc
View file

@ -158,12 +158,10 @@ profile is doing.
`rbenv init` is the only command that crosses the line of loading `rbenv init` is the only command that crosses the line of loading
extra commands into your shell. Coming from rvm, some of you might be extra commands into your shell. Coming from rvm, some of you might be
opposed to this idea. opposed to this idea. Here's what `rbenv init` actually does:
Heres what `rbenv init` actually does:
1. Sets up your shims path. This is the only requirement for rbenv to 1. Sets up your shims path. This is the only requirement for rbenv to
functional properly. You can do this by hand by prepending function properly. You can do this by hand by prepending
`~/.rbenv/shims` to your `$PATH`. `~/.rbenv/shims` to your `$PATH`.
2. Installs autocompletion. This is entirely optional but pretty 2. Installs autocompletion. This is entirely optional but pretty
@ -171,18 +169,19 @@ Heres what `rbenv init` actually does:
up. There is also a `~/.rbenv/completions/rbenv.zsh` for Zsh up. There is also a `~/.rbenv/completions/rbenv.zsh` for Zsh
users. users.
3. Initial rehash. From time to time you'll need to rebuild you're 3. Rehashes shims. From time to time you'll need to rebuild your
shim files. Doing this on init makes sure everything is up to shim files. Doing this on init makes sure everything is up to
date. `rbenv rehash` can always be ran manually. date. You can always run `rbenv rehash` manually.
4. Install sh dispatcher. This bit is also optional but allows rbenv 4. Installs the sh dispatcher. This bit is also optional, but allows
and plugins to change variables in your current shell. This makes rbenv and plugins to change variables in your current shell, making
commands like `rbenv shell` possible. This doesn't do anything commands like `rbenv shell` possible. The sh dispatcher doesn't do
crazy like override `cd` or hack your shell prompt. But for some anything crazy like override `cd` or hack your shell prompt, but if
reason you may need `rbenv` to be a real script rather than a shell for some reason you need `rbenv` to be a real script rather than a
function. shell function, you can safely skip it.
Run `rbenv init -` for yourself to see exactly whats its doing. Run `rbenv init -` for yourself to see exactly what happens under the
hood.
## Usage ## ## Usage ##