forked from rvm/rvm
/
README
126 lines (103 loc) · 6.52 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
Usage
rvm [Flags] [Options] Action [Implementation[,Implementation[,...]]
Flags
--head - with update, updates rvm to git head version.
--rubygems - with update, updates rubygems for selected ruby
--default - with 'rvm use X', sets the default ruby for new shells to X.
--debug - Toggle debug mode on for very verbose output.
--trace - Toggle trace mode on to see EVERYTHING rvm is doing.
--force - Force install, removes old install & source before install.
--summary - Used with rubydo to print out a summary of the commands run.
--latest - with gemset --dump skips version strings for latest gem.
--gems - with uninstall/remove removes gems with the interpreter.
--docs - with install, attempt to generate ri after installation.
--reconfigure - Force ./configure on install even if Makefile already exists.
Options
-v|--version - Emit rvm version loaded for current shell
-l|--level - patch level to use with rvm use / install
--prefix - path for all rvm files (~/.rvm/), with trailing slash!
--bin - path for binaries to be placed (~/.rvm/bin/)
-S - Specify a script file to attempt to load and run (rubydo)
-e - Execute code from the command line.
--gems - Used to set the 'gems_flag', use with 'remove' to remove gems
--archive - Used to set the 'archive_flag', use with 'remove' to remove archive
--patch - With MRI Rubies you may specify one or more full paths to patches
for multiple, specify comma separated:
--patch /.../.../a.patch[%prefix],/.../.../.../b.patch
'prefix' is an optional argument, which will be bypassed
to the '-p' argument of the 'patch' command. It is separated
from patch file name with '%' symbol.
-C|--configure - custom configure options. If you need to pass several configure
options then append them comma separated: -C --...,--...,--...
--nice - process niceness (for slow computers, default 0)
--ree-options - Options passed directly to ree's './installer' on the command line.
--with-rubies - Specifies a string for rvm to attempt to expand for set operations.
Action
(Note that for most actions, 'rvm help action-name' may provide more information.)
* usage - show this usage information
version - show the rvm version installed in rvm_path
use - setup current shell to use a specific ruby version
reload - reload rvm source itself (useful after changing rvm source)
implode - (seppuku) removes the rvm installation completely.
This means everything in $rvm_path (~/.rvm).
This does not touch your profiles, which is why
there is an if around the sourcing scripts/rvm.
update - upgrades rvm to the latest version.
(If you experience bugs try this first with --head)
reset - remove current and stored default & system settings.
(If you experience odd behavior try this second)
info - show the *current* environment information for current ruby
debug - show info plus additional information for common issues
install - install one or many ruby versions
See also: http://rvm.beginrescueend.com/rubies/installing/
uninstall - uninstall one or many ruby versions, leaves their sources
remove - uninstall one or many ruby versions and remove their sources
migrate - Lets you migrate all gemsets from one ruby to another.
upgrade - Lets you upgrade from one version of a ruby to another, including
migrating your gemsets semi-automatically.
wrapper - generates a set of wrapper executables for a given ruby with the
specified ruby and gemset combination. Used under the hood for
passenger support and the like.
cleanup - Lets you remove stale source folders / archives and other miscellaneous
data associated with rvm.
repair - Lets you repair parts of your environment e.g. wrappers, env files and
and similar files (e.g. general maintenance).
snapshot - Lets your backup / restore an rvm installation in a lightweight manner.
disk-usage - Tells you how much disk space rvm install is using.
tools - Provides general information about the ruby environment,
primarily useful when scripting rvm.
docs - Tools to make installing ri and rdoc documentation easier.
rvmrc - Tools related to managing rvmrc trust and loading.
exec - runs an arbitrary command as a set operation.
ruby - runs a named ruby file against specified and/or all rubies
gem - runs a gem command using selected ruby's 'gem'
rake - runs a rake task against specified and/or all rubies
tests - runs 'rake test' across selected ruby versions
specs - runs 'rake spec' across selected ruby versions
monitor - Monitor cwd for testing, run `rake {spec,test}` on changes.
gemset - gemsets: http://rvm.beginrescueend.com/gemsets/
rubygems - Lets you switch the installed version of rubygems for a given
1.8-compatible ruby.
gemdir - display the path to the current gem directory (GEM_HOME).
srcdir - display the path to rvm source directory (may be yanked)
fetch - Performs an archive / src fetch only of the selected ruby.
list - show currently installed rubies, interactive output.
http://rvm.beginrescueend.com/rubies/list/
package - Install a dependency package {readline,iconv,zlib,openssl}
http://rvm.beginrescueend.com/packages/
notes - Display notes, with operating system specifics.
Implementation
* ruby - MRI/YARV Ruby (The Gold Standard) {1.8.6,1.8.7,1.9.1,1.9.2...}
jruby - JRuby, Ruby interpreter on the Java Virtual Machine.
rbx - Rubinius
ree - Ruby Enterprise Edition, MRI Ruby with several custom
patches for performance, stability, and memory.
macruby - MacRuby, insanely fast, can make real apps (Mac OS X Only).
maglev - GemStone Ruby, awesome persistent ruby object store.
ironruby - IronRuby, NOT supported yet. Looking for volunteers to help.
system - use the system ruby (eg. pre-rvm state)
default - use rvm set default ruby and system if it hasn't been set.
http://rvm.beginrescueend.com/rubies/default/
Resources:
http://rvm.beginrescueend.com/
https://www.pivotaltracker.com/projects/26822