The Ruby Programming Language [mirror]
Go to file
naruse 89c0d70e42 * enc/shift_jis.c: Change SJIS as an alias of Windows-31J.
* enc/shift_jis.c: Add PCK as an alias of Windows-31J.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31073 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-03-09 02:54:40 +00:00
bcc32
benchmark * benchmark/driver.rb (BenchmarkDriver#measure): Show command line 2011-01-29 11:23:42 +00:00
bin cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
bootstraptest
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs
doc doc/NEWS-1.9.2: add File#size 2011-02-01 13:17:05 +00:00
enc * enc/shift_jis.c: Change SJIS as an alias of Windows-31J. 2011-03-09 02:54:40 +00:00
ext * ext/extmk.rb: nmake substitutes all occurences in macro. 2011-03-08 15:45:33 +00:00
include * gc.c (rb_gc_set_params): allow GC parameter configuration by 2011-03-07 08:39:39 +00:00
lib * lib/pstore.rb: Delete variable @transaction and fix #4474. Patch by 2011-03-07 14:03:41 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc * misc/ruby-electric.el: remove trailing spaces. 2011-03-08 14:12:48 +00:00
missing * missing/langinfo.c: parenthesize macro arguments. 2011-01-31 13:08:27 +00:00
sample * sample/list.rb (MyElem#initialize): initialize @head 2011-03-06 12:51:17 +00:00
spec
symbian Added HAVE_LABS and HAVE_LLABS to config.h 2010-11-13 19:26:55 +00:00
template * template/fake.rb.in (CROSS_COMPILING): get rid of NameError. 2011-02-11 02:39:05 +00:00
test * test/misc/test_ruby_mode.rb: test for ruby-mode.el. 2011-03-08 14:40:33 +00:00
tool * tool/compile_prelude.rb (Prelude#initialize): ignore empty 2011-01-15 01:00:09 +00:00
win32 * win32/win32.c: revert r30987 because it causes some failures in 2011-03-01 07:23:37 +00:00
.document
.gdbinit
.gitignore cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
.indent.pro
BSDL
COPYING
COPYING.ja
ChangeLog * enc/shift_jis.c: Change SJIS as an alias of Windows-31J. 2011-03-09 02:54:40 +00:00
GPL
KNOWNBUGS.rb
LEGAL
Makefile.in * configure.in (rubygems): add --disable-rubygems option. 2011-02-11 03:03:26 +00:00
NEWS cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
README
README.EXT * README.EXT, README.EXT.ja: You shouldn't choose ``conftest.c'' as a 2011-01-20 07:13:58 +00:00
README.EXT.ja * README.EXT, README.EXT.ja: You shouldn't choose ``conftest.c'' as a 2011-01-20 07:13:58 +00:00
README.ja
ToDo
addr2line.c * addr2line.c (uleb128): cast the value to unsigned long. 2011-03-02 16:14:32 +00:00
addr2line.h * addr2line.c: added to show source filename and line number of 2010-11-26 03:28:50 +00:00
array.c * array.c (ary_join_1): fix array size. 2011-02-15 11:35:35 +00:00
bignum.c * bignum.c (rb_str_to_inum): get rid of too huge alloca(). 2011-01-27 12:58:44 +00:00
class.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
common.mk * common.mk (configure-ext, build-ext), ext/extmk.rb (extmake): 2011-03-08 00:33:05 +00:00
compar.c
compile.c * prevent temporary objects from GC, and should not use 2011-02-20 07:23:55 +00:00
complex.c update doc. 2011-01-08 10:51:14 +00:00
configure.in * common.mk (configure-ext, build-ext), ext/extmk.rb (extmake): 2011-03-08 00:33:05 +00:00
constant.h * constant.h, variable.c: to ensure compatibility, rb_const_get_* must 2011-01-28 17:57:27 +00:00
cont.c * cont.c: parenthesize macro arguments. 2010-12-06 20:56:04 +00:00
debug.c * debug.c: parenthesize macro arguments. 2010-12-07 12:16:10 +00:00
debug.h * debug.h: parenthesize macro arguments. 2011-01-17 13:54:54 +00:00
dir.c update doc. 2011-01-13 11:58:20 +00:00
dln.c * dln.c (init_funcname_len): ignore rest from first dot. 2011-01-05 20:03:28 +00:00
dln.h
dln_find.c * dln_find.c (dln_find_1): use rb_warning and return immediately 2011-01-26 23:22:54 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c (rb_enc_compatible): change the rule for empty strings: 2011-02-15 07:08:15 +00:00
enum.c * enum.c (enum_inject): typo fixed. a patch from Gaku Ueda in 2011-02-12 22:41:02 +00:00
enumerator.c
error.c * prevent temporary objects from GC, and should not use 2011-02-20 07:23:55 +00:00
eval.c * vm.c (ruby_vm_destruct): run vm exit hooks after all objects are 2011-02-24 13:51:59 +00:00
eval_error.c * eval_error.c: parenthesize macro arguments. 2010-12-12 04:28:29 +00:00
eval_intern.h * eval_intern.h: parenthesize macro arguments. 2011-01-17 22:54:29 +00:00
eval_jump.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
file.c * file.c (rb_file_flock): use rb_thread_io_blocking_region for the 2011-02-20 07:22:57 +00:00
gc.c * gc.c (rb_objspace): an initializer must be a constant. 2011-03-07 16:17:27 +00:00
gc.h * eval.c (ruby_cleanup): use rb_ary_free to free internal object. 2011-02-11 10:45:34 +00:00
gem_prelude.rb * ruby.c (process_options): revert r30549. 2011-01-17 12:40:30 +00:00
golf_prelude.rb cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
goruby.c
hash.c * hash.c (ruby_setenv): MSDN says that Windows XP or earlier limits 2011-03-08 07:52:19 +00:00
ia64.s
id.c
inits.c
insns.def * compile.c (NODE_CLASS, NODE_MODULE), insns.def (defineclass): raise 2011-01-28 17:57:34 +00:00
io.c * io.c (io_cntl): use rb_thread_io_blocking_region() instead 2011-03-05 18:23:55 +00:00
iseq.c * iseq.c (prepare_iseq_build): initialize iseq_compile_data::err_info 2011-02-17 15:08:36 +00:00
iseq.h * compile.c (iseq_compile_each): fix for __goto__ and __label__ 2010-12-12 14:45:30 +00:00
lex.c.blt
load.c * load.c (rb_get_expanded_load_path): always expand load paths. 2011-02-05 01:09:39 +00:00
main.c * main.c: <stdlib.h> is needed, to introduce the getenv(3) 2010-11-01 12:43:59 +00:00
marshal.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
math.c
method.h * method.h: parenthesize macro arguments. 2011-01-19 21:03:36 +00:00
node.c * node.c (add_id): remove duplicated rb_id2str() call. 2011-01-31 14:29:49 +00:00
node.h * node.h: parenthesize macro arguments. 2011-01-20 14:59:59 +00:00
numeric.c * numeric.c (Init_Numeric): fixed a potential bug when using bccwin32 2010-12-01 13:05:17 +00:00
object.c * object.c (rb_str_to_dbl): rewrite again. use ALLOCV instead 2011-01-27 12:46:30 +00:00
pack.c * pack.c (pack_unpack): the resulted string of unpack('M') must have 2011-01-14 05:03:22 +00:00
parse.y * parse.y (words, qwords): dispatch array events. based on a 2011-02-06 03:18:44 +00:00
prelude.rb
proc.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
process.c * process.c (proc_setgroups): cleanup. 2011-03-08 14:52:05 +00:00
random.c * random.c (random_rand): suppress a warning. 2011-01-05 20:17:36 +00:00
range.c
rational.c * rational.c: parenthesize macro arguments. 2010-12-26 00:36:08 +00:00
re.c * re.c (Init_Regexp): added a constant for ARG_ENCODING_NONE 2011-02-02 22:18:14 +00:00
regcomp.c Show encoding of compiling regexp. 2011-02-23 00:04:51 +00:00
regenc.c Clean a warning. 2010-11-09 10:14:47 +00:00
regenc.h
regerror.c
regexec.c Fix type of arguments in debug prints. 2011-02-23 00:04:55 +00:00
regint.h * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
regparse.c * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
regparse.h * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
regsyntax.c
ruby.c * gc.c (rb_gc_set_params): allow GC parameter configuration by 2011-03-07 08:39:39 +00:00
safe.c fixed very important banners. 2010-11-23 14:36:37 +00:00
signal.c * signal.c (sig_trap): avoid pthread_sigmask(xx, &mask, &mask) usage 2011-02-19 18:14:30 +00:00
sprintf.c * sprintf.c: parenthesize macro arguments. 2010-12-30 02:50:34 +00:00
st.c * st.c (st_foreach): check if unpacked. 2011-01-27 14:30:00 +00:00
strftime.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
string.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
struct.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
thread.c * thread.c (exec_recursive): prevent temporary objects from GC. 2011-02-20 07:26:48 +00:00
thread_pthread.c * thread_pthread.c (register_cached_thread_and_wait): move invalid 2011-02-06 10:59:03 +00:00
thread_pthread.h * thread.c, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
thread_win32.c * thread.c (thread_cleanup_func): Moved interrupted_lock 2010-12-20 15:20:17 +00:00
thread_win32.h * thread.c, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
time.c * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
timev.h
transcode.c * transcode.c (encoded_dup): extract. 2011-02-05 00:38:15 +00:00
transcode_data.h
util.c * util.c: parenthesize macro arguments. 2011-01-10 02:24:04 +00:00
variable.c * prevent temporary objects from GC, and should not use 2011-02-20 07:23:55 +00:00
version.c * configure.in (SITE_DIR, VENDOR_DIR), 2010-11-22 21:30:54 +00:00
version.h * ext/extmk.rb: workaround for nmake. 2011-03-08 15:15:55 +00:00
vm.c * vm.c (ruby_vm_destruct): run vm exit hooks after all objects are 2011-02-24 13:51:59 +00:00
vm_core.h * thread.c (rb_thread_io_blocking_region): new function to run 2011-02-12 05:44:23 +00:00
vm_dump.c * vm_dump.c: delete dashes to make lines 80 chars, Patched by 2011-01-13 04:37:25 +00:00
vm_eval.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
vm_exec.c * vm_exec.c (vm_exec_core): Treat clang as non gcc on this 2010-10-07 00:48:03 +00:00
vm_exec.h * vm_exec.h: parenthesize macro arguments. 2011-01-23 02:39:44 +00:00
vm_insnhelper.c * prevent temporary objects from GC, and should not use 2011-02-20 07:23:55 +00:00
vm_insnhelper.h * vm_insnhelper.h: parenthesize macro arguments. 2011-01-24 12:51:13 +00:00
vm_method.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (cvt): set first byte of buf to NUL for the case when 2011-01-18 17:56:10 +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-like/POSIX compatible platforms
    as well as Windows, Mac OS X, BeOS etc.)
    cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms


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

     Some C compiler flags may be added by default depending on your
     environment.  Specify optflags=.. and warnflags=.. as necessary
     to override them.

  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'

     This command will create following directories and install files
     onto them.

       * ${DESTDIR}${prefix}/bin
       * ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
       * ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
       * ${DESTDIR}${prefix}/lib
       * ${DESTDIR}${prefix}/lib/ruby
       * ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
       * ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
       * ${DESTDIR}${prefix}/lib/ruby/site_ruby
       * ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
       * ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
       * ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
       * ${DESTDIR}${prefix}/share/man/man1
       * ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system

     If Ruby's API version is `x.y.z', the ((|${MAJOR}|)) is `x', the
     ((|${MINOR}|)) is `y', and the ((|${TEENY}|)) is `z'.

     NOTE: teeny of the API version may be different from one of
     Ruby's program version

     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: