Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The Ruby Programming Language

tree: 2c1939f458

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bcc32 * configure.in: read API version from include/ruby/version.h. August 24, 2010
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 * spec/default.mspec: expand relative path for ruby_exe which uses April 16, 2012
Octocat-spinner-32 symbian Added HAVE_LABS and HAVE_LLABS to config.h November 13, 2010
Octocat-spinner-32 template
Octocat-spinner-32 test
Octocat-spinner-32 tool
Octocat-spinner-32 win32
Octocat-spinner-32 .document
Octocat-spinner-32 .gdbinit
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .indent.pro * .indent.pro: added for ruby-style. March 11, 2010
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 BSDL
Octocat-spinner-32 COPYING * COPYING: change Ruby's License from a dual license with GPLv2 September 15, 2010
Octocat-spinner-32 COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128] September 04, 2011
Octocat-spinner-32 ChangeLog
Octocat-spinner-32 GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug #6328] June 03, 2012
Octocat-spinner-32 KNOWNBUGS.rb
Octocat-spinner-32 LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. August 03, 2011
Octocat-spinner-32 Makefile.in
Octocat-spinner-32 NEWS
Octocat-spinner-32 README
Octocat-spinner-32 README.EXT
Octocat-spinner-32 README.EXT.ja
Octocat-spinner-32 README.ja inilne markups May 03, 2012
Octocat-spinner-32 addr2line.c
Octocat-spinner-32 addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris July 08, 2011
Octocat-spinner-32 array.c
Octocat-spinner-32 atomic.h
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 * variable.c (rb_const_set): show the previous definition September 03, 2011
Octocat-spinner-32 cont.c
Octocat-spinner-32 debug.c
Octocat-spinner-32 debug.h
Octocat-spinner-32 dir.c
Octocat-spinner-32 dln.c
Octocat-spinner-32 dln.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. July 21, 2010
Octocat-spinner-32 dln_find.c * gc.c (rb_objspace_free): global_List is allocated with xmalloc. January 08, 2012
Octocat-spinner-32 dmydln.c * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control April 13, 2012
Octocat-spinner-32 dmyencoding.c * encoding.c (enc_init_db): moved to enc/encdb.c. April 07, 2008
Octocat-spinner-32 dmyext.c no K&R style May 19, 2012
Octocat-spinner-32 dmyversion.c * dmyversion.c: empty load path in miniruby. February 08, 2010
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 volatile errinfo March 18, 2012
Octocat-spinner-32 file.c
Octocat-spinner-32 gc.c
Octocat-spinner-32 gc.h
Octocat-spinner-32 gem_prelude.rb * ruby.c (process_options): revert r30549. January 17, 2011
Octocat-spinner-32 golf_prelude.rb cancel subversion backfire. sorry March 07, 2011
Octocat-spinner-32 goruby.c
Octocat-spinner-32 hash.c
Octocat-spinner-32 ia64.s * removed trailing spaces. June 09, 2012
Octocat-spinner-32 id.c
Octocat-spinner-32 inits.c ext/rbconfig/sizeof: move to an extension library November 18, 2013
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 * defs/keywords (reserved_word): made inline function static. May 16, 2009
Octocat-spinner-32 load.c
Octocat-spinner-32 main.c
Octocat-spinner-32 marshal.c
Octocat-spinner-32 math.c
Octocat-spinner-32 method.h
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 * remove trailing spaces. May 15, 2011
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 Remove unused variables. March 05, 2012
Octocat-spinner-32 regenc.c Revert r41786 "broken utf-8" July 09, 2013
Octocat-spinner-32 regenc.h * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] February 17, 2012
Octocat-spinner-32 regerror.c * regcomp.c: Merge Onigmo 3d855b3. March 21, 2012
Octocat-spinner-32 regexec.c
Octocat-spinner-32 regint.h
Octocat-spinner-32 regparse.c
Octocat-spinner-32 regparse.h * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] February 17, 2012
Octocat-spinner-32 regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] February 17, 2012
Octocat-spinner-32 ruby.c
Octocat-spinner-32 safe.c * use RB_TYPE_P which is optimized for constant types, instead of September 29, 2011
Octocat-spinner-32 signal.c
Octocat-spinner-32 sparc.c adjust style. June 27, 2012
Octocat-spinner-32 sprintf.c
Octocat-spinner-32 st.c
Octocat-spinner-32 strftime.c unecessary macros and K&R style coding August 16, 2012
Octocat-spinner-32 string.c
Octocat-spinner-32 struct.c
Octocat-spinner-32 thread.c
Octocat-spinner-32 thread_pthread.c
Octocat-spinner-32 thread_pthread.h * thread_pthread.h: no Structured Exception Handling like macros. October 29, 2011
Octocat-spinner-32 thread_win32.c
Octocat-spinner-32 thread_win32.h thread_win32.h: rb_thread_lock_t for USE_WIN32_MUTEX June 17, 2012
Octocat-spinner-32 time.c
Octocat-spinner-32 timev.h * timev.h (TIME_SCALE): defined as 1000000000. August 29, 2009
Octocat-spinner-32 transcode.c
Octocat-spinner-32 transcode_data.h Supports static linking of extensions and encodings again. May 16, 2012
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_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
= 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

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 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 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 YourFirstName YourFamilyName
e.g.
        subscribe Joseph Smith

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


== How to compile and install

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

1.   If +./configure+ does not exist or is older than configure.in,
     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
     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 "<tt>#option nodynamic</tt>" in
     +ext/Setup+.

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.


== Copying

See the file +COPYING+.


== The Author

Feel free to send comments and bug reports to the author.  Here is the
author's latest mail address:

<mailto:matz@ruby-lang.org>

-------------------------------------------------------
created at: Thu Aug  3 11:57:36 JST 1995
--
Local variables:
mode: rdoc
end:
Something went wrong with that request. Please try again.