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
usa ccf07bde23 * signal.c: need to include unistd.h for write(2).
unistd.h is now included via ruby/defines.h, but should implicitly
  include here.  (suggested by kosaki)


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40743 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-05-14 15:44:14 +00:00
benchmark * benchmark/bm_hash_shift.rb: add benchmark for Hash#shift 2013-04-25 05:03:30 +00:00
bin irb: dead code 2013-05-02 13:11:55 +00:00
bootstraptest test: tty option 2013-01-15 00:59:19 +00:00
cygwin
defs id.def: predefined IDs 2013-05-02 07:54:17 +00:00
doc * doc/contributing.rdoc: Add guide for contributing to CRuby 2013-05-09 02:15:24 +00:00
enc ext/depend: fix dependency for nmake 2013-04-08 14:56:01 +00:00
ext * ext/socket/.document: Add ifaddr.c. 2013-05-14 14:48:00 +00:00
include ruby.h: fix typo 2013-05-14 14:27:25 +00:00
lib * lib/cgi/session.rb: Fix a typo. 2013-05-05 13:27:26 +00:00
man * man/rake.1, man/ruby.1: Use the Pa macro to make URLs stand out. 2013-03-08 11:16:00 +00:00
misc Replace use of obsolete variable last-command-char by @maser [fix GH-290] 2013-04-21 10:04:54 +00:00
missing * missing/isnan.c (isnan): Don't define if isnan() macro is defined. 2013-04-23 11:27:07 +00:00
nacl Fix failures on btest for NativeClient. 2013-01-03 15:39:15 +00:00
sample * lib/drb/drb.rb: Improved documentation by adding or hiding methods. 2013-01-25 03:25:39 +00:00
spec
symbian
template ruby.pc.in: rubyarchhdrdir 2013-05-05 04:29:01 +00:00
test * ext/dl/lib/dl/func.rb (DL::Function#call): check tainted when 2013-05-14 11:06:58 +00:00
tool * common.mk: Add dependencies for include/ruby.h 2013-04-11 14:42:33 +00:00
win32 iphlpapi is unavailable with older VC 2013-05-14 08:24:58 +00:00
.document * .document: Removed extra space 2013-01-16 00:36:07 +00:00
.editorconfig
.gdbinit .gdbinit: initialize color sequences 2013-03-07 04:38:50 +00:00
.gitignore id.c: generate 2012-12-04 17:36:19 +00:00
.indent.pro
.travis.yml Fix .travis.yml for current known Linux failure 2013-04-18 18:04:11 +00:00
addr2line.c * addr2line.c: use more generic type: 2013-04-06 19:27:04 +00:00
addr2line.h
array.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
bignum.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
BSDL * BSDL: update copyright notice for 2013. 2013-02-09 01:12:30 +00:00
ChangeLog * signal.c: need to include unistd.h for write(2). 2013-05-14 15:44:14 +00:00
class.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
common.mk * common.mk (yes-test-all): needs sudo-precheck for dtrace. 2013-05-03 04:50:15 +00:00
compar.c * compar.c (Comparable#==): fix typo. 2013-05-06 06:40:23 +00:00
compile.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
complex.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
configure.in * win32/win32.c, include/ruby/win32.h (getipaddrs): [experimental] 2013-05-13 11:29:32 +00:00
constant.h
cont.c defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
COPYING
COPYING.ja
debug.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
dir.c * dir.c (dir_set_pos): Fix a compilation error when seekdir() is not 2013-04-26 09:16:14 +00:00
dln.c adjust style. 2012-12-01 15:25:28 +00:00
dln.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
dln_find.c * configure.in: add getenv() declaration check. 2013-05-12 08:40:24 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
enum.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
enumerator.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
error.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
eval.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
eval_error.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
eval_intern.h * configure.in: Check mblen(). 2013-04-24 12:52:26 +00:00
eval_jump.c
file.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
gc.c * remove trailing spaces. 2013-05-14 01:54:48 +00:00
gc.h * gc.h (SET_MACHINE_STACK_END): Add !defined(_ILP32) to a defining 2013-05-10 15:49:56 +00:00
gem_prelude.rb
golf_prelude.rb
goruby.c goruby.c: IRB at end 2012-12-23 06:34:56 +00:00
GPL
hash.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
ia64.s
inits.c
insns.def * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
internal.h * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
io.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
iseq.c * iseq.c (prepare_iseq_build): remove additional line braek. 2013-05-13 11:11:53 +00:00
iseq.h iseq: reduce array allocations for simple sequences 2013-04-17 11:20:23 +00:00
KNOWNBUGS.rb * test/ruby/test_method.rb (test_unlinked_method_entry_in_method_object_bug): 2013-03-25 05:39:32 +00:00
LEGAL
lex.c.blt
load.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
main.c
Makefile.in compiler version 2013-03-22 07:57:09 +00:00
marshal.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
math.c
method.h vm_method.c: rb_method_entry_at 2013-05-13 05:51:14 +00:00
NEWS Add NEWS about Kernel#singleton_method r40684 [Feature #8391] 2013-05-14 08:42:58 +00:00
node.c
node.h * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
numeric.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
object.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
pack.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
parse.y parse.y: fix argument type 2013-05-14 08:24:55 +00:00
prelude.rb
probes.d gen_dummy_probes.rb 2013-03-11 05:25:06 +00:00
probes_helper.h probes_helper.h: RUBY_DTRACE_HOOK 2012-12-11 03:37:19 +00:00
proc.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
process.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
random.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
range.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
rational.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
re.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
README * README: Fix typo by Benjamin Winkler [Fixes GH-281] 2013-04-11 00:18:05 +00:00
README.EXT README.EXT: update note 2013-04-28 03:38:27 +00:00
README.EXT.ja README.EXT: update note 2013-04-28 03:38:27 +00:00
README.ja
regcomp.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regenc.c
regenc.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
regerror.c
regexec.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regint.h * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regparse.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regparse.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
regsyntax.c
ruby.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
ruby_atomic.h * configure.in (AC_CHECK_HEADERS): atomic.h for Solaris atomic_ops. 2013-04-06 15:00:44 +00:00
safe.c
signal.c * signal.c: need to include unistd.h for write(2). 2013-05-14 15:44:14 +00:00
siphash.c * regint.h: fix typo: _M_AMD86 -> _M_AMD64. 2013-04-10 21:16:44 +00:00
siphash.h
sparc.c * sparc.c: Use __asm__ instead of asm for gcc. 2013-04-27 10:06:20 +00:00
sprintf.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
st.c * st.c (st_shift): remove unused variable. 2013-04-25 05:25:53 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): Test yday range. 2013-04-06 16:02:46 +00:00
string.c * string.c (rb_str_new_frozen): remove debug print. 2013-05-13 18:34:10 +00:00
struct.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
thread.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
thread_pthread.c * thread_pthread.c (ruby_init_stack): Add STACK_GROW_DIR_DETECTION. 2013-04-27 11:21:10 +00:00
thread_pthread.h
thread_win32.c timev.h: move time_t stuffs 2013-03-30 21:08:36 +00:00
thread_win32.h
time.c * time.c (localtime_with_gmtoff_zone): musl libc may return NULL for 2013-05-01 12:12:25 +00:00
timev.h timev.h: move time_t stuffs 2013-03-30 21:08:36 +00:00
transcode.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
transcode_data.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
util.c * util.c (ruby_hdtoa): revert r29729. 2013-04-22 02:59:09 +00:00
variable.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
version.c version.c: move ruby_exec_prefix 2013-02-18 01:11:58 +00:00
version.h * 2013-05-14 2013-05-13 15:55:13 +00:00
vm.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
vm_backtrace.c defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
vm_core.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
vm_debug.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
vm_dump.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
vm_eval.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
vm_exec.c * vm_exec.c: Correct predefined macro name. This typo is introduced by 2013-03-18 01:45:12 +00:00
vm_exec.h fix minor code comment typos 2013-04-22 19:40:10 +00:00
vm_insnhelper.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
vm_insnhelper.h
vm_method.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
vm_opts.h fix minor code comment typos 2013-04-22 19:40:10 +00:00
vm_trace.c id.def: predefined IDs 2013-05-02 07:54:17 +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

For a complete list of ways to install Ruby, including using third party
tools like rvm, see:

http://www.ruby-lang.org/en/downloads/

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

Some extension libraries may not get compiled because of lack of
necessary external libraries and/or headers, then you will need to run
'<tt>make distclean-ext</tt>' to remove old configuration after
installing them in such case.

== Copying

See the file +COPYING+.

== Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list
(http://www.ruby-lang.org/en/community/mailing-lists) or on websites like
(http://stackoverflow.com).

Bug reports should be filed at http://bugs.ruby-lang.org

== The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

<mailto:matz@ruby-lang.org>

--
Local variables:
mode: rdoc
end: