File: ruby-build.1.ronn

package info (click to toggle)
ruby-build 20140926-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 752 kB
  • ctags: 112
  • sloc: sh: 1,492; makefile: 11
file content (137 lines) | stat: -rw-r--r-- 4,057 bytes parent folder | download
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
ruby-build(1) -- compile and install Rubies
===========================================

## SYNOPSIS

`ruby-build` [OPTIONS...] <definition> <prefix><br>
`ruby-build` `--definitions`<br>
`ruby-build` `--version`<br>
`ruby-build` [`-h`|`--help`]<br>
`rbenv install` [OPTIONS...] [<definition>]<br>
`rbenv install` [`-l`|`--list`]<br>
`rbenv uninstall` [`-f`|`--force`] <definition><br>

## DESCRIPTION

**ruby-build** provides a simple way to compile and install different
versions of Ruby on UNIX-like systems.

`ruby-build` downloads, builds and installs the Ruby version specified
in a <definition> into a <prefix> directory. Definitions can be chosen
from the list of installed definitions or by specifying a file path
for a definition.

rbenv(1) users can also use the provided `rbenv install`
command, which installs Rubies into the `rbenv` directory.

## OPTIONS

  * `--definitions`:
    List available definitions.

  * `-f`, `--force`:
    When using `rbenv-install`, force installation of Ruby versions
    that are already installed. When using `rbenv-uninstall`,
    uninstall without prompting for confirmation or displaying an
    error message for Rubies that are not currently installed.

  * `-k`, `--keep`:
    Don't delete source code after installation.

  * `-p`, `--patch`:
    Apply a patch from standard input to the Ruby, JRuby or Rubinius
    source code before executing the `./configure` step.

  * `-v`, `--verbose`:
    Display compiler messages on standard output.

  * `--version`:
    Show `ruby-build` version and exit.

  * `-h`, `--help`:
    Show usage information and exit.

## EXAMPLES

Install Ruby 2.0.0 (MRI, patch level 0) to `~/rubies/mri-2.0.0`:
    ruby-build 2.0.0-p0 ~/rubies/mri-2.0.0

Install Ruby Enterprise Edition 1.8.7 (patch level 2011.03) for rbenv(1):
    rbenv install ree-1.8.7-2011.03

Install local app-specific Ruby version:
    rbenv install

Install Ruby from a custom definition into `~/your-ruby`:
    rbenv install /path/to/your/own/ruby/definition ~/your-ruby

Install Ruby 2.0.0-p0, applying the patch in `/path/to/some.patch`:
    rbenv install --patch 2.0.0-p0 < /path/to/some.patch

## ENVIRONMENT

  * `CC`:
    Sets the path to the C compiler.

  * `CONFIGURE_OPTS`:
    Options that are passed to `./configure` when building a Ruby.

  * `MAKE`:
    Sets the command used for `make`.

  * `MAKE_OPTS`:
    Options that are passed to `make` when building a Ruby.

  * `MAKEOPTS`:
    Used instead of `MAKE_OPTS` when `MAKE_OPTS` is not defined.

  * `RUBY_BUILD_BUILD_PATH`:
    Sets the location in which sources are downloaded and built.

  * `RUBY_BUILD_CACHE_PATH`:
    Sets the location where downloaded package files are cached.

  * `RUBY_BUILD_DEFINITIONS`:
    Adds a colon-separated list of directories to the build definition
    path.

  * `RUBY_BUILD_MIRROR_URL`:
    Sets the root URL of the mirror from which package files are
    downloaded.

  * `RUBY_BUILD_ROOT`:
    If set, overrides the default location from where build
    definitions in share/ruby-build/ are looked up.

  * `RUBY_BUILD_SKIP_MIRROR`:
    If set, forces `ruby-build` to download packages from their
    original source URLs instead of using a mirror.

  * `RUBY_CFLAGS`:
    Options that are added to the default `CFLAGS` when building a
    Ruby.

  * `RUBY_CONFIGURE_OPTS`:
    Options that are passed to `./configure` when building a Ruby. In
    contrast to `CONFIGURE_OPTS`, these are only passed to Ruby and
    not to any dependent packages (such as libyaml).

  * `RUBY_MAKE_OPTS`:
    Options that are passed to `make` when building a Ruby. In
    contrast to `MAKE_OPTS`, these are only passed to Ruby and not to
    any dependent packages (such as libyaml).

  * `TMPDIR`:
    Sets the location where `ruby-build` stores temporary files.

## AUTHORS

ruby-build is developed by Sam Stephenson <<sam@37signals.com>>.

This man page was written for the Debian GNU/Linux distribution by
Sebastian Boehm <<sebastian@sometimesfood.org>> but may be used by
others.

## SEE ALSO

rbenv(1)