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 b0f13cfebe Clean up comments and whitespace in RDoc generators
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14919 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2008-01-07 00:42:03 +00:00
bcc32 * trunk/common.mk: not use -I$(srcdir)/lib with $(MINIRUBY) for cross 2007-12-30 21:50:40 +00:00
benchmark * regerror.c, string.c, io.c, lib/getoptlong.rb, lib/net/imap.rb, 2007-12-21 02:31:11 +00:00
bin * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
bootstraptest add a comment. 2008-01-05 15:40:17 +00:00
cygwin * cygwin/GNUmakefile.in: commit miss. 2007-12-27 15:30:30 +00:00
djgpp * configure.in, cygwin/GNUmakefile.in, */Makefile.sub, 2007-12-24 06:42:06 +00:00
doc * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
enc * enc/euc_jp.c: remove eucjp_ prefix. breakpoint can be specified as 2008-01-03 17:57:48 +00:00
ext * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
include * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
lib Clean up comments and whitespace in RDoc generators 2008-01-07 00:42:03 +00:00
misc * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
missing * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
sample * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
template * tool/makedocs.rb, template/insnstbl.html: removed. 2007-11-13 22:09:43 +00:00
test * re.c (rb_reg_initialize_str): forbid raw non ASCII character 2008-01-06 12:15:48 +00:00
tool * tool/ytab.sed: skip yydestruct hack unless yymsg exists, for bison 2007-12-28 02:46:06 +00:00
vms
win32 * trunk/common.mk: not use -I$(srcdir)/lib with $(MINIRUBY) for cross 2007-12-30 21:50:40 +00:00
wince * configure.in, cygwin/GNUmakefile.in, */Makefile.sub, 2007-12-24 06:42:06 +00:00
x68
yarvtest * eval.c (rb_f_send): allow send/__send__ to call methods of all 2007-11-04 20:36:20 +00:00
.cvsignore
.document
.gdbinit * re.c (ARG_ENCODING_NONE): defined for /.../n option. 2007-12-21 16:39:36 +00:00
array.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
bignum.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
blockinlining.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
ChangeLog add ML ref. 2008-01-06 17:39:59 +00:00
class.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
common.mk * encoding.c (rb_isalnum): defined. 2008-01-03 08:44:01 +00:00
compar.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
compile.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
compile.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
config.guess
config.sub
configure.in * util.c (ruby_strtoul): locale independent strtoul is implemented to 2008-01-02 06:24:27 +00:00
cont.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
COPYING
COPYING.ja
debug.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
debug.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
dir.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
distruby.rb * distruby.rb: Add zip generation. 2007-03-20 07:37:34 +00:00
dln.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
dln.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
dmydln.c
dmyext.c
encoding.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
enum.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
enumerator.c * enumerator.c (enumerator_iter_i): adjusted for rb_block_call_func. 2007-12-21 07:33:31 +00:00
error.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
eval.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
eval_error.c * common.mk, *.ci: renamed to *.c. 2007-12-20 09:29:46 +00:00
eval_intern.h * README.EXT.ja, dir.c, eval.c, eval_intern.h, lex.c.src, 2007-12-25 04:17:06 +00:00
eval_jump.c * eval_jump.c (rb_f_catch): Resotre cfp if catched thrown object. 2008-01-03 11:26:48 +00:00
eval_method.c * eval_method.c (Init_eval_method): extracted from Init_eval 2007-12-24 09:07:20 +00:00
eval_safe.c * common.mk, *.ci: renamed to *.c. 2007-12-20 09:29:46 +00:00
file.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
gc.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
gc.h * gc.h: extern variable should not be initialized. 2007-12-21 08:13:39 +00:00
gem_prelude.rb Remove methods from Gem, not QuickLoader, to fix warnings 2007-12-24 01:38:43 +00:00
golf_prelude.rb * golf_prelude.rb: find words with underscore. 2007-12-31 00:33:40 +00:00
goruby.c * main.c, goruby.c (RUBY_MAIN_INIT): removed. 2007-12-30 22:39:34 +00:00
GPL
hash.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
ia64.s add reference. 2007-07-15 01:41:40 +00:00
id.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
id.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
inits.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
insnhelper.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
insns.def * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
install-sh
instruby.rb * instruby.rb: install goruby if exists. 2007-12-26 05:39:03 +00:00
io.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
iseq.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
keywords * README.EXT.ja, dir.c, eval.c, eval_intern.h, lex.c.src, 2007-12-25 04:17:06 +00:00
LEGAL * util.c (ruby_strtoul): locale independent strtoul is implemented to 2008-01-02 06:24:27 +00:00
lex.c.blt * README.EXT.ja, dir.c, eval.c, eval_intern.h, lex.c.src, 2007-12-25 04:17:06 +00:00
lex.c.src * README.EXT.ja, dir.c, eval.c, eval_intern.h, lex.c.src, 2007-12-25 04:17:06 +00:00
LGPL
load.c * README.EXT.ja, dir.c, eval.c, eval_intern.h, lex.c.src, 2007-12-25 04:17:06 +00:00
main.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
Makefile.in * Makefile.in, configure.in, lib/mkmf.rb, */Makefile.sub: specify 2007-12-24 03:49:56 +00:00
marshal.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
math.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
mdoc2man.rb
mkconfig.rb * mkconfig.rb: should not use the libraries under the source directory 2007-12-27 14:56:04 +00:00
numeric.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
object.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
opt_insn_unif.def
opt_operand.def
pack.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
parse.y * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
prec.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
prelude.rb * thread.c: fix Mutex to be interruptable lock. 2007-08-27 16:48:14 +00:00
proc.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
process.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
random.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
range.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
re.c * re.c (rb_reg_initialize_str): forbid raw non ASCII character 2008-01-06 12:15:48 +00:00
README
README.EXT * README.EXT: updated. a patch from Keita Yamaguchi 2007-12-23 21:01:25 +00:00
README.EXT.ja * README.EXT.ja, dir.c, eval.c, eval_intern.h, lex.c.src, 2007-12-25 04:17:06 +00:00
README.ja fix 2007-02-20 07:35:33 +00:00
regcomp.c * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regenc.c * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regenc.h * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regerror.c * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regexec.c * re.c (rb_reg_search): avoid inner loop for reverse search. 2008-01-04 01:24:12 +00:00
regint.h * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regparse.c * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regparse.h * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regsyntax.c * oniguruma.h: updated to Oniguruma 5.7.0. 2007-05-23 01:32:08 +00:00
ruby.1
ruby.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
rubytest.rb * bootstraptest/runner.rb: fix load path. 2007-07-06 09:23:53 +00:00
runruby.rb * ext/extmk.rb, ext/purelib.rb, lib/mkmf.rb, runruby.rb: clear default 2007-05-22 20:48:34 +00:00
signal.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
sprintf.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
st.c abolish warnings by previous change. 2008-01-01 13:19:21 +00:00
string.c * string.c (coderange_scan): avoid rb_enc_to_index. 2008-01-06 17:37:54 +00:00
struct.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
thread.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
thread_pthread.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
thread_pthread.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
thread_win32.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
thread_win32.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
time.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
ToDo
transcode.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
transcode_data.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
util.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
variable.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
version.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
version.h * 2008-01-07 2008-01-07 00:16:09 +00:00
vm.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
vm.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
vm_core.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
vm_dump.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
vm_evalbody.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
vm_insnhelper.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
vm_opts.h * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +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 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.

  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'

     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: