The Ruby Programming Language [mirror]
Go to file
matz cd948e4600 * struct.c (rb_struct_select): fix typo.
* io.c (io_write): check error if written data is less than
  specified size to detect EPIPE.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@2372 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2002-04-12 08:45:02 +00:00
cygwin * configure.in: remove unnecessary AC_CANONICAL_BUILD 2001-05-28 16:07:34 +00:00
djgpp INLINE 2001-01-11 01:55:18 +00:00
doc Add entries to each Setup.* and remove Changes files. 2002-04-02 13:16:00 +00:00
ext raise() -> rb_raise(). (Thanks Tetsuya Watanabe) 2002-04-11 09:38:26 +00:00
lib * eval.c (assign): ruby_verbose should be surrounded by RTEST(). 2002-04-11 10:03:01 +00:00
misc * misc/ruby-mode.el (ruby-font-lock-keywords): fontify symbols for 2002-04-10 05:24:47 +00:00
missing /tmp/log 2002-04-12 03:24:52 +00:00
sample * re.c (rb_reg_search): should clear last_match if pos is out of 2002-03-19 09:03:11 +00:00
vms * the VMS support patch submitted by Akiyoshi, Masamichi 2002-03-22 07:26:42 +00:00
win32 * win32/Makefile.sub: use missing/acosh.c. 2002-04-12 03:55:04 +00:00
x68 Initial revision 1998-01-16 12:13:05 +00:00
.cvsignore .cvsignore: add autom4te*.cache. 2002-03-26 06:44:52 +00:00
COPYING * eval.c (method_inspect): should not dump core for unbound 2002-02-25 09:16:25 +00:00
COPYING.ja Rename *.jp to *.ja, since jp is a region code and ja is a language 2001-07-19 05:44:26 +00:00
ChangeLog * struct.c (rb_struct_select): fix typo. 2002-04-12 08:45:02 +00:00
GPL * It is confusing to put the GPL license terms in the file COPYING; 2001-07-11 19:25:52 +00:00
LEGAL The author of getoptlong.rb has agreed on changing the license from 2002-01-04 09:03:11 +00:00
LGPL * It is confusing to put the GPL license terms in the file COPYING; 2001-07-11 19:25:52 +00:00
MANIFEST /tmp/log 2002-04-12 03:24:52 +00:00
Makefile.in /tmp/log 2002-04-12 03:24:52 +00:00
README * eval.c (rb_thread_restore_context): save current value of 2001-09-08 14:17:53 +00:00
README.EXT * README.EXT: Appendix B is duplicated. 2001-11-29 15:30:54 +00:00
README.EXT.ja * README.EXT: Appendix B is duplicated. 2001-11-29 15:30:54 +00:00
README.ja * eval.c (rb_thread_restore_context): save current value of 2001-09-08 14:17:53 +00:00
ToDo * array.c (Init_Array): remove Array#filter. 2002-01-23 07:30:43 +00:00
array.c * eval.c (cvar_cbase): utility function to find innermost non 2002-03-08 07:03:09 +00:00
bignum.c * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
class.c * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
compar.c * error.c (exc_exception): clone the receiver exception instead of 2001-07-02 08:46:28 +00:00
config.guess * marshal.c (r_object): better allocation type check for 2001-10-03 07:19:19 +00:00
config.sub * eval.c (POP_VARS): should not set DVAR_DONT_RECYCLE if _old 2001-10-31 06:53:22 +00:00
configure.in * configure.in: add check for initstate(3). 2002-04-12 04:05:08 +00:00
defines.h * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
dir.c * dir.c (glob_helper): should have proceed link when link->path 2002-04-10 09:58:39 +00:00
dln.c * bignum.c (rb_quad_pack): get rid of escape sequences. 2002-03-26 03:01:30 +00:00
dln.h * dln.h, ruby.h, util.h: enable prototypes in C++. 2001-12-21 07:20:23 +00:00
dmyext.c Initial revision 1998-01-16 12:13:05 +00:00
enum.c * enum.c (enum_find): catch a value before recycle. 2002-03-18 01:48:56 +00:00
env.h * dir.c (dir_s_glob): supprt backslash escape of metacharacters 2001-02-14 05:52:06 +00:00
error.c * io.c (rb_io_fptr_cleanup): need flush even when io will not be 2002-04-01 08:31:49 +00:00
eval.c * eval.c (assign): ruby_verbose should be surrounded by RTEST(). 2002-04-11 10:03:01 +00:00
file.c * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
gc.c * gc.c (rb_source_filename): added. holds unique strings for file 2002-03-07 11:19:37 +00:00
hash.c * eval.c (cvar_cbase): utility function to find innermost non 2002-03-08 07:03:09 +00:00
inits.c * dir.c (dir_s_glob): supprt backslash escape of metacharacters 2001-02-14 05:52:06 +00:00
install-sh 1.4.0 1999-08-13 05:45:20 +00:00
instruby.rb Install help-message's too. 2001-04-30 17:55:56 +00:00
intern.h * bignum.c, intern.h (rb_ull2big, rb_ll2big, rb_ull2inum, rb_ll2inum, 2002-03-15 08:51:31 +00:00
io.c * struct.c (rb_struct_select): fix typo. 2002-04-12 08:45:02 +00:00
keywords * range.c (range_step): 'iter' here should be an array. 2001-08-20 04:29:58 +00:00
lex.c * intern.h: add prototypes. 2001-12-17 07:52:35 +00:00
main.c * dir.c (dir_s_glob): supprt backslash escape of metacharacters 2001-02-14 05:52:06 +00:00
marshal.c * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
math.c should be HAVE_TANH 2002-04-11 11:39:25 +00:00
mkconfig.rb * mkconfig.rb: close duplicated $stdout before renaming rbconfig.rb. 2002-03-20 13:19:36 +00:00
node.h * parse.y (stmt): local variable declaration order was changed 2002-02-13 09:01:11 +00:00
numeric.c * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
object.c * eval.c (assign): ruby_verbose should be surrounded by RTEST(). 2002-04-11 10:03:01 +00:00
pack.c * pack.c (pack_pack): wrong # comment treatment. 2002-02-21 07:15:06 +00:00
parse.y * eval.c (assign): ruby_verbose should be surrounded by RTEST(). 2002-04-11 10:03:01 +00:00
prec.c * parse.y (yylex): ternary ? can be followed by newline. 2001-08-29 06:28:51 +00:00
process.c * the VMS support patch submitted by Akiyoshi, Masamichi 2002-03-22 07:26:42 +00:00
random.c * random.c (rand_init): add check for initstate(3). 2002-04-11 11:00:02 +00:00
range.c * class.c (rb_include_module): detect cyclic module inclusion. 2002-01-25 08:22:11 +00:00
re.c * re.c (match_select): fix index references and make 2002-04-08 20:21:14 +00:00
re.h * dir.c (dir_s_glob): supprt backslash escape of metacharacters 2001-02-14 05:52:06 +00:00
regex.c * regex.c (mbc_startpos_func): VC6 seems to be unable to 2002-03-25 09:08:15 +00:00
regex.h * process.c (rb_f_system): abandon vfork. 2002-01-04 14:15:33 +00:00
ruby.1 * eval.c (rb_thread_restore_context): save current value of 2001-09-08 14:17:53 +00:00
ruby.c * gc.c (rb_source_filename): added. holds unique strings for file 2002-03-07 11:19:37 +00:00
ruby.h * io.c (rb_io_sysseek): new method based on a patch from Aristarkh 2002-03-27 05:28:00 +00:00
rubyio.h * re.c (match_setter): it's OK to assign nil to $~. 2002-04-01 07:39:09 +00:00
rubysig.h * eval.c (block_pass): should not downgrade safe level. 2001-05-02 04:22:21 +00:00
rubytest.rb forgot some checkins. 2001-05-06 15:06:00 +00:00
signal.c * marshal.c (w_object): module inclusion using extend() should 2002-03-11 08:02:04 +00:00
sprintf.c * variable.c (rb_obj_remove_instance_variable): raise NameError if 2002-04-10 08:45:26 +00:00
st.c * the VMS support patch submitted by Akiyoshi, Masamichi 2002-03-22 07:26:42 +00:00
st.h 20000105 2000-01-05 04:41:21 +00:00
string.c * re.c (rb_reg_search): should clear last_match if pos is out of 2002-03-19 09:03:11 +00:00
struct.c * struct.c (rb_struct_select): fix typo. 2002-04-12 08:45:02 +00:00
time.c * the VMS support patch submitted by Akiyoshi, Masamichi 2002-03-22 07:26:42 +00:00
util.c * util.c (push_element): avoid warning for djgpp. 2002-03-23 16:07:55 +00:00
util.h * dln.h, ruby.h, util.h: enable prototypes in C++. 2001-12-21 07:20:23 +00:00
variable.c * eval.c (assign): ruby_verbose should be surrounded by RTEST(). 2002-04-11 10:03:01 +00:00
version.c * re.c (match_select): should propagate taintness. 2002-01-11 09:18:54 +00:00
version.h 2002-04-12 2002-04-12 03:32:52 +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 machines, and on DOS,
    Windows, Mac, BeOS etc.)


* How to get Ruby

The Ruby distribution can be found on:

  ftp://ftp.ruby-lang.org/pub/ruby/

You can get it by anonymous CVS.  How to check out is:

  $ cvs -d :pserver:anonymous@cvs.ruby-lang.org:/src login
  (Logging in to anonymous@cvs.ruby-lang.org)
  CVS password: anonymous
  $ cvs -z4 -d :pserver:anonymous@cvs.ruby-lang.org:/src checkout ruby


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

  3. Edit defines.h if you need.  Probably this step will not need.

  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'

     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: