FreeBSD Porter's Handbook
Prev | Chapter 6 Special Considerations | Next

# 6.17 Using Ruby

Table 6-24. Useful Variables for Ports That Use Ruby

Variable | Description
--- | ---
`USE_RUBY` | The port requires Ruby.
`USE_RUBY_EXTCONF` | The port uses `extconf.rb` to configure.
`USE_RUBY_SETUP` | The port uses `setup.rb` to configure.
`RUBY_SETUP` | Set to the alternative name of `setup.rb`. Common value is `install.rb`.

The following table shows the selected variables available to port authors via the ports infrastructure. These variables should be used to install files into their proper locations. Use them in `pkg-plist` as much as possible. These variables should not be redefined in the port.

Table 6-25. Selected Read-Only Variables for Ports That Use Ruby

Variable | Description | Example value
--- | --- | ---
`RUBY_PKGNAMEPREFIX` | Used as a `PKGNAMEPREFIX` to distinguish packages for different Ruby versions. | `ruby18-`
`RUBY_VERSION` | Full version of Ruby in the form of `x.y.z`. | `1.8.2`
`RUBY_SITELIBDIR` | Architecture independent libraries installation path. | `/usr/local/lib/ruby/site_ruby/1.8`
`RUBY_SITEARCHLIBDIR` | Architecture dependent libraries installation path. | `/usr/local/lib/ruby/site_ruby/1.8/amd64-freebsd6`
`RUBY_MODDOCDIR` | Module documentation installation path. | `/usr/local/share/doc/ruby18/patsy`
`RUBY_MODEXAMPLESDIR` | Module examples installation path. | `/usr/local/share/examples/ruby18/patsy`

A complete list of available variables can be found in `/usr/ports/Mk/bsd.ruby.mk`.

Prev | Home | Next
Using Emacs | Up | Using SDL

For questions about the FreeBSD ports system, e-mail <ports@FreeBSD.org>.
For questions about this documentation, e-mail <doc@FreeBSD.org>.