Skip to content
This repository

A concerted effort to augment and enhance Ruby MRI documentation

branch: trunk

This branch is 0 commits ahead and 0 commits behind trunk

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 benchmark
Octocat-spinner-32 bin
Octocat-spinner-32 bootstraptest
Octocat-spinner-32 cygwin
Octocat-spinner-32 defs
Octocat-spinner-32 doc
Octocat-spinner-32 enc
Octocat-spinner-32 ext
Octocat-spinner-32 include
Octocat-spinner-32 lib
Octocat-spinner-32 man
Octocat-spinner-32 misc
Octocat-spinner-32 missing
Octocat-spinner-32 nacl
Octocat-spinner-32 sample
Octocat-spinner-32 spec
Octocat-spinner-32 symbian
Octocat-spinner-32 template
Octocat-spinner-32 test
Octocat-spinner-32 tool
Octocat-spinner-32 win32
Octocat-spinner-32 .document
Octocat-spinner-32 .editorconfig
Octocat-spinner-32 .gdbinit
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .indent.pro
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 BSDL
Octocat-spinner-32 COPYING
Octocat-spinner-32 COPYING.ja
Octocat-spinner-32 ChangeLog
Octocat-spinner-32 GPL
Octocat-spinner-32 KNOWNBUGS.rb
Octocat-spinner-32 LEGAL
Octocat-spinner-32 Makefile.in
Octocat-spinner-32 NEWS
Octocat-spinner-32 README.EXT
Octocat-spinner-32 README.EXT.ja
Octocat-spinner-32 README.ja.md
Octocat-spinner-32 README.md
Octocat-spinner-32 addr2line.c
Octocat-spinner-32 addr2line.h
Octocat-spinner-32 array.c
Octocat-spinner-32 bignum.c
Octocat-spinner-32 class.c
Octocat-spinner-32 common.mk
Octocat-spinner-32 compar.c
Octocat-spinner-32 compile.c
Octocat-spinner-32 complex.c
Octocat-spinner-32 configure.in
Octocat-spinner-32 constant.h
Octocat-spinner-32 cont.c
Octocat-spinner-32 debug.c
Octocat-spinner-32 dir.c
Octocat-spinner-32 dln.c
Octocat-spinner-32 dln.h
Octocat-spinner-32 dln_find.c
Octocat-spinner-32 dmydln.c
Octocat-spinner-32 dmyext.c
Octocat-spinner-32 encoding.c
Octocat-spinner-32 enum.c
Octocat-spinner-32 enumerator.c
Octocat-spinner-32 error.c
Octocat-spinner-32 eval.c
Octocat-spinner-32 eval_error.c
Octocat-spinner-32 eval_intern.h
Octocat-spinner-32 eval_jump.c
Octocat-spinner-32 file.c
Octocat-spinner-32 gc.c
Octocat-spinner-32 gc.h
Octocat-spinner-32 gem_prelude.rb
Octocat-spinner-32 golf_prelude.rb
Octocat-spinner-32 goruby.c
Octocat-spinner-32 hash.c
Octocat-spinner-32 ia64.s
Octocat-spinner-32 inits.c
Octocat-spinner-32 insns.def
Octocat-spinner-32 internal.h
Octocat-spinner-32 io.c
Octocat-spinner-32 iseq.c
Octocat-spinner-32 iseq.h
Octocat-spinner-32 lex.c.blt
Octocat-spinner-32 load.c
Octocat-spinner-32 loadpath.c
Octocat-spinner-32 localeinit.c
Octocat-spinner-32 main.c
Octocat-spinner-32 marshal.c
Octocat-spinner-32 math.c
Octocat-spinner-32 method.h
Octocat-spinner-32 miniinit.c
Octocat-spinner-32 node.c
Octocat-spinner-32 node.h
Octocat-spinner-32 numeric.c
Octocat-spinner-32 object.c
Octocat-spinner-32 pack.c
Octocat-spinner-32 parse.y
Octocat-spinner-32 prelude.rb
Octocat-spinner-32 probes.d
Octocat-spinner-32 probes_helper.h
Octocat-spinner-32 proc.c
Octocat-spinner-32 process.c
Octocat-spinner-32 random.c
Octocat-spinner-32 range.c
Octocat-spinner-32 rational.c
Octocat-spinner-32 re.c
Octocat-spinner-32 regcomp.c
Octocat-spinner-32 regenc.c
Octocat-spinner-32 regenc.h
Octocat-spinner-32 regerror.c
Octocat-spinner-32 regexec.c
Octocat-spinner-32 regint.h
Octocat-spinner-32 regparse.c
Octocat-spinner-32 regparse.h
Octocat-spinner-32 regsyntax.c
Octocat-spinner-32 ruby.c
Octocat-spinner-32 ruby_atomic.h
Octocat-spinner-32 safe.c
Octocat-spinner-32 signal.c
Octocat-spinner-32 siphash.c
Octocat-spinner-32 siphash.h
Octocat-spinner-32 sparc.c
Octocat-spinner-32 sprintf.c
Octocat-spinner-32 st.c
Octocat-spinner-32 strftime.c
Octocat-spinner-32 string.c
Octocat-spinner-32 struct.c
Octocat-spinner-32 thread.c
Octocat-spinner-32 thread_native.h
Octocat-spinner-32 thread_pthread.c
Octocat-spinner-32 thread_pthread.h
Octocat-spinner-32 thread_win32.c
Octocat-spinner-32 thread_win32.h
Octocat-spinner-32 time.c
Octocat-spinner-32 timev.h
Octocat-spinner-32 transcode.c
Octocat-spinner-32 transcode_data.h
Octocat-spinner-32 util.c
Octocat-spinner-32 variable.c
Octocat-spinner-32 version.c
Octocat-spinner-32 version.h
Octocat-spinner-32 vm.c
Octocat-spinner-32 vm_backtrace.c
Octocat-spinner-32 vm_core.h
Octocat-spinner-32 vm_debug.h
Octocat-spinner-32 vm_dump.c
Octocat-spinner-32 vm_eval.c
Octocat-spinner-32 vm_exec.c
Octocat-spinner-32 vm_exec.h
Octocat-spinner-32 vm_insnhelper.c
Octocat-spinner-32 vm_insnhelper.h
Octocat-spinner-32 vm_method.c
Octocat-spinner-32 vm_opts.h
Octocat-spinner-32 vm_trace.c
Octocat-spinner-32 vsnprintf.c
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 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.

matz@ruby-lang.org

Something went wrong with that request. Please try again.