Skip to content
This repository
tree: 43a9269e37
Fetching contributors…

Cannot retrieve contributors at this time

file 264 lines (177 sloc) 6.13 kb
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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
RVM(1)
======


NAME
----
rvm - The Ruby Version Manager


SYNOPSIS
--------
*rvm* ['FLAGS'] ['OPTIONS'] 'ACTION' ['IMPLEMENTATION'[,'IMPLEMENTATION'[,'...']]


DESCRIPTION
-----------
RVM is a command line tool which allows us to easily install, manage and work
with multiple ruby environments from interpreters to sets of gems.


FLAGS
-----

*--head*::
    with update, updates rvm to git head version.

*--rubygems*::
    with update, updates rubygems for selected ruby

*--default*::
    with ruby select, sets a default ruby for new shells.

*--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

*--bin*::
    path for binaries to be placed ('~/.rvm/bin/')

*--source*::
    src directory to use ('~/.rvm/src/')

*--archives*::
    directory for downladed files ('~/.rvm/archives/')

*-S*::
    Specify a script file to attempt to load and run (rubydo).

*-e*::
    Execute code from the command line.

*-G*::
    root gem path to use

*--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*, *--patches*::
    With any ruby build from source, allows you to specify patch paths
    and patch names to be applied prior to building. Values should
    be a relative / absolute path to a patch or the name of known
    patch / patchset. Optionally, paths or names may be followed by
    '%someinteger' - e.g. '--patches mypatch%2' - where the number
    following the % specifies the value of the -p argument to patch,
    defaulting to two.

*-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.


ACTIONS
-------

*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).

*env*::
    Displays information about an environment specified but the
    given ruby string. Useful for getting a sourceable path or an
    evaluatable set of shell variable declarations.

*implode*::
    (seppuku) removes the rvm installation completely.
    This means everything in $rvm_path ('~/.rvm').
    This does not touch your profiles. However, this means that
    you must manually clean up your profiles and remove the lines
    which source 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.
    https://rvm.io/rubies/installing/

*uninstall*::
    Uninstall one or many ruby versions, leaves their sources.

*remove*::
    Uninstall one or many ruby versions and remove their sources.

*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.

*do \**::
    Runs the specified command 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: https://rvm.io/gemsets/

*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.
    https://rvm.io/rubies/list/

*pkg*::
    Install a dependency package {readline,iconv,zlib,openssl}.
    https://rvm.io/packages/

*notes*::
    Display notes, with operating system specifics.

*export*::
    Temporarily set an environment variable in the current shell.

*unexport*::
    Undo changes made to the environment by 'rvm export'.

*requirements*::
    Show additional OS specific dependencies/requirements for building various rubies.


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.
    https://rvm.io/rubies/default/


RESOURCES
---------

https://rvm.io/[Main web site]

https://www.pivotaltracker.com/projects/26822[Online issue-tracker]


COPYING
-------

Copyright (c) 2009 Wayne E. Seguin

See LICENCE file for details.

////
# vim:ft=asciidoc
////
Something went wrong with that request. Please try again.