Skip to content
The Ruby Programming Language
Ruby C Emacs Lisp Tcl Objective-C Ragel in Ruby Host Other
Find file
Pull request Compare This branch is 8177 commits behind ruby:trunk.
Latest commit 41d42a5 @nobu nobu LDFLAGS and DLDFLAGS for opt-dir
* reset LDFLAGS and DLDFLAGS for opt-dir again after
  LIBPATHFLAG and RPATHFLAG are set.  [ruby-dev:47868] [Bug #9317]

git-svn-id: svn+ssh:// b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Failed to load latest commit information.
benchmark * benchmark/bm_so_meteor_contest.rb: [DOC] Fix a few typos
bin * NEWS (with all sufficient information):
bootstraptest fix matching
cygwin * cygwin/ ( link *.res.o.
defs * defs/opt_operand.def: Fix typo
doc old ChangeLog and NEWS move to doc
enc encdb.c, encoding.c: make BOM-encodings dummy
ext * benchmark/bm_so_meteor_contest.rb: [DOC] Fix a few typos
include ruby/version.h: bump API version
lib mkmf.rb: fix for 1.8 baseruby
man * man/ruby.1: [DOC] Use instead of RAA.
misc misc/ruby-electric.el: Import version 2.1.1.
missing fix typos. Patch by k_takata.
nacl fix typos. Patch by k_takata.
sample * remove trailing spaces, append newline at EOF.
spec * spec/default.mspec: expand relative path for ruby_exe which uses
symbian Added HAVE_LABS and HAVE_LLABS to config.h
template verconf.h.tmpl: rename
test eval.c: raise with cause
tool mkconfig.rb: pass version numbers
win32 remove HAVE_FSEEKO from win32/win32.c
.document * .document: Removed extra space
.editorconfig .editorconfig: new
.gdbinit .gdbinit: initialize
.gitignore * .gitignore: ignored *.old files. * added for ruby-style.
.travis.yml * .travis.yml: Rebuild Travis CI's "ruby-head" version on successful
BSDL * BSDL: update copyright notice for 2013.
COPYING * COPYING: change Ruby's License from a dual license with GPLv2
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128]
ChangeLog LDFLAGS and DLDFLAGS for opt-dir
GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug #6328]
KNOWNBUGS.rb * test/ruby/test_method.rb (test_unlinked_method_entry_in_method_obje…
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function., cppflags
NEWS old ChangeLog and NEWS move to doc
README * README: Fix typo by Benjamin Winkler [Fixes GH-281]
README.EXT * README.EXT: add a refer to URL.
README.EXT.ja README.EXT.ja: fix probable typo
README.ja Fix the mail address of Matz; does not exist.
addr2line.c * addr2line.c: Include ELF header after system headers (especially
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris
array.c * array.c: Have to_h raise on elements that are not key-value pairs […
bignum.c * bignum.c (bigxor_int): Apply BIGLO for long in a BDIGIT expression.
class.c * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into verconf.h.tmpl: rename
compar.c * compar.c (cmp_eq_recursive): Fix the return value, the value for
compile.c compile.c: fix error by clang
complex.c * complex.c: removed meaningless lines. LDFLAGS and DLDFLAGS for opt-dir
constant.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS,
cont.c * thread_pthread.c (rb_thread_create_timer_thread): Show error
debug.c * include/ruby/ruby.h: rename FL_OLDGEN to FL_PROMOTED.
dir.c vm_insnhelper.c: rb_get_kwargs
dln.c adjust style.
dln.h dln.c: extra arguments
dln_find.c dln.c: extra arguments
dmydln.c * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control
dmyext.c no K&R style
encoding.c encoding.c: mask dummy flags
enum.c * array.c: Have to_h raise on elements that are not key-value pairs […
enumerator.c enumerator.c: should not store local variable address
error.c * error.c: add Exception#backtrace_locations.
eval.c eval.c: raise with cause
eval_error.c * eval_error.c (warn_printf): use rb_vsprintf instead so ruby specific
eval_intern.h * eval_intern.h (SAVE_ROOT_JMPBUF): workaround for the failure of
eval_jump.c eval_jump.c: reuse same tag
file.c file.c: to_uid and to_gid
gc.c * gc.c (ruby_gc_set_params): don't show obsolete warnings for
gc.h * gc.h (rb_objspace_reachable_objects_from_root): added.
gem_prelude.rb * ruby.c (process_options): revert r30549.
golf_prelude.rb * golf_prelude.rb: syntax formatting for whitespace [Fixes GH-425]
goruby.c * goruby.c (init_golf): append suffix.
hash.c hash.c: remove dead code
ia64.s * removed trailing spaces.
inits.c ext/rbconfig/sizeof: move to an extension library
insns.def * insns.def: Fix optimization bug of Float#/ [Bug #9238]
internal.h * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
io.c * io.c (io_fwrite): allocate frozen str only when str is not converted.
iseq.c compile.c: unnamed keyword rest check
iseq.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add
lex.c.blt * defs/keywords (reserved_word): made inline function static.
load.c * load.c (features_index_add_single): Move loaded_features_index arra…
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h
localeinit.c localeinit.c: split
main.c * include/ruby/debug.h: introdudced.
marshal.c * marshal.c: [DOC] Wordsmith marshal.c documentation. by @vipulnsward
math.c math.c: fix for Bignum argument
method.h * include/ruby/ruby.h (struct RClass): Add wrapper struct around
miniinit.c ext/rbconfig/sizeof: move to an extension library
node.c * include/ruby/util.h: removed extra semicolon in definition of
node.h * node.h: catch up comments for last commit.
numeric.c numeric.c: no declaration of finite
object.c * object.c (Kernel#<=>) surround Comparable operators with <code> tags.
pack.c * dir.c, pack.c, ruby.c, struct.c, vm_eval.c: use RARRAY_CONST_PTR().
parse.y parse.y: save cmdarg_stack in local scope
prelude.rb * prelude.rb: Moved Mutex#synchronize to
probes.d vm_method.c: add new ruby::method-cache-clear dtrace probe
probes_helper.h probes_helper.h: RUBY_DTRACE_HOOK
proc.c proc.c: fix inherited method owner
process.c * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
random.c * random.c (rand_init): Make it possible to specify arbitrary array
range.c hash.c: detect recursion for all
rational.c revertd.
re.c * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
regcomp.c * regcomp.c (): Merge Onigmo 5.13.5 23b523076d6f1161.
regenc.c Revert r41786 "broken utf-8"
regenc.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END}
regerror.c * regcomp.c: Merge Onigmo 3d855b30d574536d3ae600260208c6624ae4791c.
regexec.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee.
regint.h * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee.
regparse.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee.
regparse.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END}
regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
ruby.c gc.c: Load GC tuning settings earlier during boot.
ruby_atomic.h ruby_atomic.h: ATOMIC_PTR_EXCHANGE
safe.c safe.c: ruby_safe_level_4_warning
signal.c signal.c: fault address
siphash.c siphash.c: fix missing condition
siphash.h * siphash.h: check configure macros before include newer headers.
sparc.c * sparc.c: Use __asm__ instead of asm for gcc.
sprintf.c sprintf.c: QUOTE flag
st.c st.c: tweaked comment
strftime.c * strftime.c (rb_strftime_with_timespec): Test yday range.
string.c * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
struct.c hash.c: detect recursion for all
thread.c thread.c: reduce tags and stack
thread_native.h * thread_native.h: add rb_nativethread_self() which returns
thread_pthread.c thread_pthread.c: use get_main_stack properly
thread_pthread.h * thread_(pthread|win32).h: rename rb_thread_cond_t to
thread_win32.c * eval_intern.h (SAVE_ROOT_JMPBUF): workaround for the failure of
thread_win32.h * thread_(pthread|win32).h: rename rb_thread_cond_t to
time.c * time.c (v2w): Normalize a rational value to an integer if possible.
timev.h timev.h: move time_t stuffs
transcode.c * transcode.c (str_transcode0): don't scrub invalid chars if
transcode_data.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END}
util.c util.c: bump stack size in ruby_qsort()
variable.c * variable.c: Adding extra example in docs. [Bug #9210]
version.c version.c: EXIT_SUCCESS
version.h * 2014-01-01
vm.c vm.c: check cbase
vm_backtrace.c * error.c: add Exception#backtrace_locations.
vm_core.h * compile.c, insns.def, test/ruby/test_rubyvm.rb, vm.c, vm_core.h,
vm_debug.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END}
vm_dump.c vm_dump.c: improve wording of apple crashlog messages
vm_eval.c * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
vm_exec.c * vm_exec.h (VM_DEBUG_STACKOVERFLOW): added.
vm_exec.h * vm_exec.h (VM_DEBUG_STACKOVERFLOW): added.
vm_insnhelper.c proc.c: fix inherited method owner
vm_insnhelper.h * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
vm_method.c vm_method.c: use RCLASS_SERIAL macro instead of direct access
vm_opts.h fix minor code comment typos
vm_trace.c vm_trace.c: isolate exceptions
vsnprintf.c * vsnprintf.c: Fix spelling from compliment to complement.


= 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(ex. class, method calls)
*   *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
*   Operator Overloading
*   Exception Handling
*   Iterators and Closures
*   Garbage Collection
*   Dynamic Loading of Object files(on some architecture)
*   Highly Portable (works on many Unix-like/POSIX compatible platforms
    as well as Windows, Mac OS X, BeOS etc.)

== How to get Ruby

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

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

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

  $ svn co ruby

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

  $ git clone git://

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

  $ svn ls

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

  $ git ls-remote git://

== Ruby home-page

The URL of the Ruby home-page is:

== Mailing list

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

        subscribe YourFirstName YourFamilyName
        subscribe Joseph Smith

in the mail body (not subject) to the address <>.

== How to compile and install

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

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

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

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

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

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

4.   Remove comment mark(<tt>#</tt>) before the module names from +ext/Setup+
     (or add module names if not present), if you want to link modules

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

     Usually this step will not be needed.

5.   Run +make+.

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

7.   Run '<tt>make install</tt>'

     This command will create following directories and install files
     onto them.

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

     If Ruby's API version is '_x.y.z_', the <tt>${MAJOR}</tt> is '_x_', the
     <tt>${MINOR}</tt> is '_y_', and the <tt>${TEENY}</tt> 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
'<tt>make distclean-ext</tt>' 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
( or on websites like

Bug reports should be filed at

== The Author

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


Local variables:
mode: rdoc
Something went wrong with that request. Please try again.