The Ruby Programming Language [mirror]
Go to file
nobu b3dbeb6e90 mkmf.rb: fix script installation
* lib/mkmf.rb (MakeMakefile): fix condition to install script
  files.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57446 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-01-28 05:02:39 +00:00
basictest basictest: --run-opt option 2016-10-19 05:22:51 +00:00
benchmark benchmarks for Bug#13136 2017-01-20 02:27:28 +00:00
bin
bootstraptest improve C0 coverage of insns.def from 65.9% to 96.1% 2017-01-23 02:47:16 +00:00
ccan
coverage
cygwin Keep -jN option 2017-01-20 07:45:10 +00:00
defs separated_version.mk: option for linux [ci skip] 2016-10-18 06:55:15 +00:00
doc Fix function name for DBM on extension document. 2017-01-26 07:09:58 +00:00
enc Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
ext {ext,test}/dbm: Specify frozen_string_literal: true. 2017-01-28 04:36:08 +00:00
gems Update xmlrpc-0.2.1 for Ruby 2.4.0 release. 2016-12-22 03:53:53 +00:00
include fix typo [Bug #13091] 2017-01-01 16:42:43 +00:00
lib mkmf.rb: fix script installation 2017-01-28 05:02:39 +00:00
man Remove Ns before puctuation 2016-09-26 12:39:18 +00:00
misc ruby-additional.el: unquoted code block 2016-11-16 06:59:40 +00:00
missing get rid of sprintf 2016-12-26 09:28:48 +00:00
nacl
sample get rid of ambiguous parentheses warnings 2016-11-29 16:06:54 +00:00
spec default.mspec: end of options 2016-11-09 02:42:30 +00:00
template exts.mk.tmpl: ruby names 2017-01-28 01:43:29 +00:00
test {ext,test}/dbm: Specify frozen_string_literal: true. 2017-01-28 04:36:08 +00:00
tool rbinstall.rb: mimic rubygems wrapper script 2017-01-15 05:50:41 +00:00
win32 Parallel ext configuration 2017-01-23 02:50:23 +00:00
.document * .document: [DOC] add rbconfig. [ci skip] 2016-09-14 12:52:00 +00:00
.editorconfig Add config for *.yml [ci skip] 2016-10-30 11:57:41 +00:00
.gdbinit .gdbinit: fix on empty strings [ci skip] 2017-01-25 06:05:51 +00:00
.gitattributes
.gitignore Parallel ext configuration 2017-01-23 02:50:23 +00:00
.indent.pro
.travis.yml Add ruby_2_4 branch to test on travis [skip ci] 2016-12-23 16:09:09 +00:00
BSDL
CONTRIBUTING.md
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb [Bug #12705] 2016-12-26 09:32:07 +00:00
LEGAL Use https instead of http in some URLs 2016-09-11 10:33:36 +00:00
Makefile.in Parallel ext configuration 2017-01-23 02:50:23 +00:00
NEWS NEWS for SecureRandom's random source [ci skip] 2017-01-22 04:14:21 +00:00
README.EXT
README.EXT.ja
README.ja.md README{,.ja}.md: Drop support for BeOS now that Haiku is stable since 2.3.0. [ci skip] 2016-09-13 12:26:04 +00:00
README.md README{,.ja}.md: Drop support for BeOS now that Haiku is stable since 2.3.0. [ci skip] 2016-09-13 12:26:04 +00:00
acinclude.m4
aclocal.m4
addr2line.c get rid of strcpy 2016-12-26 09:28:46 +00:00
addr2line.h
appveyor.yml Use environment variable for system ruby detection on appveyor. 2016-11-10 06:38:14 +00:00
array.c array.c: improve Array#sample 2017-01-20 02:39:27 +00:00
bignum.c bignum.c: unnecessary check 2017-01-07 08:31:03 +00:00
class.c class.c: non-keyword hash class 2017-01-18 03:38:52 +00:00
common.mk exts.mk.tmpl: for not GNU makes 2017-01-27 07:16:36 +00:00
compar.c Comparable#clamp 2016-08-11 07:24:25 +00:00
compile.c compile.c: optimization of defined? in condition 2017-01-20 04:27:55 +00:00
complex.c complex.c: optimize f_gt_p some cases 2016-11-22 05:21:12 +00:00
configure.in Reapply r57093,r57094,r57097 "dtrace build fixes on FreeBSD" 2016-12-17 07:48:58 +00:00
constant.h
cont.c cont.c: change fiber stack size doc [ci skip] 2016-12-27 08:52:32 +00:00
debug.c * debug.c (ruby_debug_printf): use rb_raw_obj_info() 2016-07-25 08:00:46 +00:00
dir.c dir.c: getattrlist on OSX 10.5 2017-01-01 22:20:38 +00:00
dln.c get rid of strcpy 2016-12-26 09:28:46 +00:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c encoding.c: handle needmore error from rb_enc_precise_mbclen() 2016-12-14 12:32:42 +00:00
enum.c enum.c: write barrier 2017-01-27 03:24:45 +00:00
enumerator.c Enumerator::Lazy#chunk_while defined. 2016-11-05 15:46:48 +00:00
error.c error.c: fixed doc [ci skip] 2017-01-23 04:49:19 +00:00
eval.c eval.c: copy special exception 2017-01-24 14:52:07 +00:00
eval_error.c immediate message mode of compile error 2017-01-12 07:41:35 +00:00
eval_intern.h eval_intern.h: make TH_PUSH_TAG() initialize rb_vm_tag::tag with Qundef 2016-09-26 06:43:51 +00:00
eval_jump.c
file.c file.c: refine message 2017-01-16 02:43:55 +00:00
gc.c get rid of strcpy 2016-12-26 09:28:46 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c goruby.c: call Init_golf [ci skip] 2016-08-23 08:00:09 +00:00
hash.c Hash#fetch: fix grammar in documentation. 2017-01-22 03:06:17 +00:00
ia64.s
id_table.c swithc id_table data structure. 2017-01-25 03:03:52 +00:00
id_table.h id_table.h: dummy sentinel 2016-08-06 00:35:33 +00:00
inits.c
insns.def insns.def: float comparison 2017-01-13 05:49:43 +00:00
internal.h eval.c: copy special exception 2017-01-24 14:52:07 +00:00
io.c io.c: close before wait 2017-01-25 14:34:07 +00:00
iseq.c immediate message mode of compile error 2017-01-12 07:41:35 +00:00
iseq.h
lex.c.blt
load.c Adjust indent [ci skip] 2016-12-09 02:59:55 +00:00
loadpath.c
localeinit.c
main.c
marshal.c Prevent GC by volatile [Bug #13150] 2017-01-23 16:58:27 +00:00
math.c math.c: unused_obj 2016-11-19 01:55:34 +00:00
method.h * eval.c, method.h, proc.c, vm.c, vm_eval.c, vm_insnhelper.c, vm_method.c: 2016-11-05 13:15:26 +00:00
miniinit.c
node.c node.c: flatten NODE_BLOCK [ci skip] 2016-10-05 06:43:34 +00:00
node.h
numeric.c numeric.c: short circuit optimization 2017-01-10 12:18:21 +00:00
object.c object.c: no TypeError at Symbol 2017-01-23 06:16:04 +00:00
pack.c pack.c: avoid returning uninitialized String 2016-12-26 06:32:00 +00:00
parse.y parse.y (parser_yylex): remove wrong warning 2017-01-24 07:52:41 +00:00
prelude.rb prelude.rb: Binding#irb [ci skip] 2017-01-06 03:11:45 +00:00
probes.d
probes_helper.h
proc.c doc: improve documentation for Binding [ci skip] 2017-01-16 21:08:12 +00:00
process.c process.c: PATH env in spawn 2016-11-06 00:58:49 +00:00
random.c SecureRandom should try /dev/urandom first [Bug #9569] 2017-01-20 08:00:00 +00:00
range.c range.c: check loading 2016-11-11 11:52:03 +00:00
rational.c rational.c: short circuit optimization 2017-01-10 13:41:18 +00:00
re.c re.c: consider the case of RMatch::regexp is nil 2016-12-20 07:32:23 +00:00
regcomp.c regcomp.c: debug function [ci skip] 2017-01-25 06:08:16 +00:00
regenc.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
regenc.h Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
regerror.c get rid of strcat 2016-12-26 09:28:47 +00:00
regexec.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
regint.h regint.h: version for secure functions 2016-12-24 13:22:53 +00:00
regparse.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
regparse.h Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
regsyntax.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
ruby-runner.c
ruby.c declare `rb_w32_sysinit` in header. 2016-12-13 05:17:48 +00:00
ruby_assert.h
ruby_atomic.h
rubystub.c rubystub.c: sys/param.h for MAXPATHLEN 2016-08-20 05:58:58 +00:00
safe.c
signal.c signal.c: improve stack overflow check 2016-11-27 11:22:42 +00:00
siphash.c switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
siphash.h switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
sparc.c
sprintf.c sprintf.c: fix width underflow 2016-12-17 18:04:30 +00:00
st.c st.c: suppress a warning 2016-12-21 11:20:02 +00:00
strftime.c
string.c string.c: rindex(//) should set $~. 2017-01-19 08:13:03 +00:00
struct.c replace fixnum by integer in documents. 2016-09-08 04:57:49 +00:00
symbol.c
symbol.h
thread.c io.c: close before wait 2017-01-25 14:34:07 +00:00
thread_pthread.c [DOC] replace Fixnum with Integer [ci skip] 2016-10-26 06:11:23 +00:00
thread_pthread.h
thread_sync.c thread_sync.c: Document exception types 2016-09-29 10:34:25 +00:00
thread_win32.c Use PRIuSIZE format specifier for size_t values 2016-09-13 12:33:13 +00:00
thread_win32.h
time.c time.c: fix type of usec2subsecx 2016-12-24 12:21:52 +00:00
timev.h
transcode.c * lib/net/http/header.rb: Fix typo. [ci skip][fix GH-1407] 2016-08-16 02:18:51 +00:00
transcode_data.h
util.c util.c: round to even 2016-11-04 07:31:47 +00:00
variable.c variable.c: fix the condition to cache 2017-01-11 04:12:56 +00:00
version.c
version.h * 2017-01-28 2017-01-27 15:32:50 +00:00
vm.c vm.c: fix return in lambda 2016-12-31 08:07:58 +00:00
vm_args.c vm_args.c: cache procs 2016-10-15 09:05:58 +00:00
vm_backtrace.c * vm_trace.c (tracepoint_attr_callee_id, rb_tracearg_callee_id): 2016-11-05 13:15:27 +00:00
vm_core.h constify 2016-12-14 08:06:55 +00:00
vm_debug.h
vm_dump.c skip T_IMEMO for VMDEBUG 2017-01-26 09:57:41 +00:00
vm_eval.c vm.c: fix return in lambda 2016-12-31 08:07:58 +00:00
vm_exec.c * vm_insnhelper.h: rename REG_(CFP|PC|SP|EP) to VM_REG_.... 2016-11-05 16:31:25 +00:00
vm_exec.h
vm_insnhelper.c eval.c: copy special exception 2017-01-24 14:52:07 +00:00
vm_insnhelper.h insns.def: float comparison 2017-01-13 05:49:43 +00:00
vm_method.c More description about the protected attribute of a method 2017-01-19 09:34:30 +00:00
vm_opts.h
vm_trace.c Add clang volatile fixes from FreeBSD and NetBSD. 2016-12-07 23:27:51 +00:00
vsnprintf.c * internal.h (WARN_UNUSED_RESULT): moved to configure.in, to 2016-09-16 06:15:55 +00:00

README.md

Build Status Build status

What's Ruby

Ruby is the interpreted scripting language for quick and easy object-oriented programming. It has many features to process text files and to do system management tasks (as in Perl). It is simple, straight-forward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-oriented Features (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. Mix-in, Singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, Mac OS X, Haiku, etc.) cf. https://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms

How to get Ruby

For a complete list of ways to install Ruby, including using third-party tools like rvm, see:

https://www.ruby-lang.org/en/downloads/

The Ruby distribution files can be found on the following FTP site:

ftp://ftp.ruby-lang.org/pub/ruby/

The trunk of the Ruby source tree can be checked out with the following command:

$ svn co https://svn.ruby-lang.org/repos/ruby/trunk/ ruby

Or if you are using git then use the following command:

$ git clone git://github.com/ruby/ruby.git

There are some other branches under development. Try the following command to see the list of branches:

$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/

Or if you are using git then use the following command:

$ git ls-remote git://github.com/ruby/ruby.git

Ruby home page

The URL of the Ruby home page is:

https://www.ruby-lang.org/

Mailing list

There is a mailing list to talk about Ruby. To subscribe to this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address mailto:ruby-talk-request@ruby-lang.org.

How to compile and install

This is what you need to do to compile and install Ruby:

  1. If you want to use Microsoft Visual C++ to compile ruby, read win32/README.win32 instead of this document.

  2. If ./configure does not exist or is older than configure.in, run autoconf to (re)generate configure.

  3. Run ./configure, which will generate config.h and Makefile.

    Some C compiler flags may be added by default depending on your environment. Specify optflags=.. and warnflags=.. as necessary to override them.

  4. Edit defines.h if you need. Usually this step will not be needed.

  5. Remove comment mark(#) before the module names from ext/Setup (or add module names if not present), if you want to link modules statically.

    If you don't want to compile non static extension modules (probably on architectures which do not allow dynamic loading), remove comment mark from the line "#option nodynamic" in ext/Setup.

    Usually this step will not be needed.

  6. Run make.

  7. Optionally, run 'make check' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded", your ruby works as it should (hopefully).

  8. Run 'make install'

    This command will create the following directories and install files into them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib
    • ${DESTDIR}${prefix}/lib/ruby
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/share/man/man1
    • ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system

    If Ruby's API version is 'x.y.z', the ${MAJOR} is 'x', the ${MINOR} is 'y', and the ${TEENY} is 'z'.

    NOTE: teeny of the API version may be different from one of Ruby's program version

    You may have to be a super user to install ruby.

If you fail to compile ruby, please send the detailed error report with the error log and machine/OS type, to help others.

Some extension libraries may not get compiled because of lack of necessary external libraries and/or headers, then you will need to run 'make distclean-ext' to remove old configuration after installing them in such case.

Copying

See the file COPYING.

Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list (https://www.ruby-lang.org/en/community/mailing-lists) or on websites like (https://stackoverflow.com).

Bug reports should be filed at https://bugs.ruby-lang.org. Read HowToReport for more information.

##Contributing

See the file CONTRIBUTING.md

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

mailto:matz@ruby-lang.org