Initial commit
This commit is contained in:
179
ruby/share/man/man1/erb.1
Normal file
179
ruby/share/man/man1/erb.1
Normal file
@@ -0,0 +1,179 @@
|
||||
.TH ERB 1 "Ruby Programmers Reference Guide" "November 7, 2012" "UNIX"
|
||||
.SH NAME
|
||||
\fBerb\fP
|
||||
\- Ruby Templating
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
\fBerb\fP
|
||||
[\fB\--version\fP]
|
||||
[\fB\-UPdnvx\fP]
|
||||
[\fB\-E\fP \fIext\fP[]]:int
|
||||
[\fB\-S\fP \fIlevel\fP]
|
||||
[\fB\-T\fP \fImode\fP]
|
||||
[\fB\-r\fP \fIlibrary\fP]
|
||||
[\fB\--\fP]
|
||||
[file ...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fBerb\fP
|
||||
is a command line front-end for
|
||||
"ERB"
|
||||
library, which is an implementation of eRuby.
|
||||
|
||||
ERB provides an easy to use but powerful templating system for Ruby.
|
||||
Using ERB, actual Ruby code can be added to any plain text document for the
|
||||
purposes of generating document information details and/or flow control.
|
||||
|
||||
\fBerb\fP
|
||||
is a part of
|
||||
\fBRuby\fP.
|
||||
|
||||
.SH OPTIONS
|
||||
|
||||
.TP
|
||||
\fB\--version\fP
|
||||
Prints the version of
|
||||
\fB.\fP
|
||||
|
||||
.TP
|
||||
\fB\-E\fP \fIexternal\fP[]:\fIinternal\fP
|
||||
.TP
|
||||
\fB\--encoding\fP \fIexternal\fP[]:\fIinternal\fP
|
||||
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
|
||||
|
||||
You can omit the one for internal encodings, then the value
|
||||
("Encoding.default_internal") will be nil.
|
||||
|
||||
.TP
|
||||
\fB\-P\fP
|
||||
Evaluates lines starting with
|
||||
"%"
|
||||
as Ruby code and removes the tailing EOLs.
|
||||
|
||||
.TP
|
||||
\fB\-S\fP \fIlevel\fP
|
||||
Specifies the safe level in which eRuby script will run.
|
||||
|
||||
.TP
|
||||
\fB\-T\fP \fImode\fP
|
||||
Specifies trim mode (default 0).
|
||||
\fImode\fP
|
||||
can be one of
|
||||
.TP
|
||||
.B 0
|
||||
EOL remains after the embedded ruby script is evaluated.
|
||||
|
||||
.TP
|
||||
.B 1
|
||||
EOL is removed if the line ends with
|
||||
"%>".
|
||||
|
||||
.TP
|
||||
.B 2
|
||||
EOL is removed if the line starts with
|
||||
"<%"
|
||||
and ends with
|
||||
"%>".
|
||||
|
||||
.TP
|
||||
.B -
|
||||
EOL is removed if the line ends with
|
||||
"-%>".
|
||||
And leading whitespaces are removed if the erb directive starts with
|
||||
"<%-".
|
||||
|
||||
|
||||
.TP
|
||||
\fB\-U\fP
|
||||
can be one of
|
||||
Sets the default value for internal encodings
|
||||
("Encoding.default_internal") to UTF-8.
|
||||
|
||||
.TP
|
||||
\fB\-d\fP
|
||||
.TP
|
||||
\fB\--debug\fP
|
||||
Turns on debug mode.
|
||||
"$DEBUG"
|
||||
will be set to true.
|
||||
|
||||
.TP
|
||||
\fB\-h\fP
|
||||
.TP
|
||||
\fB\--help\fP
|
||||
Prints a summary of the options.
|
||||
|
||||
.TP
|
||||
\fB\-n\fP
|
||||
Used with
|
||||
\fB\-x\fP.
|
||||
Prepends the line number to each line in the output.
|
||||
|
||||
.TP
|
||||
\fB\-v\fP
|
||||
Enables verbose mode.
|
||||
"$VERBOSE"
|
||||
will be set to true.
|
||||
|
||||
.TP
|
||||
\fB\-x\fP
|
||||
Converts the eRuby script into Ruby script and prints it without line numbers.
|
||||
|
||||
|
||||
.SH EXAMPLES
|
||||
Here is an eRuby script
|
||||
|
||||
<?xml version="1.0" ?>
|
||||
.br
|
||||
<% require 'prime' -%>
|
||||
.br
|
||||
<erb-example>
|
||||
.br
|
||||
<calc><%= 1+1 %></calc>
|
||||
.br
|
||||
<var><%= __FILE__ %></var>
|
||||
.br
|
||||
<library><%= Prime.each(10).to_a.join(", ") %></library>
|
||||
.br
|
||||
</erb-example>
|
||||
.br
|
||||
|
||||
Command
|
||||
.nf
|
||||
\& "% erb -T - example.erb"
|
||||
.fi
|
||||
prints
|
||||
|
||||
<?xml version="1.0" ?>
|
||||
.br
|
||||
<erb-example>
|
||||
.br
|
||||
<calc>2</calc>
|
||||
.br
|
||||
<var>example.erb</var>
|
||||
.br
|
||||
<library>2, 3, 5, 7</library>
|
||||
.br
|
||||
</erb-example>
|
||||
.br
|
||||
|
||||
.SH SEE ALSO
|
||||
\fBruby\fP(1).
|
||||
|
||||
And see
|
||||
\fBri\fP(1)
|
||||
documentation for
|
||||
"ERB"
|
||||
class.
|
||||
|
||||
.SH REPORTING BUGS
|
||||
Security vulnerabilities should be reported via an email to
|
||||
<security@ruby-lang.org>
|
||||
Reported problems will be published after being fixed.
|
||||
|
||||
And you can report other bugs and feature requests via the
|
||||
Ruby Issue Tracking System (http://bugs.ruby-lang.org).
|
||||
Do not report security vulnerabilities
|
||||
via the system because it publishes the vulnerabilities immediately.
|
||||
.SH AUTHORS
|
||||
Written by Masatoshi SEKI.
|
||||
219
ruby/share/man/man1/irb.1
Normal file
219
ruby/share/man/man1/irb.1
Normal file
@@ -0,0 +1,219 @@
|
||||
.TH IRB 1 "Ruby Programmers Reference Guide" "November 7, 2012" "UNIX"
|
||||
.SH NAME
|
||||
\fBirb\fP
|
||||
\- Interactive Ruby Shell
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
\fBirb\fP
|
||||
[\fB\--version\fP]
|
||||
[\fB\-dfm\fP]
|
||||
[\fB\-I\fP \fIdirectory\fP]
|
||||
[\fB\-r\fP \fIlibrary\fP]
|
||||
[\fB\--\fP[no]inspect]
|
||||
[\fB\--\fP[no]readline]
|
||||
[\fB\--prompt\fP \fImode\fP]
|
||||
[\fB\--prompt-mode\fP \fImode\fP]
|
||||
[\fB\--inf-ruby-mode\fP]
|
||||
[\fB\--simple-prompt\fP]
|
||||
[\fB\--noprompt\fP]
|
||||
[\fB\--tracer\fP]
|
||||
[\fB\--back-trace-limit\fP \fIn\fP]
|
||||
[\fB\--irb_debug\fP \fIn\fP]
|
||||
[\fB\--\fP]
|
||||
[program_file]
|
||||
[argument ...]
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fBirb\fP
|
||||
is the REPL(read-eval-print loop) environment for Ruby programs.
|
||||
|
||||
.SH OPTIONS
|
||||
|
||||
.TP
|
||||
\fB\--version\fP
|
||||
Prints the version of
|
||||
\fB.\fP
|
||||
|
||||
.TP
|
||||
\fB\-E\fP \fIexternal\fP[]:\fIinternal\fP
|
||||
.TP
|
||||
\fB\--encoding\fP \fIexternal\fP[]:\fIinternal\fP
|
||||
Same as `ruby -E' .
|
||||
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
|
||||
|
||||
You can omit the one for internal encodings, then the value
|
||||
("Encoding.default_internal") will be nil.
|
||||
|
||||
.TP
|
||||
\fB\-I\fP \fIpath\fP
|
||||
Same as `ruby -I' .
|
||||
Specifies
|
||||
$LOAD_PATH
|
||||
directory
|
||||
|
||||
.TP
|
||||
\fB\-U\fP
|
||||
Same as `ruby -U' .
|
||||
Sets the default value for internal encodings
|
||||
("Encoding.default_internal") to UTF-8.
|
||||
|
||||
.TP
|
||||
\fB\-d\fP
|
||||
Same as `ruby -d' .
|
||||
Sets
|
||||
$DEBUG
|
||||
to true.
|
||||
|
||||
.TP
|
||||
\fB\-f\fP
|
||||
Suppresses read of
|
||||
\fI~/.irbrc\fP.
|
||||
|
||||
.TP
|
||||
\fB\-h\fP
|
||||
.TP
|
||||
\fB\--help\fP
|
||||
Prints a summary of the options.
|
||||
|
||||
.TP
|
||||
\fB\-m\fP
|
||||
Bc mode (load mathn, fraction or matrix are available)
|
||||
|
||||
.TP
|
||||
\fB\-r\fP \fIlibrary\fP
|
||||
Same as `ruby -r'.
|
||||
Causes irb to load the library using require.
|
||||
|
||||
.TP
|
||||
\fB\--inspect\fP
|
||||
Uses `inspect' for output (default except for bc mode)
|
||||
|
||||
.TP
|
||||
\fB\--noinspect\fP
|
||||
Doesn't use inspect for output
|
||||
|
||||
.TP
|
||||
\fB\--readline\fP
|
||||
Uses Readline extension module.
|
||||
|
||||
.TP
|
||||
\fB\--noreadline\fP
|
||||
Doesn't use Readline extension module.
|
||||
|
||||
.TP
|
||||
\fB\--prompt\fP \fImode\fP
|
||||
.TP
|
||||
\fB\--prompt-mode\fP \fImode\fP
|
||||
Switch prompt mode. Pre-defined prompt modes are
|
||||
`default', `simple', `xmp' and `inf-ruby'.
|
||||
|
||||
.TP
|
||||
\fB\--inf-ruby-mode\fP
|
||||
Uses prompt appropriate for inf-ruby-mode on emacs.
|
||||
Suppresses --readline.
|
||||
|
||||
.TP
|
||||
\fB\--simple-prompt\fP
|
||||
Makes prompts simple.
|
||||
|
||||
.TP
|
||||
\fB\--noprompt\fP
|
||||
No prompt mode.
|
||||
|
||||
.TP
|
||||
\fB\--tracer\fP
|
||||
Displays trace for each execution of commands.
|
||||
|
||||
.TP
|
||||
\fB\--back-trace-limit\fP \fIn\fP
|
||||
Displays backtrace top
|
||||
\fIn\fP
|
||||
and tail
|
||||
\fIn\fP.
|
||||
The default value is 16.
|
||||
|
||||
.TP
|
||||
\fB\--irb_debug\fP \fIn\fP
|
||||
Sets internal debug level to n (not for popular use)
|
||||
|
||||
|
||||
.SH ENVIRONMENT
|
||||
.TP
|
||||
.B IRBRC
|
||||
|
||||
|
||||
Also
|
||||
\fBirb\fP
|
||||
depends on same variables as
|
||||
\fBruby\fP(1).
|
||||
|
||||
.SH FILES
|
||||
.TP
|
||||
.B ~/.irbrc
|
||||
Personal irb initialization.
|
||||
|
||||
|
||||
.SH EXAMPLES
|
||||
.nf
|
||||
\& % irb
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):001:0> \fB1 + 1\fP
|
||||
.fi
|
||||
.nf
|
||||
\& 2
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):002:0> \fBdef t(x)\fP
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):003:1> \fBx+1\fP
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):004:1> \fBend\fP
|
||||
.fi
|
||||
.nf
|
||||
\& => nil
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):005:0> \fBt(3)\fP
|
||||
.fi
|
||||
.nf
|
||||
\& => 4
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):006:0> \fBif t(3) == 4\fP
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):007:1> \fBp :ok\fP
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):008:1> \fBend\fP
|
||||
.fi
|
||||
.nf
|
||||
\& :ok
|
||||
.fi
|
||||
.nf
|
||||
\& => :ok
|
||||
.fi
|
||||
.nf
|
||||
\& irb(main):009:0> \fBquit\fP
|
||||
.fi
|
||||
.nf
|
||||
\& %
|
||||
.fi
|
||||
|
||||
.SH SEE ALSO
|
||||
\fBruby\fP(1).
|
||||
|
||||
.SH REPORTING BUGS
|
||||
Security vulnerabilities should be reported via an email to
|
||||
<security@ruby-lang.org>
|
||||
Reported problems will be published after being fixed.
|
||||
|
||||
And you can report other bugs and feature requests via the
|
||||
Ruby Issue Tracking System (http://bugs.ruby-lang.org).
|
||||
Do not report security vulnerabilities
|
||||
via the system because it publishes the vulnerabilities immediately.
|
||||
.SH AUTHORS
|
||||
Written by Keiju ISHITSUKA.
|
||||
257
ruby/share/man/man1/rake.1
Normal file
257
ruby/share/man/man1/rake.1
Normal file
@@ -0,0 +1,257 @@
|
||||
.TH RAKE 1 "Ruby Programmers Reference Guide" "November 7, 2012" "UNIX"
|
||||
.SH NAME
|
||||
\fBrake\fP
|
||||
\- Ruby Make
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
\fBrake\fP
|
||||
[\fB\--f\fP \fIRakefile\fP]
|
||||
[\fB\--version\fP]
|
||||
[\fB\-CGNPgnqstv\fP]
|
||||
[\fB\-D\fP [\fIPATTERN\fP]]
|
||||
[\fB\-E\fP \fICODE\fP]
|
||||
[\fB\-I\fP \fILIBDIR\fP]
|
||||
[\fB\-R\fP \fIRAKELIBDIR\fP]
|
||||
[\fB\-T\fP [\fIPATTERN\fP]]
|
||||
[\fB\-e\fP \fICODE\fP]
|
||||
[\fB\-p\fP \fICODE\fP]
|
||||
[\fB\-r\fP \fIMODULE\fP]
|
||||
[\fB\--rules\fP]
|
||||
[\fIvariable\fP=\fIvalue\fP]
|
||||
\fItarget\fP ...
|
||||
.SH DESCRIPTION
|
||||
\fBRake\fP
|
||||
is a simple
|
||||
\fBruby\fP(1)
|
||||
build program with capabilities similar to the regular
|
||||
\fBmake\fP(1)
|
||||
command.
|
||||
|
||||
\fBRake\fP
|
||||
has the following features:
|
||||
.IP \(bu
|
||||
Rakefiles (Rake's version of Makefiles) are completely defined in standard Ruby syntax.
|
||||
No XML files to edit. No quirky Makefile syntax to worry about (is that a tab or a space?).
|
||||
.IP \(bu
|
||||
Users can specify tasks with prerequisites.
|
||||
.IP \(bu
|
||||
Rake supports rule patterns to synthesize implicit tasks.
|
||||
.IP \(bu
|
||||
Flexible FileLists that act like arrays but know about manipulating file names and paths.
|
||||
.IP \(bu
|
||||
A library of prepackaged tasks to make building rakefiles easier.
|
||||
|
||||
.SH OPTIONS
|
||||
|
||||
.TP
|
||||
\fB\--version\fP
|
||||
Display the program version.
|
||||
|
||||
.TP
|
||||
\fB\-C\fP
|
||||
.TP
|
||||
\fB\--classic-namespace\fP
|
||||
Put Task and FileTask in the top level namespace
|
||||
|
||||
.TP
|
||||
\fB\-D\fP [\fIPATTERN\fP]
|
||||
.TP
|
||||
\fB\--describe\fP [\fIPATTERN\fP]
|
||||
Describe the tasks (matching optional
|
||||
\fIPATTERN\fP
|
||||
), then exit.
|
||||
|
||||
.TP
|
||||
\fB\-E\fP \fICODE\fP
|
||||
.TP
|
||||
\fB\--execute-continue\fP \fICODE\fP
|
||||
Execute some Ruby code, then continue with normal task processing.
|
||||
|
||||
.TP
|
||||
\fB\-G\fP
|
||||
.TP
|
||||
\fB\--no-system\fP
|
||||
.TP
|
||||
\fB\--nosystem\fP
|
||||
Use standard project Rakefile search paths, ignore system wide rakefiles.
|
||||
|
||||
.TP
|
||||
\fB\-I\fP \fILIBDIR\fP
|
||||
.TP
|
||||
\fB\--libdir\fP \fILIBDIR\fP
|
||||
Include
|
||||
\fILIBDIR\fP
|
||||
in the search path for required modules.
|
||||
|
||||
.TP
|
||||
\fB\-N\fP
|
||||
.TP
|
||||
\fB\--no-search\fP
|
||||
.TP
|
||||
\fB\--nosearch\fP
|
||||
Do not search parent directories for the Rakefile.
|
||||
|
||||
.TP
|
||||
\fB\-P\fP
|
||||
.TP
|
||||
\fB\--prereqs\fP
|
||||
Display the tasks and dependencies, then exit.
|
||||
|
||||
.TP
|
||||
\fB\-R\fP \fIRAKELIBDIR\fP
|
||||
.TP
|
||||
\fB\--rakelib\fP \fIRAKELIBDIR\fP
|
||||
.TP
|
||||
\fB\--rakelibdir\fP \fIRAKELIBDIR\fP
|
||||
Auto-import any .rake files in
|
||||
\fIRAKELIBDIR\fP.
|
||||
(default is
|
||||
\fIrakelib\fP
|
||||
)
|
||||
|
||||
.TP
|
||||
\fB\-T\fP [\fIPATTERN\fP]
|
||||
.TP
|
||||
\fB\--tasks\fP [\fIPATTERN\fP]
|
||||
Display the tasks (matching optional
|
||||
\fIPATTERN\fP
|
||||
) with descriptions, then exit.
|
||||
|
||||
.TP
|
||||
\fB\-e\fP \fICODE\fP
|
||||
.TP
|
||||
\fB\--execute\fP \fICODE\fP
|
||||
Execute some Ruby code and exit.
|
||||
|
||||
.TP
|
||||
\fB\-f\fP \fIFILE\fP
|
||||
.TP
|
||||
\fB\--rakefile\fP \fIFILE\fP
|
||||
Use FILE as the rakefile.
|
||||
|
||||
.TP
|
||||
\fB\-h\fP
|
||||
.TP
|
||||
\fB\--help\fP
|
||||
Prints a summary of options.
|
||||
|
||||
.TP
|
||||
\fB\-g\fP
|
||||
.TP
|
||||
\fB\--system\fP
|
||||
Using system wide (global) rakefiles (usually
|
||||
\fI~/.rake/*.rake\fP
|
||||
).
|
||||
|
||||
.TP
|
||||
\fB\-n\fP
|
||||
.TP
|
||||
\fB\--dry-run\fP
|
||||
Do a dry run without executing actions.
|
||||
|
||||
.TP
|
||||
\fB\-p\fP \fICODE\fP
|
||||
.TP
|
||||
\fB\--execute-print\fP \fICODE\fP
|
||||
Execute some Ruby code, print the result, then exit.
|
||||
|
||||
.TP
|
||||
\fB\-q\fP
|
||||
.TP
|
||||
\fB\--quiet\fP
|
||||
Do not log messages to standard output.
|
||||
|
||||
.TP
|
||||
\fB\-r\fP \fIMODULE\fP
|
||||
.TP
|
||||
\fB\--require\fP \fIMODULE\fP
|
||||
Require MODULE before executing rakefile.
|
||||
|
||||
.TP
|
||||
\fB\-s\fP
|
||||
.TP
|
||||
\fB\--silent\fP
|
||||
Like
|
||||
\fB\--quiet\fP,
|
||||
but also suppresses the 'in directory' announcement.
|
||||
|
||||
.TP
|
||||
\fB\-t\fP
|
||||
.TP
|
||||
\fB\--trace\fP
|
||||
Turn on invoke/execute tracing, enable full backtrace.
|
||||
|
||||
.TP
|
||||
\fB\-v\fP
|
||||
.TP
|
||||
\fB\--verbose\fP
|
||||
Log message to standard output (default).
|
||||
|
||||
.TP
|
||||
\fB\--rules\fP
|
||||
Trace the rules resolution.
|
||||
|
||||
|
||||
.SH ENVIRONMENT
|
||||
.TP
|
||||
.B RAKE_SYSTEM
|
||||
The directory path containing the system wide rakefiles.
|
||||
|
||||
.TP
|
||||
.B RAKE_COLUMNS
|
||||
Override the number of columns used for output, such as
|
||||
\fB\-Fl\fP tasks
|
||||
|
||||
.TP
|
||||
.B RAKEOPT
|
||||
Used to provide default command line arguments to Rake.
|
||||
|
||||
.TP
|
||||
.B TAGS
|
||||
Generate an Emacs TAGS file
|
||||
|
||||
.TP
|
||||
.B TEST
|
||||
The list of test files will be overridden to include only the filename specified on the command line.
|
||||
|
||||
This provides an easy way to run just one test.
|
||||
|
||||
.TP
|
||||
.B TESTOPTS
|
||||
.TP
|
||||
.B TESTOPT
|
||||
.TP
|
||||
.B TEST_OPTS
|
||||
.TP
|
||||
.B TEST_OPT
|
||||
The given options are passed to the test process after a
|
||||
\fB\-Fl\fP
|
||||
|
||||
This allows Test::Unit options to be passed to the test suite.
|
||||
|
||||
.TP
|
||||
.B USERPROFILE
|
||||
.TP
|
||||
.B HOME
|
||||
.TP
|
||||
.B HOMEDRIVE
|
||||
.TP
|
||||
.B HOMEPATH
|
||||
The standard directory containing system wide rake files on Win 32 systems.
|
||||
|
||||
.SH SEE ALSO
|
||||
\fBruby\fP(1)
|
||||
\fBmake\fP(1)
|
||||
|
||||
\fIhttp://rake.rubyforge.org/\fP
|
||||
.SH REPORTING BUGS
|
||||
Bugs, features requests and other issues can be logged at
|
||||
<\fIhttp://onestepback.org/redmine/projects/show/rake\fP.>
|
||||
|
||||
You will need an account to before you can post issues. Register at
|
||||
<\fIhttp://onestepback.org/redmine/account/register\fP.>
|
||||
Or you can send an email to the author.
|
||||
.SH AUTHOR
|
||||
\fBRake\fP
|
||||
is written by
|
||||
Jim Weirich <jim@weirichhouse.org>
|
||||
198
ruby/share/man/man1/ri.1
Normal file
198
ruby/share/man/man1/ri.1
Normal file
@@ -0,0 +1,198 @@
|
||||
.TH RI 1 "Ruby Programmers Reference Guide" "November 7, 2012" "UNIX"
|
||||
.SH NAME
|
||||
\fBri\fP
|
||||
\- Ruby API reference front end
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
\fBri\fP
|
||||
[\fB\-Ti\fP]
|
||||
[\fB\-d\fP \fIdirectory\fP]
|
||||
[\fB\-f\fP \fIformat\fP]
|
||||
[\fB\--list-doc-dirs\fP]
|
||||
[\fB\--no-standard-docs\fP]
|
||||
[\fB\--\fP[\fBno-\fP]Bro \fBsystem\fP|\fBsite\fP|\fBgems\fP|\fBhome\fP Brc]
|
||||
[\fB\--\fP[\fBno-\fP]\fBuse-cache\fP]
|
||||
[\fB\--width\fP=\fIwidth\fP]
|
||||
[\fItarget\fP ...]
|
||||
.SH DESCRIPTION
|
||||
\fBri\fP
|
||||
is a CLI front end for the Ruby API reference.
|
||||
You can search and read API reference for classes and methods with
|
||||
\fB.\fP
|
||||
|
||||
\fBri\fP
|
||||
is a part of Ruby.
|
||||
|
||||
\fItarget\fP
|
||||
can be one of the following forms:
|
||||
It Class
|
||||
for classes
|
||||
It Class::method
|
||||
for class methods
|
||||
It Class#method
|
||||
for instance methods
|
||||
It Class.method
|
||||
for both class and instance methods
|
||||
It method
|
||||
for both class and instance methods
|
||||
|
||||
All class names may be abbreviated to their minimum unambiguous form. If a name
|
||||
is ambiguous, all valid options will be listed.
|
||||
|
||||
For example:
|
||||
|
||||
ri Fil
|
||||
.br
|
||||
ri File
|
||||
.br
|
||||
ri File.new
|
||||
.br
|
||||
ri zip
|
||||
.br
|
||||
|
||||
Note that shell quoting may be required for method names containing
|
||||
punctuation:
|
||||
|
||||
ri 'Array.[]'
|
||||
.br
|
||||
ri compact\!
|
||||
.br
|
||||
.SH OPTIONS
|
||||
|
||||
.TP
|
||||
\fB\--version\fP
|
||||
Prints the version of
|
||||
\fB.\fP
|
||||
|
||||
.TP
|
||||
\fB\-T\fP
|
||||
.TP
|
||||
\fB\--no-pager\fP
|
||||
Send output directly to stdout, rather than to a pager.
|
||||
|
||||
.TP
|
||||
\fB\-d\fP \fIdirectory\fP
|
||||
.TP
|
||||
\fB\--doc-dir\fP=\fIdirectory\fP
|
||||
List of directories from which to source documentation in addition to the standard
|
||||
directories. May be repeated.
|
||||
|
||||
.TP
|
||||
\fB\-f\fP \fIFORMAT\fP
|
||||
.TP
|
||||
\fB\--fmt\fP \fIFORMAT\fP
|
||||
.TP
|
||||
\fB\--format\fP=FORMAT
|
||||
Format to use when displaying output:
|
||||
|
||||
ansi, bs, html, plain, simple
|
||||
|
||||
Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the
|
||||
pager or tell the pager to allow control characters.
|
||||
|
||||
.TP
|
||||
\fB\-i\fP
|
||||
.TP
|
||||
\fB\--interactive\fP
|
||||
This makes
|
||||
\fBri\fP
|
||||
go into interactive mode.
|
||||
|
||||
When
|
||||
\fBri\fP
|
||||
is in interactive mode it will allow the user to disambiguate lists of
|
||||
methods in case multiple methods match against a method search string. It also
|
||||
will allow the user to enter in a method name (with auto-completion, if readline
|
||||
is supported) when viewing a class.
|
||||
|
||||
.TP
|
||||
\fB\--list-doc-dirs\fP
|
||||
List the directories from which ri will source documentation on stdout and exit.
|
||||
|
||||
.TP
|
||||
\fB\--no-standard-docs\fP
|
||||
Do not include documentation from the Ruby standard library,
|
||||
\fIsite_lib\fP,
|
||||
installed gems, or
|
||||
\fI~/.rdoc\fP.
|
||||
|
||||
Equivalent to specifying the options
|
||||
\fB\--no-system\fP,\fB\--no-site\fP,\fB\--no-gems\fP,
|
||||
and
|
||||
\fB\--no-home\fP.
|
||||
|
||||
.TP
|
||||
\fB\--\fP[\fBno-\fP]\fBsystem\fP
|
||||
Include documentation from Ruby's standard library. Defaults to true.
|
||||
|
||||
.TP
|
||||
\fB\--\fP[\fBno-\fP]\fBsite\fP
|
||||
Include documentation from libraries installed in site_lib. Defaults to true.
|
||||
|
||||
.TP
|
||||
\fB\--\fP[\fBno-\fP]\fBgems\fP
|
||||
Include documentation from RubyGems. Defaults to true.
|
||||
|
||||
.TP
|
||||
\fB\--\fP[\fBno-\fP]\fBhome\fP
|
||||
Include documentation stored in ~/.rdoc. Defaults to true.
|
||||
|
||||
.TP
|
||||
\fB\--\fP[\fBno-\fP]\fBuse-cache\fP
|
||||
Whether or not to use
|
||||
\fBNs\fP
|
||||
's cache. True by default.
|
||||
|
||||
.TP
|
||||
\fB\-w\fP \fIwidth\fP
|
||||
.TP
|
||||
\fB\--width\fP=\fIwidth\fP
|
||||
Set the width of the output.
|
||||
|
||||
|
||||
.SH ENVIRONMENT
|
||||
|
||||
.TP
|
||||
.B RI
|
||||
Additional options.
|
||||
|
||||
.TP
|
||||
.B PAGER
|
||||
Used as the name of pager program for displaying.
|
||||
|
||||
.TP
|
||||
.B HOME
|
||||
.TP
|
||||
.B USERPROFILE
|
||||
.TP
|
||||
.B HOMEPATH
|
||||
Path to user's home directory.
|
||||
|
||||
.SH FILES
|
||||
|
||||
.TP
|
||||
.B ~/.ri
|
||||
Caches recently referenced documents here.
|
||||
|
||||
.TP
|
||||
.B ~/.rdoc
|
||||
Searches user-wide documents here.
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
\fBruby\fP(1)
|
||||
\fBrdoc\fP(1)
|
||||
\fBgem\fP(1)
|
||||
|
||||
.SH REPORTING BUGS
|
||||
Security vulnerabilities should be reported via an email to
|
||||
<security@ruby-lang.org>
|
||||
Reported problems will be published after being fixed.
|
||||
|
||||
And you can report other bugs and feature requests via the
|
||||
Ruby Issue Tracking System (http://bugs.ruby-lang.org).
|
||||
Do not report security vulnerabilities
|
||||
via the system because it publishes the vulnerabilities immediately.
|
||||
.SH AUTHORS
|
||||
Written by Dave Thomas
|
||||
<dave@pragmaticprogrammer.com>
|
||||
593
ruby/share/man/man1/ruby.1
Normal file
593
ruby/share/man/man1/ruby.1
Normal file
@@ -0,0 +1,593 @@
|
||||
.TH RUBY 1 "Ruby Programmers Reference Guide" "November 7, 2012" "UNIX"
|
||||
.SH NAME
|
||||
\fBruby\fP
|
||||
\- Interpreted object-oriented scripting language
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
\fBruby\fP
|
||||
[\fB\--copyright\fP]
|
||||
[\fB\--version\fP]
|
||||
[\fB\-SUacdlnpswvy\fP]
|
||||
[\fB\-0\fP[\fIoctal\fP]]
|
||||
[\fB\-C\fP \fIdirectory\fP]
|
||||
[\fB\-E\fP \fIexternal\fP[]]:\fIinternal\fP
|
||||
[\fB\-F\fP \fIpattern\fP]
|
||||
[\fB\-I\fP \fIdirectory\fP]
|
||||
[\fB\-K\fP \fIc\fP]
|
||||
[\fB\-T\fP[\fIlevel\fP]]
|
||||
[\fB\-W\fP[\fIlevel\fP]]
|
||||
[\fB\-e\fP \fIcommand\fP]
|
||||
[\fB\-i\fP[\fIextension\fP]]
|
||||
[\fB\-r\fP \fIlibrary\fP]
|
||||
[\fB\-x\fP[\fIdirectory\fP]]
|
||||
[-Bro \fBenable\fP|\fBdisable\fP Brc-\fIFEATURE\fP]
|
||||
[\fB\--dump\fP=\fItarget\fP]
|
||||
[\fB\--verbose\fP]
|
||||
[\fB\--\fP]
|
||||
[\fIprogram_file\fP]
|
||||
[\fIargument\fP ...]
|
||||
.SH DESCRIPTION
|
||||
Ruby is an interpreted scripting language for quick and easy
|
||||
object-oriented programming. It has many features to process text
|
||||
files and to do system management tasks (like in 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 many parentheses, Ruby might be your language of
|
||||
choice.
|
||||
.SH FEATURES
|
||||
Ruby's features are as follows:
|
||||
.TP
|
||||
.B "Interpretive"
|
||||
Ruby is an interpreted language, so you don't have to recompile
|
||||
programs written in Ruby to execute them.
|
||||
|
||||
.TP
|
||||
.B "Variables have no type (dynamic typing)"
|
||||
Variables in Ruby can contain data of any type. You don't have to
|
||||
worry about variable typing. Consequently, it has a weaker compile
|
||||
time check.
|
||||
|
||||
.TP
|
||||
.B "No declaration needed"
|
||||
You can use variables in your Ruby programs without any declarations.
|
||||
Variable names denote their scope - global, class, instance, or local.
|
||||
|
||||
.TP
|
||||
.B "Simple syntax"
|
||||
Ruby has a simple syntax influenced slightly from Eiffel.
|
||||
|
||||
.TP
|
||||
.B "No user-level memory management"
|
||||
Ruby has automatic memory management. Objects no longer referenced
|
||||
from anywhere are automatically collected by the garbage collector
|
||||
built into the interpreter.
|
||||
|
||||
.TP
|
||||
.B "Everything is an object"
|
||||
Ruby is a purely object-oriented language, and was so since its
|
||||
creation. Even such basic data as integers are seen as objects.
|
||||
|
||||
.TP
|
||||
.B "Class, inheritance, and methods"
|
||||
Being an object-oriented language, Ruby naturally has basic
|
||||
features like classes, inheritance, and methods.
|
||||
|
||||
.TP
|
||||
.B "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 methods, if you want
|
||||
to.
|
||||
|
||||
.TP
|
||||
.B "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 a
|
||||
`Mix-in'.
|
||||
|
||||
.TP
|
||||
.B "Iterators"
|
||||
Ruby has iterators for loop abstraction.
|
||||
|
||||
.TP
|
||||
.B "Closures"
|
||||
In Ruby, you can objectify the procedure.
|
||||
|
||||
.TP
|
||||
.B "Text processing and regular expressions"
|
||||
Ruby has a bunch of text processing features like in Perl.
|
||||
|
||||
.TP
|
||||
.B "M17N, character set independent"
|
||||
Ruby supports multilingualized programming. Easy to process texts
|
||||
written in many different natural languages and encoded in many
|
||||
different character encodings, without dependence on Unicode.
|
||||
|
||||
.TP
|
||||
.B "Bignums"
|
||||
With built-in bignums, you can for example calculate factorial(400).
|
||||
|
||||
.TP
|
||||
.B "Reflection and domain specific languages"
|
||||
Class is also an instance of the Class class. Definition of classes and methods
|
||||
is an expression just as 1+1 is. So your programs can even write and modify programs.
|
||||
Thus you can write your application in your own programming language on top of Ruby.
|
||||
|
||||
.TP
|
||||
.B "Exception handling"
|
||||
As in Java(tm).
|
||||
|
||||
.TP
|
||||
.B "Direct access to the OS"
|
||||
Ruby can use most
|
||||
UNIX
|
||||
system calls, often used in system programming.
|
||||
|
||||
.TP
|
||||
.B "Dynamic loading"
|
||||
On most
|
||||
UNIX
|
||||
systems, you can load object files into the Ruby interpreter
|
||||
on-the-fly.
|
||||
.TP
|
||||
.B "Rich libraries"
|
||||
Libraries called "builtin libraries" and "standard libraries" are bundled with Ruby.
|
||||
And you can obtain more libraries via the package management system called `RubyGems'.
|
||||
|
||||
Moreover there are thousands of Ruby projects on GitHub
|
||||
<\fIhttps://github.com/languages/Ruby\fP.>
|
||||
|
||||
.SH OPTIONS
|
||||
Ruby interpreter accepts following command-line options (switches).
|
||||
They are quite similar to those of
|
||||
\fBperl\fP(1).
|
||||
|
||||
.TP
|
||||
\fB\--copyright\fP
|
||||
Prints the copyright notice.
|
||||
|
||||
.TP
|
||||
\fB\--version\fP
|
||||
Prints the version of Ruby interpreter.
|
||||
|
||||
.TP
|
||||
\fB\-0\fP[\fIoctal\fP]
|
||||
(The digit
|
||||
``zero''.)
|
||||
Specifies the input record separator
|
||||
("$/")
|
||||
as an octal number. If no digit is given, the null character is taken
|
||||
as the separator. Other switches may follow the digits.
|
||||
\fB\-00\fP
|
||||
turns Ruby into paragraph mode.
|
||||
\fB\-0777\fP
|
||||
makes Ruby read whole file at once as a single string since there is
|
||||
no legal character with that value.
|
||||
|
||||
.TP
|
||||
\fB\-C\fP \fIdirectory\fP
|
||||
.TP
|
||||
\fB\-X\fP \fIdirectory\fP
|
||||
Causes Ruby to switch to the directory.
|
||||
|
||||
.TP
|
||||
\fB\-E\fP \fIexternal\fP[]:\fIinternal\fP
|
||||
.TP
|
||||
\fB\--encoding\fP \fIexternal\fP[]:\fIinternal\fP
|
||||
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
|
||||
|
||||
You can omit the one for internal encodings, then the value
|
||||
("Encoding.default_internal") will be nil.
|
||||
|
||||
.TP
|
||||
\fB\--external-encoding\fP=\fIencoding\fP
|
||||
.TP
|
||||
\fB\--internal-encoding\fP=\fIencoding\fP
|
||||
Specify the default external or internal character encoding
|
||||
|
||||
.TP
|
||||
\fB\-F\fP \fIpattern\fP
|
||||
Specifies input field separator
|
||||
("$;").
|
||||
|
||||
.TP
|
||||
\fB\-I\fP \fIdirectory\fP
|
||||
Used to tell Ruby where to load the library scripts. Directory path
|
||||
will be added to the load-path variable
|
||||
("$:").
|
||||
|
||||
.TP
|
||||
\fB\-K\fP \fIkcode\fP
|
||||
Specifies KANJI (Japanese) encoding. The default value for script encodings
|
||||
("__ENCODING__") and external encodings ("Encoding.default_external") will be the specified one.
|
||||
\fIkcode\fP
|
||||
can be one of
|
||||
.TP
|
||||
.B e
|
||||
EUC-JP
|
||||
|
||||
.TP
|
||||
.B s
|
||||
Windows-31J (CP932)
|
||||
|
||||
.TP
|
||||
.B u
|
||||
UTF-8
|
||||
|
||||
.TP
|
||||
.B n
|
||||
ASCII-8BIT (BINARY)
|
||||
|
||||
.TP
|
||||
\fB\-S\fP
|
||||
Makes Ruby use the
|
||||
.IR PATH
|
||||
environment variable to search for script, unless its name begins
|
||||
with a slash. This is used to emulate
|
||||
#!
|
||||
on machines that don't support it, in the following manner:
|
||||
|
||||
#! /usr/local/bin/ruby
|
||||
.br
|
||||
# This line makes the next one a comment in Ruby \e
|
||||
.br
|
||||
exec /usr/local/bin/ruby -S $0 $*
|
||||
.br
|
||||
|
||||
.TP
|
||||
\fB\-T\fP[\fIlevel=1\fP]
|
||||
Turns on taint checks at the specified level (default 1).
|
||||
|
||||
.TP
|
||||
\fB\-U\fP
|
||||
Sets the default value for internal encodings
|
||||
("Encoding.default_internal") to UTF-8.
|
||||
|
||||
.TP
|
||||
\fB\-W\fP[\fIlevel=2\fP]
|
||||
Turns on verbose mode at the specified level without printing the version
|
||||
message at the beginning. The level can be;
|
||||
.TP
|
||||
.B 0
|
||||
Verbose mode is "silence". It sets the
|
||||
"$VERBOSE"
|
||||
to nil.
|
||||
|
||||
.TP
|
||||
.B 1
|
||||
Verbose mode is "medium". It sets the
|
||||
"$VERBOSE"
|
||||
to false.
|
||||
|
||||
.TP
|
||||
.B 2 (default)
|
||||
Verbose mode is "verbose". It sets the
|
||||
"$VERBOSE"
|
||||
to true.
|
||||
\fB\-W\fP
|
||||
2 is same as
|
||||
\fB\-w\fP
|
||||
|
||||
.TP
|
||||
\fB\-a\fP
|
||||
Turns on auto-split mode when used with
|
||||
\fB\-n\fP
|
||||
or
|
||||
\fB\-p\fP.
|
||||
In auto-split mode, Ruby executes
|
||||
.nf
|
||||
\& $F = $_.split
|
||||
.fi
|
||||
at beginning of each loop.
|
||||
|
||||
.TP
|
||||
\fB\-c\fP
|
||||
Causes Ruby to check the syntax of the script and exit without
|
||||
executing. If there are no syntax errors, Ruby will print
|
||||
``Syntax OK''
|
||||
to the standard output.
|
||||
|
||||
.TP
|
||||
\fB\-d\fP
|
||||
.TP
|
||||
\fB\--debug\fP
|
||||
Turns on debug mode.
|
||||
"$DEBUG"
|
||||
will be set to true.
|
||||
|
||||
.TP
|
||||
\fB\-e\fP \fIcommand\fP
|
||||
Specifies script from command-line while telling Ruby not to search
|
||||
the rest of the arguments for a script file name.
|
||||
|
||||
.TP
|
||||
\fB\-h\fP
|
||||
.TP
|
||||
\fB\--help\fP
|
||||
Prints a summary of the options.
|
||||
|
||||
.TP
|
||||
\fB\-i\fP \fIextension\fP
|
||||
Specifies in-place-edit mode. The extension, if specified, is added
|
||||
to old file name to make a backup copy. For example:
|
||||
|
||||
% echo matz > /tmp/junk
|
||||
.br
|
||||
% cat /tmp/junk
|
||||
.br
|
||||
matz
|
||||
.br
|
||||
% ruby -p -i.bak -e '$_.upcase!' /tmp/junk
|
||||
.br
|
||||
% cat /tmp/junk
|
||||
.br
|
||||
MATZ
|
||||
.br
|
||||
% cat /tmp/junk.bak
|
||||
.br
|
||||
matz
|
||||
.br
|
||||
|
||||
.TP
|
||||
\fB\-l\fP
|
||||
(The lowercase letter
|
||||
``ell''.)
|
||||
Enables automatic line-ending processing, which means to firstly set
|
||||
"$\e"
|
||||
to the value of
|
||||
"$/",
|
||||
and secondly chops every line read using
|
||||
chop!.
|
||||
|
||||
.TP
|
||||
\fB\-n\fP
|
||||
Causes Ruby to assume the following loop around your script, which
|
||||
makes it iterate over file name arguments somewhat like
|
||||
\fBsed\fP
|
||||
\fB\-n\fP
|
||||
or
|
||||
\fBawk\fP.
|
||||
|
||||
while gets
|
||||
.br
|
||||
...
|
||||
.br
|
||||
end
|
||||
.br
|
||||
|
||||
.TP
|
||||
\fB\-p\fP
|
||||
Acts mostly same as -n switch, but print the value of variable
|
||||
"$_"
|
||||
at the each end of the loop. For example:
|
||||
|
||||
% echo matz | ruby -p -e '$_.tr! "a-z", "A-Z"'
|
||||
.br
|
||||
MATZ
|
||||
.br
|
||||
|
||||
.TP
|
||||
\fB\-r\fP \fIlibrary\fP
|
||||
Causes Ruby to load the library using require. It is useful when using
|
||||
\fB\-n\fP
|
||||
or
|
||||
\fB\-p\fP.
|
||||
|
||||
.TP
|
||||
\fB\-s\fP
|
||||
Enables some switch parsing for switches after script name but before
|
||||
any file name arguments (or before a
|
||||
\fB\--\fP).
|
||||
Any switches found there are removed from
|
||||
ARGV
|
||||
and set the corresponding variable in the script. For example:
|
||||
|
||||
#! /usr/local/bin/ruby -s
|
||||
.br
|
||||
# prints "true" if invoked with `-xyz' switch.
|
||||
.br
|
||||
print "true\en" if $xyz
|
||||
.br
|
||||
|
||||
On some systems
|
||||
"$0"
|
||||
does not always contain the full pathname, so you need the
|
||||
\fB\-S\fP
|
||||
switch to tell Ruby to search for the script if necessary (to handle embedded
|
||||
spaces and such). A better construct than
|
||||
"$*"
|
||||
would be
|
||||
${1+"$@"},
|
||||
but it does not work if the script is being interpreted by
|
||||
\fBcsh\fP(1).
|
||||
|
||||
.TP
|
||||
\fB\-v\fP
|
||||
Enables verbose mode. Ruby will print its version at the beginning
|
||||
and set the variable
|
||||
"$VERBOSE"
|
||||
to true. Some methods print extra messages if this variable is true.
|
||||
If this switch is given, and no other switches are present, Ruby quits
|
||||
after printing its version.
|
||||
|
||||
.TP
|
||||
\fB\-w\fP
|
||||
Enables verbose mode without printing version message at the
|
||||
beginning. It sets the
|
||||
"$VERBOSE"
|
||||
variable to true.
|
||||
|
||||
.TP
|
||||
\fB\-x\fP[\fIdirectory\fP]
|
||||
Tells Ruby that the script is embedded in a message. Leading garbage
|
||||
will be discarded until the first line that starts with
|
||||
``#!''
|
||||
and contains the string,
|
||||
``ruby''.
|
||||
Any meaningful switches on that line will be applied. The end of the script
|
||||
must be specified with either
|
||||
EOF,
|
||||
"^D" ("control-D"),
|
||||
"^Z" ("control-Z"),
|
||||
or the reserved word
|
||||
__END__.
|
||||
If the directory name is specified, Ruby will switch to that directory
|
||||
before executing script.
|
||||
|
||||
.TP
|
||||
\fB\-y\fP
|
||||
.TP
|
||||
\fB\--yydebug\fP
|
||||
DO NOT USE.
|
||||
|
||||
Turns on compiler debug mode. Ruby will print a bunch of internal
|
||||
state messages during compilation. Only specify this switch you are going to
|
||||
debug the Ruby interpreter.
|
||||
|
||||
.TP
|
||||
\fB\--disable-\fP\fIFEATURE\fP
|
||||
.TP
|
||||
\fB\--enable-\fP\fIFEATURE\fP
|
||||
Disables (or enables) the specified
|
||||
\fIFEATURE\fP
|
||||
\&.
|
||||
.TP
|
||||
\fB\--disable-gems\fP
|
||||
.TP
|
||||
\fB\--enable-gems\fP
|
||||
Disables (or enables) RubyGems libraries. By default, Ruby will load the latest
|
||||
version of each installed gem. The
|
||||
Gem
|
||||
constant is true if RubyGems is enabled, false if otherwise.
|
||||
|
||||
.TP
|
||||
\fB\--disable-rubyopt\fP
|
||||
.TP
|
||||
\fB\--enable-rubyopt\fP
|
||||
Ignores (or considers) the
|
||||
.IR RUBYOPT
|
||||
environment variable. By default, Ruby considers the variable.
|
||||
|
||||
.TP
|
||||
\fB\--disable-all\fP
|
||||
.TP
|
||||
\fB\--enable-all\fP
|
||||
Disables (or enables) all features.
|
||||
|
||||
|
||||
.TP
|
||||
\fB\--dump\fP=\fItarget\fP
|
||||
DO NOT USE.
|
||||
|
||||
Prints the specified target.
|
||||
\fItarget\fP
|
||||
can be one of;
|
||||
.TP
|
||||
.B insns
|
||||
disassembled instructions
|
||||
|
||||
|
||||
Only specify this switch if you are going to debug the Ruby interpreter.
|
||||
|
||||
.TP
|
||||
\fB\--verbose\fP
|
||||
Enables verbose mode without printing version message at the
|
||||
beginning. It sets the
|
||||
"$VERBOSE"
|
||||
variable to true.
|
||||
If this switch is given, and no other switches are present, Ruby quits
|
||||
after printing its version.
|
||||
|
||||
.SH ENVIRONMENT
|
||||
.TP
|
||||
.B RUBYLIB
|
||||
A colon-separated list of directories that are added to Ruby's
|
||||
library load path
|
||||
("$:"). Directories from this environment variable are searched
|
||||
before the standard load path is searched.
|
||||
|
||||
e.g.:
|
||||
.nf
|
||||
\& RUBYLIB="$HOME/lib/ruby:$HOME/lib/rubyext"
|
||||
.fi
|
||||
|
||||
.TP
|
||||
.B RUBYOPT
|
||||
Additional Ruby options.
|
||||
|
||||
e.g.
|
||||
.nf
|
||||
\& RUBYOPT="-w -Ke"
|
||||
.fi
|
||||
|
||||
Note that RUBYOPT can contain only
|
||||
\fB\-d\fP,\fB\-E\fP,\fB\-I\fP,\fB\-K\fP,\fB\-r\fP,\fB\-T\fP,\fB\-U\fP,\fB\-v\fP,\fB\-w\fP,\fB\-W,\fP \fB\--debug\fP,
|
||||
\fB\--disable-\fP\fIFEATURE\fP
|
||||
and
|
||||
\fB\--enable-\fP\fIFEATURE\fP.
|
||||
|
||||
.TP
|
||||
.B RUBYPATH
|
||||
A colon-separated list of directories that Ruby searches for
|
||||
Ruby programs when the
|
||||
\fB\-S\fP
|
||||
flag is specified. This variable precedes the
|
||||
.IR PATH
|
||||
environment variable.
|
||||
|
||||
.TP
|
||||
.B 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
|
||||
.IR COMSPEC.
|
||||
|
||||
.TP
|
||||
.B PATH
|
||||
Ruby refers to the
|
||||
.IR PATH
|
||||
environment variable on calling Kernel#system.
|
||||
|
||||
.TP
|
||||
.B RUBYLIB_PREFIX
|
||||
This variable is obsolete.
|
||||
|
||||
And Ruby depends on some RubyGems related environment variables unless RubyGems is disabled.
|
||||
See the help of
|
||||
\fBgem\fP(1)
|
||||
as bellow.
|
||||
|
||||
% gem help
|
||||
.br
|
||||
|
||||
.SH SEE ALSO
|
||||
.TP
|
||||
http://www.ruby-lang.org
|
||||
The official web site.
|
||||
.TP
|
||||
http://www.rubyforge.org
|
||||
hosting many open source ruby projects.
|
||||
.TP
|
||||
https://www.ruby-toolbox.com
|
||||
Comprehensive catalog of Ruby libraries.
|
||||
|
||||
.SH REPORTING BUGS
|
||||
Security vulnerabilities should be reported via an email to
|
||||
<security@ruby-lang.org>
|
||||
Reported problems will be published after they've been fixed.
|
||||
|
||||
And you can report other bugs and feature requests via the
|
||||
Ruby Issue Tracking System (http://bugs.ruby-lang.org).
|
||||
Do not report security vulnerabilities
|
||||
via the system because it publishes the vulnerabilities immediately.
|
||||
.SH AUTHORS
|
||||
Ruby is designed and implemented by
|
||||
Yukihiro Matsumoto <matz@netlab.jp>.
|
||||
|
||||
See
|
||||
<\fIhttp://bugs.ruby-lang.org/wiki/ruby/Contributors\fP>
|
||||
for contributors to Ruby.
|
||||
Reference in New Issue
Block a user