Skip to content
This repository
Browse code

README.

  • Loading branch information...
commit e34f22d0abbc954b0eea9bcc9001a1b5840f08a3 1 parent da39010
Wayne E. Seguin authored

Showing 3 changed files with 166 additions and 165 deletions. Show diff stats Hide diff stats

  1. +165 0 README
  2. +0 165 README.txt
  3. +1 0  README.txt
165 README
... ... @@ -0,0 +1,165 @@
  1 += rvm
  2 +
  3 +* http://github.com/wayneeseguin/rvm
  4 +
  5 +== DESCRIPTION:
  6 +
  7 +RVM is the Ruby Version Manager (rvm). It manages Ruby interpreter
  8 +environments and switching between them.
  9 +
  10 +== Usage
  11 +
  12 + rvm [Flags] [Options] Action [Implementation[,Implementation[,...]]
  13 +
  14 +== Flags
  15 +
  16 + --default - with 'rvm use X', sets the default ruby for new shells to X.
  17 + --debug - Toggle debug mode on for very verbose output.
  18 + --trace - Toggle trace mode on to see EVERYTHING rvm is doing.
  19 + --force - Force install, removes old install & source before install.
  20 + --summary - Used with rubydo to print out a summary of the commands run.
  21 + --latest - with gemset --dump skips version strings for latest gem.
  22 + --gems - with uninstall/remove removes gems with the interpreter.
  23 + --docs - with install, attempt to generate ri after installation.
  24 + --reconfigure - Force ./configure on install even if Makefile already exists.
  25 +
  26 +== Options
  27 +
  28 + -v|--version - Emit rvm version loaded for current shell
  29 + -l|--level - patch level to use with rvm use / install
  30 + --prefix - path for all rvm files (~/.rvm/), with trailing slash!
  31 + --bin - path for binaries to be placed (~/.rvm/bin/)
  32 + -S - Specify a script file to attempt to load and run (rubydo)
  33 + -e - Execute code from the command line.
  34 + --gems - Used to set the 'gems_flag', use with 'remove' to remove gems
  35 + --archive - Used to set the 'archive_flag', use with 'remove' to remove archive
  36 + --patch - With MRI Rubies you may specify one or more full paths to patches
  37 + for multiple, specify comma separated:
  38 + --patch /.../.../a.patch[%prefix],/.../.../.../b.patch
  39 + 'prefix' is an optional argument, which will be bypassed
  40 + to the '-p' argument of the 'patch' command. It is separated
  41 + from patch file name with '%' symbol.
  42 + -C|--configure - custom configure options. If you need to pass several configure
  43 + options then append them comma separated: -C --...,--...,--...
  44 + --nice - process niceness (for slow computers, default 0)
  45 + --ree-options - Options passed directly to ree's './installer' on the command line.
  46 + --with-rubies - Specifies a string for rvm to attempt to expand for set operations.
  47 +
  48 +== Action
  49 +
  50 + (Note that for most actions, 'rvm help action-name' may provide more information.)
  51 +
  52 + * usage - show this usage information
  53 + version - show the rvm version installed in rvm_path
  54 + use - setup current shell to use a specific ruby version
  55 + reload - reload rvm source itself (useful after changing rvm source)
  56 + implode - (seppuku) removes the rvm installation completely.
  57 + This means everything in $rvm_path (~/.rvm).
  58 + This does not touch your profiles, which is why
  59 + there is an if around the sourcing scripts/rvm.
  60 + update - upgrades rvm to the latest version.
  61 + (If you experience bugs try this first with --head)
  62 + reset - remove current and stored default & system settings.
  63 + (If you experience odd behavior try this second)
  64 + info - show the *current* environment information for current ruby
  65 + current - print the *current* ruby version and the name of any gemset being used.
  66 + debug - show info plus additional information for common issues
  67 +
  68 + install - install one or many ruby versions
  69 + See also: http://rvm.beginrescueend.com/rubies/installing/
  70 + uninstall - uninstall one or many ruby versions, leaves their sources
  71 + remove - uninstall one or many ruby versions and remove their sources
  72 +
  73 + migrate - Lets you migrate all gemsets from one ruby to another.
  74 + upgrade - Lets you upgrade from one version of a ruby to another, including
  75 + migrating your gemsets semi-automatically.
  76 +
  77 + wrapper - generates a set of wrapper executables for a given ruby with the
  78 + specified ruby and gemset combination. Used under the hood for
  79 + passenger support and the like.
  80 +
  81 + cleanup - Lets you remove stale source folders / archives and other miscellaneous
  82 + data associated with rvm.
  83 + repair - Lets you repair parts of your environment e.g. wrappers, env files and
  84 + and similar files (e.g. general maintenance).
  85 + snapshot - Lets your backup / restore an rvm installation in a lightweight manner.
  86 +
  87 + disk-usage - Tells you how much disk space rvm install is using.
  88 + tools - Provides general information about the ruby environment,
  89 + primarily useful when scripting rvm.
  90 + docs - Tools to make installing ri and rdoc documentation easier.
  91 + rvmrc - Tools related to managing rvmrc trust and loading.
  92 +
  93 + exec - runs an arbitrary command as a set operation.
  94 + ruby - runs a named ruby file against specified and/or all rubies
  95 + gem - runs a gem command using selected ruby's 'gem'
  96 + rake - runs a rake task against specified and/or all rubies
  97 + tests - runs 'rake test' across selected ruby versions
  98 + specs - runs 'rake spec' across selected ruby versions
  99 + monitor - Monitor cwd for testing, run `rake {spec,test}` on changes.
  100 +
  101 + gemset - gemsets: http://rvm.beginrescueend.com/gemsets/
  102 +
  103 + rubygems - Switches the installed version of rubygems for the current ruby.
  104 +
  105 + gemdir - display the path to the current gem directory (GEM_HOME).
  106 + srcdir - display the path to rvm source directory (may be yanked)
  107 +
  108 + fetch - Performs an archive / src fetch only of the selected ruby.
  109 + list - show currently installed rubies, interactive output.
  110 + http://rvm.beginrescueend.com/rubies/list/
  111 + package - Install a dependency package {readline,iconv,zlib,openssl}
  112 + http://rvm.beginrescueend.com/packages/
  113 + notes - Display notes, with operating system specifics.
  114 +
  115 + export - Temporarily set an environment variable in the current shell.
  116 + unexport - Undo changes made to the environment by 'rvm export'.
  117 +
  118 +== Implementation
  119 +
  120 + * ruby - MRI/YARV Ruby (The Gold Standard) {1.8.6,1.8.7,1.9.1,1.9.2...}
  121 + jruby - JRuby, Ruby interpreter on the Java Virtual Machine.
  122 + rbx - Rubinius
  123 + ree - Ruby Enterprise Edition, MRI Ruby with several custom
  124 + patches for performance, stability, and memory.
  125 + macruby - MacRuby, insanely fast, can make real apps (Mac OS X Only).
  126 + maglev - GemStone Ruby, awesome persistent ruby object store.
  127 + ironruby - IronRuby, NOT supported yet. Looking for volunteers to help.
  128 + system - use the system ruby (eg. pre-rvm state)
  129 + default - use rvm set default ruby and system if it hasn't been set.
  130 + http://rvm.beginrescueend.com/rubies/default/
  131 +
  132 +== Resources:
  133 +
  134 + http://rvm.beginrescueend.com/
  135 + https://www.pivotaltracker.com/projects/26822
  136 +
  137 +== Contributions:
  138 +
  139 + Any and all contributions offered in any form, past present or future, to the
  140 + RVM project are understood to be in complete agreement and acceptance with the
  141 + Apache Licence v2.0.
  142 +
  143 +== INSTALL:
  144 +
  145 +See http://rvm.beginrescueend.com/rvm/install/
  146 +
  147 +or just use:
  148 +
  149 + bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-latest )
  150 +
  151 +== LICENSE:
  152 +
  153 +Copyright (c) 2009-2011 Wayne E. Seguin
  154 +
  155 +Licensed under the Apache License, Version 2.0 (the "License");
  156 +you may not use this file except in compliance with the License.
  157 +You may obtain a copy of the License at
  158 +
  159 + http://www.apache.org/licenses/LICENSE-2.0
  160 +
  161 +Unless required by applicable law or agreed to in writing, software
  162 +distributed under the License is distributed on an "AS IS" BASIS,
  163 +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  164 +See the License for the specific language governing permissions and
  165 +limitations under the License.
