The Ruby Programming Language [mirror]
Go to file
nobu 96064d1889 * tool/mkconfig.rb (RbConfig): get rid of unused variable.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30238 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-12-17 09:35:42 +00:00
bcc32 * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +00:00
benchmark
bin
bootstraptest * bootstraptest/test_method.rb: fix last commit. 2010-09-21 16:56:59 +00:00
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs
doc Mention the command search path issue on Windows. Pointed out by 2010-09-22 04:13:03 +00:00
enc * enc/trans/big5-hkscs-tbl.rb: Update table as HKSCS-2008. 2010-11-24 16:40:38 +00:00
ext * ext/openssl/ossl_x509ext.c (ossl_x509extfactory_set_config): 2010-12-14 18:24:44 +00:00
include * transcode.c (transcode_loop): call default handler of the given 2010-12-07 13:05:26 +00:00
lib Imported minitest 2.0.1 r6079. 2010-12-15 22:23:52 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc update how to install again. 2010-12-12 12:06:36 +00:00
missing * missing/langinfo.c (strncasecmp): get rid of redefinition. 2010-11-17 22:16:53 +00:00
sample * lib/optparse.rb (OptionParser::Officious): separate completion 2010-12-07 13:31:11 +00:00
spec
symbian Added HAVE_LABS and HAVE_LLABS to config.h 2010-11-13 19:26:55 +00:00
template * template/id.h.tmpl: suppress all warning: "SUPPORT_JOKE" is not 2010-12-12 11:49:32 +00:00
test * test/ruby/test_rubyoptions.rb (TestRubyOptions#test_require): -r 2010-12-17 08:04:35 +00:00
tool * tool/mkconfig.rb (RbConfig): get rid of unused variable. 2010-12-17 09:35:42 +00:00
win32 * win32/setup.mak (BASERUBY): quit with an error when BASERUBY was not 2010-12-17 04:29:16 +00:00
.document
.gdbinit
.gitignore * .gitignore: ignore pkg-config metadata file. 2010-10-26 03:44:56 +00:00
.indent.pro
BSDL Add BSDL file. 2010-09-15 15:40:52 +00:00
COPYING * COPYING: change Ruby's License from a dual license with GPLv2 2010-09-15 15:35:31 +00:00
COPYING.ja * COPYING: change Ruby's License from a dual license with GPLv2 2010-09-15 15:35:31 +00:00
ChangeLog * win32/setup.mak (BASERUBY): quit with an error when BASERUBY was not 2010-12-17 04:29:16 +00:00
GPL
KNOWNBUGS.rb
LEGAL Revert r29271 pending due discussion. 2010-09-16 13:20:11 +00:00
Makefile.in * Makefile.in (reconfig): force reconfigure with previous options. 2010-11-17 22:37:48 +00:00
NEWS * lib/webrick/accesslog.rb (WEBrick::AccessLog#format): support 2010-12-09 10:16:50 +00:00
README
README.EXT * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
README.EXT.ja Make punctuation consistent. 2010-09-13 07:58:47 +00:00
README.ja
ToDo
addr2line.c * addr2line.c: Follow .gnu_debuglink section. 2010-12-01 00:32:19 +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 (rb_ary_dup): should copy contents only. no instance 2010-12-09 06:46:25 +00:00
bignum.c * bignum.c: parenthesize macro arguments. 2010-12-02 08:01:24 +00:00
class.c * class.c (make_metaclass): fix probable typo. builtin type flag 2010-12-05 08:56:42 +00:00
common.mk * common.mk (clean-local): remove pc file. 2010-12-15 02:31:58 +00:00
compar.c
compile.c * compile.c (iseq_compile_each): fix for __goto__ and __label__ 2010-12-12 14:45:30 +00:00
complex.c * complex.c: parenthesize macro arguments. 2010-12-05 01:37:16 +00:00
configure.in * io.c (rb_io_advise): New API. IO#advise() allows to tell the 2010-12-16 15:01:55 +00:00
constant.h remove a comma at end of enumerator list. 2010-12-10 02:42:06 +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.c (ruby_set_debug_option): define always for binary 2010-10-13 02:04:10 +00:00
dir.c * dir.c: parenthesize macro arguments. 2010-12-08 11:38:29 +00:00
dln.c * dln.c: parenthesize macro arguments. 2010-12-09 10:26:14 +00:00
dln.h
dln_find.c * dln_find.c: parenthesize macro arguments. 2010-12-10 13:34:08 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c: parenthesize macro arguments. 2010-12-11 00:28:25 +00:00
enum.c * enum.c: use constants in id.h. 2010-10-30 00:40:56 +00:00
enumerator.c
error.c * encoding.c: parenthesize macro arguments. 2010-12-12 02:54:23 +00:00
eval.c * eval.c (ruby_cleanup): fix type. 2010-12-02 21:45:49 +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 (CHECK_STACK_OVERFLOW): it was not intended to add 2010-11-15 14:57:18 +00:00
eval_jump.c
file.c * file.c: parenthesize macro arguments. 2010-12-13 03:01:12 +00:00
gc.c * gc.c: parenthesize macro arguments. 2010-12-14 11:32:59 +00:00
gc.h
gem_prelude.rb Tue Aug 17 07:38:43 2010 Nobuyoshi Nakada <nobu@ruby-lang.org> 2010-08-16 22:38:46 +00:00
golf_prelude.rb
goruby.c
hash.c * hash.c: parenthesize macro arguments. 2010-12-14 22:18:39 +00:00
ia64.s
id.c
inits.c
insns.def * compile.c (new_child_iseq): adjust argument types. 2010-10-31 13:11:02 +00:00
io.c * io.c: removed garbage line. 2010-12-16 22:08:50 +00:00
iseq.c * iseq.c: parenthesize macro arguments. 2010-12-16 22:05:58 +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 (ruby_init_ext): export for golfers. 2010-09-04 01:41:04 +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 * configure.in (RUBY_CHECK_PRINTF_PREFIX): check for printf format 2010-10-12 15:03:51 +00:00
math.c * math.c (math_atan2): you should know that M_PI is not the feature 2010-08-27 06:29:47 +00:00
method.h * class.c, constant.h, gc.c, method.h, object.c, variable.c, 2010-10-26 17:27:32 +00:00
node.c
node.h * node.h (RNode): match the type of flags to RBasic, and renamed 2010-12-15 23:04:50 +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: Make BasicObject.new accept no parameter. 2010-10-30 01:25:41 +00:00
pack.c * pack.c (PACK_ITEM_ADJUST): return nil not result array and yield 2010-11-15 21:39:39 +00:00
parse.y * parse.y (lvar_defined_gen, shadowing_lvar_gen, dvar_defined): no 2010-12-09 11:14:42 +00:00
prelude.rb
proc.c * transcode.c (transcode_loop): call default handler of the given 2010-12-07 13:05:26 +00:00
process.c * process.c (p_uid_change_privilege, p_gid_change_privilege): 2010-11-05 22:33:14 +00:00
random.c * random.c (random_rand): get rid of overflow. 2010-11-20 03:04:59 +00:00
range.c
rational.c modified some descriptions. 2010-11-23 14:28:55 +00:00
re.c Revert "* re.c (rb_reg_initialize): don't set US-ASCII to regexp" 2010-12-02 19:19:44 +00:00
regcomp.c * regcomp.c (setup_tree): restart setup_tree() for a node whose 2010-11-26 03:28:48 +00:00
regenc.c Clean a warning. 2010-11-09 10:14:47 +00:00
regenc.h
regerror.c
regexec.c * regcomp.c (print_distance_range): use PRIuSIZE. 2010-11-25 14:14:44 +00:00
regint.h * regint.h (OnigOpInfoType): constify name. 2010-11-17 06:21:11 +00:00
regparse.c * regparse.c (and_cclass, or_cclass): fix memory leak. Coverity Scan 2010-11-15 16:06:35 +00:00
regparse.h
regsyntax.c
ruby.c * ruby.c (ruby_init_loadpath_safe): relatively called non-shared 2010-12-10 09:29:22 +00:00
safe.c fixed very important banners. 2010-11-23 14:36:37 +00:00
signal.c * signal.c (ruby_signal): fix condition. 2010-11-11 12:30:35 +00:00
sprintf.c * sprintf.c (_HAVE_SANE_QUAD_): Don't forget LP64, r30156. 2010-12-10 01:50:51 +00:00
st.c * st.c (MurmurMagic): get rid of literal overflow. 2010-10-12 15:18:22 +00:00
strftime.c
string.c * string.c (rb_str_inspect): fix: extra back slash is added when 2010-12-11 19:03:26 +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, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
thread_pthread.c * thread_pthread.c (NATIVE_MUTEX_LOCK_DEBUG): move and use it. 2010-11-28 13:16:50 +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_win32.c (gvl_release, gvl_init): suppress warnings. 2010-11-28 05:55:49 +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 * time.c: parenthesize macro arguments. 2010-11-27 10:12:48 +00:00
timev.h
transcode.c Alter comment on String#encode for better wording and ri output 2010-12-16 19:20:51 +00:00
transcode_data.h
util.c * util.c (ruby_strtod): this code uses FPU's rounding system. 2010-11-09 01:57:49 +00:00
variable.c * object.c (Init_Object), constant.h, variable.c 2010-10-26 17:27:44 +00:00
version.c * configure.in (SITE_DIR, VENDOR_DIR), 2010-11-22 21:30:54 +00:00
version.h * 2010-12-17 2010-12-16 15:01:57 +00:00
vm.c * gc.c (rb_objspace_free): With our "lazy-sweep" GC engine, it is 2010-12-03 03:53:21 +00:00
vm_core.h remove a comma at end of enumerator list. 2010-12-10 02:42:06 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): suppress a warning. 2010-12-08 12:39:13 +00:00
vm_eval.c * vm_eval.c (rb_funcall): ensure va_end after va_init_list. Coverity 2010-11-15 13:48:37 +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 * configure.in (RUBY_CHECK_PRINTF_PREFIX): check for printf format 2010-10-12 15:03:51 +00:00
vm_insnhelper.c * iseq.c (set_relation), vm_insnhelper.c (vm_cref_push): nd_file 2010-12-15 22:51:51 +00:00
vm_insnhelper.h
vm_method.c * vm_method.c (rb_clear_cache_by_class): just return if the class has 2010-11-02 22:37:08 +00:00
vm_opts.h
vsnprintf.c * vsnprintf (BSD_vfprintf): use QUADINT macro only when _HAVE_SANE_QUAD_ 2010-11-24 06:18:43 +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: