The Ruby Programming Language [mirror]
Go to file
ktsj a17fd731c9 * ChangeLog: style fix.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33180 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-09-04 06:18:06 +00:00
bcc32
benchmark * benchmark/driver.rb: Add difference column to report that averages 2011-07-06 21:47:56 +00:00
bin * lib/rdoc: Update to RDoc 3.9. Fixed `ri []`, stopdoc creating an 2011-07-31 00:19:00 +00:00
bootstraptest * proc.c (proc_new): force to rewrite errinfo when calling Proc.new in ensure. 2011-08-27 09:59:48 +00:00
cygwin
defs * tool/rbinstall.rb (gem): install all gemspecs under lib and ext. 2011-08-04 07:08:48 +00:00
doc * ext/date/date_core.c (date_strftime_alloc): followed the change 2011-08-13 00:12:05 +00:00
enc Forward-ports r32780 from branches/ruby_1_9_3 to trunk. 2011-07-31 14:17:42 +00:00
ext * ext/io/console/console.c (console_set_winsize): remove 2011-09-03 14:54:14 +00:00
include * win32/win32.c, include/ruby/intern.h (rb_w32_fd_copy): implement 2011-08-30 15:04:11 +00:00
lib * lib/thread.rb (SizedQueue#max=) raise ArgumentError if max is not 2011-09-03 09:46:51 +00:00
man
misc * misc/ruby-mode.el (ruby-indent-beg-re): Fix broken regular 2011-06-30 14:54:11 +00:00
missing * missing/lgamma_r.c (lgamma_r): get rid of false warning on mingw. 2011-05-18 13:35:13 +00:00
sample * ext/pathname/lib/pathname.rb: Fix typos and grammar mistakes. Patch 2011-08-26 22:22:37 +00:00
spec * spec/README: update the description. 2011-05-24 22:13:14 +00:00
symbian
template
test * test/ruby/test_fiber.rb (TestFiber#test_no_valid_cfp): 2011-09-03 15:54:44 +00:00
tool * tool/mkconfig.rb: do not make the entries related to sitedir and 2011-08-13 13:17:30 +00:00
win32 * win32/win32.c (rb_w32_fd_copy): cast explicitly to suppress warnings. 2011-09-02 21:23:22 +00:00
.document
.gdbinit
.gitignore
.indent.pro
BSDL
COPYING
COPYING.ja
ChangeLog * ChangeLog: style fix. 2011-09-04 06:18:06 +00:00
GPL
KNOWNBUGS.rb
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. 2011-08-03 07:10:56 +00:00
Makefile.in Forward-ports r32776 from branches/ruby_1_9_3 to trunk. 2011-07-31 14:17:37 +00:00
NEWS * time.c (strftimev): Make Time#to_s default to US-ASCII encoding but 2011-08-25 23:24:33 +00:00
README * README*: remove trailing spaces. 2011-08-25 21:00:03 +00:00
README.EXT * README*: remove trailing spaces. 2011-08-25 21:00:03 +00:00
README.EXT.ja * README*: remove trailing spaces. 2011-08-25 21:00:03 +00:00
README.ja * README*: remove trailing spaces. 2011-08-25 21:00:03 +00:00
addr2line.c * addr2line.c: use USE_ELF instead of __ELF__ because Solaris 2011-07-08 12:23:10 +00:00
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris 2011-07-08 12:23:10 +00:00
array.c * array.c (rb_ary_set_len): new function to set array length. 2011-07-29 14:53:51 +00:00
atomic.h * atomic.h (ATOMIC_OR): _InterlockedOr is unavailable in VC6. 2011-07-09 07:56:04 +00:00
bignum.c * numeric.c (bit_coerce): A Fixnum and a Bignum are only permitted for 2011-08-29 01:07:15 +00:00
class.c * class.c (Init_class_hierarchy): should name BasicObject 2011-06-30 18:34:09 +00:00
common.mk Forward-ports r32776 from branches/ruby_1_9_3 to trunk. 2011-07-31 14:17:37 +00:00
compar.c
compile.c * iseq.h, iseq.c, compile.c: Change the line number data structure 2011-08-24 06:31:15 +00:00
complex.c * complex.c (nucomp_rationalize): calls rationalize of real part if 2011-08-10 10:35:08 +00:00
configure.in * configure.in (sizeof_struct_dirent_too_small): check if struct 2011-09-03 14:56:26 +00:00
constant.h * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
cont.c * cont.c (fiber_entry): fix stack allocation failure on Debian 2011-08-30 00:51:46 +00:00
debug.c
debug.h
dir.c * dir.c: Make RDoc more precise about order of Dir.glob 2011-06-27 23:38:31 +00:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c (enc_find): mistakenly remained !. [Bug #5150] 2011-08-02 22:46:34 +00:00
enum.c * enum.c (enum_inject): remove empty line to notify rdoc 2011-07-21 09:12:36 +00:00
enumerator.c * enumerator.c: Remove "enumeration sequenced by". 2011-07-09 00:25:27 +00:00
error.c * error.c (report_bug): use a small message buffer instead of BUFSIZ. 2011-08-04 11:23:16 +00:00
eval.c * thread_pthread.c (rb_thread_create_timer_thread): removed 2011-07-10 17:04:40 +00:00
eval_error.c * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
eval_intern.h * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
eval_jump.c
file.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
gc.c * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c * hash.c (recursive_hash): hash value of emptied hash should be 2011-08-02 03:03:18 +00:00
ia64.s
id.c
inits.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
insns.def * vm_insnhelper.c (vm_search_const_defined_class): search 2011-09-02 05:36:49 +00:00
internal.h * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
io.c * io.c (argf_next_argv): open in default text mode. 2011-09-03 14:52:18 +00:00
iseq.c Use PRIdSIZE. 2011-08-29 03:54:35 +00:00
iseq.h * iseq.h, iseq.c, compile.c: Change the line number data structure 2011-08-24 06:31:15 +00:00
lex.c.blt
load.c * load.c (rb_f_require): Improve documentation of Kernel#require. 2011-08-23 06:26:11 +00:00
main.c
marshal.c * marshal.c (w_object): Fix exception message when _dump_data is not 2011-08-05 22:14:05 +00:00
math.c * complex.c (f_signbit): fix compile error in gcc4 on Solaris with 2011-08-05 07:03:21 +00:00
method.h * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
node.c * node.c (dump_node): add today's knowledge. "init arguments (m)" and 2011-07-21 10:35:52 +00:00
node.h * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
numeric.c * numeric.c (flo_round): substitute machine dependent magic number. 2011-09-01 16:07:16 +00:00
object.c * object.c: Add usage documentation for BasicObject. Based on patch 2011-07-27 06:44:39 +00:00
pack.c
parse.y * parse.y (parser_tokadd_string, parser_yylex): ignore a backslash 2011-09-02 00:58:10 +00:00
prelude.rb
proc.c * proc.c (proc_new): force to rewrite errinfo when calling Proc.new in ensure. 2011-08-27 09:59:48 +00:00
process.c * process.c (proc_spawn_v, proc_spawn): should not wait the 2011-08-19 05:25:52 +00:00
random.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
range.c * range.c (range_max): fix behavior with excluded end value. 2011-07-10 00:47:31 +00:00
rational.c * rational.c (nurat_coerce): Rational#coerce should converts itself 2011-08-17 01:24:22 +00:00
re.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h * regint.h (PLATFORM_UNALIGNED_WORD_ACCESS): Power PC does not 2011-07-14 16:51:29 +00:00
regparse.c
regparse.h
regsyntax.c
ruby.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
safe.c
signal.c * vm.c (th_init): preallocate alternative stack. 2011-07-30 01:57:06 +00:00
sprintf.c * sprintf.c (rb_str_format): add RB_GC_GUARD to prevent temporary 2011-08-22 14:48:10 +00:00
st.c * regint.h (PLATFORM_UNALIGNED_WORD_ACCESS): Power PC does not 2011-07-14 16:51:29 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): get enc argument to specify 2011-08-27 09:18:18 +00:00
string.c * string.c (tr_trans): free heap ptr when the str is not embeded. 2011-07-01 05:28:48 +00:00
struct.c * error.c (rb_check_trusted): new function to check an object is 2011-07-17 07:26:45 +00:00
thread.c * thread.c (rb_thread_select): critical typo in r33117. 2011-08-30 15:49:55 +00:00
thread_pthread.c * thread_pthread.c: fix typo. 2011-08-05 01:11:12 +00:00
thread_pthread.h * thread_pthread.h (rb_global_vm_lock_struct): add volatile to 2011-06-27 12:59:08 +00:00
thread_win32.c * include/ruby/intern.h, thread_pthread.c (rb_reserved_fd_p, 2011-07-03 21:56:59 +00:00
thread_win32.h
time.c * internal.h (rb_strftime_timespec): moved from time.c and define only 2011-08-27 10:06:25 +00:00
timev.h
transcode.c * io.c (validate_enc_binmode, prep_stdio): default to text mode on 2011-09-02 12:11:17 +00:00
transcode_data.h
util.c * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. 2011-08-03 07:10:56 +00:00
variable.c * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
version.c * math.c: Attach documentation for Math. 2011-06-29 03:09:34 +00:00
version.h * 2011-09-04 2011-09-03 15:11:57 +00:00
vm.c * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
vm_core.h * vm.c (rb_vm_rewrite_dfp_in_errinfo): change return type 2011-08-27 11:51:02 +00:00
vm_dump.c * vm_dump.c (VMDEBUG): suppress undefined macro warnings. 2011-07-27 02:04:51 +00:00
vm_eval.c * test/ruby/test_object.rb: tests that respond_to? returns false. 2011-08-05 06:55:36 +00:00
vm_exec.c * vm_exec.c: remove conditions for clang 2011-05-31 02:08:58 +00:00
vm_exec.h
vm_insnhelper.c * vm_insnhelper.c (vm_search_const_defined_class): search 2011-09-02 05:36:49 +00:00
vm_insnhelper.h * vm_insnhelper.h, vm_insnhelper.c, vm.c, vm_method.c, insns.def: 2011-08-24 22:02:03 +00:00
vm_method.c * vm_insnhelper.h, vm_insnhelper.c, vm.c, vm_method.c, insns.def: 2011-08-24 22:02:03 +00:00
vm_opts.h
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://redmine.ruby-lang.org/wiki/ruby-19/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

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/


* 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 <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 optflags=.. and warnflags=.. as necessary
     to override them.

  3. Edit defines.h if you need.  Usually this step will not be needed.

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

  5. Run make.

  6. Optionally, run 'make test' to check whether the compiled Ruby
     interpreter works well.  If you see the message "test succeeded",
     your ruby works as it should (hopefully).

  7. 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}/${PLATFORM}
       * ${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}/${PLATFORM}
       * ${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.


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

  matz@netlab.jp

-------------------------------------------------------
created at: Thu Aug  3 11:57:36 JST 1995
Local variables:
mode: indented-text
end: