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
tadf 4fcd5e3fc1 * lib/date.rb: some corrections of documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@29584 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-10-24 15:30:25 +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_method.rb: fix last commit. 2010-09-21 16:56:59 +00:00
cygwin * Makefile.in (CPP): already used in .c.i rule. 2010-10-16 01:55:01 +00:00
defs
doc Mention the command search path issue on Windows. Pointed out by 2010-09-22 04:13:03 +00:00
enc add references. 2010-10-18 06:42:01 +00:00
ext * ext/dbm/dbm.c: rdoc based on a patch by mathew meta AT 2010-10-20 14:54:40 +00:00
include * include/ruby/intern.h (rb_check_frozen): optimize. 2010-10-24 08:05:55 +00:00
lib * lib/date.rb: some corrections of documentation. 2010-10-24 15:30:25 +00:00
man
misc Commit miss. 2010-10-19 03:25:29 +00:00
missing * missing/strchr.c: add strlen's prototype. 2010-10-12 20:23:53 +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
template * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441. 2010-08-03 05:48:05 +00:00
test * vm.c (vm_define_method): defined method is run with the default 2010-10-24 05:11:26 +00:00
tool * tool/enc-unicode.rb: get rid of lots of warnings. 2010-10-13 14:16:49 +00:00
win32 * win32/win32.c (rb_w32_open_osfhandle, rb_w32_wopen, rb_w32_pipe): 2010-10-12 14:58:23 +00:00
.document
.gdbinit * .gdbinit (rp): show type name for RTypedData. 2010-06-05 07:39:47 +00:00
.gitignore * .gitignore: ignore doc/capi. 2010-10-15 14:56:47 +00:00
.indent.pro
array.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
bignum.c * random.c (rb_genrand_ulong_limited): renamed from 2010-09-10 05:44:54 +00:00
BSDL Add BSDL file. 2010-09-15 15:40:52 +00:00
ChangeLog * lib/date.rb: some corrections of documentation. 2010-10-24 15:30:25 +00:00
class.c * class.c (rb_define_{class,module}_id_under): register to be 2010-10-17 01:40:22 +00:00
common.mk git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@29425 b2dd03c8-39d4-4d8f-98ff-823fe69b080e 2010-10-08 01:52:37 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * compile.c (iseq_build_body), error.c (set_syserr, get_syserr), 2010-10-12 14:47:23 +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 (dev_t): use RUBY_REPLACE_TYPE. 2010-10-15 11:30:33 +00:00
cont.c * cont.c (fiber_setcontext): missing variable definition. 2010-10-12 13:18:21 +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
debug.c * debug.c (ruby_set_debug_option): define always for binary 2010-10-13 02:04: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 (dir_initialize): remove useless intermediate variable. 2010-10-21 14:47:13 +00:00
dln.c * dln.c (dln_strerror): get English message first, instead of 2010-10-15 23:39:16 +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/intern.h (rb_check_frozen): optimize. 2010-10-24 08:05:55 +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 (NUM2DEVT, DEVT2NUM, PRI_DEVT_PREFIX): fallback to 2010-10-15 14:36:28 +00:00
gc.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +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 * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +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 * insns.def, iseq.c, vm_insnhelper.c: rename variable name 2010-10-14 13:19:30 +00:00
io.c * io.c (rb_f_select): change rdoc. 2010-10-21 07:09:17 +00:00
iseq.c * iseq.c (insn_operand_intern): fix format specifier. 2010-10-15 14:11:26 +00:00
iseq.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
KNOWNBUGS.rb
LEGAL Revert r29271 pending due discussion. 2010-09-16 13:20:11 +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 (CPP): already used in .c.i rule. 2010-10-16 01:55:01 +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 * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
NEWS * pack.c (pack_pack): support endian modifiers: < and >. 2010-10-14 13:12:56 +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 * numeric.c (ruby_float_step): fix Numeric#step with infinity unit 2010-10-13 19:17:49 +00:00
object.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
pack.c Revert r29527. [ruby-dev:42419] 2010-10-18 06:33:50 +00:00
parse.y * io.c (rb_io_ctl), parse.y (LVAR_USED): suppress warnings. 2010-10-12 15:10:04 +00:00
prelude.rb
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 (rand_init): This checks the value is in 32bit or not, 2010-10-04 01:24:01 +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 * random.c (rand_init): remove useless assignment. 2010-10-04 01:23: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 Make punctuation consistent. 2010-09-13 07:58:47 +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 * debug.c (ruby_set_debug_option): define always for binary 2010-10-13 02:04:10 +00:00
sprintf.c Revert "* sprintf.c (rb_str_format): fix: sprintf with hex format and" 2010-10-15 08:31:58 +00:00
st.c * st.c (MurmurMagic): get rid of literal overflow. 2010-10-12 15:18:22 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): suppress warnings. 2010-08-08 01:08:27 +00:00
string.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +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 * configure.in (RUBY_CHECK_PRINTF_PREFIX): check for printf format 2010-10-12 15:03:51 +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 (w32_error): get English message first, instead 2010-10-13 03:10:49 +00:00
thread_win32.h
time.c * array.c (rb_ary_and, rb_ary_or), class.c (rb_mod_init_copy), 2010-10-13 22:22:18 +00:00
timev.h
ToDo
transcode.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +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): reject 0x1.p+0. [ruby-dev:42432] #3966 2010-10-20 01:48:24 +00:00
variable.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
version.c * include/ruby/version.h (RUBY_API_VERSION_*): renamed and moved 2010-08-23 21:08:19 +00:00
version.h * test/ruby/test_rubyoptions.rb (test_segv_test): follow up the 2010-10-23 15:25:20 +00:00
vm.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
vm_core.h * vm_core.h (rb_signal_buff_size, rb_signal_exec): moved 2010-10-09 20:33:21 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): fix to add bug outputs. 2010-10-23 02:02:50 +00:00
vm_eval.c * string.c (sym_call), vm.c (invoke_block_from_c), 2010-09-24 14:45:19 +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 * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
vm_insnhelper.h
vm_method.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (BSD_vfprintf): print floating point on "%#a". 2010-10-20 01:03:18 +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: