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
knu 34bb945c40 Add Process.setproctitle().
* ruby.c (Process.setproctitle): New method to change the title of
  the running process that is shown in ps(1). [Feature #8696]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42425 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-08-07 14:12:04 +00:00
benchmark * benchmark/gc/gcbench.rb: fix summary of benchmark result notaton. 2013-06-21 08:57:18 +00:00
bin
bootstraptest parse.y: parse precisely 2013-08-02 14:14:55 +00:00
cygwin
defs Set mode for GNU Makefile. 2013-06-20 10:19:02 +00:00
doc * doc/syntax/refinements.rdoc: Remove mention of instance_eval and 2013-08-02 19:24:14 +00:00
enc Revert r41786 "broken utf-8" 2013-07-09 07:38:15 +00:00
ext * ext/openssl/ossl_hmac.c: [DOC] Documentation for OpenSSL::HMAC 2013-08-06 23:32:42 +00:00
include * include/ruby/encoding.h: document which user flags are used by 2013-08-05 02:51:58 +00:00
lib * lib/rss/utils.rb: [DOC] RSS::Utils by Steve Klabnik [Bug #8745] 2013-08-06 22:46:46 +00:00
man * man/ri.1: Incorrect use of .Dd macro [Bug #8620] by Tristan Hill 2013-07-10 15:55:12 +00:00
misc
missing
nacl
sample * ext/curses/curses.c: [DOC] Update location of samples 2013-07-29 13:25:46 +00:00
spec
symbian
template * template/encdb.h.tmpl: define encoding index macros to use the index 2013-07-01 14:12:10 +00:00
test Add Process.setproctitle(). 2013-08-07 14:12:04 +00:00
tool * vm_exec.h, tool/instruction.rb: not an error, but a BUG if stack 2013-07-26 10:28:26 +00:00
win32 win32.c: fix conversion 2013-08-06 08:42:25 +00:00
.document
.editorconfig
.gdbinit
.gitignore
.indent.pro
.travis.yml
addr2line.c
addr2line.h
array.c * array.c (rb_ary_zip): performance implement by using 2013-08-04 12:24:26 +00:00
bignum.c * bignum.c (rb_big_odd_p): Check the bignum length. 2013-08-07 11:08:03 +00:00
BSDL
ChangeLog Add Process.setproctitle(). 2013-08-07 14:12:04 +00:00
class.c * include/ruby/ruby.h, gc.c: rename macros and functions: 2013-06-22 21:54:10 +00:00
common.mk win32.c: conversion to WCHAR 2013-08-05 08:38:39 +00:00
compar.c
compile.c * compile.c (iseq_set_arguments): use RARRAY_RAWPTR() instead of 2013-07-24 11:59:44 +00:00
complex.c
configure.in * string.c (rb_str_rindex): performance improvement by using 2013-07-31 08:47:13 +00:00
constant.h
cont.c * cont.c (rb_fiber_start): use RARRAY_RAWPTR() instead of 2013-08-07 07:19:57 +00:00
COPYING
COPYING.ja
debug.c
dir.c fix typo 2013-07-25 04:16:08 +00:00
dln.c
dln.h dln.c: extra arguments 2013-06-30 01:58:51 +00:00
dln_find.c dln.c: extra arguments 2013-06-30 01:58:51 +00:00
dmydln.c
dmyext.c
encoding.c encoding.c: is_obj_encoding 2013-07-25 08:21:23 +00:00
enum.c internal.h: STATIC_ASSERT 2013-07-10 11:47:54 +00:00
enumerator.c * enumerator.c: [DOC] Remove reference to Enumerator::Lazy#cycle 2013-08-04 21:15:08 +00:00
error.c error.c: evaluate RARRAY_AREF once 2013-06-20 04:14:09 +00:00
eval.c * eval.c (rb_mod_refine, mod_using, top_using): don't show 2013-07-31 09:29:40 +00:00
eval_error.c * eval_error.c (warn_printf): use rb_vsprintf instead so ruby specific 2013-06-24 13:03:35 +00:00
eval_intern.h
eval_jump.c
file.c file.c: use rb_str_conv_enc 2013-07-26 04:02:01 +00:00
gc.c * bignum.c (rb_big_realloc): Use VALGRIND_MAKE_MEM_UNDEFINED to 2013-08-06 03:26:34 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c * hash.c (rb_hash_compare_by_id): add function prototype. 2013-07-29 13:06:34 +00:00
ia64.s
inits.c sizes.c: RbConfig::SIZEOF 2013-07-29 13:55:29 +00:00
insns.def * vm_insnhelper.c (vm_push_frame): fix stack overflow check codes. 2013-08-06 08:33:05 +00:00
internal.h * bignum.c (rb_big_realloc): Use VALGRIND_MAKE_MEM_UNDEFINED to 2013-08-06 03:26:34 +00:00
io.c * io.c (io_getpartial): use rb_str_locktmp_ensure(). 2013-07-28 11:31:58 +00:00
iseq.c parse.y, vm_eval.c: file encoding in eval 2013-07-29 08:00:34 +00:00
iseq.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c load.c: search in OS path encoding 2013-07-26 04:04:23 +00:00
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h 2013-06-17 11:56:21 +00:00
localeinit.c localeinit.c: split 2013-07-14 17:47:25 +00:00
main.c
Makefile.in
marshal.c * bignum.c (MSB): Removed. 2013-06-25 03:08:23 +00:00
math.c
method.h
miniinit.c localeinit.c: split 2013-07-14 17:47:25 +00:00
NEWS Add Process.setproctitle(). 2013-08-07 14:12:04 +00:00
node.c
node.h parse.y, vm_eval.c: file encoding in eval 2013-07-29 08:00:34 +00:00
numeric.c [DOC] refine a call seq. 2013-08-06 03:33:22 +00:00
object.c * object.c (rb_class_inherited_p): allow iclasses to be tested for 2013-08-05 01:02:22 +00:00
pack.c * internal.h (ruby_digit36_to_number_table): Declared. 2013-07-03 13:32:14 +00:00
parse.y parse.y: no reduction with 1 2013-08-03 01:33:58 +00:00
prelude.rb
probes.d
probes_helper.h
proc.c * cont.c (rb_fiber_start): use RARRAY_RAWPTR() instead of 2013-08-07 07:19:57 +00:00
process.c * process.c: [DOC] Document caveats of command form of Process.spawn 2013-08-05 16:42:37 +00:00
random.c * random.c (random_load): use RARRAY_RAWPTR() instead of 2013-08-07 04:20:56 +00:00
range.c range.c: return nil for empty range 2013-08-06 12:59:59 +00:00
rational.c * rational.c (rb_flt_rationalize_with_prec): new public C function 2013-08-01 14:58:54 +00:00
re.c * re.c (rb_reg_to_s): convert closing parenthes to the target encoding 2013-07-25 08:52:32 +00:00
README
README.EXT * README.EXT, README.EXT.ja: Mention rb_integer_pack and 2013-08-03 22:15:26 +00:00
README.EXT.ja * README.EXT, README.EXT.ja: Mention rb_integer_pack and 2013-08-03 22:15:26 +00:00
README.ja
regcomp.c * regcomp.c (): Merge Onigmo 5.13.5 23b523076d6f1161. 2013-07-04 01:16:22 +00:00
regenc.c Revert r41786 "broken utf-8" 2013-07-09 07:38:15 +00:00
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c Add Process.setproctitle(). 2013-08-07 14:12:04 +00:00
ruby_atomic.h ruby_atomic.h: ATOMIC_CAS on VC6 2013-07-03 15:13:06 +00:00
safe.c safe.c: ruby_safe_level_4_warning 2013-07-20 06:02:54 +00:00
signal.c signal.c: suppress a warning 2013-07-14 17:43:55 +00:00
siphash.c
siphash.h
sizes.c * sizes.c (Init_sizes): Define sizes only if the type actually exists. 2013-07-29 23:22:25 +00:00
sparc.c
sprintf.c sprintf.c: QUOTE flag 2013-07-30 08:16:20 +00:00
st.c * st.c (st_locale_insensitive_strcasecmp): Renamed from st_strcasecmp. 2013-07-16 23:15:41 +00:00
strftime.c
string.c * string.c: [DOC] Description of rb_str_equal [Fixes GH-375] 2013-08-07 00:02:17 +00:00
struct.c struct.c: rb_struct_define_under 2013-08-03 00:31:02 +00:00
thread.c * thread.c (thread_start_func_2): use RARRAY_RAWPTR() instead of 2013-08-07 03:59:30 +00:00
thread_native.h * thread_native.h: add rb_nativethread_self() which returns 2013-07-23 10:46:37 +00:00
thread_pthread.c * thread_(pthread|win32).h: rename rb_thread_cond_t to 2013-07-23 10:50:32 +00:00
thread_pthread.h * thread_(pthread|win32).h: rename rb_thread_cond_t to 2013-07-23 10:50:32 +00:00
thread_win32.c * thread_(pthread|win32).h: rename rb_thread_cond_t to 2013-07-23 10:50:32 +00:00
thread_win32.h * thread_(pthread|win32).h: rename rb_thread_cond_t to 2013-07-23 10:50:32 +00:00
time.c * time.c: [DOC] Typo in Time overview by @sparr [Fixes GH-374] 2013-08-06 13:39:15 +00:00
timev.h
transcode.c encoding.c: refill terminator at associating encoding 2013-07-12 07:28:40 +00:00
transcode_data.h
util.c * internal.h (ruby_digit36_to_number_table): Declared. 2013-07-03 13:32:14 +00:00
variable.c * include/ruby/ruby.h (OBJ_WRITE): cast to (VALUE *) for second 2013-06-21 19:52:40 +00:00
version.c
version.h * 2013-08-07 2013-08-06 22:43:06 +00:00
vm.c * vm_insnhelper.c (vm_push_frame): fix stack overflow check codes. 2013-08-06 08:33:05 +00:00
vm_backtrace.c * vm_backtrace.c: Update rdoc for Backtrace#label with @_ko1 2013-06-17 05:31:28 +00:00
vm_core.h * vm_insnhelper.c (vm_push_frame): fix stack overflow check codes. 2013-08-06 08:33:05 +00:00
vm_debug.h
vm_dump.c
vm_eval.c * vm_insnhelper.c (vm_push_frame): fix stack overflow check codes. 2013-08-06 08:33:05 +00:00
vm_exec.c
vm_exec.h vm_exec.h: fix CHECK_VM_STACK_OVERFLOW_FOR_INSN 2013-07-26 13:14:22 +00:00
vm_insnhelper.c * vm_insnhelper.c (vm_push_frame): change type of stack_max to size_t. 2013-08-06 08:59:24 +00:00
vm_insnhelper.h
vm_method.c * class.c (rb_include_class_new), eval.c (rb_using_refinement): 2013-06-22 20:48:35 +00:00
vm_opts.h
vm_trace.c * vm_trace.c: [DOC] Fix TracePoint return values in examples 2013-08-05 13:25:02 +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: