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 62fed7c91a update doc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33791 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-11-19 10:48:22 +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 * 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/rake/CHANGES: reverted. this file is not written in Japanese. 2011-09-05 06:05:31 +00:00
enc Forward-ports r32780 from branches/ruby_1_9_3 to trunk. 2011-07-31 14:17:42 +00:00
ext * ext/io/console/console.c (console_raw, console_set_raw) 2011-11-18 08:18:18 +00:00
include * include/ruby/ruby.h(NUM2LONG, NUM2INT, NUM2SHORT, NUM2LL, 2011-11-15 05:57:34 +00:00
lib * test/unit/assertions.rb (MINI_DIR): quick dirty hack to get rid of 2011-11-18 04:21:23 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc * misc/ruby-mode.el (ruby-indent-beg-re): Fix broken regular 2011-06-30 14:54:11 +00:00
missing * missing/lgamma_r.c (lgamma_r): get rid of false warning on mingw. 2011-05-18 13:35:13 +00:00
sample * sample/drb/dhasenc.rb: coding cookie of Emacs is coding, 2011-09-09 16:44:38 +00:00
spec * spec/README: update the description. 2011-05-24 22:13:14 +00:00
symbian Added HAVE_LABS and HAVE_LLABS to config.h 2010-11-13 19:26:55 +00:00
template * template/Doxyfile.tmpl (INCLUDE_PATH): add srcdir and include. 2011-11-09 02:40:39 +00:00
test * time.c (TIME_COPY_GMT): copy vtm.utc_offset and vtm.zone too. 2011-11-19 10:47:03 +00:00
tool * tool/rbinstall.rb (install_recursive, bin-comm): split mere 2011-10-30 01:50:38 +00:00
win32 * io.c (rb_cloexec_open): set O_NOINHERIT instead of O_CLOEXEC if it is 2011-11-18 04:06:01 +00:00
.document
.gdbinit
.gitignore remove duplicated and change comment location 2011-03-19 00:25:01 +00:00
.indent.pro
addr2line.c * addr2line.c (PATH_MAX): define if not defined. [ruby-core:40840] 2011-11-08 14:31:56 +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 (rb_ary_initialize): Improve explanation of Array.new 2011-10-10 23:50:02 +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 (rb_big2ulong): need to calc in unsigned long, because 2011-11-16 04:53:51 +00:00
BSDL Add BSDL file. 2010-09-15 15:40:52 +00:00
ChangeLog * time.c (TIME_COPY_GMT): copy vtm.utc_offset and vtm.zone too. 2011-11-19 10:47:03 +00:00
class.c * class.c (class_alloc): allocate extra memory after containing 2011-10-04 12:10:09 +00:00
common.mk Forward-ports r32776 from branches/ruby_1_9_3 to trunk. 2011-07-31 14:17:37 +00:00
compar.c
compile.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
complex.c * complex.c (nucomp_rationalize): fix function. [ruby-core:40667] 2011-11-02 12:36:06 +00:00
configure.in Improved error message when using llvm-gcc 2011-11-17 22:38:18 +00:00
constant.h * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
cont.c * cont.c (rb_fiber_m_transfer, rb_fiber_resume): prohibit using 2011-11-09 04:26:39 +00:00
COPYING
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128] 2011-09-04 12:22:46 +00:00
debug.c * debug.c: parenthesize macro arguments. 2010-12-07 12:16:10 +00:00
debug.h * debug.h: parenthesize macro arguments. 2011-01-17 13:54:54 +00:00
dir.c * include/ruby/defines.h: remove NextStep, OpenStep, Rhapsody 2011-09-26 00:19:03 +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 * dln_find.c (dln_find_1): use rb_warning and return immediately 2011-01-26 23:22:54 +00:00
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 (Init_Exception): Document $! and $@. Provide 2011-10-19 02:52:38 +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_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
eval_jump.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
file.c * file.c (file_expand_path): reset coderange after expanding path. 2011-11-01 08:17:59 +00:00
gc.c * gc.c (initial_params): pack in a struct. 2011-10-21 13:02:19 +00:00
gc.h * eval.c (ruby_cleanup): use rb_ary_free to free internal object. 2011-02-11 10:45:34 +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
GPL
hash.c * whitespace cleanup. 2011-11-04 07:19:23 +00:00
ia64.s
id.c
inits.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
insns.def insns.def: Some fixes and tweaks to English explanations 2011-11-05 11:30:51 +00:00
internal.h * internal.h (rb_maygvl_fd_fix_cloexec): change the visibility for 2011-11-01 03:37:01 +00:00
io.c * io.c (rb_cloexec_open): set O_NOINHERIT instead of O_CLOEXEC if it is 2011-11-18 04:06:01 +00:00
iseq.c suppress warnings. 2011-09-25 07:42: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
KNOWNBUGS.rb
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. 2011-08-03 07:10:56 +00:00
lex.c.blt
load.c * load.c (rb_f_require): Improve documentation of Kernel#require. 2011-08-23 06:26:11 +00:00
main.c * main.c: <stdlib.h> is needed, to introduce the getenv(3) 2010-11-01 12:43:59 +00:00
Makefile.in * Makefile.in (LIBRUBY_A): check if generated linked library is 2011-11-16 09:13:56 +00:00
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 * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
NEWS added a description of NUM2SHORT() to NEWS 2011-11-14 16:00:29 +00:00
node.c * node.c (dump_node): add today's knowledge. "init arguments (m)" and 2011-07-21 10:35:52 +00:00
node.h * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
numeric.c * numeric.c (rb_fix2ushort): fix typo. use num rb_num2ushort() 2011-11-14 05:53:59 +00:00
object.c * object.c (Init_Object): Add reference to BasicObject, brief 2011-10-10 20:54:45 +00:00
pack.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
parse.y * parse.y (parser_nextc): set encoding for the buffer of ripper. 2011-10-28 02:30:22 +00:00
prelude.rb * remove trailing spaces. 2011-05-15 11:55:52 +00:00
proc.c * proc.c (proc_call): Update documentation to match argument handling 2011-10-03 23:16:11 +00:00
process.c * process.c (proc_seteuid): separate an internal wrapper function 2011-11-11 09:42:02 +00:00
random.c * process.c (ruby_setsid): use rb_cloexec_open. 2011-10-29 04:01:54 +00:00
range.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +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 (match_aref): Use <code> around indexing examples to prevent 2011-10-24 21:35:05 +00:00
README * README*: remove trailing spaces. 2011-08-25 21:00:03 +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.ja, README.EXT.ja: remove garbage spaces. 2011-09-25 13:40:25 +00:00
regcomp.c * regcomp.c (print_indent_tree): fix double printing of ENCLOSE_OPTION 2011-11-15 00:51:46 +00:00
regenc.c Clean a warning. 2010-11-09 10:14:47 +00:00
regenc.h
regerror.c
regexec.c Fix type of arguments in debug prints. 2011-02-23 00:04:55 +00:00
regint.h * regint.h (PLATFORM_UNALIGNED_WORD_ACCESS): Power PC does not 2011-07-14 16:51:29 +00:00
regparse.c * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
regparse.h * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
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 * atomic.h (ATOMIC_INC, ATOMIC_DEC): return old values. 2011-10-13 20:58:08 +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 * io.c, thread.c, ext/pty/pty.c, ext/fiddle/closure.c: use 2011-11-15 11:09:47 +00:00
thread_pthread.c * thread_pthread.c (gvl_yield): don't prevent concurrent sched_yield(). 2011-11-09 17:10:48 +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 * include/ruby/intern.h, thread_pthread.c (rb_reserved_fd_p, 2011-07-03 21:56:59 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c update doc. 2011-11-19 10:48:22 +00:00
timev.h
transcode.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
transcode_data.h
util.c * util.c (mmprepare): fix for fragmental size. 2011-10-20 02:42:26 +00:00
variable.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
version.c * math.c: Attach documentation for Math. 2011-06-29 03:09:34 +00:00
version.h * 2011-11-19 2011-11-18 23:19:30 +00:00
vm.c * vm.c (rb_thread_mark), cont.c (cont_mark): self pointer should not 2011-10-01 23:48:48 +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 * vm_dump.c (HAVE_BACKTRACE): fallback to 0. 2011-11-11 08:09:48 +00:00
vm_eval.c * vm_eval.c (check_funcall): set array elements one-by-one to fix 2011-10-20 12:30:13 +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 * vm_insnhelper.c (vm_call_cfunc): adding back useless hack. For some 2011-10-27 18:02:42 +00:00
vm_insnhelper.h fix typos 2011-10-06 11:51:55 +00:00
vm_method.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (BSD_vfprintf): support 'll' prefix. 2011-11-01 04:31:52 +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: