The Ruby Programming Language [mirror]
Go to file
naruse 3f1f9e9a0a show progress of rdoc parsing to prevent timeout on chkbuild
http://c64b.rubyci.org/~chkbuild/ruby-trunk/log/20140520T030303Z.fail.html.gz

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46027 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-05-20 06:39:08 +00:00
benchmark vm*: doubly-linked list from ccan to manage vm->living_threads 2014-05-10 23:48:51 +00:00
bin * bin/testrb: Removed. Forgot to remove in r45971. 2014-05-19 05:07:15 +00:00
bootstraptest * (lib/tmpdir.rb): Rescue LoadError on etc.so for miniruby. 2014-04-29 05:19:38 +00:00
ccan vm*: doubly-linked list from ccan to manage vm->living_threads 2014-05-10 23:48:51 +00:00
cygwin
defs id.def: predefine conversion method IDs 2014-05-20 06:28:52 +00:00
doc fix typo [Fix GH-603] 2014-04-28 15:20:28 +00:00
enc unused functions and variables 2014-03-17 04:57:14 +00:00
ext * ext/socket/extconf.rb: Don't check fields of struct tcp_info if the 2014-05-19 20:00:00 +00:00
include * configure.in: Check nextafter() availability. 2014-05-18 00:37:10 +00:00
lib show progress of rdoc parsing to prevent timeout on chkbuild 2014-05-20 06:39:08 +00:00
man * man/ruby.1: remove deadlink. [ruby-core:62145][Bug #9773] 2014-05-10 00:33:38 +00:00
misc ruby-additional.el: ruby-encode-unicode 2014-04-23 02:03:24 +00:00
missing * missing/nextafter.c: Include ruby/missing.h. 2014-05-18 03:03:26 +00:00
nacl
sample * remove trailing spaces, append newline at EOF. 2013-12-25 03:46:08 +00:00
spec
symbian
template Doxyfile.tmpl: exclude ccan 2014-05-17 07:46:05 +00:00
test * test/dbm/test_dbm.rb: Use Etc.uname. 2014-05-19 10:37:14 +00:00
tool * tool/release.sh: need -f option because this overwrite the previous links if they exist. 2014-05-16 15:35:50 +00:00
win32 win32.c: fix infinite recursion 2014-05-18 13:20:39 +00:00
.document
.editorconfig
.gdbinit .gdbinit (rp): dump T_SYMBOL 2014-03-28 07:58:10 +00:00
.gitignore * ext/etc/etc.c: Etc.sysconf, Etc.confstr and IO#pathconf implemented. 2014-05-18 01:48:47 +00:00
.indent.pro
.travis.yml add uname -r 2014-04-23 05:31:08 +00:00
BSDL
COPYING
COPYING.ja
ChangeLog * ext/socket/extconf.rb: Don't check fields of struct tcp_info if the 2014-05-19 20:00:00 +00:00
GPL
KNOWNBUGS.rb
LEGAL * LEGAL: added license infomation of ccan files. 2014-05-14 02:07:32 +00:00
Makefile.in * common.mk: Unused target, $(MKMAIN_CMD), removed. 2014-04-13 01:21:39 +00:00
NEWS * ext/etc/etc.c: Etc.sysconf, Etc.confstr and IO#pathconf implemented. 2014-05-18 01:48:47 +00:00
README.EXT fix typo 2014-04-18 15:11:35 +00:00
README.EXT.ja README.EXT: about string termination 2014-04-18 12:42:04 +00:00
README.ja.md * README.md, README.ja.md: removed (wrong) mode setting for emacs. 2014-02-24 12:42:45 +00:00
README.md * README.md, README.ja.md: removed (wrong) mode setting for emacs. 2014-02-24 12:42:45 +00:00
addr2line.c * addr2line.c (fill_lines): get base addrs in fill_lines to use it 2014-04-14 10:08:04 +00:00
addr2line.h * addr2line.c (fill_lines): loop reverse order not to overwrite 2014-03-26 04:30:43 +00:00
array.c * array.c (ARY_SET): added. 2014-04-11 09:55:10 +00:00
bignum.c * internal.h (struct RBignum): Use size_t for len. 2014-04-19 01:11:04 +00:00
class.c class.c: always clear tables first 2014-05-08 05:34:31 +00:00
common.mk vm*: doubly-linked list from ccan to manage vm->living_threads 2014-05-10 23:48:51 +00:00
compar.c * compar.c (cmp_equal): warn for this release and still rescue 2014-01-18 21:40:58 +00:00
compile.c * compile.c (BUFSIZE): Unused macro removed. 2014-05-11 13:29:16 +00:00
complex.c avoid large alloca on Complex/Rational calls 2014-05-02 19:21:18 +00:00
configure.in configure.in: rb_cv_atan2_inf_c99 2014-05-18 08:31:34 +00:00
constant.h constant.h: reduce rb_const_entry_t size on 64-bit 2014-02-06 20:33:03 +00:00
cont.c eval_intern.h: VAR_INITIALIZED 2014-04-04 08:34:12 +00:00
debug.c
dir.c dir.c: try match PLAIN 2014-05-17 02:02:51 +00:00
dln.c dln.c: non-ascii path on Windows 2014-04-05 23:52:52 +00:00
dln.h
dln_find.c dln_find.c: PATH_SEP 2014-04-16 02:46:51 +00:00
dmydln.c
dmyext.c
encoding.c encoding.c: fix rdoc of `__FILE__` 2014-04-09 06:17:00 +00:00
enum.c enum.c: suppress warnings 2014-05-18 03:15:34 +00:00
enumerator.c * enum.c: Enumerable#slice_after implemented. 2014-05-18 00:06:05 +00:00
error.c error.c: Crash Report log 2014-02-12 02:25:30 +00:00
eval.c eval.c: method name 2014-05-06 08:54:36 +00:00
eval_error.c eval_error.c: investigate core dump 2014-05-18 08:47:41 +00:00
eval_intern.h Handle machine stack overflow on mingw 2014-05-15 08:32:55 +00:00
eval_jump.c eval_intern.h: VAR_INITIALIZED 2014-04-04 08:34:12 +00:00
file.c * file.c (rb_f_test): removed meaningless "case 'a'". 2014-05-05 19:38:11 +00:00
gc.c fix type 2014-05-18 11:02:43 +00:00
gc.h * gc.c, gc.h (rb_objspace_each_objects_without_setup): 2014-04-02 11:59:50 +00:00
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c hash.c: make rb_hash_keys extern 2014-05-07 04:26:53 +00:00
ia64.s
inits.c
insns.def insns.def (opt_regexpmatch2): respect redefined match op 2014-03-11 22:28:33 +00:00
internal.h * include/ruby/ruby.h: Hide Rational internal. 2014-05-17 16:37:41 +00:00
io.c io.c: update ARGF examples 2014-05-18 03:15:57 +00:00
iseq.c iseq.c: linear search 2014-01-12 07:49:26 +00:00
iseq.h
lex.c.blt
load.c * parse.y: support Symbol GC. [ruby-trunk Feature #9634] 2014-03-26 04:57:47 +00:00
loadpath.c
localeinit.c localeinit.c: cp on cygwin 2014-01-25 23:42:16 +00:00
main.c
marshal.c * internal.h (struct RBignum): Use size_t for len. 2014-04-19 01:11:04 +00:00
math.c configure.in: check atan2 2014-05-12 14:57:17 +00:00
method.h * method.h: rearrange rb_method_definition_struct to save 8 bytes in 2014-01-23 04:59:30 +00:00
miniinit.c
node.c node.c: indent 2014-04-25 07:12:58 +00:00
node.h
numeric.c * configure.in: Check nextafter() availability. 2014-05-18 00:37:10 +00:00
object.c id.def: predefine conversion method IDs 2014-05-20 06:28:52 +00:00
pack.c * compile.c (BUFSIZE): Unused macro removed. 2014-05-11 13:29:16 +00:00
parse.y parse.y: no duplicated names 2014-05-06 14:29:07 +00:00
prelude.rb * prelude.rb: [DOC] Update Thread::exclusive docs by @stevenharman. 2014-04-17 07:31:43 +00:00
probes.d vm_method.c: add new ruby::method-cache-clear dtrace probe 2013-12-09 22:50:44 +00:00
probes_helper.h probes_helper.h (RUBY_DTRACE_HOOK): correct type for _id 2014-02-15 04:23:33 +00:00
proc.c proc.c: use already included ancestor iclass 2014-04-14 08:20:10 +00:00
process.c process.c: use ruby_stop 2014-05-10 04:41:02 +00:00
random.c * internal.h: Rename macro names: RBIGNUM_FOO to BIGNUM_FOO. 2014-02-15 21:17:34 +00:00
range.c range.c: unused function 2014-03-14 01:27:46 +00:00
rational.c * include/ruby/ruby.h: Hide Rational internal. 2014-05-17 16:37:41 +00:00
re.c string.c: infect match result 2014-03-28 02:28:18 +00:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c ruby.c: drop older cygwin 2014-04-17 08:24:15 +00:00
ruby_atomic.h iseq.c: potential memory leak 2014-01-12 07:41:10 +00:00
safe.c * include/ruby/intern.h, 2014-02-14 15:16:31 +00:00
signal.c signal.c: use mcontext_t 2014-05-18 08:15:16 +00:00
siphash.c siphash.c: fix missing condition 2013-11-30 04:28:15 +00:00
siphash.h
sparc.c
sprintf.c * parse.y: support Symbol GC. [ruby-trunk Feature #9634] 2014-03-26 04:57:47 +00:00
st.c * st.c (st_foreach_check): chnage start point of search at check 2014-04-20 03:58:22 +00:00
strftime.c
string.c string.c: byte offset 2014-05-19 07:29:51 +00:00
struct.c struct.c: avoid pinning down 2014-03-28 12:36:27 +00:00
thread.c * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
thread_pthread.c thread_pthread.c: variable for errno 2014-05-10 15:52:45 +00:00
thread_pthread.h * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
thread_win32.c Handle machine stack overflow on mingw 2014-05-15 08:32:55 +00:00
thread_win32.h * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
time.c * compile.c (BUFSIZE): Unused macro removed. 2014-05-11 13:29:16 +00:00
timev.h configure.in, win32/Makefile.sub: PACKED_STRUCT with VC 2014-02-25 07:00:10 +00:00
transcode.c
transcode_data.h
util.c util.c: let getcwd allocate buffer 2014-04-16 08:46:29 +00:00
variable.c variable.c, vm_method.c: pin down 2014-03-31 14:38:38 +00:00
version.c version.c: EXIT_SUCCESS 2013-11-28 07:34:18 +00:00
version.h * 2014-05-20 2014-05-19 20:00:14 +00:00
vm.c * compile.c (BUFSIZE): Unused macro removed. 2014-05-11 13:29:16 +00:00
vm_backtrace.c vm_backtrace.c: initialize flag 2014-01-24 07:17:17 +00:00
vm_core.h * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
vm_debug.h
vm_dump.c * vm_dump.c (rb_print_backtrace): current implementation 2014-03-31 22:34:41 +00:00
vm_eval.c vm_eval.c: hide intermediate hash 2014-05-07 04:26:55 +00:00
vm_exec.c * vm_exec.c (cfp): Fixes a SEGV issue in r44554. 2014-01-14 02:32:45 +00:00
vm_exec.h * vm_exec.h (VM_DEBUG_STACKOVERFLOW): added. 2013-12-18 05:33:50 +00:00
vm_insnhelper.c * vm.c (invoke_block_from_c): add VM_FRAME_FLAG_BMETHOD to record 2014-04-30 09:08:10 +00:00
vm_insnhelper.h * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into 2013-12-20 08:07:47 +00:00
vm_method.c variable.c, vm_method.c: pin down 2014-03-31 14:38:38 +00:00
vm_opts.h
vm_trace.c vm*: doubly-linked list from ccan to manage vm->living_threads 2014-05-10 23:48:51 +00:00
vsnprintf.c * vsnprintf.c: remove duplicated def of `UNINITIALIZED_VAR()'. 2014-02-05 05:42:52 +00:00

README.md

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.) cf. http://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:

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

The Ruby distribution files can be found in 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 http://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 and see the list of branches:

$ svn ls http://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:

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

Mailing list

There is a mailing list to talk about Ruby. To subscribe 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 does 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 following directories and install files onto them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFOR M}
    • ${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}/${P LATFORM}
    • ${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 (http://www.ruby-lang.org/en/community/mailing-lists) or on websites like (http://stackoverflow.com).

Bug reports should be filed at http://bugs.ruby-lang.org

The Author

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

mailto:matz@ruby-lang.org