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 937b7ab8b5 Reorganize RDoc generators
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@15017 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2008-01-13 03:02:49 +00:00
bcc32 * {bcc,win}32/Makefile.sub (MV): use move instead of ren. [ruby-Bugs-17019] 2008-01-13 00:17:31 +00:00
benchmark
bin Clean up namespacing of RI's classes 2008-01-08 10:18:41 +00:00
bootstraptest add a test. 2008-01-12 16:42:43 +00:00
cygwin
djgpp
doc * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
enc * encoding.c (ENCINDEX_EUC_JP, ENCINDEX_SJIS): removed. 2008-01-13 02:51:15 +00:00
ext * ext/nkf/nkf.c: rdoc update. 2008-01-12 03:46:13 +00:00
include * defines.h (WORDS_BIGENDIAN): honor __BIG_ENDIAN__ than the result of 2008-01-11 02:57:38 +00:00
lib Reorganize RDoc generators 2008-01-13 03:02:49 +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
test add tests. 2008-01-11 03:11:42 +00:00
tool
vms
win32 * {bcc,win}32/Makefile.sub (MV): use move instead of ren. [ruby-Bugs-17019] 2008-01-13 00:17:31 +00:00
wince * win{32,ce}/Makefile.sub: merged. 2008-01-08 11:02:10 +00:00
x68
yarvtest
.cvsignore
.document
.gdbinit
array.c * enum.c (enum_zip): honor length of the receiver, not the 2008-01-08 09:50:01 +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 Reorganize RDoc generators 2008-01-13 03:02:49 +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 (ENCINDEX_EUC_JP, ENCINDEX_SJIS): removed. 2008-01-13 02:51:15 +00:00
compar.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
compile.c * compile.c (iseq_build_from_ary), iseq.c (iseq_load): fix for format change. 2008-01-08 04:05:59 +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 * configure.in: AC_TRY_CPP has no FUNCTION-BODY while AC_TRY_COMPILE 2008-01-11 03:35:59 +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
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 * encoding.c (ENCINDEX_EUC_JP, ENCINDEX_SJIS): removed. 2008-01-13 02:51:15 +00:00
enum.c * enum.c: Updating the documentation of Enumrable#zip to reflect 2008-01-08 23:42:38 +00:00
enumerator.c * enum.c (enum_zip): honor length of the receiver, not the 2008-01-08 09:50:01 +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
eval_intern.h
eval_jump.c
eval_method.c * eval_method.c (rb_define_alloc_func, rb_undef_alloc_func): should 2008-01-12 09:27:43 +00:00
eval_safe.c
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
gem_prelude.rb
golf_prelude.rb * golf_prelude.rb (Array#to_s): alias to join. 2008-01-09 09:28:19 +00:00
goruby.c
GPL
hash.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
ia64.s
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
io.c io.c (io_encoding_set): typo fixed 2008-01-10 06:44:30 +00:00
iseq.c * compile.c (iseq_build_from_ary), iseq.c (iseq_load): fix for format change. 2008-01-08 04:05:59 +00:00
keywords
LEGAL
lex.c.blt
lex.c.src
LGPL
load.c
main.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
Makefile.in * encoding.c, Makefile.in, include/ruby/oniguruma.h, 2008-01-08 13:35:24 +00:00
marshal.c * encoding.c (rb_enc_internal_get_index): extracted from 2008-01-07 02:49:01 +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
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 * parse.y (yycompile0): remove setting parser->enc because it is set 2008-01-09 05:57:29 +00:00
prec.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
prelude.rb * prelude.rb (Mutex::synchronize): capture exception from unlock. 2008-01-10 09:01:30 +00:00
proc.c * proc.c (proc_mark): needs to mark the receiver too. a patch from 2008-01-11 11:20:18 +00:00
process.c * configure.in: moved broken syscall checks from process.c etc. 2008-01-11 03:27:46 +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_preprocess): fix fixed_enc condition. 2008-01-07 04:55:26 +00:00
README
README.EXT
README.EXT.ja
README.ja
regcomp.c * include/ruby/oniguruma.h: Oniguruma 1.9.1 merged. 2008-01-03 15:55:04 +00:00
regenc.c * regenc.c (onigenc_strlen_null, onigenc_str_bytelen_null): suppressed 2008-01-08 06:40:33 +00:00
regenc.h * enc/make_encdb.rb: added. search enc/*.c and make encoding database. 2008-01-12 16:03:51 +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
ruby.1
ruby.c * encoding.c (ENCINDEX_EUC_JP, ENCINDEX_SJIS): removed. 2008-01-13 02:51:15 +00:00
rubytest.rb
runruby.rb
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
string.c * string.c (string.c): call rb_str_buf_append to update encoding of 2008-01-11 14:26:26 +00:00
struct.c * $Date$ keyword removed to avoid inclusion of locale dependent 2008-01-06 15:49:38 +00:00
thread.c * thread.c (rb_mutex_unlock): proper error message for unlocking 2008-01-10 16:12:32 +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 * enc/make_encdb.rb: should work on Ruby 1.8. [ruby-dev:33069] 2008-01-12 16:55:33 +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: