summaryrefslogtreecommitdiff
path: root/doc/irb/irb.rd
diff options
context:
space:
mode:
Diffstat (limited to 'doc/irb/irb.rd')
-rw-r--r--doc/irb/irb.rd51
1 files changed, 36 insertions, 15 deletions
diff --git a/doc/irb/irb.rd b/doc/irb/irb.rd
index 522bbef555..731c44eec8 100644
--- a/doc/irb/irb.rd
+++ b/doc/irb/irb.rd
@@ -1,5 +1,5 @@
irb -- interactive ruby
- $Release Version: 0.5 $
+ $Release Version: 0.9 $
$Revision$
$Date$
by Keiju ISHITSUKA(keiju@ishitsuka.com)
@@ -48,7 +48,12 @@ is the standard default action if Readline is installed.
-f suppress read ~/.irbrc
-m bc mode (fraction or matrix are available)
-d set $DEBUG to true (same as `ruby -d')
+ -Kc same as `ruby -Kc'
-r load-module same as `ruby -r'
+ --verbose command input is echoed(default)
+ --noverbose command input isn't echoed
+ --echo commands are echoed immediately before execution(default)
+ --noecho commands aren't echoed immediately before execution
--inspect uses `inspect' for output (the default except bc mode)
--noinspect doesn't uses inspect for output
--readline uses Readline extension module
@@ -56,7 +61,7 @@ is the standard default action if Readline is installed.
--prompt prompt-mode
--prompt-mode prompt-mode
switches prompt mode. Pre-defined prompt modes are
- `deflaut', `simple', `xmp' and `inf-ruby'
+ `default', `simple', `xmp' and `inf-ruby'
--inf-ruby-mode uses prompt appreciate for inf-ruby-mode on emacs.
Suppresses --readline.
@@ -69,8 +74,6 @@ is the standard default action if Readline is installed.
--irb_debug n sets internal debug level to n (It shouldn't be used)
-v, --version prints the version of irb
-
-
= Configurations
irb reads `~/.irbrc' when it is invoked. If `~/.irbrb' doesn't exist
@@ -160,12 +163,17 @@ For irb commands, both simple name and `irb_'-prefixed name are prepared.
--- exit, quit, irb_exit
Quits (sub)irb.
- if you've done cb (see below), exit from the binding mode.
--- conf, irb_context
Displays current configuration. Modifing the configuration is
achieved by sending message to `conf'.
+--- conf.eval_history = N
+ Sets execution result history.
+ N is a integer or nil. If N > 0, the number of historys is N.
+ If N == 0, the number of historys is unlimited. If N is nill,
+ execution result history isn't used(default).
+
--- conf.back_trace_limit
Sets display lines of backtrace as top n and tail n.
The default value is 16.
@@ -193,9 +201,6 @@ For irb commands, both simple name and `irb_'-prefixed name are prepared.
nil: inspect mode in non math mode,
non inspect mode in math mode.
---- conf.irb_level
- The level of cb.
-
--- conf.math_mode
Whether bc mode or not.
@@ -223,13 +228,19 @@ For irb commands, both simple name and `irb_'-prefixed name are prepared.
true: uses
false: doen't use
nil: intends to use readline except for inf-reuby-mode (default)
+#
+#--- conf.verbose=T/F
+# Whether verbose messages are display or not.
---- conf.verbose=T/F
- Whether verbose messages are display or not.
+--- cws, chws, irb_change_workspace [obj]
+ obj will be self. If obj is omitted, self will be home-object, or
+ the main object of first started irb.
---- cb, irb_change_binding [obj]
- Enter new binding which has a distinct scope of local variables.
- If obj is given, obj will be self.
+--- pushws, irb_pushws, irb_push_workspace [obj]
+ same as UNIX-shell command pushd.
+
+--- popws, irb_popws, irb_pop_workspace
+ same as UNIX-shell command popd
--- irb [obj]
Invoke subirb. If obj is given, obj will be self.
@@ -248,10 +259,20 @@ For irb commands, both simple name and `irb_'-prefixed name are prepared.
--- kill n, irb_kill n
Kill subirb. The means of n is as same as the case of irb_fg.
-= System variable
+--- souce, irb_source path
+ This is a like UNIX-shell command source. evaluate script in path
+ on current context.
- _ The latest value of evaluation (it is local)
+--- irb_load path, prev
+ irb-version of Ruby's load.
+
+= System variable
+--- _ The latest value of evaluation (it is local)
+--- __ The history of evaluation values.
+ __[line_no] return an evaluation value of line number<line_no>. If
+ line_no is a negative, return value before -<line_no> from latest
+ value.
= Session Example