github/pyenv
1
0
Fork 0
mirror of https://github.com/pyenv/pyenv.git synced 2024-11-21 20:47:00 -05:00
Code Issues Projects Releases Packages Wiki Activity

Sync doc/README.mdtoc with the actual README

Browse source 
All the changes to documentation should be done in doc/README.mdtoc
This commit is contained in:
Guillermo Iguaran 2012-12-11 16:06:02 -05:00
parent fc3a634e22
commit 2df165c49e
1 changed files with 14 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
doc/README.mdtoc
View file

@ -44,11 +44,11 @@ tools that do one thing well.
rbenv operates on the per-user directory `~/.rbenv`. Version names in rbenv operates on the per-user directory `~/.rbenv`. Version names in
rbenv correspond to subdirectories of `~/.rbenv/versions`. For rbenv correspond to subdirectories of `~/.rbenv/versions`. For
example, you might have `~/.rbenv/versions/1.8.7-p354` and example, you might have `~/.rbenv/versions/1.8.7-p354` and
`~/.rbenv/versions/1.9.3-rc1`. `~/.rbenv/versions/1.9.3-p327`.
Each version is a working tree with its own binaries, like Each version is a working tree with its own binaries, like
`~/.rbenv/versions/1.8.7-p354/bin/ruby` and `~/.rbenv/versions/1.8.7-p354/bin/ruby` and
`~/.rbenv/versions/1.9.3-rc1/bin/irb`. rbenv makes _shim binaries_ `~/.rbenv/versions/1.9.3-p327/bin/irb`. rbenv makes _shim binaries_
for every such binary across all installed versions of Ruby. for every such binary across all installed versions of Ruby.
These shims are simple wrapper scripts that live in `~/.rbenv/shims` These shims are simple wrapper scripts that live in `~/.rbenv/shims`
@ -73,8 +73,7 @@ easy to fork and contribute any changes back upstream.
1. Check out rbenv into `~/.rbenv`. 1. Check out rbenv into `~/.rbenv`.
$ cd $ git clone git://github.com/sstephenson/rbenv.git ~/.rbenv
$ git clone git://github.com/sstephenson/rbenv.git .rbenv
2. Add `~/.rbenv/bin` to your `$PATH` for access to the `rbenv` 2. Add `~/.rbenv/bin` to your `$PATH` for access to the `rbenv`
command-line utility. command-line utility.
@ -95,9 +94,9 @@ easy to fork and contribute any changes back upstream.
$ exec $SHELL $ exec $SHELL
5. Install Ruby versions into `~/.rbenv/versions`. For example, to 5. Install Ruby versions into `~/.rbenv/versions`. For example, to
install Ruby 1.9.2-p290, download and unpack the source, then run: install Ruby 1.9.3-p327, download and unpack the source, then run:
$ ./configure --prefix=$HOME/.rbenv/versions/1.9.2-p290 $ ./configure --prefix=$HOME/.rbenv/versions/1.9.3-p327
$ make $ make
$ make install $ make install
@ -105,7 +104,7 @@ easy to fork and contribute any changes back upstream.
provides an `rbenv install` command that simplifies the process of provides an `rbenv install` command that simplifies the process of
installing new Ruby versions to: installing new Ruby versions to:
$ rbenv install 1.9.2-p290 $ rbenv install 1.9.3-p327
6. Rebuild the shim binaries. You should do this any time you install 6. Rebuild the shim binaries. You should do this any time you install
a new Ruby binary (for example, when installing a new Ruby version, a new Ruby binary (for example, when installing a new Ruby version,
@ -195,7 +194,7 @@ the version name to the `~/.rbenv/version` file. This version can be
overridden by a per-project `.rbenv-version` file, or by setting the overridden by a per-project `.rbenv-version` file, or by setting the
`RBENV_VERSION` environment variable. `RBENV_VERSION` environment variable.
$ rbenv global 1.9.2-p290 $ rbenv global 1.9.3-p327
The special version name `system` tells rbenv to use the system Ruby The special version name `system` tells rbenv to use the system Ruby
(detected by searching your `$PATH`). (detected by searching your `$PATH`).
@ -224,7 +223,7 @@ Sets a shell-specific Ruby version by setting the `RBENV_VERSION`
environment variable in your shell. This version overrides both environment variable in your shell. This version overrides both
project-specific versions and the global version. project-specific versions and the global version.
$ rbenv shell jruby-1.6.4 $ rbenv shell jruby-1.7.1
When run without a version number, `rbenv shell` reports the current When run without a version number, `rbenv shell` reports the current
value of `RBENV_VERSION`. You can also unset the shell version: value of `RBENV_VERSION`. You can also unset the shell version:
@ -236,7 +235,7 @@ the installation instructions) in order to use this command. If you
prefer not to use shell integration, you may simply set the prefer not to use shell integration, you may simply set the
`RBENV_VERSION` variable yourself: `RBENV_VERSION` variable yourself:
$ export RBENV_VERSION=jruby-1.6.4 $ export RBENV_VERSION=jruby-1.7.1
### rbenv versions ### ### rbenv versions ###
@ -246,8 +245,8 @@ the currently active version.
$ rbenv versions $ rbenv versions
1.8.7-p352 1.8.7-p352
1.9.2-p290 1.9.2-p290
* 1.9.3-rc1 (set by /Users/sam/.rbenv/global) * 1.9.3-p327 (set by /Users/sam/.rbenv/global)
jruby-1.6.4 jruby-1.7.1
rbx-1.2.4 rbx-1.2.4
ree-1.8.7-2011.03 ree-1.8.7-2011.03
@ -273,15 +272,15 @@ Displays the full path to the binary that rbenv will execute when you
run the given command. run the given command.
$ rbenv which irb $ rbenv which irb
/Users/sam/.rbenv/versions/1.9.2-p290/bin/irb /Users/sam/.rbenv/versions/1.9.3-p327/bin/irb
### rbenv whence ### ### rbenv whence ###
Lists all Ruby versions with the given command installed. Lists all Ruby versions with the given command installed.
$ rbenv whence rackup $ rbenv whence rackup
1.9.3-rc1 1.9.3-p327
jruby-1.6.4 jruby-1.7.1
ree-1.8.7-2011.03 ree-1.8.7-2011.03
## Development ## ## Development ##