diff options
author | Takashi Kokubun <takashikkbn@gmail.com> | 2022-11-19 14:14:40 -0800 |
---|---|---|
committer | git <svn-admin@ruby-lang.org> | 2022-11-19 22:14:44 +0000 |
commit | 5958c305e527460465bdbd43e59b2da26d4cfbfb (patch) | |
tree | c25f78068c239e00f5cc9a234294346068751866 /lib/irb.rb | |
parent | 23750c866a69cec982cc16921bbdc6224dfded94 (diff) | |
download | ruby-5958c305e527460465bdbd43e59b2da26d4cfbfb.tar.gz |
[ruby/irb] Document a full list of commands
(https://github.com/ruby/irb/pull/451)
* Document a full list of commands
* Document debug as well
* Make it less duplicated
Diffstat (limited to 'lib/irb.rb')
-rw-r--r-- | lib/irb.rb | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/lib/irb.rb b/lib/irb.rb index 741ad7e59f..0a856d3929 100644 --- a/lib/irb.rb +++ b/lib/irb.rb @@ -53,6 +53,50 @@ require_relative "irb/easter-egg" # # :include: ./irb/lc/help-message # +# == Commands +# +# The following commands are available on IRB. +# +# * cwws +# * Show the current workspace. +# * cb, cws, chws +# * Change the current workspace to an object. +# * bindings, workspaces +# * Show workspaces. +# * pushb, pushws +# * Push an object to the workspace stack. +# * popb, popws +# * Pop a workspace from the workspace stack. +# * load +# * Load a Ruby file. +# * require +# * Require a Ruby file. +# * source +# * Loads a given file in the current session. +# * irb +# * Start a child IRB. +# * jobs +# * List of current sessions. +# * fg +# * Switches to the session of the given number. +# * kill +# * Kills the session with the given number. +# * help +# * Enter the mode to look up RI documents. +# * irb_info +# * Show information about IRB. +# * ls +# * Show methods, constants, and variables. +# -g [query] or -G [query] allows you to filter out the output. +# * measure +# * measure enables the mode to measure processing time. measure :off disables it. +# * $, show_source +# * Show the source code of a given method or constant. +# * @, whereami +# * Show the source code around binding.irb again. +# * debug +# * Start the debugger of debug.gem. +# # == Configuration # # IRB reads a personal initialization file when it's invoked. |