forked from rvm/rvm
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation built into rvm for wrapper
- Loading branch information
Showing
3 changed files
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,41 @@ | |||
|
|||
∴ rvm wrapper [ruby_string] [wrapper_prefix] [binary[ binary[ ...]]] | |||
|
|||
Where ruby_string is the ruby version and gemset combination to wrap, | |||
wrapper prefix is what to prepend to the name of the generated wrapper | |||
binaries and binaries is the names of the binaries you wish to provide | |||
a wrapper for (e.g. gem). | |||
|
|||
When no binaries are provided, rvm will by default generate wrappers for | |||
ruby, gem, rake, irb, rdoc, ri, and testrb. | |||
|
|||
Examples: | |||
|
|||
If you wish to provide an environment-specific wrapper for rspec with a | |||
rails 3 gemset, you could do: | |||
|
|||
∴ rvm --create ree@rails3 | |||
∴ rvm wrapper ree@rails3 r3 spec | |||
|
|||
Which would add r3_spec with the specified environment to your the bin | |||
directory where you installed rvm. | |||
|
|||
Alternatively, if you do: | |||
|
|||
∴ rvm wrapper ruby-1.9.2-head | |||
|
|||
It will create binaries named ruby,gem, rake, irb, rdoc, ri and tesrb | |||
in the rvm bin directory. | |||
|
|||
Finally, to show another real and common use, you can use wrapper | |||
to generate ruby executables and gems for passenger to use. Namely: | |||
|
|||
∴ rvm use ree@rails3 --passenger | |||
|
|||
is equivelant to: | |||
|
|||
∴ rvm use ree@rails3 | |||
∴ rvm wrapper ree@rails3 passenger | |||
|
|||
Which creates passenger_* binaries in the rvm bin directory using | |||
ree and the rails3 gemset. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters