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

Fetching latest commit…

Cannot retrieve the latest commit at this time

bcc32 * configure.in: read API version from include/ruby/version.h.
benchmark
bin
bootstraptest
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc.
defs
doc
enc
ext
include
lib
man
misc
missing
nacl
sample
spec * spec/default.mspec: expand relative path for ruby_exe which uses
symbian Added HAVE_LABS and HAVE_LLABS to config.h
template
test
tool
win32
.document * prelude.rb, .document: Stuff in prelude.rb should be documented
.editorconfig .editorconfig: new
.gdbinit
.gitignore
.indent.pro * .indent.pro: added for ruby-style.
.travis.yml
BSDL Add BSDL file.
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
GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug #6328]
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 inilne markups
addr2line.c
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris
array.c
atomic.h
bignum.c
class.c
common.mk
compar.c * array.c: Documentation: change => in call-seq to ->.
compile.c
complex.c
configure.in
constant.h * variable.c (rb_const_set): show the previous definition
cont.c
debug.c
debug.h * debug.h: parenthesize macro arguments.
dir.c
dln.c
dln.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible.
dln_find.c * gc.c (rb_objspace_free): global_List is allocated with xmalloc.
dmydln.c * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control
dmyencoding.c * encoding.c (enc_init_db): moved to enc/encdb.c.
dmyext.c no K&R style
dmyversion.c * dmyversion.c: empty load path in miniruby.
encoding.c
enum.c
enumerator.c
error.c
eval.c
eval_error.c
eval_intern.h
eval_jump.c
file.c
gc.c
gc.h
gem_prelude.rb * ruby.c (process_options): revert r30549.
golf_prelude.rb cancel subversion backfire. sorry
goruby.c
hash.c
ia64.s * removed trailing spaces.
id.c
inits.c ext/rbconfig/sizeof: move to an extension library
insns.def
internal.h
io.c
iseq.c
iseq.h
lex.c.blt * defs/keywords (reserved_word): made inline function static.
load.c
main.c
marshal.c
math.c
method.h
node.c
node.h
numeric.c
object.c
pack.c
parse.y
prelude.rb * remove trailing spaces.
proc.c
process.c
random.c
range.c
rational.c
re.c
regcomp.c
regenc.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
regenc.h * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
regerror.c * regcomp.c: Merge Onigmo 3d855b3.
regexec.c
regint.h
regparse.c
regparse.h * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
ruby.c
safe.c * use RB_TYPE_P which is optimized for constant types, instead of
signal.c
sparc.c adjust style.
sprintf.c
st.c
strftime.c unecessary macros and K&R style coding
string.c
struct.c
thread.c
thread_pthread.c
thread_pthread.h * thread_pthread.h: no Structured Exception Handling like macros.
thread_win32.c
thread_win32.h thread_win32.h: rb_thread_lock_t for USE_WIN32_MUTEX
time.c
timev.h * timev.h (TIME_SCALE): defined as 1000000000.
transcode.c
transcode_data.h Supports static linking of extensions and encodings again.
util.c
variable.c
version.c
version.h
vm.c
vm_backtrace.c
vm_core.h
vm_dump.c
vm_eval.c
vm_exec.c
vm_exec.h
vm_insnhelper.c
vm_insnhelper.h
vm_method.c
vm_opts.h * vm_opts.h: enable "OPT_TRACE_INSTRUCTION" on default.
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

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.