development fork of ruby/ruby
Перейти к файлу
dave d89650c8cf RDoc comments for Symbol
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5317 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2003-12-27 06:09:08 +00:00
bcc32 * bcc32/Makefile.sub (config.h): bcc has finite(). [ruby-list:38940] 2003-12-23 08:29:54 +00:00
bin Forgot to save buffer.... sigh 2003-12-24 04:24:29 +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 * lib/generator.rb: A new library which converts an internal 2003-10-14 20:14:20 +00:00
ext * string.c (rb_str_update): call rb_str_modify(). 2003-12-25 08:49:20 +00:00
lib * io.c (rb_f_backquote): need not to check nil result. 2003-12-26 15:34:33 +00:00
misc * misc/ruby-mode.el (ruby-calculate-indent): proper indentation 2003-12-19 17:29:09 +00:00
missing * missing/isinf.c (isinf): typo fix. 2003-12-21 10:30:24 +00:00
sample * numeric.c (num_sadded): prohibit singleton method definition for 2003-12-01 13:16:09 +00:00
test * test/ruby/test_pack.rb: new test test_pack_N. 2003-12-26 05:05:37 +00:00
vms config.h_in has been renamed to config.h 2003-12-26 01:39:25 +00:00
win32 * bcc32/Makefile.sub, win32/Makefile.sub (config.h): remove 2003-12-22 09:26:24 +00:00
wince * bcc32/Makefile.sub, win32/Makefile.sub, wince/Makefile.sub 2003-12-01 00:30:37 +00:00
x68 Initial revision 1998-01-16 12:13:05 +00:00
.cvsignore 031031 2003-10-30 17:55:51 +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 RDoc comments for Symbol 2003-12-27 06:09:08 +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 vms/config.h and remove vms/config.h_in. 2003-12-26 01:59:42 +00:00
Makefile.in * lib/cgi.rb (CGI::QueryExtension::Value::[]): should work like 2003-12-17 06:38:18 +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 Fix doc typos 2003-12-23 21:19:03 +00:00
bignum.c * io.c (rb_f_backquote): need not to check nil result. 2003-12-26 15:34:33 +00:00
class.c * class.c (rb_mod_init_copy): always copy singleton class. 2003-12-22 12:15:34 +00:00
compar.c Fix dependency issue 2003-12-19 00:01:19 +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 * io.c (rb_f_backquote): need not to check nil result. 2003-12-26 15:34:33 +00:00
defines.h * configure.in (ac_cv_func_setitimer): moved from defines.h 2003-12-22 08:23:55 +00:00
dir.c Document Class and Dir 2003-12-19 15:18:09 +00:00
dln.c * string.c (rb_str_update): call rb_str_modify(). 2003-12-25 08:49:20 +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 Annotate enum.c. Add pager support, and report on methods in included modules 2003-12-18 21:08:25 +00:00
env.h * eval.c (PUSH_FRAME): generate unique number to be TAG_JUMP() 2003-10-20 08:33:49 +00:00
error.c Add file.c comments (and necessary support in parse_c.rb) 2003-12-21 07:28:54 +00:00
eval.c * configure.in: check if getcontext and setcontext are available. 2003-12-26 09:34:03 +00:00
file.c * stable version 1.8.1 released. 2003-12-24 15:19:11 +00:00
gc.c Add RDoc comments 2003-12-22 06:20:14 +00:00
hash.c RDoc comments for Fixnum, Float, and Hash. Add heuristic to RDoc to handle yaml/stringio 2003-12-23 16:21:17 +00:00
inits.c Add boot_classes to rdoc parsing, fix a couple of bugs 2003-12-19 03:58:57 +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 * class.c (rb_check_inheritable): new function. [ruby-dev:22316] 2003-12-21 08:29:06 +00:00
io.c Added RDoc for class IO 2003-12-27 00:44:05 +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 * gc.c (Init_stack): stack region is far smaller than usual if 2003-11-22 04:00:03 +00:00
marshal.c * configure.in (ac_cv_func_setitimer): moved from defines.h 2003-12-22 08:23:55 +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 * configure.in (ac_cv_func_setitimer): moved from defines.h 2003-12-22 08:23:55 +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_method_node): new API to retrieve method body. 2003-11-14 23:54:06 +00:00
numeric.c Add RDoc comments 2003-12-27 05:46:46 +00:00
object.c RDoc comments for Symbol 2003-12-27 06:09:08 +00:00
pack.c * io.c (rb_f_backquote): need not to check nil result. 2003-12-26 15:34:33 +00:00
parse.y * parse.y (arg): should return 0 after error. [ruby-dev:22360] 2003-12-24 00:38:53 +00:00
prec.c * variable.c (rb_obj_classname): new function. 2003-01-31 04:00:17 +00:00
process.c * win32/win32.h: define execv() using do_aspawn(). 2003-12-10 04:00:07 +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 Michael Granger added RDoc for range.c 2003-12-24 04:29:32 +00:00
re.c MG added RDoc comments for re.c 2003-12-26 15:58:28 +00:00
re.h * configure.in, bcc32/Makefile.sub, win32/Makefile.sub: define 2003-03-04 14:12:19 +00:00
regex.c * eval.c (catch_timer): do not call rb_thread_schedule() inside to 2003-12-24 08:47:36 +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 Fix markups and grammar. 2003-11-21 07:13:43 +00:00
ruby.c * ext/stringio/stringio.c (strio_set_string, strio_reopen): check 2003-11-06 01:17:59 +00:00
ruby.h * configure.in (ac_cv_func_setitimer): moved from defines.h 2003-12-22 08:23:55 +00:00
rubyio.h * rubyio.h (struct OpenFile): add error raise flag to finalizer. 2003-04-14 09:04:43 +00:00
rubysig.h * eval.c (catch_timer): do not call rb_thread_schedule() inside to 2003-12-24 08:47:36 +00:00
rubytest.rb set dldpath on darwin 2003-08-01 14:35:51 +00:00
signal.c * configure.in (ac_cv_func_setitimer): moved from defines.h 2003-12-22 08:23:55 +00:00
sprintf.c * array.c (rb_values_at): extract common procedure from 2003-07-03 11:02:53 +00:00
st.c * string.c (rb_str_hash): Update the HASH_PERL alternative hash 2003-11-01 16:16:31 +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 * string.c (rb_str_update): don't return any value. 2003-12-25 13:30:39 +00:00
struct.c * io.c (read_all): fptr->f may be NULL, if IO is closed in the 2003-11-04 09:13:57 +00:00
time.c * gc.c (gc_mark): explicitly check mark recursion levels, instead 2003-11-28 14:23:33 +00:00
util.c * gc.c (Init_stack): stack region is far smaller than usual if 2003-11-22 04:00:03 +00:00
util.h * util.h: remove unnecessary parentheses. [ruby-dev:20879] 2003-08-04 01:27:25 +00:00
variable.c * gc.c (Init_stack): stack region is far smaller than usual if 2003-11-22 04:00:03 +00:00
version.c Updated Copyrights of Matz to 2003. 2003-01-16 07:34:03 +00:00
version.h 2003-12-27 2003-12-26 17:08:57 +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: