-.\"Ruby is copyrighted by Yukihiro Matsumoto <[email protected]>.

-.Dd August 11, 2019

-.Dt IRB \&1 "Ruby Programmer's Reference Guide"

-.Os UNIX

-.Sh NAME

-.Nm irb

-.Nd Interactive Ruby Shell

-.Sh SYNOPSIS

-.Nm

-.Op Fl -version

-.Op Fl dfUw

-.Op Fl I Ar directory

-.Op Fl r Ar library

-.Op Fl E Ar external Ns Op : Ns Ar internal

-.Op Fl W Ns Op Ar level

-.Op Fl - Ns Oo no Oc Ns inspect

-.Op Fl - Ns Oo no Oc Ns multiline

-.Op Fl - Ns Oo no Oc Ns singleline

-.Op Fl - Ns Oo no Oc Ns echo

-.Op Fl - Ns Oo no Oc Ns colorize

-.Op Fl - Ns Oo no Oc Ns autocomplete

-.Op Fl - Ns Oo no Oc Ns verbose

-.Op Fl -prompt Ar mode

-.Op Fl -prompt-mode Ar mode

-.Op Fl -inf-ruby-mode

-.Op Fl -simple-prompt

-.Op Fl -noprompt

-.Op Fl -tracer

-.Op Fl -back-trace-limit Ar n

-.Op Fl -

-.Op program_file

-.Op argument ...

-.Pp

-.Sh DESCRIPTION

-.Nm

-is the REPL(read-eval-print loop) environment for Ruby programs.

-.Pp

-.Sh OPTIONS

-.Bl -tag -width "1234567890123" -compact

-.Pp

-.It Fl -version

-Prints the version of

-.Nm .

-.Pp

-.It Fl E Ar external Ns Op : Ns Ar internal

-.It Fl -encoding Ar external Ns Op : Ns Ar internal

-Same as `ruby -E' .

-Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).

-.Pp

-You can omit the one for internal encodings, then the value

-.Pf ( Li "Encoding.default_internal" ) will be nil.

-.Pp

-.It Fl I Ar path

-Same as `ruby -I' .

-Specifies

-.Li $LOAD_PATH

-directory

-.Pp

-.It Fl U

-Same as `ruby -U' .

-Sets the default value for internal encodings

-.Pf ( Li "Encoding.default_internal" ) to UTF-8.

-.Pp

-.It Fl d

-Same as `ruby -d' .

-Sets

-.Li $DEBUG

-to true.

-.Pp

-.It Fl f

-Suppresses read of

-.Pa ~/.irbrc .

-.Pp

-.It Fl w

-Same as `ruby -w' .

-.Pp

-.Pp

-.It Fl W

-Same as `ruby -W' .

-.Pp

-.It Fl h

-.It Fl -help

-Prints a summary of the options.

-.Pp

-.It Fl r Ar library

-Same as `ruby -r'.

-Causes irb to load the library using require.

-.Pp

-.It Fl -inspect

-Uses `inspect' for output (default except for bc mode)

-.Pp

-.It Fl -noinspect

-Doesn't use inspect for output

-.Pp

-.It Fl -multiline

-Uses multiline editor module.

-.Pp

-.It Fl -nomultiline

-Doesn't use multiline editor module.

-.Pp

-.It Fl -singleline

-Uses singleline editor module.

-.Pp

-.It Fl -nosingleline

-Doesn't use singleline editor module.

-.Pp

-.Pp

-.It Fl -extra-doc-dir

-Add an extra doc dir for the doc dialog.

-.Pp

-.Pp

-.It Fl -echo

-Show result (default).

-.Pp

-.It Fl -noecho

-Don't show result.

-.Pp

-.Pp

-.It Fl -echo-on-assignment

-Show result on assignment.

-.Pp

-.It Fl -noecho-on-assignment

-Don't show result on assignment.

-.Pp

-.It Fl -truncate-echo-on-assignment

-Show truncated result on assignment (default).

-.Pp

-.Pp

-.It Fl -colorize

-Use colorization.

-.Pp

-.It Fl -nocolorize

-Don't use colorization.

-.Pp

-.Pp

-.It Fl -autocomplete

-Use autocompletion.

-.Pp

-.It Fl -noautocomplete

-Don't use autocompletion.

-.Pp

-.Pp

-.It Fl -regexp-completor

-Use regexp based completion.

-.Pp

-.It Fl -type-completor

-Use type based completion.

-.Pp

-.Pp

-.It Fl -verbose

-Show details.

-.Pp

-.It Fl -noverbose

-Don't show details.

-.Pp

-.It Fl -prompt Ar mode

-.It Fl -prompt-mode Ar mode

-Switch prompt mode. Pre-defined prompt modes are

-`default', `simple', `xmp' and `inf-ruby'.

-.Pp

-.It Fl -inf-ruby-mode

-Uses prompt appropriate for inf-ruby-mode on emacs.

-Suppresses --multiline and --singleline.

-.Pp

-.It Fl -simple-prompt

-Makes prompts simple.

-.Pp

-.It Fl -noprompt

-No prompt mode.

-.Pp

-.It Fl -tracer

-Displays trace for each execution of commands.

-.Pp

-.It Fl -back-trace-limit Ar n

-Displays backtrace top

-.Ar n

-and tail

-.Ar n Ns .

-The default value is 16.

-.El

-.Pp

-.Sh ENVIRONMENT

-.Bl -tag -compact -width "IRB_USE_AUTOCOMPLETE"

-.It Ev IRB_LANG

-The locale used for

-.Nm .

-.Pp

-.It Ev IRBRC

-The path to the personal initialization file.

-.Pp

-.It Ev XDG_CONFIG_HOME

-.Nm

-respects XDG_CONFIG_HOME. If it is set and

-.Ev IRBRC

-is unset, load

-.Pa $XDG_CONFIG_HOME/irb/irbrc

-as a personal initialization file.

-.Pp

-.It Ev RI_PAGER

-The command specified would be used as a pager.

-.Pp

-.It Ev PAGER

-The command specified would be used as a pager if

-.Ev RI_PAGER

-is unset.

-.Pp

-.It Ev VISUAL

-Its value would be used to open files by the edit command.

-.Pp

-.It Ev EDITOR

-Its value would be used to open files by the edit command if

-.Ev VISUAL

-is unset.

-.Pp

-.It Ev NO_COLOR

-Assigning a value to it disables colorization.

-.Pp

-.It Ev IRB_USE_AUTOCOMPLETE

-Assigning

-.Sy false

-to it disables autocompletion.

-.Pp

-.It Ev IRB_COMPLETOR

-Autocompletion behavior. Allowed values are

-.Sy regexp

-or

-.Sy type

-.

-.Pp

-.It Ev IRB_COPY_COMMAND

-Overrides the default program used to interface with the system clipboard.

-.El

-.Pp

-Also

-.Nm

-depends on same variables as

-.Xr ruby 1 .

-.Pp

-.Sh FILES

-.Bl -tag -compact

-.It Pa ~/.irbrc

-Personal irb initialization. If

-.Ev IRBRC

-is set, read

-.Pa $IRBRC

-instead. If

-.Ev IRBRC

-is not set and

-.Ev XDG_CONFIG_HOME

-is set,

-.Pa $XDG_CONFIG_HOME/irb/irbrc

-is loaded.

-.Pp

-.El

-.Pp

-.Sh EXAMPLES

-.Dl % irb

-.Dl irb(main):001:0> Ic 1 + 1

-.Dl 2

-.Dl irb(main):002:0> Ic def t(x)

-.Dl irb(main):003:1> Ic x + 1

-.Dl irb(main):004:1> Ic end

-.Dl => :t

-.Dl irb(main):005:0> Ic t(3)

-.Dl => 4

-.Dl irb(main):006:0> Ic if t(3) == 4

-.Dl irb(main):007:1> Ic p :ok

-.Dl irb(main):008:1> Ic end

-.Dl :ok

-.Dl => :ok

-.Dl irb(main):009:0> Ic quit

-.Dl %

-.Pp

-.Sh SEE ALSO

-.Xr ruby 1 .

-.Pp

-.Sh REPORTING BUGS

-.Bl -bullet

-.It

-Security vulnerabilities should be reported via an email to

-.Mt [email protected] .

-Reported problems will be published after being fixed.

-.Pp

-.It

-Other bugs and feature requests can be reported via the

-Ruby Issue Tracking System

-.Pq Lk https://bugs.ruby-lang.org/ .

-Do not report security vulnerabilities

-via this system because it publishes the vulnerabilities immediately.

-.El

-.Sh AUTHORS

-Written by Keiju ISHITSUKA.

-.\"Ruby is copyrighted by Yukihiro Matsumoto <[email protected]>.

-.Dd April 20, 2017

-.Dt RI \&1 "Ruby Programmer's Reference Guide"

-.Os UNIX

-.Sh NAME

-.Nm ri

-.Nd Ruby API reference front end

-.Sh SYNOPSIS

-.Nm

-.Op Fl ahilTv

-.Op Fl d Ar DIRNAME

-.Op Fl f Ar FORMAT

-.Op Fl w Ar WIDTH

-.Op Fl - Ns Oo Cm no- Oc Ns Cm pager

-.Op Fl -server Ns Oo = Ns Ar PORT Oc

-.Op Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs

-.Op Fl -no-standard-docs

-.Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc

-.Op Fl - Ns Oo Cm no- Oc Ns Cm profile

-.Op Fl -dump Ns = Ns Ar CACHE

-.Op Ar name ...

-.Sh DESCRIPTION

-.Nm

-is a command-line front end for the Ruby API reference.

-You can search and read the API reference for classes and methods with

-.Nm .

-.Pp

-.Nm

-is a part of Ruby.

-.Pp

-.Ar name

-can be:

-.Bl -diag -offset indent

-.It Class | Module | Module::Class

-.Pp

-.It Class::method | Class#method | Class.method | method

-.Pp

-.It gem_name: | gem_name:README | gem_name:History

-.El

-.Pp

-All class names may be abbreviated to their minimum unambiguous form.

-If a name is ambiguous, all valid options will be listed.

-.Pp

-A

-.Ql \&.

-matches either class or instance methods, while #method

-matches only instance and ::method matches only class methods.

-.Pp

-README and other files may be displayed by prefixing them with the gem name

-they're contained in. If the gem name is followed by a

-.Ql \&:

-all files in the gem will be shown.

-The file name extension may be omitted where it is unambiguous.

-.Pp

-For example:

-.Bd -literal -offset indent

-ri Fil

-ri File

-ri File.new

-ri zip

-ri rdoc:README

-.Ed

-.Pp

-Note that shell quoting or escaping may be required for method names

-containing punctuation:

-.Bd -literal -offset indent

-ri 'Array.[]'

-ri compact\e!

-.Ed

-.Pp

-To see the default directories

-.Nm

-will search, run:

-.Bd -literal -offset indent

-ri --list-doc-dirs

-.Ed

-.Pp

-Specifying the

-.Fl -system , Fl -site , Fl -home , Fl -gems ,

-or

-.Fl -doc-dir

-options will limit

-.Nm

-to searching only the specified directories.

-.Pp

-.Nm

-options may be set in the

-.Ev RI

-environment variable.

-.Pp

-The

-.Nm

-pager can be set with the

-.Ev RI_PAGER

-environment variable or the

-.Ev PAGER

-environment variable.

-.Pp

-.Sh OPTIONS

-.Bl -tag -width "1234567890123" -compact

-.Pp

-.It Fl i

-.It Fl - Ns Oo Cm no- Oc Ns Cm interactive

-In interactive mode you can repeatedly

-look up methods with autocomplete.

-.Pp

-.It Fl a

-.It Fl - Ns Oo Cm no- Oc Ns Cm all

-Show all documentation for a class or module.

-.Pp

-.It Fl l

-.It Fl - Ns Oo Cm no- Oc Ns Cm list

-List classes

-.Nm

-knows about.

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm pager

-Send output to a pager,

-rather than directly to stdout.

-.Pp

-.It Fl T

-Synonym for

-.Fl -no-pager .

-.Pp

-.It Fl w Ar WIDTH

-.It Fl -width Ns = Ns Ar WIDTH

-Set the width of the output.

-.Pp

-.It Fl -server Ns Oo = Ns Ar PORT Oc

-Run RDoc server on the given port.

-The default port is\~8214.

-.Pp

-.It Fl f Ar FORMAT

-.It Fl -format Ns = Ns Ar FORMAT

-Use the selected formatter.

-The default formatter is

-.Li bs

-for paged output and

-.Li ansi

-otherwise.

-Valid formatters are:

-.Li ansi , Li bs , Li markdown , Li rdoc .

-.Pp

-.It Fl h

-.It Fl -help

-Show help and exit.

-.Pp

-.It Fl v

-.It Fl -version

-Output version information and exit.

-.El

-.Pp

-Data source options:

-.Bl -tag -width "1234567890123" -compact

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs

-List the directories from which

-.Nm

-will source documentation on stdout and exit.

-.Pp

-.It Fl d Ar DIRNAME

-.It Fl -doc-dir Ns = Ns Ar DIRNAME

-List of directories from which to source

-documentation in addition to the standard

-directories. May be repeated.

-.Pp

-.It Fl -no-standard-docs

-Do not include documentation from the Ruby standard library,

-.Pa site_lib ,

-installed gems, or

-.Pa ~/.rdoc .

-Use with

-.Fl -doc-dir .

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm system

-Include documentation from Ruby's standard library. Defaults to true.

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm site

-Include documentation from libraries installed in

-.Pa site_lib .

-Defaults to true.

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm gems

-Include documentation from RubyGems. Defaults to true.

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm home

-Include documentation stored in

-.Pa ~/.rdoc .

-Defaults to true.

-.El

-.Pp

-Debug options:

-.Bl -tag -width "1234567890123" -compact

-.Pp

-.It Fl - Ns Oo Cm no- Oc Ns Cm profile

-Run with the Ruby profiler.

-.Pp

-.It Fl -dump Ns = Ns Ar CACHE

-Dump data from an ri cache or data file.

-.El

-.Pp

-.Sh ENVIRONMENT

-.Bl -tag -width "USERPROFILE" -compact

-.Pp

-.It Ev RI

-Options to prepend to those specified on the command-line.

-.Pp

-.It Ev RI_PAGER

-.It Ev PAGER

-Pager program to use for displaying.

-.Pp

-.It Ev HOME

-.It Ev USERPROFILE

-.It Ev HOMEPATH

-Path to the user's home directory.

-.El

-.Pp

-.Sh FILES

-.Bl -tag -width "USERPROFILE" -compact

-.Pp

-.It Pa ~/.rdoc

-Path for ri data in the user's home directory.

-.Pp

-.El

-.Pp

-.Sh SEE ALSO

-.Xr ruby 1 ,

-.Xr rdoc 1 ,

-.Xr gem 1

-.Pp

-.Sh REPORTING BUGS

-.Bl -bullet

-.It

-Security vulnerabilities should be reported via an email to

-.Mt [email protected] .

-Reported problems will be published after being fixed.

-.Pp

-.It

-Other bugs and feature requests can be reported via the

-Ruby Issue Tracking System

-.Pq Lk https://bugs.ruby-lang.org/ .

-Do not report security vulnerabilities

-via this system because it publishes the vulnerabilities immediately.

-.El

-.Sh AUTHORS

-Written by

-.An Dave Thomas Aq [email protected] .