'\" t
.\"     Title: ruby-build
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.16
.\"      Date: 2022-05-04
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "RUBY\-BUILD" "1" "2022-05-04" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ruby-build \- utility to compile and install Rubies
.SH "SYNOPSIS"
.sp
\fBruby\-build\fP [\fIOPTIONS\fP...] \fIDEFINITION\fP \fIPREFIX\fP
.sp
\fBruby\-build \-\-definitions\fP
.sp
\fBruby\-build \-\-version\fP
.sp
\fBruby\-build\fP [\fB\-h\fP|\fB\-\-help\fP]
.sp
\fBrbenv install\fP [\fIOPTIONS\fP...] [\fIDEFINITION\fP]
.sp
\fBrbenv install\fP [\fB\-l\fP|\fB\-\-list\fP]
.sp
\fBrbenv uninstall\fP [\fB\-f\fP|\fB\-\-force\fP] \fIDEFINITION\fP
.SH "DESCRIPTION"
.sp
\fBruby\-build\fP provides a simple way to compile and install different
versions of Ruby on UNIX\-like systems.
.sp
ruby\-build downloads, builds and installs the Ruby version specified
in a \fIDEFINITION\fP into a \fIPREFIX\fP directory. Definitions can be chosen
from the list of installed definitions or by specifying a file path
for a definition.
.sp
rbenv(1) users can also use the provided \fBrbenv install\fP
command, which installs Rubies into the \f(CRrbenv\fP directory.
.SH "OPTIONS"
.sp
\fB\-\-definitions\fP
.RS 4
List available definitions.
.RE
.sp
\fB\-f\fP, \fB\-\-force\fP
.RS 4
When using \fBrbenv\-install\fP, force installation of Ruby versions that
are already installed. When using \fBrbenv\-uninstall\fP, uninstall
without prompting for confirmation or displaying an error message
for Rubies that are not currently installed.
.RE
.sp
\fB\-k\fP, \fB\-\-keep\fP
.RS 4
Don\(cqt delete source code after installation.
.RE
.sp
\fB\-p\fP, \fB\-\-patch\fP
.RS 4
Apply a patch from standard input to the Ruby, JRuby or Rubinius
source code before executing the \f(CR./configure\fP step.
.RE
.sp
\fB\-v\fP, \fB\-\-verbose\fP
.RS 4
Display compiler messages on standard output.
.RE
.sp
\fB\-\-version\fP
.RS 4
Show \f(CRruby\-build\fP version and exit.
.RE
.sp
\fB\-h\fP, \fB\-\-help\fP
.RS 4
Show usage information and exit.
.RE
.SH "EXAMPLES"
.sp
Install Ruby 2.0.0 (MRI, patch level 0) to \f(CR~/rubies/mri\-2.0.0\fP:
.sp
.if n .RS 4
.nf
.fam C
ruby\-build 2.0.0\-p0 ~/rubies/mri\-2.0.0
.fam
.fi
.if n .RE
.sp
Install Ruby Enterprise Edition 1.8.7 (patch level 2011.03) for rbenv(1):
.sp
.if n .RS 4
.nf
.fam C
rbenv install ree\-1.8.7\-2011.03
.fam
.fi
.if n .RE
.sp
Install local app\-specific Ruby version:
.sp
.if n .RS 4
.nf
.fam C
rbenv install
.fam
.fi
.if n .RE
.sp
Install Ruby from a custom definition into \f(CR~/your\-ruby\fP:
.sp
.if n .RS 4
.nf
.fam C
rbenv install /path/to/your/own/ruby/definition ~/your\-ruby
.fam
.fi
.if n .RE
.sp
Install Ruby 2.0.0\-p0, applying the patch in \f(CR/path/to/some.patch\fP:
.sp
.if n .RS 4
.nf
.fam C
rbenv install \-\-patch 2.0.0\-p0 < /path/to/some.patch
.fam
.fi
.if n .RE
.SH "ENVIRONMENT"
.sp
\fBCC\fP
.RS 4
Sets the path to the C compiler.
.RE
.sp
\fBCONFIGURE_OPTS\fP
.RS 4
Options that are passed to \f(CR./configure\fP when building a Ruby.
.RE
.sp
\fBMAKE\fP
.RS 4
Sets the command used for \f(CRmake\fP.
.RE
.sp
\fBMAKE_OPTS\fP
.RS 4
Options that are passed to \f(CRmake\fP when building a Ruby.
.RE
.sp
\fBMAKEOPTS\fP
.RS 4
Used instead of \fBMAKE_OPTS\fP when \fBMAKE_OPTS\fP is not defined.
.RE
.sp
\fBRUBY_BUILD_BUILD_PATH\fP
.RS 4
Sets the location in which sources are downloaded and built.
.RE
.sp
\fBRUBY_BUILD_CACHE_PATH\fP
.RS 4
Sets the location where downloaded package files are cached.
.RE
.sp
\fBRUBY_BUILD_DEFINITIONS\fP
.RS 4
Adds a colon\-separated list of directories to the build definition
path.
.RE
.sp
\fBRUBY_BUILD_MIRROR_URL\fP
.RS 4
Sets the root URL of the mirror from which package files are
downloaded.
.RE
.sp
\fBRUBY_BUILD_ROOT\fP
.RS 4
If set, overrides the default location from where build definitions
in \f(CRshare/ruby\-build/\fP are looked up.
.RE
.sp
\fBRUBY_BUILD_SKIP_MIRROR\fP
.RS 4
If set, forces \f(CRruby\-build\fP to download packages from their
original source URLs instead of using a mirror.
.RE
.sp
\fBRUBY_CFLAGS\fP
.RS 4
Options that are added to the default \f(CRCFLAGS\fP when building a Ruby.
.RE
.sp
\fBRUBY_CONFIGURE_OPTS\fP
.RS 4
Options that are passed to \f(CR./configure\fP when building a Ruby. In
contrast to \fBCONFIGURE_OPTS\fP, these are only passed to Ruby and not
to any dependent packages (such as \f(CRlibyaml\fP).
.RE
.sp
\fBRUBY_MAKE_OPTS\fP
.RS 4
Options that are passed to \f(CRmake\fP when building a Ruby. In contrast
to \fBMAKE_OPTS\fP, these are only passed to Ruby and not to any
dependent packages (such as \f(CRlibyaml\fP).
.RE
.sp
\fBTMPDIR\fP
.RS 4
Sets the location where \f(CRruby\-build\fP stores temporary files.
.RE
.SH "AUTHORS"
.sp
ruby\-build is developed by Sam Stephenson <sam@37signals.com>.
.sp
This man page was written for the Debian GNU/Linux distribution by
Sebastian Boehm <sebastian@sometimesfood.org> but may be used by
others.
.SH "SEE ALSO"
.sp
rbenv(1)