ruby-build(1)

1RUBY-BUILD(1)                                                    RUBY-BUILD(1)
2
3
4

NAME

6       ruby-build - utility to compile and install Rubies
7

SYNOPSIS

9       ruby-build [OPTIONS...] DEFINITION PREFIX
10
11       ruby-build --definitions
12
13       ruby-build --version
14
15       ruby-build [-h|--help]
16
17       rbenv install [OPTIONS...] [DEFINITION]
18
19       rbenv install [-l|--list]
20
21       rbenv uninstall [-f|--force] DEFINITION
22

DESCRIPTION

24       ruby-build provides a simple way to compile and install different
25       versions of Ruby on UNIX-like systems.
26
27       ruby-build downloads, builds and installs the Ruby version specified in
28       a DEFINITION into a PREFIX directory. Definitions can be chosen from
29       the list of installed definitions or by specifying a file path for a
30       definition.
31
32       rbenv(1) users can also use the provided rbenv install command, which
33       installs Rubies into the rbenv directory.
34

OPTIONS

36       --definitions
37           List available definitions.
38
39       -f, --force
40           When using rbenv-install, force installation of Ruby versions that
41           are already installed. When using rbenv-uninstall, uninstall
42           without prompting for confirmation or displaying an error message
43           for Rubies that are not currently installed.
44
45       -k, --keep
46           Don’t delete source code after installation.
47
48       -p, --patch
49           Apply a patch from standard input to the Ruby, JRuby or Rubinius
50           source code before executing the ./configure step.
51
52       -v, --verbose
53           Display compiler messages on standard output.
54
55       --version
56           Show ruby-build version and exit.
57
58       -h, --help
59           Show usage information and exit.
60

EXAMPLES

62       Install Ruby 2.0.0 (MRI, patch level 0) to ~/rubies/mri-2.0.0:
63
64           ruby-build 2.0.0-p0 ~/rubies/mri-2.0.0
65
66       Install Ruby Enterprise Edition 1.8.7 (patch level 2011.03) for
67       rbenv(1):
68
69           rbenv install ree-1.8.7-2011.03
70
71       Install local app-specific Ruby version:
72
73           rbenv install
74
75       Install Ruby from a custom definition into ~/your-ruby:
76
77           rbenv install /path/to/your/own/ruby/definition ~/your-ruby
78
79       Install Ruby 2.0.0-p0, applying the patch in /path/to/some.patch:
80
81           rbenv install --patch 2.0.0-p0 < /path/to/some.patch
82

ENVIRONMENT

84       CC
85           Sets the path to the C compiler.
86
87       CONFIGURE_OPTS
88           Options that are passed to ./configure when building a Ruby.
89
90       MAKE
91           Sets the command used for make.
92
93       MAKE_OPTS
94           Options that are passed to make when building a Ruby.
95
96       MAKEOPTS
97           Used instead of MAKE_OPTS when MAKE_OPTS is not defined.
98
99       RUBY_BUILD_BUILD_PATH
100           Sets the location in which sources are downloaded and built.
101
102       RUBY_BUILD_CACHE_PATH
103           Sets the location where downloaded package files are cached.
104
105       RUBY_BUILD_DEFINITIONS
106           Adds a colon-separated list of directories to the build definition
107           path.
108
109       RUBY_BUILD_MIRROR_URL
110           Sets the root URL of the mirror from which package files are
111           downloaded.
112
113       RUBY_BUILD_ROOT
114           If set, overrides the default location from where build definitions
115           in share/ruby-build/ are looked up.
116
117       RUBY_BUILD_SKIP_MIRROR
118           If set, forces ruby-build to download packages from their original
119           source URLs instead of using a mirror.
120
121       RUBY_CFLAGS
122           Options that are added to the default CFLAGS when building a Ruby.
123
124       RUBY_CONFIGURE_OPTS
125           Options that are passed to ./configure when building a Ruby. In
126           contrast to CONFIGURE_OPTS, these are only passed to Ruby and not
127           to any dependent packages (such as libyaml).
128
129       RUBY_MAKE_OPTS
130           Options that are passed to make when building a Ruby. In contrast
131           to MAKE_OPTS, these are only passed to Ruby and not to any
132           dependent packages (such as libyaml).
133
134       TMPDIR
135           Sets the location where ruby-build stores temporary files.
136

AUTHORS

138       ruby-build is developed by Sam Stephenson <sam@37signals.com>.
139
140       This man page was written for the Debian GNU/Linux distribution by
141       Sebastian Boehm <sebastian@sometimesfood.org> but may be used by
142       others.
143