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
nobu 0e4b86b5b9 * common.mk (newline.c, miniprelude.c): use VPATH.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33949 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-12-05 08:13:28 +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
bootstraptest * bootstraptest/runner.rb: don't suppress SIGINT. 2011-11-12 04:37:54 +00:00
cygwin
defs
doc * doc/rake/CHANGES: reverted. this file is not written in Japanese. 2011-09-05 06:05:31 +00:00
enc * enc/unicode.c (PROPERTY_NAME_MAX_SIZE): +1. 2011-11-20 13:44:11 +00:00
ext * include/ruby/{subst.h,win32.h}, ext/socket/rubysocket.h: revert 2011-12-05 05:29:31 +00:00
include * include/ruby/{subst.h,win32.h}, ext/socket/rubysocket.h: revert 2011-12-05 05:29:31 +00:00
lib * lib/tempfile.rb: don't use lock directory. [ruby-dev:39197] 2011-12-04 13:53:59 +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 * lib/delegate.rb (Delegator#methods): Kernel#methods receives 2011-12-04 03:05:03 +00:00
tool * tool/rbinstall.rb (install_recursive, bin-comm): split mere 2011-10-30 01:50:38 +00:00
win32 Introduce NEED_READCONV and NEED_WRITECONV to replace universal newline decorator 2011-12-04 01:10:06 +00:00
.document
.gdbinit
.gitignore
.indent.pro
.travis.yml * .travis.yml (script): should be ./configure 2011-11-26 06:41:29 +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_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 (): refix of r33536. Don't change behavior of Bignum#/. 2011-11-22 02:27:53 +00:00
BSDL
ChangeLog * signal.c (reserved_signal_p): static. 2011-12-05 05:33:49 +00:00
class.c * lib/delegate.rb (Delegator#methods): Kernel#methods receives 2011-12-04 03:05:03 +00:00
common.mk * common.mk (newline.c, miniprelude.c): use VPATH. 2011-12-05 08:13:28 +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 * Makefile.in (CFLAGS): append ARCH_FLAG. 2011-12-02 22:17:34 +00:00
constant.h
cont.c * cont.c (fiber_switch): ignore fiber context switch 2011-11-20 21:17:57 +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.h
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
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_jump.c
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): static. it seems to be forgetten at r33501. 2011-11-28 03:38:52 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
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 * internal.h (rb_maygvl_fd_fix_cloexec): change the visibility for 2011-11-01 03:37:01 +00:00
io.c * io.c: suppress unused-value warnings. fixup of r33937. 2011-12-04 23:56:59 +00:00
iseq.c suppress warnings. 2011-09-25 07:42:38 +00:00
iseq.h
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c
main.c
Makefile.in * Makefile.in (CFLAGS): append ARCH_FLAG. 2011-12-02 22:17:34 +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
NEWS * lib/pathname.rb (Pathname#find): return an enumerator if 2011-11-19 12:52:37 +00:00
node.c
node.h
numeric.c Fix for r33811. 2011-11-22 04:54:42 +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 (nodetype, nodeline): suppress warnings. 2011-11-29 00:51:37 +00:00
prelude.rb
proc.c Revert r33921. 2011-12-01 22:14:45 +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 (rb_reg_initialize): fix indent. 2011-11-20 14:05:44 +00:00
README
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
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
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 * signal.c (reserved_signal_p): static. 2011-12-05 05:33:49 +00:00
sparc.c * fix ANSI C compliance of r33757 2011-11-15 05:05:35 +00:00
sprintf.c
st.c * hash.c (identhash): share with type_numhash. 2011-10-18 14:28:58 +00:00
strftime.c
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 (thread_timer): call prctl(PR_SET_NAME) only if 2011-12-01 14:28:42 +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: Simplified rb_econv_binmode, avoided a warning on cygwin. 2011-11-30 11:03:22 +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): print a warning when no argument 2011-12-03 11:52:14 +00:00
version.c
version.h * 2011-12-05 2011-12-04 23:57:03 +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 * io.c (rb_write_error2): get rid of warning on linux. fwrite 2011-11-27 12:06:10 +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.h
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 * 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

* 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: