The Ruby Programming Language [mirror]
Go to file
nobu c6820cc3be * README.EXT{,.ja} (rb_block_call): fixed about third/fourth
arguments to the block.  based on [ruby-core:31192] by Asher
  Haig.  [Bug #3558]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28617 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-07-11 12:20:28 +00:00
bcc32
benchmark
bin
bootstraptest * bootstraptest/test_class.rb: add a test for [ruby-core:30843]. 2010-06-27 18:13:06 +00:00
cygwin
defs
doc * ext/pty: moved documents and samples to the appropriate places. 2010-06-23 08:25:12 +00:00
enc * enc/trans/utf8_mac.trans (buf_apply): fix for patterns 2010-06-12 17:13:54 +00:00
ext * ext/psych/lib/psych/visitors/yaml_tree.rb (format_time): use new 2010-07-08 16:51:28 +00:00
include * include/ruby/ruby.h (rb_cRandom): added. 2010-07-11 10:05:27 +00:00
lib * gem_prelude.rb: provide workaround for gem activation. Currently, 2010-07-07 15:40:52 +00:00
man
misc * misc/ruby-mode.el (ruby-mode-set-encoding): commit miss. 2010-05-31 09:27:06 +00:00
missing * missing/close.c: ignore ECONNRESET. 2010-07-07 01:29:22 +00:00
sample * test/ruby/test_system.rb (test_syntax2): moved from sample/test.rb 2010-07-04 12:01:46 +00:00
spec
symbian
template * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
test * test/rdoc/test_rdoc_ri_driver.rb (test_formatter): add a test. a 2010-07-11 02:09:09 +00:00
tool * Makefile.in ({,dist-,real-}clean-ext): should also omit 2010-07-11 08:01:59 +00:00
win32 * configure.in (enable-debug-env): option for RUBY_DEBUG env. 2010-06-26 04:07:20 +00:00
.cvsignore
.document
.gdbinit * .gdbinit (rp): show type name for RTypedData. 2010-06-05 07:39:47 +00:00
.gitignore
.indent.pro
COPYING
COPYING.ja
ChangeLog * README.EXT{,.ja} (rb_block_call): fixed about third/fourth 2010-07-11 12:20:28 +00:00
GPL
KNOWNBUGS.rb
LEGAL
Makefile.in * Makefile.in ({,dist-,real-}clean-ext): should also omit 2010-07-11 08:01:59 +00:00
NEWS * vm_method.c (rb_method_boundp): Return false for protected 2010-07-05 07:11:44 +00:00
README
README.EXT * README.EXT{,.ja} (rb_block_call): fixed about third/fourth 2010-07-11 12:20:28 +00:00
README.EXT.ja * README.EXT{,.ja} (rb_block_call): fixed about third/fourth 2010-07-11 12:20:28 +00:00
README.ja
ToDo
array.c * array.c (rb_ary_product): clear uninitialized elements in temporary 2010-06-06 10:56:45 +00:00
bignum.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00
class.c * class.c (rb_mod_init_copy): when class is dup'ed, a metaclass of the 2010-06-27 17:47:21 +00:00
common.mk * common.mk (test-knownbug): ignore known bugs. 2010-07-01 04:00:56 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * compile.c (iseq_compile_each): should consider block on stack, 2010-06-02 03:05:06 +00:00
complex.c
configure.in * missing/close.c: ignore ECONNRESET. 2010-07-07 01:29:22 +00:00
cont.c * cont.c (fiber_setcontext): Use swapcontext() instead longjmp(). 2010-05-21 18:55:50 +00:00
debug.c * suppress warnings. 2010-05-21 09:10:23 +00:00
debug.h
dir.c Clarification of what '*' matches. Patch by John Wells <john.wells at greatworx.com> 2010-06-04 21:22:47 +00:00
dln.c * suppress warnings. 2010-05-21 09:10:23 +00:00
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c update comment. 2010-05-31 13:37:50 +00:00
enum.c * enum.c (zip): rdoc fix, patch by okkez [ruby-dev:41737] 2010-06-27 03:10:20 +00:00
enumerator.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00
error.c * error.c (rb_bug): existance of _set_abort_behavior() depends on 2010-06-16 06:41:56 +00:00
eval.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
eval_error.c * eval_error.c (error_print): clear raised_flag while error-printing 2010-06-21 14:43:58 +00:00
eval_intern.h * load.c (rb_load_internal): remove call to rb_realpath_internal 2010-06-17 14:32:20 +00:00
eval_jump.c
file.c * file.c (ruby_find_basename): set correct baselen. 2010-07-07 04:22:30 +00:00
gc.c * gc.c (unlink_heap_slot, slot_sweep): unlink heaps_slot of 2010-06-29 03:11:05 +00:00
gc.h
gem_prelude.rb * gem_prelude.rb: provide workaround for gem activation. Currently, 2010-07-07 15:40:52 +00:00
golf_prelude.rb
goruby.c
hash.c * hash.c: Documentation: change => in call-seq to ->. 2010-05-17 21:31:22 +00:00
ia64.s
id.c * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
inits.c
insns.def * insns.def (concatarray): removed unused variable. 2010-06-03 09:40:25 +00:00
io.c * io.c (nogvl_copy_stream_sendfile): jump to retry_sendfile directly 2010-07-06 13:59:12 +00:00
iseq.c * load.c (rb_load_internal): remove call to rb_realpath_internal 2010-06-17 14:32:20 +00:00
iseq.h
lex.c.blt
load.c * ruby.c: add prototype of rb_realpath_internal. 2010-06-18 01:16:13 +00:00
main.c
marshal.c * marshal.c (w_object): suppress empty instance variable entry on 2010-06-30 23:40:37 +00:00
math.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
method.h
node.c
node.h
numeric.c Merge branch 'mybranch' of git://github.com/orangea/ruby into trunk 2010-07-07 10:59:44 +00:00
object.c * object.c (rb_f_integer): add example with base. 2010-07-06 22:02:25 +00:00
pack.c update doc. 2010-06-28 13:05:07 +00:00
parse.y * parse.y (shadowing_lvar_gen): should add lvar to vars and 2010-06-22 10:57:40 +00:00
prelude.rb
proc.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00
process.c * process.c (rb_f_spawn): use correct command name for the error 2010-05-23 23:16:09 +00:00
random.c * random.c (random_rand): add the result of random to the 2010-05-26 11:19:30 +00:00
range.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
rational.c
re.c * re.c (rb_reg_expr_str): ASCII incompatible strings 2010-06-05 11:32:05 +00:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c * regparse.c (onig_syntax_warn): do not use external strings as 2010-05-31 10:26:01 +00:00
regparse.h
regsyntax.c
ruby.c * include/ruby/io.h, io.c: reverted r21709. 2010-06-27 14:31:19 +00:00
safe.c
signal.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
sprintf.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
st.c
strftime.c * strftime.c (rb_strftime_with_timespec): fix precision handling for 2010-07-10 12:43:54 +00:00
string.c * string.c (rb_str_conv_enc_opts): fix infinite loop because 2010-07-08 08:18:07 +00:00
struct.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
thread.c * thread.c (rb_fd_resize, rb_fd_copy): avoid NULL dereference upon 2010-06-28 12:58:03 +00:00
thread_pthread.c * thread_pthread.c (thread_start_func_1): don't call 2010-07-01 07:25:20 +00:00
thread_pthread.h
thread_win32.c * vm.c (Init_BareVM): call Init_native_thread here. 2010-06-05 23:26:43 +00:00
thread_win32.h
time.c update doc. 2010-07-10 11:26:54 +00:00
timev.h
transcode.c * file.c (rb_str_encode_ospath): when the encoding of the parameter 2010-06-17 09:46:30 +00:00
transcode_data.h * gc.c (gc_lazy_sweep): clean a warning. 2010-06-18 01:44:52 +00:00
util.c * io.c (argf_inplace_mode_set): prohibits an assignment of a tainted 2010-07-02 14:31:26 +00:00
variable.c * variable.c (uninitialized_constant): process through 2010-06-12 00:20:27 +00:00
version.c
version.h * 2010-07-11 2010-07-11 02:09:13 +00:00
vm.c * vm.c (thread_free): free altstack to prevent memory leak. a patch 2010-07-05 15:57:20 +00:00
vm_core.h
vm_dump.c
vm_eval.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00
vm_exec.c
vm_exec.h
vm_insnhelper.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00
vm_insnhelper.h
vm_method.c * vm_method.c (rb_method_boundp): respond_to?(:protected_method, 2010-07-07 04:06:32 +00:00
vm_opts.h
vsnprintf.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00

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: