Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The Ruby Programming Language
Ruby C Emacs Lisp Tcl Objective-C Ragel in Ruby Host Other
branch: trunk

This branch is 5258 commits behind ruby:trunk

configure.in: LDFLAGS and DLDFLAGS for opt-dir

* configure.in: reset LDFLAGS and DLDFLAGS for opt-dir again after
  LIBPATHFLAG and RPATHFLAG are set.  [ruby-dev:47868] [Bug #9317]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@44476 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
latest commit 41d42a5937
@nobu nobu authored
Failed to load latest commit information.
benchmark
bin
bootstraptest
cygwin
defs * defs/opt_operand.def: Fix typo
doc old ChangeLog and NEWS move to doc
enc
ext
include
lib
man
misc
missing
nacl
sample * remove trailing spaces, append newline at EOF.
spec
symbian Added HAVE_LABS and HAVE_LLABS to config.h
template
test
tool
win32 remove HAVE_FSEEKO from win32/win32.c
.document * .document: Removed extra space
.editorconfig .editorconfig: new
.gdbinit
.gitignore
.indent.pro * .indent.pro: added for ruby-style.
.travis.yml * .travis.yml: Rebuild Travis CI's "ruby-head" version on successful
BSDL
COPYING
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128]
ChangeLog
GPL
KNOWNBUGS.rb
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function.
Makefile.in
NEWS
README
README.EXT
README.EXT.ja
README.ja
addr2line.c
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris
array.c
bignum.c
class.c
common.mk
compar.c
compile.c
complex.c * complex.c: removed meaningless lines.
configure.in
constant.h
cont.c
debug.c * include/ruby/ruby.h: rename FL_OLDGEN to FL_PROMOTED.
dir.c
dln.c adjust style.
dln.h
dln_find.c
dmydln.c * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control
dmyext.c
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
error.c * error.c: add Exception#backtrace_locations.
eval.c
eval_error.c
eval_intern.h * eval_intern.h (SAVE_ROOT_JMPBUF): workaround for the failure of
eval_jump.c
file.c
gc.c
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c hash.c: remove dead code
ia64.s
inits.c
insns.def
internal.h
io.c
iseq.c
iseq.h
lex.c.blt
load.c
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h
localeinit.c localeinit.c: split
main.c
marshal.c
math.c
method.h
miniinit.c ext/rbconfig/sizeof: move to an extension library
node.c
node.h
numeric.c
object.c
pack.c
parse.y
prelude.rb
probes.d
probes_helper.h probes_helper.h: RUBY_DTRACE_HOOK
proc.c
process.c
random.c
range.c hash.c: detect recursion for all
rational.c
re.c
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee.
regint.h
regparse.c
regparse.h
regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
ruby.c
ruby_atomic.h
safe.c safe.c: ruby_safe_level_4_warning
signal.c
siphash.c siphash.c: fix missing condition
siphash.h
sparc.c
sprintf.c sprintf.c: QUOTE flag
st.c
strftime.c
string.c * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into
struct.c hash.c: detect recursion for all
thread.c
thread_native.h
thread_pthread.c
thread_pthread.h * thread_(pthread|win32).h: rename rb_thread_cond_t to
thread_win32.c
thread_win32.h * thread_(pthread|win32).h: rename rb_thread_cond_t to
time.c
timev.h
transcode.c
transcode_data.h
util.c
variable.c
version.c version.c: EXIT_SUCCESS
version.h
vm.c vm.c: check cbase
vm_backtrace.c * error.c: add Exception#backtrace_locations.
vm_core.h
vm_debug.h
vm_dump.c vm_dump.c: improve wording of apple crashlog messages
vm_eval.c
vm_exec.c * vm_exec.h (VM_DEBUG_STACKOVERFLOW): added.
vm_exec.h
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_opts.h
vm_trace.c
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

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 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:

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 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+.

     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
(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>

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