{ "content": [ { "type": "text", "text": "# irb (man)\n\n## NAME\n\nirb — Interactive Ruby Shell\n\n## SYNOPSIS\n\nirb [--version] [-dfUw] [-I directory] [-r library] [-E external[:internal]] [-W[level]]\n[--[no]inspect] [--[no]multiline] [--[no]singleline] [--[no]echo] [--[no]colorize]\n[--[no]verbose] [--prompt mode] [--prompt-mode mode] [--inf-ruby-mode] [--simple-prompt]\n[--noprompt] [--tracer] [--back-trace-limit n] [--] [programfile] [argument ...]\n\n## DESCRIPTION\n\nirb is the REPL(read-eval-print loop) environment for Ruby programs.\n\n## TLDR\n\n> Interactive Ruby shell.\n\n- Start the interactive shell:\n `irb`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (12 subsections)\n- **ENVIRONMENT**\n- **FILES**\n- **EXAMPLES**\n- **SEE ALSO**\n- **REPORTING BUGS**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "irb", "section": "", "mode": "man", "summary": "irb — Interactive Ruby Shell", "synopsis": "irb [--version] [-dfUw] [-I directory] [-r library] [-E external[:internal]] [-W[level]]\n[--[no]inspect] [--[no]multiline] [--[no]singleline] [--[no]echo] [--[no]colorize]\n[--[no]verbose] [--prompt mode] [--prompt-mode mode] [--inf-ruby-mode] [--simple-prompt]\n[--noprompt] [--tracer] [--back-trace-limit n] [--] [programfile] [argument ...]", "tldr_summary": "Interactive Ruby shell.", "tldr_examples": [ { "description": "Start the interactive shell", "command": "irb" } ], "tldr_source": "official", "flags": [ { "flag": "-E", "long": null, "arg": null, "description": "--encoding external[:internal] 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.defaultinternal) will be nil." }, { "flag": "-I", "long": null, "arg": null, "description": "" }, { "flag": "-U", "long": null, "arg": null, "description": "(Encoding.defaultinternal) to UTF-8." }, { "flag": "-d", "long": null, "arg": null, "description": "" }, { "flag": "-f", "long": null, "arg": null, "description": "" }, { "flag": "-w", "long": null, "arg": null, "description": "" }, { "flag": "-W", "long": null, "arg": null, "description": "" }, { "flag": "-h", "long": null, "arg": null, "description": "--help Prints a summary of the options." }, { "flag": "-r", "long": null, "arg": null, "description": "--inspect Uses `inspect' for output (default except for bc mode) --noinspect Doesn't use inspect for output --multiline Uses multiline editor module. --nomultiline Doesn't use multiline editor module. --singleline Uses singleline editor module." }, { "flag": "", "long": "--nosingleline", "arg": null, "description": "Doesn't use singleline editor module. --echo Show result(default). --noecho Don't show result. --colorize Use colorization. --nocolorize Don't use colorization. --verbose Show details. --noverbose Don't show details. --prompt mode --prompt-mode mode Switch prompt mode. Pre-defined prompt modes are `default', `simple', `xmp' and `inf-ruby'." }, { "flag": "", "long": "--inf-ruby-mode", "arg": null, "description": "Uses prompt appropriate for inf-ruby-mode on emacs. Suppresses --multiline and --singleline." }, { "flag": "", "long": "--simple-prompt", "arg": null, "description": "Makes prompts simple. --noprompt No prompt mode. --tracer Displays trace for each execution of commands. --back-trace-limit n Displays backtrace top n and tail n. The default value is 16." } ], "examples": [ "% irb", "irb(main):001:0> 1 + 1", "irb(main):002:0> def t(x)", "irb(main):003:1> x + 1", "irb(main):004:1> end", "=> :t", "irb(main):005:0> t(3)", "=> 4", "irb(main):006:0> if t(3) == 4", "irb(main):007:1> p :ok", "irb(main):008:1> end", ":ok", "=> :ok", "irb(main):009:0> quit" ], "see_also": [ { "name": "ruby", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ruby/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 5, "subsections": [] }, { "name": "DESCRIPTION", "lines": 2, "subsections": [] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "-E", "lines": 7, "flag": "-E" }, { "name": "-I", "lines": 1, "flag": "-I" }, { "name": "-U", "lines": 2, "flag": "-U" }, { "name": "-d", "lines": 1, "flag": "-d" }, { "name": "-f", "lines": 1, "flag": "-f" }, { "name": "-w", "lines": 1, "flag": "-w" }, { "name": "-W", "lines": 1, "flag": "-W" }, { "name": "-h", "lines": 2, "flag": "-h" }, { "name": "-r", "lines": 10, "flag": "-r" }, { "name": "--nosingleline", "lines": 19, "long": "--nosingleline" }, { "name": "--inf-ruby-mode", "lines": 3, "long": "--inf-ruby-mode" }, { "name": "--simple-prompt", "lines": 9, "long": "--simple-prompt" } ] }, { "name": "ENVIRONMENT", "lines": 4, "subsections": [] }, { "name": "FILES", "lines": 3, "subsections": [] }, { "name": "EXAMPLES", "lines": 17, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "REPORTING BUGS", "lines": 7, "subsections": [] }, { "name": "AUTHORS", "lines": 3, "subsections": [] } ], "sections": { "NAME": { "content": "irb — Interactive Ruby Shell\n", "subsections": [] }, "SYNOPSIS": { "content": "irb [--version] [-dfUw] [-I directory] [-r library] [-E external[:internal]] [-W[level]]\n[--[no]inspect] [--[no]multiline] [--[no]singleline] [--[no]echo] [--[no]colorize]\n[--[no]verbose] [--prompt mode] [--prompt-mode mode] [--inf-ruby-mode] [--simple-prompt]\n[--noprompt] [--tracer] [--back-trace-limit n] [--] [programfile] [argument ...]\n", "subsections": [] }, "DESCRIPTION": { "content": "irb is the REPL(read-eval-print loop) environment for Ruby programs.\n", "subsections": [] }, "OPTIONS": { "content": "--version Prints the version of irb.\n", "subsections": [ { "name": "-E", "content": "--encoding external[:internal]\nSame as `ruby -E' . Specifies the default value(s) for external encodings and\ninternal encoding. Values should be separated with colon (:).\n\nYou can omit the one for internal encodings, then the value\n(Encoding.defaultinternal) will be nil.\n", "flag": "-E" }, { "name": "-I", "content": "", "flag": "-I" }, { "name": "-U", "content": "(Encoding.defaultinternal) to UTF-8.\n", "flag": "-U" }, { "name": "-d", "content": "", "flag": "-d" }, { "name": "-f", "content": "", "flag": "-f" }, { "name": "-w", "content": "", "flag": "-w" }, { "name": "-W", "content": "", "flag": "-W" }, { "name": "-h", "content": "--help Prints a summary of the options.\n", "flag": "-h" }, { "name": "-r", "content": "--inspect Uses `inspect' for output (default except for bc mode)\n\n--noinspect Doesn't use inspect for output\n\n--multiline Uses multiline editor module.\n\n--nomultiline Doesn't use multiline editor module.\n\n--singleline Uses singleline editor module.\n", "flag": "-r" }, { "name": "--nosingleline", "content": "Doesn't use singleline editor module.\n\n--echo Show result(default).\n\n--noecho Don't show result.\n\n--colorize Use colorization.\n\n--nocolorize Don't use colorization.\n\n--verbose Show details.\n\n--noverbose Don't show details.\n\n--prompt mode\n--prompt-mode mode\nSwitch prompt mode. Pre-defined prompt modes are `default', `simple', `xmp' and\n`inf-ruby'.\n", "long": "--nosingleline" }, { "name": "--inf-ruby-mode", "content": "Uses prompt appropriate for inf-ruby-mode on emacs. Suppresses --multiline and\n--singleline.\n", "long": "--inf-ruby-mode" }, { "name": "--simple-prompt", "content": "Makes prompts simple.\n\n--noprompt No prompt mode.\n\n--tracer Displays trace for each execution of commands.\n\n--back-trace-limit n\nDisplays backtrace top n and tail n. The default value is 16.\n", "long": "--simple-prompt" } ] }, "ENVIRONMENT": { "content": "IRBRC\n\nAlso irb depends on same variables as ruby(1).\n", "subsections": [] }, "FILES": { "content": "~/.irbrc\nPersonal irb initialization.\n", "subsections": [] }, "EXAMPLES": { "content": "% irb\nirb(main):001:0> 1 + 1\n2\nirb(main):002:0> def t(x)\nirb(main):003:1> x + 1\nirb(main):004:1> end\n=> :t\nirb(main):005:0> t(3)\n=> 4\nirb(main):006:0> if t(3) == 4\nirb(main):007:1> p :ok\nirb(main):008:1> end\n:ok\n=> :ok\nirb(main):009:0> quit\n%\n", "subsections": [] }, "SEE ALSO": { "content": "ruby(1).\n", "subsections": [] }, "REPORTING BUGS": { "content": "•• Security vulnerabilities should be reported via an email to security@ruby-lang.org. Re‐\nported problems will be published after being fixed.\n\n•• Other bugs and feature requests can be reported via the Ruby Issue Tracking System\n(https://bugs.ruby-lang.org/). Do not report security vulnerabilities via this system be‐\ncause it publishes the vulnerabilities immediately.\n", "subsections": [] }, "AUTHORS": { "content": "Written by Keiju ISHITSUKA.\n\nUNIX August 11, 2019 UNIX", "subsections": [] } } } }