The Ruby Programming Language [mirror]
Go to file
akr 48c7c84e46 update doc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@34059 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-12-17 01:17:23 +00:00
bcc32
benchmark * benchmark/bm_io_select[23].rb: use Process::RLIMIT_NOFILE only when 2011-11-17 11:24:07 +00:00
bin * lib/rdoc: Update to RDoc 3.9. Fixed `ri []`, stopdoc creating an 2011-07-31 00:19:00 +00:00
bootstraptest * bootstraptest/runner.rb: don't suppress SIGINT. 2011-11-12 04:37:54 +00:00
cygwin
defs * tool/rbinstall.rb (gem): install all gemspecs under lib and ext. 2011-08-04 07:08:48 +00:00
doc * doc/re.rdoc: Document difference between match and =~, options with 2011-12-07 23:22:30 +00:00
enc * enc/trans/iso-8859-16-tbl.rb: add ISO-8859-16 converter. 2011-12-09 10:27:37 +00:00
ext * ext/strscan/strscan.c: use typed data with 2011-12-15 05:48:39 +00:00
include * win32/win32.c, include/ruby/win32.h (rb_w32_fd_is_text): new function. 2011-12-14 10:38:12 +00:00
lib update doc. 2011-12-17 01:17:23 +00:00
man
misc
missing
sample * sample/drb/dhasenc.rb: coding cookie of Emacs is coding, 2011-09-09 16:44:38 +00:00
spec
symbian
template * template/Doxyfile.tmpl (INCLUDE_PATH): add srcdir and include. 2011-11-09 02:40:39 +00:00
test * io.c (argf_type): make typed data. 2011-12-15 08:57:01 +00:00
tool * tool/rbinstall.rb (install_recursive, bin-comm): split mere 2011-10-30 01:50:38 +00:00
win32 * common.mk,Makefile.in,win32/Makefile.sub (ECHO1): move platform 2011-12-14 11:02:00 +00:00
.document
.gdbinit
.gitignore
.indent.pro
.travis.yml * .travis.yml (script): should be ./configure 2011-11-26 06:41:29 +00:00
BSDL
COPYING
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128] 2011-09-04 12:22:46 +00:00
ChangeLog * README, README.ja: 'make check' is preferable to 'make test'. 2011-12-16 08:18:40 +00:00
GPL
KNOWNBUGS.rb
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. 2011-08-03 07:10:56 +00:00
Makefile.in * common.mk,Makefile.in,win32/Makefile.sub (ECHO1): move platform 2011-12-14 11:02:00 +00:00
NEWS * lib/pathname.rb (Pathname#find): return an enumerator if 2011-11-19 12:52:37 +00:00
README * README, README.ja: 'make check' is preferable to 'make test'. 2011-12-16 08:18:40 +00:00
README.EXT * lib/mkmf.rb (checking_for): should not modify the result. 2011-11-13 14:46:01 +00:00
README.EXT.ja * README.ja, README.EXT.ja: remove garbage spaces. 2011-09-25 13:40:25 +00:00
README.ja * README, README.ja: 'make check' is preferable to 'make test'. 2011-12-16 08:18:40 +00:00
addr2line.c * addr2line.c (PATH_MAX): define if not defined. [ruby-core:40840] 2011-11-08 14:31:56 +00:00
addr2line.h
array.c * array.c (rb_ary_reject_bang, rb_ary_delete_if): update rdoc. 2011-12-15 01:44:58 +00:00
atomic.h * complex.c: use "__sun" instead of "__sun__" to detect SunOS. 2011-10-24 14:57:08 +00:00
bignum.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
class.c * class.c (rb_obj_methods), compile.c (iseq_compile_each), 2011-12-05 09:50:12 +00:00
common.mk * common.mk,Makefile.in,win32/Makefile.sub (ECHO1): move platform 2011-12-14 11:02:00 +00:00
compar.c
compile.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
complex.c * complex.c (nucomp_rationalize): fix function. [ruby-core:40667] 2011-11-02 12:36:06 +00:00
configure.in * configure.in (RUBY_WERROR_FLAG): append all warning flags which 2011-12-08 03:11:11 +00:00
constant.h * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
cont.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
debug.c
debug.h
dir.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
dln.c * include/ruby/defines.h: use "__sparc" instead of "sparc" and 2011-10-25 12:54:21 +00:00
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c (rb_locale_charmap): ignore calling nl_langinfo_codeset() 2011-11-03 15:19:24 +00:00
enum.c * enum.c: Reformat block args to a single standard, { |args| ... }. 2011-10-19 02:07:50 +00:00
enumerator.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
error.c * error.c (builtin_type_name): don't return pointer to the buffer of 2011-12-15 14:19:59 +00:00
eval.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
eval_error.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
eval_intern.h
eval_jump.c
file.c * file.c (file_path_convert): don't convert it when the path string is 2011-12-09 06:01:41 +00:00
gc.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c * whitespace cleanup. 2011-11-04 07:19:23 +00:00
ia64.s
id.c
inits.c
insns.def * insns.def (pop): suppress self-assign warning of clang. 2011-11-27 08:24:19 +00:00
internal.h * load.c (load_unlock): all threads requiring one file should 2011-12-13 07:13:31 +00:00
io.c * io.c (argf_type): make typed data. 2011-12-15 08:57:01 +00:00
iseq.c * class.c (rb_obj_methods), compile.c (iseq_compile_each), 2011-12-05 09:50:12 +00:00
iseq.h * iseq.h, iseq.c, compile.c: Change the line number data structure 2011-08-24 06:31:15 +00:00
lex.c.blt
load.c * load.c (load_unlock): release loading barrier and then remove it 2011-12-14 03:20:02 +00:00
main.c
marshal.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
math.c * complex.c: use "__sun" instead of "__sun__" to detect SunOS. 2011-10-24 14:57:08 +00:00
method.h
node.c
node.h
numeric.c Fix for r33811. 2011-11-22 04:54:42 +00:00
object.c * object.c (rb_check_to_int): new function to convert a VALUE to 2011-12-11 01:37:50 +00:00
pack.c * class.c (rb_obj_methods), compile.c (iseq_compile_each), 2011-12-05 09:50:12 +00:00
parse.y * parse.y (primary): point method name line. [ruby-core:40936] 2011-12-13 15:01:20 +00:00
prelude.rb
proc.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
process.c * process.c (rb_exit_status_code): extract from rb_f_exit_bang and 2011-12-11 01:34:42 +00:00
random.c * process.c (ruby_setsid): use rb_cloexec_open. 2011-10-29 04:01:54 +00:00
range.c * range.c: Improve documentation for Range. Patch by Chris Zetter. 2011-12-05 23:36:53 +00:00
rational.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
re.c * re.c (rb_reg_initialize): fix indent. 2011-11-20 14:05:44 +00:00
regcomp.c * regcomp.c (onig_region_memsize): implemented for memsize_of(). 2011-12-15 04:15:54 +00:00
regenc.c
regenc.h
regerror.c
regexec.c
regint.h * regcomp.c (onig_region_memsize): implemented for memsize_of(). 2011-12-15 04:15:54 +00:00
regparse.c * regparse.c: fix typo. 2011-12-05 10:12:02 +00:00
regparse.h
regsyntax.c
ruby.c * ruby.c (load_file_internal): convert the encoding of load path if 2011-10-31 18:05:03 +00:00
safe.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
signal.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
sparc.c * fix ANSI C compliance of r33757 2011-11-15 05:05:35 +00:00
sprintf.c * sprintf.c (rb_str_format): add RB_GC_GUARD to prevent temporary 2011-08-22 14:48:10 +00:00
st.c * hash.c (identhash): share with type_numhash. 2011-10-18 14:28:58 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): get enc argument to specify 2011-08-27 09:18:18 +00:00
string.c * whitespace cleanup. 2011-11-04 07:19:23 +00:00
struct.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
thread.c * load.c (load_unlock): release loading barrier and then remove it 2011-12-14 03:20:02 +00:00
thread_pthread.c * thread_pthread.c (ubf_select): call rb_thread_wakeup_timer_thread() 2011-12-14 02:26:20 +00:00
thread_pthread.h * thread_pthread.h: no Structured Exception Handling like macros. 2011-10-29 00:05:11 +00:00
thread_win32.c
thread_win32.h
time.c update doc. 2011-11-19 10:48:22 +00:00
timev.h
transcode.c * transcode.c (str_encode): about the extension of :fallback 2011-12-14 06:28:32 +00:00
transcode_data.h
util.c * util.c (mmprepare): fix for fragmental size. 2011-10-20 02:42:26 +00:00
variable.c * variable.c (set_const_visibility): clear inine-cache when constant's 2011-12-08 14:47:19 +00:00
version.c
version.h * 2011-12-16 2011-12-16 08:18:44 +00:00
vm.c * vm.c (vm_set_top_stack, vm_set_eval_stack): check for stack 2011-12-07 09:56:01 +00:00
vm_core.h * vm_core.h (ruby_current_thread): probeprofiler has been removed 2011-10-18 14:07:32 +00:00
vm_dump.c * io.c (rb_write_error2): get rid of warning on linux. fwrite 2011-11-27 12:06:10 +00:00
vm_eval.c * class.c (rb_obj_methods), compile.c (iseq_compile_each), 2011-12-05 09:50:12 +00:00
vm_exec.c
vm_exec.h
vm_insnhelper.c * vm_insnhelper.c (vm_yield_setup_block_args): splat single 2011-12-12 20:50:09 +00:00
vm_insnhelper.h fix typos 2011-10-06 11:51:55 +00:00
vm_method.c * variable.c (set_const_visibility): print a warning when no argument 2011-12-03 11:52:14 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (BSD_vfprintf): support 'll' prefix. 2011-11-01 04:31:52 +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/projects/ruby-trunk/wiki/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 check' 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: