Top Level Namespace

Relationships & Source Files
Namespace Children
Modules: Comparable, Enumerable, Errno, FileTest, GC, Kernel, Marshal, Math, ObjectSpace, Process, Signal, Warning
Classes: ARGF, Array, BasicObject, Binding, Class, Complex, ConditionVariable, Continuation, Data, Dir, ENV, Encoding, Enumerator, FalseClass, Fiber, File, Float, Hash, IO, Integer, MatchData, Method, Module, Mutex, NilClass, Numeric, Object, Proc, Queue, Random, Range, Rational, Regexp, RubyVM, SizedQueue, String, Struct, Symbol, Thread, ThreadGroup, Time, TracePoint, TrueClass, UnboundMethod
Exceptions: ArgumentError, ClosedQueueError, EOFError, EncodingError, Exception, FiberError, FloatDomainError, IOError, IndexError, Interrupt, KeyError, LoadError, LocalJumpError, NameError, NoMemoryError, NoMethodError, NotImplementedError, RangeError, RegexpError, RuntimeError, ScriptError, SecurityError, SignalException, StandardError, StopIteration, SyntaxError, SystemCallError, SystemExit, SystemStackError, ThreadError, TypeError, UncaughtThrowError, ZeroDivisionError, fatal

Constant Summary

ARGV =

ARGV contains the command line arguments used to run ruby.

A library like OptionParser can be used to process command-line arguments.

# File 'ruby.c', line 2174
```
rb_argv
```

DATA =

$ cat t.rb

puts DATA.gets
__END__

# File 'ruby.c', line 1965

DATA is a File that contains the data section of the executed file.
To create a data section use <tt>__END__</tt>

FALSE =

An obsolete alias of false

# File 'object.c', line 3651
```
Qfalse
```
NIL =

An obsolete alias of nil

# File 'object.c', line 3551
```
Qnil
```
RUBY_COPYRIGHT =

The copyright string for ruby

# File 'version.c', line 73
```
MKSTR(copyright)
```
RUBY_DESCRIPTION =

The full ruby version string, like ruby -v prints'

# File 'version.c', line 69
```
MKSTR(description)
```
RUBY_ENGINE =

The engine or interpreter this ruby uses.

# File 'version.c', line 77
```
ruby_engine_name = MKSTR(engine)
```
RUBY_ENGINE_VERSION =

The version of the engine or interpreter this ruby uses.

# File 'version.c', line 82
```
(1 ? version : MKSTR(version))
```
RUBY_PATCHLEVEL =

The patchlevel for this ruby. If this is a development build of ruby the patchlevel will be -1

# File 'version.c', line 61
```
MKINT(patchlevel)
```
RUBY_PLATFORM =

The platform for this ruby

# File 'version.c', line 56
```
MKSTR(platform)
```
RUBY_RELEASE_DATE =

The date this ruby was released

# File 'version.c', line 52
```
MKSTR(release_date)
```
RUBY_REVISION =

The SVN revision for this ruby.

# File 'version.c', line 65
```
MKINT(revision)
```
RUBY_VERSION =

The running version of ruby

# File 'version.c', line 48
```
(version = MKSTR(version))
```
STDERR =

Holds the original stderr

# File 'io.c', line 12567
```
rb_stderr
```
STDIN =

Holds the original stdin

# File 'io.c', line 12563
```
rb_stdin
```
STDOUT =

Holds the original stdout

# File 'io.c', line 12565
```
rb_stdout
```
TOPLEVEL_BINDING =

The Binding of the top level scope

# File 'vm.c', line 3087
```
rb_binding_new()
```
TRUE =

An obsolete alias of true

# File 'object.c', line 3636
```
Qtrue
```

Class Attribute Summary

$, rw
$-0 rw

Alias for $/.
$-F rw

Alias for $;.
$-i(*var) rw
$-K rw

Alias for $KCODE.
$-v rw

Alias for $VERBOSE.
$-w rw

Alias for $VERBOSE.
$.(*var) rw
$/ (also: .$-0) rw

avoid modifying RS_default.
$0 (also: .$PROGRAM_NAME) rw
$; (also: .$-F) rw
$= rw
$> rw

Alias for $stdout.
$@ rw
$\\ rw
$_ rw
$KCODE (also: .$-K) rw
$PROGRAM_NAME rw

Alias for $0.
$SAFE rw
$stderr rw
$stdout (also: .$>) rw
$VERBOSE (also: .$-v, .$-w) rw

! Defines built-in variables.
$VERBOSE= (also: .$-v=, .$-w=) rw

! Defines built-in variables.
$~ rw
$! readonly
Process.pid ⇒ Integer readonly

Returns the process id of this process.
$& readonly
$' readonly
$*(*var) readonly
$+ readonly
$-d readonly

Alias for $DEBUG.
$-W() readonly
$< readonly
$\ (also: .$LOADED_FEATURES) readonly
$` readonly
$DEBUG (also: .$-d) readonly
$FILENAME(*var) readonly
$find_time_numguess readonly
$LOADED_FEATURES readonly

Alias for $.
$stdin readonly

Class Method Summary

$? ⇒ Boolean

::Process::Status encapsulates the information on the status of a running or terminated system process.

Class Attribute Details

$! (readonly)

Process.pid ⇒ Integer (readonly)

Returns the process id of this process. Not available on all platforms.

Process.pid   #=> 27415

$& (readonly)

$' (readonly)

$(var) (readonly)

$+ (readonly)

$, (rw)

$-0 (rw)

Alias for $/.

$-d (readonly)

Alias for $DEBUG.

$-F (rw)

Alias for $;.

$-i(*var) (rw)

$-K (rw)

Alias for $KCODE.

$-v (rw)

Alias for $VERBOSE.

$-W() (readonly)

$-w (rw)

Alias for $VERBOSE.

$.(*var) (rw)

$/ (rw) Also known as: ::$-0

avoid modifying RS_default

$0 (rw) Also known as: ::$PROGRAM_NAME

$; (rw) Also known as: ::$-F

$< (readonly)

$= (rw)

$> (rw)

Alias for $stdout.

$@ (rw)

$\ (readonly) Also known as: ::$LOADED_FEATURES

$\\ (rw)

$_ (rw)

$` (readonly)

$DEBUG (readonly) Also known as: ::$-d

$FILENAME(*var) (readonly)

$find_time_numguess (readonly)

$KCODE (rw) Also known as: ::$-K

$LOADED_FEATURES (readonly)

Alias for $.

$PROGRAM_NAME (rw)

Alias for $0.

$SAFE (rw)

$stderr (rw)

$stdin (readonly)

$stdout (rw) Also known as: ::$>

$VERBOSE (rw) Also known as: ::$-v, ::$-w

! Defines built-in variables

$VERBOSE= (rw) Also known as: ::$-v=, ::$-w=

! Defines built-in variables

$~ (rw)

Class Method Details

$? ⇒ `Boolean`

::Process::Status encapsulates the information on the status of a running or terminated system process. The built-in variable $? is either nil or a ::Process::Status object.

fork { exit 99 }   #=> 26557
Process.wait       #=> 26557
$?.class           #=> Process::Status
$?.to_i            #=> 25344
$? >> 8            #=> 99
$?.stopped?        #=> false
$?.exited?         #=> true
$?.exitstatus      #=> 99

Posix systems record information on processes using a 16-bit integer. The lower bits record the process status (stopped, exited, signaled) and the upper bits possibly contain additional information (for example the program's return code in the case of exited processes). Pre Ruby 1.8, these bits were exposed directly to the Ruby program. Ruby now encapsulates these in a ::Process::Status object. To maximize compatibility, however, these objects retain a bit-oriented interface. In the descriptions that follow, when we talk about the integer value of stat, we're referring to this 16 bit value.

Top Level Namespace

Constant Summary

Class Attribute Summary

Class Method Summary

Class Attribute Details

$! (readonly)

Process.pid ⇒ Integer (readonly)

$& (readonly)

$' (readonly)

$*(*var) (readonly)

$+ (readonly)

$, (rw)

$-0 (rw)

$-d (readonly)

$-F (rw)

$-i(*var) (rw)

$-K (rw)

$-v (rw)

$-W() (readonly)

$-w (rw)

$.(*var) (rw)

$/ (rw) Also known as: ::$-0

$0 (rw) Also known as: ::$PROGRAM_NAME

$; (rw) Also known as: ::$-F

$< (readonly)

$= (rw)

$> (rw)

$@ (rw)

$\ (readonly) Also known as: ::$LOADED_FEATURES

$\\ (rw)

$_ (rw)

$` (readonly)

$DEBUG (readonly) Also known as: ::$-d

$FILENAME(*var) (readonly)

$find_time_numguess (readonly)

$KCODE (rw) Also known as: ::$-K

$LOADED_FEATURES (readonly)

$PROGRAM_NAME (rw)

$SAFE (rw)

$stderr (rw)

$stdin (readonly)

$stdout (rw) Also known as: ::$>

$VERBOSE (rw) Also known as: ::$-v, ::$-w

$VERBOSE= (rw) Also known as: ::$-v=, ::$-w=

$~ (rw)

Class Method Details

$? ⇒ Boolean

$(var) (readonly)

$? ⇒ `Boolean`