development fork of ruby/ruby
Перейти к файлу
wew 3e7ba606a2 Added RDoc documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@4435 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2003-08-23 12:00:21 +00:00
bcc32 * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +00:00
bin add explicit trim mode 2003-07-31 03:42:17 +00:00
cygwin * cygwin/GNUmakefile: remove unnecessary '--drive-name=$(CC)' 2003-08-09 15:36:23 +00:00
djgpp * configure.in: better DJGPP support. add GNUmakefile. 2003-01-01 09:26:45 +00:00
doc doc/NEWS: typo fix(CVS -> CSV). 2003-08-05 02:14:52 +00:00
ext * ext/nkf/nkf.c (rb_nkf_putchar): should use rb_str_resize() to just 2003-08-23 09:56:56 +00:00
lib Added RDoc documentation. 2003-08-23 12:00:21 +00:00
misc * eval.c (rb_yield_splat): should check if "values" is array. 2003-08-23 04:05:42 +00:00
missing * bcc32/Makefile.sub, win32/Makefile.sub, wince/Makefile.sub 2003-06-05 09:38:01 +00:00
sample * eval.c (POP_BLOCK): turn on BLOCK_LEFT flag when leaving block. 2003-08-13 10:31:33 +00:00
vms * the VMS support patch submitted by Akiyoshi, Masamichi 2002-03-22 07:26:42 +00:00
win32 * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +00:00
wince * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +00:00
x68 Initial revision 1998-01-16 12:13:05 +00:00
.cvsignore * object.c (copy_object): copy finalizers as well if any. 2002-12-04 07:39:32 +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 again, sorry 2003-08-23 10:13:44 +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 * math.c (math_erf,math_erfc): new function. [ruby-list:37753] 2003-06-05 06:40:42 +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 * MANIFEST: add lib/webrick/ssl.rb. 2003-08-19 13:50:43 +00:00
Makefile.in * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +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, README.EXT.ja (3.3): clarified -1 as free for 2003-04-02 06:11:28 +00:00
README.EXT.ja * README.EXT, README.EXT.ja (3.3): clarified -1 as free for 2003-04-02 06:11:28 +00:00
README.ja * eval.c (rb_thread_restore_context): save current value of 2001-09-08 14:17:53 +00:00
ToDo * gc.c (rb_gc): check odd alignment stack on m68k machines. 2003-05-08 09:45:52 +00:00
array.c * eval.c (rb_call0): update ruby_class as well as ruby_cref. 2003-08-06 21:50:06 +00:00
bignum.c * gcc -Wall clean-up. 2003-07-24 18:33:50 +00:00
class.c * eval.c (rb_call0): update ruby_class as well as ruby_cref. 2003-08-06 21:50:06 +00:00
compar.c * ext/pty/pty.c (pty_finalize_syswait): join (using Thread#value) 2003-05-19 15:45:46 +00:00
config.guess * lib/xmlrpc: import. 2003-07-19 10:05:54 +00:00
config.sub * variable.c (rb_mod_name): always return empty string for 2003-04-10 08:37:12 +00:00
configure.in * configure.in (HUGE_ST_INO): check whether struct stat.st_ino 2003-08-15 03:01:52 +00:00
defines.h * configure.in (AC_C_VOLATILE): check if volatile works. 2003-07-24 07:05:28 +00:00
dir.c * dir.c (glob_helper): preserve raw order for **. 2003-08-18 02:23:13 +00:00
dln.c * ext/socket/socket.c (tcp_s_gethostbyname): was using 2003-07-25 05:36:55 +00:00
dln.h Updated Copyrights of Matz to 2003. 2003-01-16 07:34:03 +00:00
dmyext.c Initial revision 1998-01-16 12:13:05 +00:00
enum.c * enum.c (each_with_index_i): typo. 2003-08-22 17:43:57 +00:00
env.h * eval.c (rb_call0): update ruby_class as well as ruby_cref. 2003-08-06 21:50:06 +00:00
error.c * configure.in (HUGE_ST_INO): check whether struct stat.st_ino 2003-08-15 03:01:52 +00:00
eval.c * eval.c (rb_eval, rb_iterate, block_pass): reduce PUSH/POP_TAG and 2003-08-23 07:00:02 +00:00
file.c * configure.in (HUGE_ST_INO): check whether struct stat.st_ino 2003-08-15 03:01:52 +00:00
gc.c * enum.c (inject_i): use rb_yield_values. 2003-08-22 08:09:58 +00:00
hash.c * class.c (rb_obj_singleton_methods): should not go up to 2003-08-01 20:16:53 +00:00
inits.c * configure.in (HUGE_ST_INO): check whether struct stat.st_ino 2003-08-15 03:01:52 +00:00
install-sh 1.4.0 1999-08-13 05:45:20 +00:00
instruby.rb * ext/curses/curses.c (_XOPEN_SOURCE_EXTENDED): Mac OS X standard 2003-08-18 16:24:42 +00:00
intern.h * eval.c (rb_call0): update ruby_class as well as ruby_cref. 2003-08-06 21:50:06 +00:00
io.c * io.c (next_argv): should not call GetOpenFile() if rb_stdout is 2003-08-19 02:21:04 +00:00
keywords * keywords: add braces around initializers. 2002-09-28 11:08:59 +00:00
lex.c * keywords: add braces around initializers. 2002-09-28 11:08:59 +00:00
main.c Updated Copyrights of Matz to 2003. 2003-01-16 07:34:03 +00:00
marshal.c * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +00:00
math.c * math.c (math_log): nan takes a dummy argument on Cygwin 1.5.0. 2003-07-10 05:48:43 +00:00
mdoc2man.rb * mdoc2man.rb: Properly put nested braces, parentheses and angles. 2003-01-20 12:10:40 +00:00
missing.h * lib/shell/command-processor.rb (Shell::CommandProcessor::rmdir): 2003-08-05 09:27:21 +00:00
mkconfig.rb * lib/shell/command-processor.rb (Shell::CommandProcessor::rmdir): 2003-08-05 09:27:21 +00:00
node.h * eval.c (rb_disable_super, rb_enable_super): deprecate. 2003-07-16 07:11:30 +00:00
numeric.c * eval.c (method_proc): should specify YIELD_FUNC_SVALUE. 2003-08-04 05:28:50 +00:00
object.c * object.c (rb_class_s_alloc): add function prototype to avoid VC++ 2003-08-13 07:13:45 +00:00
pack.c * eval.c (rb_load): put rb_load_file() in a thread critical 2003-07-09 22:28:42 +00:00
parse.y * gc.c (id2ref): recycle check should be done by klass == 0. 2003-08-14 17:20:14 +00:00
prec.c * variable.c (rb_obj_classname): new function. 2003-01-31 04:00:17 +00:00
process.c * modify macro to detect 'MacOS X' based on [ruby-talk:77849] 2003-08-03 02:55:52 +00:00
random.c * bignum.c (BIGZEROP): macro to determine if x is a bignum zero. 2003-04-09 06:44:34 +00:00
range.c * gcc -Wall clean-up. 2003-07-24 18:33:50 +00:00
re.c * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +00:00
re.h * configure.in, bcc32/Makefile.sub, win32/Makefile.sub: define 2003-03-04 14:12:19 +00:00
regex.c * marshal.c (w_object): if object responds to 'marshal_dump', 2003-07-29 18:26:55 +00:00
regex.h * regex.h (re_mbctab): should refer to RUBY_EXPORT. [ruby-ext:02199] 2003-08-03 09:22:50 +00:00
ruby.1 * ruby.1: Properly close .Bl with .El. 2003-01-20 08:32:15 +00:00
ruby.c * ruby.c (proc_options): -F set compiled regular expression to $;. 2003-07-30 07:08:56 +00:00
ruby.h * enum.c (inject_i): use rb_yield_values. 2003-08-22 08:09:58 +00:00
rubyio.h * rubyio.h (struct OpenFile): add error raise flag to finalizer. 2003-04-14 09:04:43 +00:00
rubysig.h * configure.in, bcc32/Makefile.sub, win32/Makefile.sub: define 2003-03-04 14:12:19 +00:00
rubytest.rb set dldpath on darwin 2003-08-01 14:35:51 +00:00
signal.c * eval.c (proc_alloc): re-unification of Block and Proc. Block 2003-06-16 07:14:50 +00:00
sprintf.c * array.c (rb_values_at): extract common procedure from 2003-07-03 11:02:53 +00:00
st.c * st.h, st.c: Back out the introduction of st_*_func_t. Some 2003-01-09 04:28:28 +00:00
st.h * string.c (rb_str_chomp_bang): defer rb_str_modify() to actual 2003-07-27 17:20:29 +00:00
string.c * enum.c (inject_i): use rb_yield_values. 2003-08-22 08:09:58 +00:00
struct.c * struct.c (struct_entry): add prototype to avoid VC++ warnings. 2003-07-12 08:02:26 +00:00
time.c * marshal.c (w_symbol, w_object): get rid of warnings. 2003-08-16 14:58:34 +00:00
util.c * util.c (ruby_strtod): exp should be less than MDMAXEXPT. 2003-07-11 07:10:14 +00:00
util.h * util.h: remove unnecessary parentheses. [ruby-dev:20879] 2003-08-04 01:27:25 +00:00
variable.c * variable.c (classname): find regular class name if not set. 2003-08-02 05:02:43 +00:00
version.c Updated Copyrights of Matz to 2003. 2003-01-16 07:34:03 +00:00
version.h 2003-08-23 2003-08-23 04:48:49 +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: