1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
drbrain 54441753a4 Include more documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10672 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2006-08-04 19:12:47 +00:00
bcc32 * ruby.h, lib/mkmf.rb (create_header): clear command line options for 2006-05-25 23:44:08 +00:00
bin * bin/erb (ERB::Main::run): typo fixed. [ruby-core:06337] 2005-10-21 09:00:02 +00:00
cygwin * configure.in, cygwin/GNUmakefile.in (mingw): use def file to alias 2005-11-05 04:43:46 +00:00
djgpp
doc * doc/irb/irb.rd.ja: a lost of release IRB 0.9.5. 2005-04-13 20:45:54 +00:00
ext * ext/tk/lib/multi-tk.rb: freeze ip_name for security reason. 2006-07-28 21:14:30 +00:00
lib Include more documentation. 2006-08-04 19:12:47 +00:00
misc * misc/ruby-mode.el (ruby-expr-beg): support $! at the end of 2005-11-30 04:50:04 +00:00
missing * intern.h (st_foreach_safe): fix prototype. 2006-07-18 06:22:28 +00:00
sample * sample/test.rb: update test suites. 2006-07-10 08:37:37 +00:00
test * test/ruby/test_process.rb (TestProcess#test_rlimit_nofile): 2006-07-31 07:18:43 +00:00
vms * vms/vmsruby_private.c, vms/vmsruby_private.h: private routines 2005-05-25 23:35:25 +00:00
win32 * win32/win32.c (exit_handler): new function; release winsock and 2006-07-31 07:58:34 +00:00
wince * ruby.h, lib/mkmf.rb (create_header): clear command line options for 2006-05-25 23:44:08 +00:00
x68
.cvsignore * eval.c (Init_eval): rename #invoke_method and 2006-07-26 09:40:05 +00:00
.document Support "require" as variable name in RDoc 2004-10-10 03:35:51 +00:00
array.c * array.c (rb_ary_pop): may cause realloc oscillation. a patch 2006-07-13 15:12:56 +00:00
ascii.c This commit was generated by cvs2svn to compensate for changes in r7843, 2005-01-28 15:02:36 +00:00
bignum.c * bignum.c (rb_int2big): use SIGNED_VALUE. [ruby-dev:29019] 2006-07-11 06:47:09 +00:00
ChangeLog * sprintf.c (rb_str_format): a bug in %c type check. 2006-08-04 11:46:44 +00:00
class.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
common.mk * configure.in: define IA64 for portability. (HP aC++/ANSI C doesn't 2005-12-27 05:40:04 +00:00
compar.c * ext/digest/digest.c (rb_digest_base_s_digest): add volatile to 2005-12-12 00:36:54 +00:00
config.guess * eval.c (THREAD_ALLOC): th->thread should be initialized to NULL. 2004-07-17 02:23:52 +00:00
config.sub * config.guess, config.sub: Update to a more recent version as of 2004-06-09 06:10:59 +00:00
configure.in * configure.in: add support for as and ASFLAGS. [ruby-dev:29138] 2006-07-26 13:28:17 +00:00
COPYING * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
COPYING.ja * ext/bigdecimal/lib/bigdecimal/newton.rb (Newton::nlsolve): typo 2006-06-10 16:09:12 +00:00
defines.h forgot to commit too. 2006-01-22 13:34:41 +00:00
dir.c * bignum.c: ruby 1.9 HEAD 64 bit warnings clean up from 2006-07-03 20:07:10 +00:00
dln.c * configure.in, dln.c, file.c, intern.h, missing.h (eaccess): use 2006-01-25 13:30:11 +00:00
dln.h * bignum.c: changed foo _((boo))' to foo(boo)`. [ruby-dev:27056] 2005-09-14 06:32:32 +00:00
dmydln.c * Makefile.in, common.mk: miniruby depens on MINIOBJS. 2005-04-20 14:25:34 +00:00
dmyext.c * array.c: moved to ANSI function style from K&R function style. 2005-09-12 10:44:21 +00:00
enum.c Documentation typo. 2006-06-15 01:15:11 +00:00
enumerator.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
env.h * variable.c (rb_const_get_0): skip ruby_wrapper in const search 2006-02-17 16:08:08 +00:00
error.c * object.c (rb_mod_attr): make Module#attr to be an alias to 2006-07-20 17:36:36 +00:00
euc_jp.c * oniguruma.h: merge Oniguruma 4.0.0 [ruby-dev:28290] 2006-02-04 12:31:19 +00:00
eval.c * eval.c (rb_call0): trace call/return of method defined from block. 2006-07-30 14:27:01 +00:00
file.c * object.c (rb_mod_attr): make Module#attr to be an alias to 2006-07-20 17:36:36 +00:00
gc.c * gc.c (gc_sweep): expand heap earlier. 2006-07-10 10:26:45 +00:00
GPL
hash.c * eval.c (proc_invoke): should not overwrite block information in 2006-07-10 01:08:15 +00:00
ia64.s * ia64.s: remove .pred.safe_across_calls directive. 2005-12-28 05:14:10 +00:00
inits.c * bignum.c: changed foo _((boo))' to foo(boo)`. [ruby-dev:27056] 2005-09-14 06:32:32 +00:00
install-sh
instruby.rb * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
intern.h * intern.h (st_foreach_safe): fix prototype. 2006-07-18 06:22:28 +00:00
io.c * io.c (io_reopen): STDERR.reopen(File.open("/dev/null", "w")) should 2006-08-03 16:30:46 +00:00
keywords * ext/socket/socket.c (sock_accept): revert to avoid ambiguity of 2006-06-26 14:15:49 +00:00
LEGAL * LEGAL (ext/nkf/nkf-utf8): updated from nkf1.7 to nkf-utf8. 2005-07-13 15:46:37 +00:00
lex.c * ext/socket/socket.c (sock_accept): revert to avoid ambiguity of 2006-06-26 14:15:49 +00:00
LGPL
main.c * gc.c (gc_stress): renamed from always_gc and enabled by default. 2006-01-09 22:32:55 +00:00
Makefile.in * configure.in: add support for as and ASFLAGS. [ruby-dev:29138] 2006-07-26 13:28:17 +00:00
marshal.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
math.c * math.c (domain_check): ANSI style function arguments 2006-07-27 15:29:30 +00:00
mdoc2man.rb
missing.h * configure.in, dln.c, file.c, intern.h, missing.h (eaccess): use 2006-01-25 13:30:11 +00:00
mkconfig.rb * Makefile.in, mkconfig.rb: catch-up for latest autoconf. 2006-06-25 14:03:10 +00:00
node.h * intern.h (st_foreach_safe): fix prototype. 2006-07-18 06:22:28 +00:00
numeric.c * bignum.c (rb_int2big): use SIGNED_VALUE. [ruby-dev:29019] 2006-07-11 06:47:09 +00:00
object.c * object.c (rb_cstr_to_dbl): "9_e8" should consider "_e8" as 2006-07-21 14:53:11 +00:00
oniguruma.h * bignum.c: ruby 1.9 HEAD 64 bit warnings clean up from 2006-07-03 20:07:10 +00:00
pack.c * pack.c (pack_pack): check argument overrun for 'P'. based on a 2006-08-04 04:58:25 +00:00
parse.y * parse.y (f_args): allow post mandatory arguments after optional 2006-07-12 11:10:22 +00:00
prec.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
process.c * process.c (rb_proc_times): rename hz to hertz to avoid name 2006-07-25 04:58:15 +00:00
random.c * array.c: moved to ANSI function style from K&R function style. 2005-09-12 10:44:21 +00:00
range.c * range.c (range_include): should always call Enumerable#include? 2006-08-03 06:21:03 +00:00
re.c * object.c (rb_mod_attr): make Module#attr to be an alias to 2006-07-20 17:36:36 +00:00
re.h add back reference by name in replace string 2006-03-22 15:03:40 +00:00
README
README.EXT * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
README.EXT.ja * README.EXT, README.EXT.ja: add new features. 2005-09-20 23:20:58 +00:00
README.ja
regcomp.c merge Oniguruma 4.0.2 2006-03-23 12:08:08 +00:00
regenc.c * oniguruma.h: merge Oniguruma 4.0.0 [ruby-dev:28290] 2006-02-04 12:31:19 +00:00
regenc.h * oniguruma.h: merge Oniguruma 4.0.0 [ruby-dev:28290] 2006-02-04 12:31:19 +00:00
regerror.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
regex.h remove oniggnu.h (GNU regex API). 2005-02-26 08:05:06 +00:00
regexec.c fix bug [ruby-list:42234] 2006-05-21 00:56:05 +00:00
regint.h merge Oniguruma 4.0.1 2006-02-12 15:05:19 +00:00
regparse.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
regparse.h merge Oniguruma 4.0.1 2006-02-12 15:05:19 +00:00
ruby.1 * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
ruby.c * ruby.c (proc_options): script is never used while recursing. 2006-07-21 14:58:18 +00:00
ruby.h * ruby.h: use ifdef (or defined) for macro constants that may or 2006-07-31 06:34:10 +00:00
rubyio.h * rubyio.h (rb_io_set_nonblock): declared. 2006-05-22 07:38:42 +00:00
rubysig.h * rubysig.h (CHECK_INTS): fixed typo. (I believe bit-or is improper) 2005-10-21 10:23:03 +00:00
rubytest.rb * mkconfig.rb: generate RbConfig instead of Config. 2006-02-20 08:34:53 +00:00
runruby.rb * mkconfig.rb: generate RbConfig instead of Config. 2006-02-20 08:34:53 +00:00
signal.c * signal.c (install_nativethread_sighandler): commented out. 2006-07-10 05:01:08 +00:00
sjis.c * oniguruma.h: merge Oniguruma 4.0.0 [ruby-dev:28290] 2006-02-04 12:31:19 +00:00
sprintf.c * sprintf.c (rb_str_format): a bug in %c type check. 2006-08-04 11:46:44 +00:00
st.c * st.c: still need to include config.h on some platforms. 2006-07-17 02:49:01 +00:00
st.h * eval.c (proc_invoke): should not overwrite block information in 2006-07-10 01:08:15 +00:00
string.c * string.c (rb_str_scan): add string modification check. 2006-07-26 07:43:16 +00:00
struct.c * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
time.c * time.c (time_to_s): fixed typo. [ruby-dev:29162] 2006-07-28 00:47:26 +00:00
ToDo
utf8.c * oniguruma.h: merge Oniguruma 4.0.0 [ruby-dev:28290] 2006-02-04 12:31:19 +00:00
util.c * object.c (rb_cstr_to_dbl): limit out-of-range message. 2006-07-18 01:55:15 +00:00
util.h * eval.c (rb_call_super): should call method_missing if super is 2005-11-01 13:04:35 +00:00
variable.c * object.c (rb_mod_attr): make Module#attr to be an alias to 2006-07-20 17:36:36 +00:00
version.c * array.c: moved to ANSI function style from K&R function style. 2005-09-12 10:44:21 +00:00
version.h 2006-08-05 2006-08-04 18:05:42 +00:00

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