165 README.txt
... ... @@ -1,165 +0,0 @@
1   -= rvm
2   -
3   -* http://github.com/wayneeseguin/rvm
4   -
5   -== DESCRIPTION:
6   -
7   -RVM is the Ruby Version Manager (rvm). It manages Ruby interpreter
8   -environments and switching between them.
9   -
10   -== Usage
11   -
12   - rvm [Flags] [Options] Action [Implementation[,Implementation[,...]]
13   -
14   -== Flags
15   -
16   - --default - with 'rvm use X', sets the default ruby for new shells to X.
17   - --debug - Toggle debug mode on for very verbose output.
18   - --trace - Toggle trace mode on to see EVERYTHING rvm is doing.
19   - --force - Force install, removes old install & source before install.
20   - --summary - Used with rubydo to print out a summary of the commands run.
21   - --latest - with gemset --dump skips version strings for latest gem.
22   - --gems - with uninstall/remove removes gems with the interpreter.
23   - --docs - with install, attempt to generate ri after installation.
24   - --reconfigure - Force ./configure on install even if Makefile already exists.
25   -
26   -== Options
27   -
28   - -v|--version - Emit rvm version loaded for current shell
29   - -l|--level - patch level to use with rvm use / install
30   - --prefix - path for all rvm files (~/.rvm/), with trailing slash!
31   - --bin - path for binaries to be placed (~/.rvm/bin/)
32   - -S - Specify a script file to attempt to load and run (rubydo)
33   - -e - Execute code from the command line.
34   - --gems - Used to set the 'gems_flag', use with 'remove' to remove gems
35   - --archive - Used to set the 'archive_flag', use with 'remove' to remove archive
36   - --patch - With MRI Rubies you may specify one or more full paths to patches
37   - for multiple, specify comma separated:
38   - --patch /.../.../a.patch[%prefix],/.../.../.../b.patch
39   - 'prefix' is an optional argument, which will be bypassed
40   - to the '-p' argument of the 'patch' command. It is separated
41   - from patch file name with '%' symbol.
42   - -C|--configure - custom configure options. If you need to pass several configure
43   - options then append them comma separated: -C --...,--...,--...
44   - --nice - process niceness (for slow computers, default 0)
45   - --ree-options - Options passed directly to ree's './installer' on the command line.
46   - --with-rubies - Specifies a string for rvm to attempt to expand for set operations.
47   -
48   -== Action
49   -
50   - (Note that for most actions, 'rvm help action-name' may provide more information.)
51   -
52   - * usage - show this usage information
53   - version - show the rvm version installed in rvm_path
54   - use - setup current shell to use a specific ruby version
55   - reload - reload rvm source itself (useful after changing rvm source)
56   - implode - (seppuku) removes the rvm installation completely.
57   - This means everything in $rvm_path (~/.rvm).
58   - This does not touch your profiles, which is why
59   - there is an if around the sourcing scripts/rvm.
60   - update - upgrades rvm to the latest version.
61   - (If you experience bugs try this first with --head)
62   - reset - remove current and stored default & system settings.
63   - (If you experience odd behavior try this second)
64   - info - show the *current* environment information for current ruby
65   - current - print the *current* ruby version and the name of any gemset being used.
66   - debug - show info plus additional information for common issues
67   -
68   - install - install one or many ruby versions
69   - See also: http://rvm.beginrescueend.com/rubies/installing/
70   - uninstall - uninstall one or many ruby versions, leaves their sources
71   - remove - uninstall one or many ruby versions and remove their sources
72   -
73   - migrate - Lets you migrate all gemsets from one ruby to another.
74   - upgrade - Lets you upgrade from one version of a ruby to another, including
75   - migrating your gemsets semi-automatically.
76   -
77   - wrapper - generates a set of wrapper executables for a given ruby with the
78   - specified ruby and gemset combination. Used under the hood for
79   - passenger support and the like.
80   -
81   - cleanup - Lets you remove stale source folders / archives and other miscellaneous
82   - data associated with rvm.
83   - repair - Lets you repair parts of your environment e.g. wrappers, env files and
84   - and similar files (e.g. general maintenance).
85   - snapshot - Lets your backup / restore an rvm installation in a lightweight manner.
86   -
87   - disk-usage - Tells you how much disk space rvm install is using.
88   - tools - Provides general information about the ruby environment,
89   - primarily useful when scripting rvm.
90   - docs - Tools to make installing ri and rdoc documentation easier.
91   - rvmrc - Tools related to managing rvmrc trust and loading.
92   -
93   - exec - runs an arbitrary command as a set operation.
94   - ruby - runs a named ruby file against specified and/or all rubies
95   - gem - runs a gem command using selected ruby's 'gem'
96   - rake - runs a rake task against specified and/or all rubies
97   - tests - runs 'rake test' across selected ruby versions
98   - specs - runs 'rake spec' across selected ruby versions
99   - monitor - Monitor cwd for testing, run `rake {spec,test}` on changes.
100   -
101   - gemset - gemsets: http://rvm.beginrescueend.com/gemsets/
102   -
103   - rubygems - Switches the installed version of rubygems for the current ruby.
104   -
105   - gemdir - display the path to the current gem directory (GEM_HOME).
106   - srcdir - display the path to rvm source directory (may be yanked)
107   -
108   - fetch - Performs an archive / src fetch only of the selected ruby.
109   - list - show currently installed rubies, interactive output.
110   - http://rvm.beginrescueend.com/rubies/list/
111   - package - Install a dependency package {readline,iconv,zlib,openssl}
112   - http://rvm.beginrescueend.com/packages/
113   - notes - Display notes, with operating system specifics.
114   -
115   - export - Temporarily set an environment variable in the current shell.
116   - unexport - Undo changes made to the environment by 'rvm export'.
117   -
118   -== Implementation
119   -
120   - * ruby - MRI/YARV Ruby (The Gold Standard) {1.8.6,1.8.7,1.9.1,1.9.2...}
121   - jruby - JRuby, Ruby interpreter on the Java Virtual Machine.
122   - rbx - Rubinius
123   - ree - Ruby Enterprise Edition, MRI Ruby with several custom
124   - patches for performance, stability, and memory.
125   - macruby - MacRuby, insanely fast, can make real apps (Mac OS X Only).
126   - maglev - GemStone Ruby, awesome persistent ruby object store.
127   - ironruby - IronRuby, NOT supported yet. Looking for volunteers to help.
128   - system - use the system ruby (eg. pre-rvm state)
129   - default - use rvm set default ruby and system if it hasn't been set.
130   - http://rvm.beginrescueend.com/rubies/default/
131   -
132   -== Resources:
133   -
134   - http://rvm.beginrescueend.com/
135   - https://www.pivotaltracker.com/projects/26822
136   -
137   -== Contributions:
138   -
139   - Any and all contributions offered in any form, past present or future, to the
140   - RVM project are understood to be in complete agreement and acceptance with the
141   - Apache Licence v2.0.
142   -
143   -== INSTALL:
144   -
145   -See http://rvm.beginrescueend.com/rvm/install/
146   -
147   -or just use:
148   -
149   - bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-latest )
150   -
151   -== LICENSE:
152   -
153   -Copyright (c) 2009-2011 Wayne E. Seguin
154   -
155   -Licensed under the Apache License, Version 2.0 (the "License");
156   -you may not use this file except in compliance with the License.
157   -You may obtain a copy of the License at
158   -
159   - http://www.apache.org/licenses/LICENSE-2.0
160   -
161   -Unless required by applicable law or agreed to in writing, software
162   -distributed under the License is distributed on an "AS IS" BASIS,
163   -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
164   -See the License for the specific language governing permissions and
165   -limitations under the License.
1  README.txt

0 comments on commit e34f22d

Please sign in to comment.
Something went wrong with that request. Please try again.