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 e553663cbd value.rb: adjust indent
* ext/fiddle/lib/fiddle/value.rb (Fiddle::ValueUtil#wrap_arg): adjust
  indent.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38020 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-11-30 01:35:13 +00:00
bcc32
benchmark * common.mk: specify label `built-ruby'. 2012-11-26 09:30:32 +00:00
bin * lib/rdoc*: Updated to RDoc 4.0 (pre-release) 2012-11-27 04:28:14 +00:00
bootstraptest * vm.c (rb_vm_make_env_object): make Proc object if Env is possible 2012-11-27 11:58:10 +00:00
cygwin * cygwin/GNUmakefile.in (uncommon.mk): link *.res.o. 2012-11-05 14:00:35 +00:00
defs
doc * doc/globals.rdoc: Add documentation file for magic globals 2012-11-27 23:57:20 +00:00
enc
ext value.rb: adjust indent 2012-11-30 01:35:13 +00:00
include vm_backtrace.c: RB_GC_GUARD 2012-11-30 00:38:24 +00:00
lib * lib/rdoc/markdown.rb: Fixed warnings with -w 2012-11-30 01:01:26 +00:00
man * man/erb.1: Fix grammar and copyright dates 2012-11-15 04:22:44 +00:00
misc ruby-additional.el: set encoding 2012-11-07 02:48:19 +00:00
missing
nacl
sample revert r37326 "remove string literal concatenation" 2012-10-25 14:06:31 +00:00
spec
symbian
template Drop executable bits of files that are not executable. 2012-11-22 05:54:13 +00:00
test Refix r38002: capture_subprocess_io also doesn't fork 2012-11-30 01:29:57 +00:00
tool tool/vpath.rb 2012-11-29 08:12:29 +00:00
win32 mkmf.rb: each_compile_rules 2012-11-28 12:19:49 +00:00
.document * .document: Add README's to be included with docs 2012-11-27 23:55:31 +00:00
.editorconfig
.gdbinit
.gitignore probes.h: select by suffix rules 2012-11-16 15:22:37 +00:00
.indent.pro
.travis.yml * .travis.yml (script): add OPTS=-v, requested by @_ko1. 2012-11-19 06:41:43 +00:00
addr2line.c Fix build when gcc is used and the platform's libc lacks alloca(). 2012-11-09 03:34:08 +00:00
addr2line.h
array.c * array.c: Fix rdoc for Array#delete [#7437] 2012-11-26 20:14:49 +00:00
bignum.c * bignum.c (bigdivrem): optimize the way to retry calculation of 2012-11-27 12:46:32 +00:00
BSDL
ChangeLog * lib/rdoc/markdown.rb: Fixed warnings with -w 2012-11-30 01:01:26 +00:00
class.c * vm_method.c (rb_method_entry_make): add a method entry with 2012-11-29 12:50:10 +00:00
common.mk tool/vpath.rb 2012-11-29 08:12:29 +00:00
compar.c
compile.c [EXPERIMENTAL: NEED DISCUSS] 2012-11-29 22:28:16 +00:00
complex.c * complex.c (string_to_c_strict, string_to_c): check NUL. 2012-11-22 11:32:52 +00:00
configure.in * configure.in: fix r37294: run only on i[3-6]86-linux. 2012-11-28 06:45:25 +00:00
constant.h
cont.c * include/ruby/util.h: removed extra semicolon in definition of 2012-11-21 12:42:11 +00:00
COPYING
COPYING.ja
debug.c * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
dir.c dir.c: FNM_EXTGLOB 2012-11-04 01:19:11 +00:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c
enum.c enum.c: prefix 2012-11-06 22:52:52 +00:00
enumerator.c * include/ruby/intern.h: Restore rb_enumeratorize as it was before r37497 2012-11-07 19:46:16 +00:00
error.c hash.c: refine error messages 2012-11-11 06:38:17 +00:00
eval.c * vm.c: add a return hook when a method raises an exception. 2012-11-29 17:55:54 +00:00
eval_error.c * eval_error.c (error_print), vm_eval.c (eval_string_with_cref), 2012-10-23 20:42:45 +00:00
eval_intern.h Fix build when gcc is used and the platform's libc lacks alloca(). 2012-11-09 03:34:08 +00:00
eval_jump.c
file.c * file.c (Init_File): null device definition uses rb_define_const 2012-11-20 16:00:04 +00:00
gc.c * gc.c : remove a unused function. 2012-11-29 23:10:36 +00:00
gc.h * ext/objspace/objspace.c (ObjectSpace.reachable_objects_from): 2012-10-24 00:04:56 +00:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c * probes.d: add DTrace probe declarations. [ruby-core:27448] 2012-11-12 21:52:12 +00:00
ia64.s
id.c
inits.c
insns.def [EXPERIMENTAL: NEED DISCUSS] 2012-11-29 22:28:16 +00:00
internal.h * vm_method.c (rb_method_entry_make): add a method entry with 2012-11-29 12:50:10 +00:00
io.c * thread.c (struct rb_mutex_struct): add allow_trap field. 2012-11-28 08:30:51 +00:00
iseq.c * iseq.c (make_compile_option_value): add trace_instruction option. 2012-11-26 10:46:01 +00:00
iseq.h
KNOWNBUGS.rb vm.c: rewrite all catch points 2012-11-02 19:14:24 +00:00
LEGAL
lex.c.blt
load.c * probes.d: add DTrace probe declarations. [ruby-core:27448] 2012-11-12 21:52:12 +00:00
main.c * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
Makefile.in configure.in: --disable-dln 2012-11-23 15:00:12 +00:00
marshal.c * marshal.c: add marshal readahead. marshalized Array, Hash and Struct 2012-11-20 15:17:15 +00:00
math.c * include/ruby/util.h: removed extra semicolon in definition of 2012-11-21 12:42:11 +00:00
method.h * vm_method.c (rb_method_entry_make): add a method entry with 2012-11-29 12:50:10 +00:00
NEWS * lib/rake/*: Updated to rake 0.9.5 2012-11-29 19:16:46 +00:00
node.c * include/ruby/util.h: removed extra semicolon in definition of 2012-11-21 12:42:11 +00:00
node.h
numeric.c * numeric.c: Add description of that the results of the comparing 2012-11-08 00:34:55 +00:00
object.c * vm_method.c (rb_method_entry_make): add a method entry with 2012-11-29 12:50:10 +00:00
pack.c set encoding to ASCII for appropriate String#unpack modifiers 2012-10-19 13:13:32 +00:00
parse.y * include/ruby/util.h: removed extra semicolon in definition of 2012-11-21 12:42:11 +00:00
prelude.rb * prelude.rb: Moved Mutex#synchronize to 2012-11-19 10:22:53 +00:00
probes.d * probes.d: Change function-entry probe to method-entry. 2012-11-28 20:20:50 +00:00
probes_helper.h * vm.c: add a return hook when a method raises an exception. 2012-11-29 17:55:54 +00:00
proc.c * vm_method.c (rb_method_entry_make): add a method entry with 2012-11-29 12:50:10 +00:00
process.c * process.c (proc_getsid): adds new method for getting session id. 2012-11-24 02:51:24 +00:00
random.c random.c: BYTE_ORDER 2012-11-09 14:05:11 +00:00
range.c remove trailing spaces. 2012-11-29 02:58:31 +00:00
rational.c * complex.c (string_to_c_strict, string_to_c): check NUL. 2012-11-22 11:32:52 +00:00
re.c Apply performance improvement to short byte array search. 2012-11-22 05:23:12 +00:00
README * README: mention about README.win32. 2012-11-26 16:01:51 +00:00
README.EXT
README.EXT.ja
README.ja
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c ruby.c: argv check 2012-11-23 15:00:55 +00:00
ruby_atomic.h * ruby_atomic.h (ATOMIC_CAS): added for Solaris and other platforms. 2012-11-27 10:21:59 +00:00
safe.c
signal.c * ruby_atomic.h (ATOMIC_CAS): added for Solaris and other platforms. 2012-11-27 10:21:59 +00:00
siphash.c siphash.c: union sip_init_state 2012-11-09 14:02:31 +00:00
siphash.h * siphash.h: check configure macros before include newer headers. 2012-11-09 15:34:31 +00:00
sparc.c
sprintf.c
st.c st_update passes the key in st_table 2012-11-17 02:46:13 +00:00
strftime.c
string.c * string.c (rb_str_enumerate_chars, rb_str_enumerate_codepoints) 2012-11-27 13:34:40 +00:00
struct.c struct.c: fix typo 2012-11-19 07:54:53 +00:00
thread.c * thread.c (rb_thread_interrupted): avoid warning of 2012-11-29 22:44:51 +00:00
thread_pthread.c * thread_pthread.c (rb_reserved_fd_p): fix typo in macro check 2012-11-05 16:43:32 +00:00
thread_pthread.h
thread_win32.c * thread_win32.c: catch up latest change of BLOCKING_REGION. 2012-11-28 13:57:52 +00:00
thread_win32.h
time.c
timev.h
transcode.c
transcode_data.h
util.c
variable.c variable.c: show namespace 2012-11-29 08:45:13 +00:00
version.c
version.h * 2012-11-30 2012-11-29 16:55:28 +00:00
vm.c [EXPERIMENTAL: NEED DISCUSS] 2012-11-29 22:28:16 +00:00
vm_backtrace.c vm_backtrace.c: RB_GC_GUARD 2012-11-30 00:38:24 +00:00
vm_core.h * include/ruby/debug.h: add rb_debug_inspector_* APIs. 2012-11-29 07:05:27 +00:00
vm_debug.h * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
vm_dump.c * vm_dump.c: not to include probes.h because the code does not depend 2012-11-19 12:37:43 +00:00
vm_eval.c * vm.c: add a return hook when a method raises an exception. 2012-11-29 17:55:54 +00:00
vm_exec.c * probes.d: add DTrace probe declarations. [ruby-core:27448] 2012-11-12 21:52:12 +00:00
vm_exec.h * vm_exec.h (GENTRY): GENTRY should be pointer size. 2012-11-15 13:42:27 +00:00
vm_insnhelper.c * vm.c: add a return hook when a method raises an exception. 2012-11-29 17:55:54 +00:00
vm_insnhelper.h * vm_insnhelper.h: partly revert r37631 (DTrace support). 2012-11-22 06:28:17 +00:00
vm_method.c * vm_method.c (rb_method_entry_make): add a method entry with 2012-11-29 12:50:10 +00:00
vm_opts.h * Makefile.in (probes.o): add -C to ignore #include in probes.d. 2012-11-22 09:03:43 +00:00
vm_trace.c [EXPERIMENTAL: NEED DISCUSS] 2012-11-29 22:28:16 +00:00
vsnprintf.c

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

0.   If you want to use Microsoft Visual C++ to compile ruby,
     read win32/README.win32 instead of this document.

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+.

     Usually this step will not be needed.

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: