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
akr 3f0fd715f4 update document.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@29231 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-09-12 00:15:27 +00:00
bcc32 * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +00:00
benchmark
bin * lib/test/unit.rb (MiniTest::Unit#process_args): refactored. 2010-07-17 10:01:49 +00:00
bootstraptest * bootstraptest/test_class.rb: add a test for [ruby-core:30843]. 2010-06-27 18:13:06 +00:00
cygwin
defs
doc * ext/pathname/pathname.c (path_exist_p): Pathname#exist? translated 2010-08-31 12:11:02 +00:00
enc Forward-ports r28360 from ruby_1_9_2 into trunk. 2010-09-03 15:57:33 +00:00
ext * ext/pathname/pathname.c (path_symlink_p): Pathname#symlink? 2010-09-10 21:54:24 +00:00
include * include/ruby/intern.h (rb_set_kcode, rb_get_kcode): removed 2010-09-11 03:32:08 +00:00
lib update document. 2010-09-11 23:43:13 +00:00
man
misc * misc/ruby-mode.el (ruby-mode-set-encoding): commit miss. 2010-05-31 09:27:06 +00:00
missing * missing/close.c: undef the macros "getpeername", "getsockname" and 2010-08-07 10:05:37 +00:00
sample * test/ruby/test_system.rb (test_syntax2): moved from sample/test.rb 2010-07-04 12:01:46 +00:00
spec * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441. 2010-08-03 05:48:05 +00:00
symbian * symbian/setup (config.h): RUBY_EXEC_PREFIX defined. 2010-03-21 15:02:19 +00:00
template * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441. 2010-08-03 05:48:05 +00:00
test * process.c (rlimit_resource_name2int): support more limits: 2010-09-11 23:38:44 +00:00
tool * tool/rbinstall.rb (install?): gemspec filename should include 2010-09-09 00:17:11 +00:00
win32 * win32/win32.c (rb_w32_spawn, rb_w32_aspawn): don't forget to free 2010-09-02 00:12:43 +00:00
.document * prelude.rb, .document: Stuff in prelude.rb should be documented 2010-03-29 12:48:43 +00:00
.gdbinit * .gdbinit (rp): show type name for RTypedData. 2010-06-05 07:39:47 +00:00
.gitignore * .gitignore: updated. 2010-08-24 14:29:39 +00:00
.indent.pro * .indent.pro: added for ruby-style. 2010-03-11 21:50:56 +00:00
array.c * array.c (rb_ary_rotate_m): fix typo of rdoc. 2010-09-01 05:36:33 +00:00
bignum.c * random.c (rb_genrand_ulong_limited): renamed from 2010-09-10 05:44:54 +00:00
ChangeLog * process.c (rlimit_resource_name2int): support more limits: 2010-09-11 23:38:44 +00:00
class.c * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
common.mk Merges r27968 from ruby_1_9_2 into trunk. 2010-09-03 15:57:39 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * compile.c: math.h for modf. 2010-09-10 05:03:40 +00:00
complex.c * configure.in, include/ruby/defines.h (RUBY_FUNC_EXPORTED): macro 2010-08-14 06:33:06 +00:00
configure.in * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +00:00
cont.c * cont.c: typos. 2010-07-28 00:38:21 +00:00
COPYING
COPYING.ja
debug.c * suppress warnings. 2010-05-21 09:10:23 +00:00
debug.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
dir.c * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
dln.c * suppress warnings. 2010-05-21 09:10:23 +00:00
dln.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
enum.c * enum.c (enum_zip): fix typo of rdoc. 2010-09-01 05:36:31 +00:00
enumerator.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
error.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
eval.c * eval.c (frame_func_id), vm_eval.c (rb_iterate), 2010-07-14 11:23:10 +00:00
eval_error.c * eval_error.c (error_print): clear raised_flag while error-printing 2010-06-21 14:43:58 +00:00
eval_intern.h * load.c (rb_load_internal): remove call to rb_realpath_internal 2010-06-17 14:32:20 +00:00
eval_jump.c
file.c * file.c (rb_file_s_readlink): symlink target should be in 2010-09-04 14:48:55 +00:00
gc.c * gc.c (gc_profile_result): Index begins with 1. 2010-08-16 11:31:58 +00:00
gc.h * gc.h (rb_objspace_each_objects): used in objspace. 2010-08-14 06:11:03 +00:00
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
GPL
hash.c * hash.c (ruby_setenv): raise if putenv and SetEnvironmentVariable 2010-09-11 07:47:44 +00:00
ia64.s
id.c * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
inits.c
insns.def * compile.c (case_when_optimizable_literal): When float value can be 2010-09-09 13:40:14 +00:00
io.c * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
iseq.c * class.c, compile.c, dir.c, file.c, iseq.c, parse.y, random.c: 2010-07-27 07:13:43 +00:00
iseq.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
KNOWNBUGS.rb
LEGAL * LEGAL: separated the section for parse.c. contributed by Paul 2010-04-12 12:47:43 +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
Makefile.in * Makefile.in, win32/Makefile.sub (test-rubyspec-precheck): split 2010-08-16 03:29:08 +00:00
marshal.c * marshal.c (w_float): should not append a dot if no fractal part 2010-08-05 09:25:39 +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 * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
NEWS * lib/webrick/httprequest.rb (WEBrick::HTTPRequest#continue): add 2010-09-10 10:20:35 +00:00
node.c * cont.c (fiber_set_stack_location), iseq.c (prepare_iseq_build), 2010-05-16 02:46:16 +00:00
node.h * include/ruby/intern.h (rb_make_backtrace, rb_make_exception): 2010-08-14 04:20:59 +00:00
numeric.c Add links about floating point. [ruby-core:31849] 2010-08-29 00:42:05 +00:00
object.c * object.c (rb_obj_class): remove mention of obsolete method. 2010-08-27 03:27:50 +00:00
pack.c update doc. 2010-08-09 13:13:31 +00:00
parse.y * include/ruby/intern.h (rb_make_backtrace, rb_make_exception): 2010-08-14 04:20:59 +00:00
prelude.rb Fix :nodoc: definition. [ruby-dev:40949] 2010-04-10 22:09:09 +00:00
proc.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
process.c update document. 2010-09-12 00:15:27 +00:00
random.c * random.c (rb_genrand_ulong_limited): renamed from 2010-09-10 05:44:54 +00:00
range.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
rational.c * configure.in, include/ruby/defines.h (RUBY_FUNC_EXPORTED): macro 2010-08-14 06:33:06 +00:00
re.c * re.c (rb_reg_search): fix: 4th argument should be regexp 2010-08-23 03:32:58 +00:00
README * README: update. 2010-05-06 03:12:28 +00:00
README.EXT * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
README.EXT.ja * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
README.ja * README: update. 2010-05-06 03:12:28 +00:00
regcomp.c * regcomp.c: revert r26701; it introduces Bug #3681. 2010-08-17 16:53:25 +00:00
regenc.c
regenc.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
regerror.c
regexec.c * regexec.c (onig_search): don't skip non-ANYCHARs when 2010-07-15 06:55:42 +00:00
regint.h * regint.h (OnigStackIndex): the type should be intptr_t. 2010-08-26 01:50:07 +00:00
regparse.c * regparse.c (onig_syntax_warn): do not use external strings as 2010-05-31 10:26:01 +00:00
regparse.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
regsyntax.c
ruby.c * ruby.c (ruby_init_loadpath_safe): ensure sopath to be modifiable 2010-08-05 05:12:50 +00:00
safe.c
signal.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
sprintf.c * sprintf.c: add short documentation about named reference. 2010-07-21 06:16:07 +00:00
st.c
strftime.c * strftime.c (rb_strftime_with_timespec): suppress warnings. 2010-08-08 01:08:27 +00:00
string.c * string.c (tr_setup_table): optimized. don't create hash objects 2010-09-01 07:52:16 +00:00
struct.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
thread.c * thread.c (ruby_suppress_tracing): restore the state and invoke 2010-09-01 03:56:39 +00:00
thread_pthread.c * thread_pthread.c (native_sleep): suppress a warning for platforms 2010-08-19 10:29:30 +00:00
thread_pthread.h
thread_win32.c * thread_win32.c (native_thread_join): need to wait thread, of course. 2010-08-02 07:35:35 +00:00
thread_win32.h
time.c update doc. 2010-07-19 11:36:23 +00:00
timev.h
ToDo
transcode.c * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
transcode_data.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
util.c * util.c (ruby_strtod): check there is at least 1 digit after 2010-09-06 01:00:29 +00:00
variable.c * configure.in, include/ruby/defines.h (RUBY_FUNC_EXPORTED): macro 2010-08-14 06:33:06 +00:00
version.c * include/ruby/version.h (RUBY_API_VERSION_*): renamed and moved 2010-08-23 21:08:19 +00:00
version.h * 2010-09-12 2010-09-11 19:28:09 +00:00
vm.c * vm.c (vm_backtrace_each): skip allocator frames which have no 2010-09-09 14:25:56 +00:00
vm_core.h * load.c (ruby_init_ext): export for golfers. 2010-09-04 01:41:04 +00:00
vm_dump.c * eval_intern.h (rb_vm_get_sourceline): add prototype. 2010-05-11 00:57:09 +00:00
vm_eval.c * vm_eval.c (vm_call0): fix for VM_METHOD_TYPE_NOTIMPLEMENTED. 2010-08-07 04:33:33 +00:00
vm_exec.c
vm_exec.h * class.c, compile.c, dir.c, file.c, iseq.c, parse.y, random.c: 2010-07-27 07:13:43 +00:00
vm_insnhelper.c * vm_insnhelper.c (vm_push_frame): initialize block_iseq. a patch 2010-08-18 21:03:32 +00:00
vm_insnhelper.h
vm_method.c * vm_method.c (rb_method_boundp): revert r28543, r28564. 2010-07-21 05:00:53 +00:00
vm_opts.h
vsnprintf.c * removed trailing spaces. 2010-05-29 18:51:39 +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-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: