Seth Woolley's Man Viewer

ruby(1) - ruby, ruby - Interpreted object-oriented scripting language - man 1 ruby

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

RUBY(1)                Ruby Programmers Reference Guide                RUBY(1)

     ruby -- Interpreted object-oriented scripting language

     ruby [--copyright] [--version] [-Sacdlnpswvy] [-0[octal]] [-C directory]
          [-F pattern] [-I directory] [-K c] [-T[level]] [-e command]
          [-i[extension]] [-r library] [-x[directory]] [--] [program_file]
          [argument ...]

     Ruby is an interpreted scripting language for quick and easy object-ori-
     ented programming.  It has many features to process text files and to do
     system management tasks (as in(1,8) Perl).  It is simple, straight-forward,
     and extensible.

     If you want a language for easy object-oriented programming, or you don't
     like the Perl ugliness, or you do like the concept of LISP, but don't
     like too much parentheses, Ruby may be the language of your choice.

     Ruby's features are as follows:

             Ruby is an interpreted language, so you don't have to recompile
             programs written in(1,8) Ruby to execute them.

     Variables have no type (dynamic typing)
             Variables in(1,8) Ruby can contain data of any type.  You don't have
             to worry about variable typing.  Consequently, it has a weaker
             compile time(1,2,n) check.

     No declaration needed
             You can use variables in(1,8) your Ruby programs without any declara-
             tions.  Variable names denote their scope, local, global,
             instance, etc.

     Simple syntax
             Ruby has a simple syntax influenced slightly from Eiffel.

     No user-level memory management
             Ruby has automatic memory management.  Objects no longer refer-
             enced from anywhere are automatically collected by the garbage
             collector built into the interpreter.

     Everything is an object
             Ruby is the purely object-oriented language, and was so since its
             creation.  Even such basic data as integers are seen as objects.

     Class, inheritance, and methods
             Of course, as an object-oriented language, Ruby has such basic
             features like classes, inheritance, and methods.

     Singleton methods
             Ruby has the ability to define methods for certain objects.  For
             example, you can define a press-button action for certain widget
             by defining a singleton method for the button.  Or, you can make
             up your own prototype based object system using singleton meth-
             ods, if(3,n) you want to.

     Mix-in by modules
             Ruby intentionally does not have the multiple inheritance as it
             is a source of confusion.  Instead, Ruby has the ability to share
             implementations across the inheritance tree.  This is often
             called `Mix-in'.

             Ruby has iterators for loop abstraction.

             In Ruby, you can objectify the procedure.

     Text processing and regular expression
             Ruby has a bunch of text processing features like in(1,8) Perl.

             With built-in bignums, you can for example calculate facto-

     Exception handling
             As in(1,8) Java(tm).

     Direct access(2,5) to the OS
             Ruby can use most UNIX system calls, often used in(1,8) system pro-

     Dynamic loading
             On most UNIX systems, you can load(7,n) object files into the Ruby
             interpreter on-the-fly.

     Ruby interpreter accepts following command-line options (switches).  They
     are quite similar to those of perl(1).

     --copyright    Prints the copyright notice.

     --version      Prints the version(1,3,5) of Ruby interpreter.

     -0[octal]      (The digit ``zero''.)  Specifies the input record separa-
                    tor ($/) as an octal number. If no digit is given, the
                    null character is taken as the separator.  Other switches
                    may follow the digits.  -00 turns Ruby into paragraph
                    mode.  -0777 makes Ruby read(2,n,1 builtins) whole file(1,n) at once as a sin-
                    gle string(3,n) since there is no legal character with that

     -C directory   Causes Ruby to switch(1,n) to the directory.

     -F pattern     Specifies input field separator ($;).

     -I directory   Used to tell Ruby where to load(7,n) the library scripts.
                    Directory path will be added to the load-path variable

     -K kcode       Specifies KANJI (Japanese) encoding.

     -S             Makes Ruby use the PATH environment variable to search for
                    script, unless if(3,n) its name begins with a slash.  This is
                    used to emulate #! on machines that don't support it, in(1,8)
                    the following manner:

                          #! /usr/local/bin/ruby
                          # This line makes the next one a comment in(1,8) Ruby \
                            exec(3,n,1 builtins) /usr/local/bin/ruby -S $0 $*

     -T[level]      Turns on taint checks at the specified level (default 1).

     -a             Turns on auto-split mode when used with -n or -p.  In
                    auto-split mode, Ruby executes
                          $F = $_.split
                    at beginning of each loop.

     -c             Causes Ruby to check the syntax of the script and exit(3,n,1 builtins)
                    without executing. If there are no syntax errors, Ruby
                    will print ``Syntax OK'' to the standard output.

     --debug        Turns on debug mode.  $DEBUG will be set(7,n,1 builtins) to true.

     -e command     Specifies script from command-line while telling Ruby not
                    to search the rest of arguments for a script file(1,n) name.

     --help         Prints a summary of the options.

     -i extension   Specifies in-place-edit mode.  The extension, if(3,n) speci-
                    fied, is added to old file(1,n) name to make a backup copy.
                    For example:

                          % echo(1,3x,1 builtins) matz > /tmp/junk
                          % cat /tmp/junk
                          % ruby -p -i.bak -e '$_.upcase!' /tmp/junk
                          % cat /tmp/junk
                          % cat /tmp/junk.bak

     -l             (The lowercase letter ``ell''.)  Enables automatic line-
                    ending processing, which means to firstly set(7,n,1 builtins) $\ to the
                    value of $/, and secondly chops every line read(2,n,1 builtins) using

     -n             Causes Ruby to assume the following loop around your
                    script, which makes it iterate over file(1,n) name arguments
                    somewhat like sed -n or awk.

                          while gets(3,n)

     -p             Acts mostly same as -n switch(1,n), but print the value of
                    variable $_ at the each end of the loop.  For example:

                          % echo(1,3x,1 builtins) matz | ruby -p -e '$! "a-z", "A-Z"'

     -r library     Causes Ruby to load(7,n) the library using require.  It is use-
                    ful when using -n or -p.

     -s             Enables some switch(1,n) parsing for switches after script name
                    but before any file(1,n) name arguments (or before a --).  Any
                    switches found there are removed from ARGV and set(7,n,1 builtins) the
                    corresponding variable in(1,8) the script.  For example:

                          #! /usr/local/bin/ruby -s
                          # prints "true" if(3,n) invoked with `-xyz' switch.
                          print "true\n" if(3,n) $xyz

                    On some systems $0 does not always contain the full path-
                    name, so you need the -S switch(1,n) to tell Ruby to search for
                    the script if(3,n) necessary.  To handle embedded spaces or
                    such.  A better construct than $* would be ${1+"$@"}, but
                    it does not work if(3,n) the script is being interpreted by

     --verbose      Enables verbose mode.  Ruby will print its version(1,3,5) at the
                    beginning, and set(7,n,1 builtins) the variable $VERBOSE to true.  Some
                    methods print extra messages if(3,n) this variable is true.  If
                    this switch(1,n) is given, and no other switches are present,
                    Ruby quits after printing its version.

     -w             Enables verbose mode without printing version(1,3,5) message at
                    the beginning.  It sets the $VERBOSE variable to true.

     -x[directory]  Tells Ruby that the script is embedded in(1,8) a message.
                    Leading garbage will be discarded until the first that
                    starts with ``#!'' and contains the string(3,n), ``ruby''.  Any
                    meaningful switches on that line will applied.  The end of
                    script must be specified with either EOF, ^D (control-D),
                    ^Z (control-Z), or reserved word __END__.  If the direc-
                    tory name is specified, Ruby will switch(1,n) to that directory
                    before executing script.

     --yydebug      Turns on compiler debug mode.  Ruby will print a bunch of
                    internal state messages during compiling scripts.  You
                    don't have to specify this switch(1,n), unless you are going to
                    debug the Ruby interpreter.

     RUBYLIB         A colon-separated list of directories that are appended
                     to Ruby's library load(7,n) path ($:).


     RUBYOPT         Additional Ruby options.

                           RUBYOPT="-w -Ke"

     RUBYPATH        A colon-separated list of directories that Ruby searches
                     for Ruby programs when the -S flag is specified.  This
                     variable precedes the PATH environment variable.

     RUBYSHELL       The path to the system shell command.  This environment
                     variable is enabled for only mswin32, mingw32, and OS/2
                     platforms.  If this variable is not defined, Ruby refers
                     to COMSPEC.

     PATH            Ruby refers to the PATH environment variable on calling

     RUBYLIB_PREFIX  This variable is obsolete.

     Ruby is designed and implemented by Yukihiro Matsumoto <>.

UNIX                           December 31, 2002                          UNIX

References for this manual (incoming links)