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
kazu 1ca8760902 * misc/README: mention rdoc-mode.el and ruby-style.el.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30503 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-01-09 22:44:19 +00:00
bcc32
benchmark
bin
bootstraptest
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs
doc
enc * enc/{emacs_mule,euc_jp}.c (code_to_mbc): suppress warnings. 2011-01-05 20:16:32 +00:00
ext * ext/readline/readline.c: apply a patch from Nobuyoshi Nakada. 2011-01-09 05:54:33 +00:00
include * array.c (rb_ary_modify): export. 2011-01-05 20:25:50 +00:00
lib * lib/irb/locale.rb (IRB::Locale::LOCALE_NAME_RE): 2011-01-09 07:39:16 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc * misc/README: mention rdoc-mode.el and ruby-style.el. 2011-01-09 22:44:19 +00:00
missing
sample * lib/optparse.rb (OptionParser::Officious): separate completion 2010-12-07 13:31:11 +00:00
spec
symbian
template * template/id.h.tmpl: suppress all warning: "SUPPORT_JOKE" is not 2010-12-12 11:49:32 +00:00
test * ext/psych/lib/psych/json/tree_builder.rb (start_mapping): tags 2011-01-06 02:29:18 +00:00
tool * tool/mkconfig.rb (RbConfig): get rid of unused variable. 2010-12-17 09:35:42 +00:00
win32 * win32/win32.c (rb_w32_write_console): don't raise exception when 2010-12-31 19:26:30 +00:00
.document
.gdbinit
.gitignore
.indent.pro
addr2line.c * addr2line.c: Follow .gnu_debuglink section. 2010-12-01 00:32:19 +00:00
addr2line.h * addr2line.c: added to show source filename and line number of 2010-11-26 03:28:50 +00:00
array.c * array.c (rb_ary_modify): export. 2011-01-05 20:25:50 +00:00
bignum.c * bignum.c (bigmul1_karatsuba): avoid overflow that make assertion 2011-01-07 00:17:06 +00:00
BSDL
ChangeLog * misc/README: mention rdoc-mode.el and ruby-style.el. 2011-01-09 22:44:19 +00:00
class.c * class.c (make_metaclass): fix probable typo. builtin type flag 2010-12-05 08:56:42 +00:00
common.mk * common.mk (EXTMK_ARGS): specify to pass macro V, because nmake 2010-12-27 03:16:30 +00:00
compar.c
compile.c * compile.c (setup_args), vm.c (invoke_block_from_c), 2010-12-20 21:10:24 +00:00
complex.c update doc. 2011-01-08 10:51:14 +00:00
configure.in * io.c (Kernel.#syscall): implemented on LP64/LLP64 environments too. 2011-01-09 07:39:22 +00:00
constant.h remove a comma at end of enumerator list. 2010-12-10 02:42:06 +00:00
cont.c * cont.c: parenthesize macro arguments. 2010-12-06 20:56:04 +00:00
COPYING
COPYING.ja
debug.c * debug.c: parenthesize macro arguments. 2010-12-07 12:16:10 +00:00
debug.h
dir.c * dir.c: parenthesize macro arguments. 2010-12-08 11:38:29 +00:00
dln.c * dln.c (init_funcname_len): ignore rest from first dot. 2011-01-05 20:03:28 +00:00
dln.h
dln_find.c * dln_find.c: parenthesize macro arguments. 2010-12-10 13:34:08 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c: parenthesize macro arguments. 2010-12-11 00:28:25 +00:00
enum.c * enum.c (enum_sort_by): use rb_ary_resize. 2011-01-08 12:48:12 +00:00
enumerator.c
error.c Error#to_s should ensure that the value returned is a string. 2011-01-05 05:18:48 +00:00
eval.c * eval.c (ruby_cleanup): fix type. 2010-12-02 21:45:49 +00:00
eval_error.c * eval_error.c: parenthesize macro arguments. 2010-12-12 04:28:29 +00:00
eval_intern.h
eval_jump.c
file.c * file.c (file_expand_path): get rid of warnings caused by 2010-12-26 13:24:17 +00:00
gc.c * gc.c (Init_GC): move back object_id to Kernel. [ruby-dev:42840] 2010-12-22 05:38:41 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c * hash.c: parenthesize macro arguments. 2010-12-14 22:18:39 +00:00
ia64.s
id.c
inits.c
insns.def
io.c * io.c (Kernel.#syscall): implemented on LP64/LLP64 environments too. 2011-01-09 07:39:22 +00:00
iseq.c * iseq.c: parenthesize macro arguments. 2010-12-16 22:05:58 +00:00
iseq.h * compile.c (iseq_compile_each): fix for __goto__ and __label__ 2010-12-12 14:45:30 +00:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c * load.c (rb_f_require_relative): don't omit return type. 2010-12-25 03:48:57 +00:00
main.c
Makefile.in * Makefile.in: remove unnecessary semicolons. 2010-12-30 18:03:13 +00:00
marshal.c * marshal.c: parenthesize macro arguments. 2010-12-19 10:15:57 +00:00
math.c
method.h
NEWS * NEWS (optparse): shell completion support. 2011-01-01 02:03:59 +00:00
node.c * node.c: parenthesize macro arguments. 2010-12-20 14:13:12 +00:00
node.h * node.h (RNode): match the type of flags to RBasic, and renamed 2010-12-15 23:04:50 +00:00
numeric.c * numeric.c (Init_Numeric): fixed a potential bug when using bccwin32 2010-12-01 13:05:17 +00:00
object.c
pack.c * pack.c (swapf): compilation condition simplified. 2011-01-08 12:25:03 +00:00
parse.y * re.c (rb_reg_expr_str): need to escape if the coderage is invalid. 2010-12-28 09:43:49 +00:00
prelude.rb
proc.c * transcode.c (transcode_loop): call default handler of the given 2010-12-07 13:05:26 +00:00
process.c update doc. 2010-12-29 01:33:28 +00:00
random.c * random.c (random_rand): suppress a warning. 2011-01-05 20:17:36 +00:00
range.c
rational.c * rational.c: parenthesize macro arguments. 2010-12-26 00:36:08 +00:00
re.c Sorry, commit miss of r30412. 2010-12-29 09:24:37 +00:00
README
README.EXT
README.EXT.ja
README.ja
regcomp.c * regcomp.c (setup_tree): restart setup_tree() for a node whose 2010-11-26 03:28:48 +00:00
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c * ruby.c: parenthesize macro arguments. 2010-12-27 22:37:59 +00:00
safe.c
signal.c * signal.c: parenthesize macro arguments. 2010-12-29 01:07:26 +00:00
sprintf.c * sprintf.c: parenthesize macro arguments. 2010-12-30 02:50:34 +00:00
st.c * st.c: parenthesize macro arguments. 2010-12-31 01:28:41 +00:00
strftime.c * strftime.c: parenthesize macro arguments. 2011-01-01 02:45:04 +00:00
string.c fix spaces. 2011-01-08 13:07:20 +00:00
struct.c
thread.c * thread.c: parenthesize macro arguments. 2011-01-08 10:29:15 +00:00
thread_pthread.c * thread.c (thread_cleanup_func): Moved interrupted_lock 2010-12-20 15:20:17 +00:00
thread_pthread.h * thread.c, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
thread_win32.c * thread.c (thread_cleanup_func): Moved interrupted_lock 2010-12-20 15:20:17 +00:00
thread_win32.h * thread.c, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
time.c * time.c: parenthesize macro arguments. 2010-11-27 10:12:48 +00:00
timev.h
ToDo
transcode.c * transcode.c: parenthesize macro arguments. 2011-01-09 11:38:55 +00:00
transcode_data.h
util.c
variable.c
version.c
version.h * 2011-01-10 2011-01-09 22:44:17 +00:00
vm.c * vm.c (rb_vm_make_proc): fix indent. 2011-01-05 19:52:51 +00:00
vm_core.h * compile.c (setup_args), vm.c (invoke_block_from_c), 2010-12-20 21:10:24 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): suppress a warning. 2010-12-08 12:39:13 +00:00
vm_eval.c
vm_exec.c
vm_exec.h
vm_insnhelper.c * compile.c (setup_args), vm.c (invoke_block_from_c), 2010-12-20 21:10:24 +00:00
vm_insnhelper.h
vm_method.c
vm_opts.h
vsnprintf.c * vsnprintf.c (BSD__uqtoa): Fix overflow when long != quad_t. 2010-12-30 18:53:41 +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: