development fork of ruby/ruby
Перейти к файлу
akr cb44ffc4af * process.c (rb_exec_getargs): remove rb_exec_arg argument.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35887 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-06-03 12:25:54 +00:00
bcc32 * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +00:00
benchmark * benchmark/bm_vm1_lvar_init.rb: fix newline code. 2012-05-27 16:14:46 +00:00
bin * lib/rdoc: Update to RDoc 3.9. Fixed `ri []`, stopdoc creating an 2011-07-31 00:19:00 +00:00
bootstraptest color option 2012-05-30 01:24:08 +00:00
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs * tool/rbinstall.rb (gem): install all gemspecs under lib and ext. 2011-08-04 07:08:48 +00:00
doc * doc/re.rdoc (Performance): Replaced incorrect example of reducing 2012-06-01 22:05:46 +00:00
enc enc: fix dependencies 2012-05-21 03:11:28 +00:00
ext * ext/date/date_core.c: checks whether the object is frozen or not. 2012-06-03 05:14:47 +00:00
include * marshal.c: calls directly rb_{Complex,Rational}_marshal_load(). 2012-06-03 12:21:18 +00:00
lib * lib/ipaddr.rb: Inhibit zero-filled octets in an IPv4 address in 2012-06-02 09:18:32 +00:00
man * README.ja: Update redmine.ruby-lang.org to bugs.ruby-lang.org 2011-12-19 21:07:09 +00:00
misc * misc/rdoc-mode.el (rdoc-imenu-create-index): Add imenu support 2012-01-22 15:56:03 +00:00
missing Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
nacl Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
sample color option 2012-05-30 01:24:08 +00:00
spec * spec/default.mspec: expand relative path for ruby_exe which uses 2012-04-16 09:23:50 +00:00
symbian Added HAVE_LABS and HAVE_LLABS to config.h 2010-11-13 19:26:55 +00:00
template * template/Doxyfile.tmpl (EXCLUDE_PATTERNS): exclude files only for tests. 2012-05-03 14:56:36 +00:00
test * process.c (rb_proc_exec_e): extended version of rb_proc_exec() to 2012-06-03 11:12:20 +00:00
tool common test options 2012-05-30 01:24:05 +00:00
win32 * win32/win32.c (finish_overlapped_socket, overlapped_socket_io): 2012-05-23 01:21:33 +00:00
.document * prelude.rb, .document: Stuff in prelude.rb should be documented 2010-03-29 12:48:43 +00:00
.gdbinit * .gdbinit (rb_ps_vm): follow st_table's packing change. 2012-04-23 05:19:54 +00:00
.gitignore * ext/iconv: deprecated. [Feature #6322] 2012-04-23 13:57:53 +00:00
.indent.pro * .indent.pro: added for ruby-style. 2010-03-11 21:50:56 +00:00
.travis.yml * .travis.yml (install): It seems tcl/tk is skipped in Travis 2012-05-21 03:45:52 +00:00
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 Change encoding from EUC-JP to UTF-8. [Feature #5128] 2011-09-04 12:22:46 +00:00
ChangeLog * process.c (rb_exec_getargs): remove rb_exec_arg argument. 2012-06-03 12:25:54 +00:00
GPL * It is confusing to put the GPL license terms in the file COPYING; 2001-07-11 19:25:52 +00:00
KNOWNBUGS.rb indented. 2010-02-20 03:17:44 +00:00
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. 2011-08-03 07:10:56 +00:00
Makefile.in Bug #6462: EXTSOLIBS 2012-05-20 03:25:14 +00:00
NEWS * NEWS: expanded a tab. 2012-05-27 04:47:43 +00:00
README single quotes 2012-05-03 15:09:39 +00:00
README.EXT * parse.y (rb_check_id_cstr): new function to check if ID is 2012-04-11 13:31:23 +00:00
README.EXT.ja * parse.y (rb_check_id_cstr): new function to check if ID is 2012-04-11 13:31:23 +00:00
README.ja inilne markups 2012-05-03 15:09:41 +00:00
addr2line.c * io.c (io_encoding_set): suppress warnings. [ruby-dev:45627] 2012-05-06 12:39:59 +00:00
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris 2011-07-08 12:23:10 +00:00
array.c * array.c: Updated Array documentation formatting. Patch by Zachary 2012-05-31 23:51:33 +00:00
atomic.h * complex.c: use "__sun" instead of "__sun__" to detect SunOS. 2011-10-24 14:57:08 +00:00
bignum.c * reduce UNREACHABLE. 2012-04-15 00:06:13 +00:00
class.c * class.c (rb_mod_init_copy): Clear the cached inspect string of a 2012-05-22 20:15:28 +00:00
common.mk * common.mk: fix to build vm_backtrace.c only itself (vm_backtrace.c 2012-06-02 15:59:37 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * vm_core.h: add a data type rb_location_t to store iseq location 2012-05-22 08:31:38 +00:00
complex.c * marshal.c: calls directly rb_{Complex,Rational}_marshal_load(). 2012-06-03 12:21:18 +00:00
configure.in static-linked-ext: no ext/libext.a 2012-05-19 06:02:43 +00:00
constant.h * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
cont.c decrease fiber stack size. 1MB is too large for windows. [Bug #6344] 2012-05-18 09:10:46 +00:00
debug.c * gc.c: use Bitmap Marking algorithm to avoid copy-on-write of 2012-01-07 14:02:23 +00:00
debug.h * debug.h: parenthesize macro arguments. 2011-01-17 13:54:54 +00:00
dir.c Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
dln.c Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
dln.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
dln_find.c * gc.c (rb_objspace_free): global_List is allocated with xmalloc. 2012-01-08 21:02:08 +00:00
dmydln.c * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control 2012-04-13 23:45:37 +00:00
dmyencoding.c * encoding.c (enc_init_db): moved to enc/encdb.c. 2008-04-07 06:51:33 +00:00
dmyext.c no K&R style 2012-05-19 03:36:39 +00:00
dmyversion.c * dmyversion.c: empty load path in miniruby. 2010-02-08 07:28:00 +00:00
encoding.c * reduce UNREACHABLE. 2012-04-15 00:06:13 +00:00
enum.c * enum.c (enum_count): Enumerable#count no longer uses #size when 2012-05-24 23:51:56 +00:00
enumerator.c use RB_TYPE_P() instead of comparison of TYPE() 2012-05-23 07:13:21 +00:00
error.c * error.c (exc_set_backtrace): Updated documentation to indicate 2012-05-29 21:20:45 +00:00
eval.c * vm.c: add RubyVM::Backtrace object (btobj). 2012-05-24 06:09:23 +00:00
eval_error.c * vm_method.c (rb_method_defined_by): removed. 2012-05-24 06:36:44 +00:00
eval_intern.h * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
eval_jump.c volatile errinfo 2012-03-18 15:21:00 +00:00
file.c file.c: fix for UNC 2012-05-26 07:26:36 +00:00
gc.c gc.c: simplified 2012-06-02 21:34:14 +00:00
gc.h Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +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 * goruby.c: windows support. 2011-12-21 07:03:06 +00:00
hash.c use RB_TYPE_P() instead of comparison of TYPE() 2012-05-23 07:13:21 +00:00
ia64.s add reference. 2007-07-15 01:41:40 +00:00
id.c * parse.y (assoc, parser_yylex): add syntax to splat keyword hash. 2012-04-28 21:12:05 +00:00
inits.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
insns.def * numeric.c: fix flodivmod for cornercases [Bug #6044] 2012-03-14 06:10:01 +00:00
internal.h * common.mk: fix to build vm_backtrace.c only itself (vm_backtrace.c 2012-06-02 15:59:37 +00:00
io.c Bug #6487 2012-05-24 03:07:49 +00:00
iseq.c * vm_core.h: add a data type rb_location_t to store iseq location 2012-05-22 08:31:38 +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 * defs/keywords (reserved_word): made inline function static. 2009-05-16 00:30:16 +00:00
load.c * thread.c (rb_threadptr_execute_interrupts_common): 2012-05-11 20:39:35 +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 * marshal.c: calls directly rb_{Complex,Rational}_marshal_load(). 2012-06-03 12:21:18 +00:00
math.c * complex.c: use "__sun" instead of "__sun__" to detect SunOS. 2011-10-24 14:57:08 +00:00
method.h * proc.c (method_hash, proc_hash): Fix {Unbound}Method#hash 2012-02-21 00:13:44 +00:00
node.c * compile.c (iseq_set_arguments): keyword rest arg without keyword args. 2012-03-13 13:00:17 +00:00
node.h * enumerator.c (lazy_take): add Enumerable::Lazy#take. 2012-03-14 10:29:25 +00:00
numeric.c * reduce UNREACHABLE. 2012-04-15 00:06:13 +00:00
object.c class_or_module_required 2012-06-01 00:31:00 +00:00
pack.c use RB_TYPE_P() instead of comparison of TYPE() 2012-05-23 07:13:21 +00:00
parse.y Bug #6403: reset states after empty args 2012-05-14 07:28:36 +00:00
prelude.rb * remove trailing spaces. 2011-05-15 11:55:52 +00:00
proc.c use RB_TYPE_P() instead of comparison of TYPE() 2012-05-23 07:13:21 +00:00
process.c * process.c (rb_exec_getargs): remove rb_exec_arg argument. 2012-06-03 12:25:54 +00:00
random.c * random.c (random_init): Clarify that the default seed is 2012-04-19 00:35:32 +00:00
range.c trivial changes 2012-03-03 03:29:01 +00:00
rational.c * marshal.c: calls directly rb_{Complex,Rational}_marshal_load(). 2012-06-03 12:21:18 +00:00
re.c use RB_TYPE_P() instead of comparison of TYPE() 2012-05-23 07:13:21 +00:00
regcomp.c Remove unused variables. 2012-03-05 07:40:51 +00:00
regenc.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] 2012-02-17 07:42:23 +00:00
regenc.h * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] 2012-02-17 07:42:23 +00:00
regerror.c * regcomp.c: Merge Onigmo 3d855b30d574536d3ae600260208c6624ae4791c. 2012-03-21 10:53:06 +00:00
regexec.c * regcomp.c: Merge Onigmo 3d855b30d574536d3ae600260208c6624ae4791c. 2012-03-21 10:53:06 +00:00
regint.h * regint.h (BITS_IN_ROOM, BS_ROOM, BS_BIT): suppress warnings. 2012-03-22 09:37:44 +00:00
regparse.c * regparse.c (onig_number_of_names): suppress a warning. 2012-06-02 18:24:24 +00:00
regparse.h * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] 2012-02-17 07:42:23 +00:00
regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] 2012-02-17 07:42:23 +00:00
ruby.c ruby.c: fixed typo 2012-05-20 14:00:10 +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 Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
sparc.c * README.ja: Update redmine.ruby-lang.org to bugs.ruby-lang.org 2011-12-19 21:07:09 +00:00
sprintf.c sprintf.c: inspect by plus 2012-05-24 16:15:42 +00:00
st.c * st.c (st_foreach_check, st_foreach): remove ancient check. This 2012-03-31 01:13:26 +00:00
strftime.c strftime.c: triple colons modifier 2012-05-29 08:28:13 +00:00
string.c Fix previous commit, it means not need to make the condition. 2012-06-02 08:52:55 +00:00
struct.c * struct.c (rb_struct_members): Refactoring. As Struct#members had 2012-05-21 15:47:03 +00:00
thread.c * thread.c (vm_living_thread_num): suppress a warning. 2012-06-03 10:47:45 +00:00
thread_pthread.c * thread_pthread.c (rb_thread_create_timer_thread): Added error 2012-05-18 08:47:54 +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.c (TIME_QUANTUM_USEC): 10ms(= old setting) [experimental] 2012-03-29 01:17:39 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c utc offset in seconds 2012-05-30 01:58:34 +00:00
timev.h * timev.h (TIME_SCALE): defined as 1000000000. 2009-08-29 19:06:29 +00:00
transcode.c update doc. 2012-04-24 13:52:13 +00:00
transcode_data.h Supports static linking of extensions and encodings again. 2012-05-16 05:39:06 +00:00
util.c Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
variable.c * variable.c (trace_ev): Removed "not reached" comment as this line is 2012-04-14 00:36:26 +00:00
version.c * configure.in (verconf.h): separate load path specific stuff from 2012-03-27 13:44:25 +00:00
version.h * 2012-06-03 2012-06-02 15:23:41 +00:00
vm.c * common.mk: fix to build vm_backtrace.c only itself (vm_backtrace.c 2012-06-02 15:59:37 +00:00
vm_backtrace.c * vm_backtrace.c: change names. 2012-06-02 16:46:08 +00:00
vm_core.h * common.mk: fix to build vm_backtrace.c only itself (vm_backtrace.c 2012-06-02 15:59:37 +00:00
vm_dump.c * common.mk: fix to build vm_backtrace.c only itself (vm_backtrace.c 2012-06-02 15:59:37 +00:00
vm_eval.c * common.mk: fix to build vm_backtrace.c only itself (vm_backtrace.c 2012-06-02 15:59:37 +00:00
vm_exec.c * vm_exec.c: remove conditions for clang 2011-05-31 02:08:58 +00:00
vm_exec.h * vm_exec.h: parenthesize macro arguments. 2011-01-23 02:39:44 +00:00
vm_insnhelper.c Feature #5896 2012-05-24 14:36:54 +00:00
vm_insnhelper.h fix typos 2011-10-06 11:51:55 +00:00
vm_method.c * vm_method.c (rb_method_defined_by): removed. 2012-05-24 06:36:44 +00:00
vm_opts.h * vm_opts.h: enable "OPT_TRACE_INSTRUCTION" on default. 2008-08-23 06:18:11 +00:00
vsnprintf.c sprintf.c: inspect by plus 2012-05-24 16:15:42 +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://bugs.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

Or if you are using git then use following command:

  $ git clone git://github.com/ruby/ruby.git

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/

Or if you are using git then use following command:

  $ git ls-remote git://github.com/ruby/ruby.git

== 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 <mailto: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 <tt>optflags=..</tt> and <tt>warnflags=..</tt> as
     necessary to override them.

3.   Edit +defines.h+ if you need. Usually this step will not be needed.

4.   Remove comment mark(<tt>#</tt>) 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 "<tt>#option nodynamic</tt>" in
     +ext/Setup+.

5.   Run +make+.

6.   Optionally, run '<tt>make check</tt>' to check whether the compiled Ruby
     interpreter works well. If you see the message "<tt>check succeeded</tt>",
     your ruby works as it should (hopefully).

7.   Run '<tt>make install</tt>'

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

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

     If Ruby's API version is '_x.y.z_', the <tt>${MAJOR}</tt> is '_x_', the
     <tt>${MINOR}</tt> is '_y_', and the <tt>${TEENY}</tt> 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:

<mailto:matz@ruby-lang.org>

-------------------------------------------------------
created at: Thu Aug  3 11:57:36 JST 1995
--
Local variables:
mode: rdoc
end: