summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkeiju <keiju@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2002-07-09 11:22:04 +0000
committerkeiju <keiju@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2002-07-09 11:22:04 +0000
commit1f6f2325f8985271d9c36d75b70852a30f1ecd6a (patch)
tree90e216ad80b7a24805a8d3d224a0636355dd5968
parentaf064b04b1622897995fe1177aabfb60db90e6f7 (diff)
* irb 0.9(doc)
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@2628 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--doc/irb/irb.rd51
-rw-r--r--doc/irb/irb.rd.ja58
2 files changed, 75 insertions, 34 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([email protected])
@@ -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
diff --git a/doc/irb/irb.rd.ja b/doc/irb/irb.rd.ja
index 5068f4536f..7e80c7fc6f 100644
--- a/doc/irb/irb.rd.ja
+++ b/doc/irb/irb.rd.ja
@@ -1,23 +1,19 @@
irb -- interactive ruby
- $Release Version: 0.6 $
+ $Release Version: 0.9 $
$Revision$
$Date$
by Keiju ISHITSUKA([email protected])
=begin
= irb�Ȥ�?
-irb��interactive ruby��ά�Ǥ�. ruby�μ���ɸ�����Ϥ����ñ������/�¹Ԥ�
-�뤿��Υġ���Ǥ�.
+irb��interactive ruby��ά�Ǥ�. ruby�μ���ɸ�����Ϥ����ñ������/�¹Ԥ���
+����Υġ���Ǥ�.
= ��ư
- % ruby -r irb -e0
% irb
-�Τ����줫�ǹԤʤ��ޤ�. ���Ԥξ��irb�ؤΥ��ץ��������, �ʲ��Τ褦��
-�ʤ�ޤ�.
-
- % ruby -r irb -e0 -- -v
+�ǹԤʤ��ޤ�.
= �Ȥ���
@@ -47,7 +43,12 @@ irb�λȤ�����, Ruby�����ΤäƤ���Ф����äƴ�ñ�Ǥ�. ����Ū�ˤ� irb ��
-f ~/.irbrc ���ɤ߹��ޤʤ�.
-m bc�⡼��(ʬ��, ����η׻����Ǥ���)
-d $DEBUG ��true�ˤ���(ruby -d ��Ʊ��)
+ -Kc ruby -Kc��Ʊ��
-r load-module ruby -r ��Ʊ��.
+ --verbose ���줫��¹Ԥ���Ԥ�ɽ������(�ǥե����)
+ --noverbose ���줫��¹Ԥ���Ԥ�ɽ�����ʤ�
+ --echo �¹Է�̤�ɽ������(�ǥե����)
+ --noecho �¹Է�̤�ɽ�����ʤ�
--inspect ��̽��Ϥ�inspect���Ѥ���(bc�⡼�ɰʳ��ϥǥե����).
--noinspect ��̽��Ϥ�inspect���Ѥ��ʤ�.
--readline readline�饤�֥������Ѥ���.
@@ -168,13 +169,17 @@ irb��ĥ���ޥ�ɤ�, ��ñ��̾����Ƭ��`irb_'��Ĥ���̾����ξ����������
--- exit, quit, irb_exit
�����.
����irb��, ������irb�����.
- cb���Ƥ�����, ���ΥХ���ǥ��󥰤Υ⡼�ɤ�λ����.
--- conf, irb_context
irb�θ��ߤ������ɽ������. ������ѹ���, conf�˥�å����������뤳
�Ȥˤ�äƹԤʤ���.
---- conf.back_trace_limit
+--- conf.eval_history = N
+ �¹Է�̤Υҥ��ȥ굡ǽ������.
+ nn��������nil�� nn>0 �Ǥ���Ф��ο������ҥ��ȥ�ˤ���롣nn==0�λ���
+ ̵���¤˵������롢nil���ȥҥ��ȥ굡ǽ�Ϥ���(�ǥե����).
+
+--- Conf.back_trace_limit
�Хå��ȥ졼��ɽ����Хå��ȥ졼����Ƭ����n, �������n�����Ԥʤ�.
�ǥե���Ȥ�16
@@ -201,9 +206,6 @@ irb��ĥ���ޥ�ɤ�, ��ñ��̾����Ƭ��`irb_'��Ĥ���̾����ξ����������
nil: �̾�⡼�ɤǤ����, inspect mode�Ȥʤ�, math�⡼�ɤλ���, non
inspect mode�Ȥʤ�.
---- conf.irb_level
- ���ȤΤ�. irb������cb���Ƥ��뤫?
-
--- conf.math_mode
���ȤΤ�. bc�⡼��(ʬ��, ����η׻����Ǥ��ޤ�)���ɤ���?
@@ -232,13 +234,19 @@ irb��ĥ���ޥ�ɤ�, ��ñ��̾����Ƭ��`irb_'��Ĥ���̾����ξ����������
false: readline��Ȥ�ʤ�.
nil: (�ǥե����)inf-reuby-mode�ʳ���readline�饤�֥������Ѥ���
���Ȥ���.
+#
+#--- conf.verbose=T/F
+# irb���餤�������ʥ�å���������Ϥ��뤫?
---- conf.verbose=T/F
- irb���餤�������ʥ�å���������Ϥ��뤫?
+--- cws, chws, irb_cws, irb_chws, irb_change_workspace [obj]
+ obj��self�Ȥ���. obj����ά���줿�Ȥ���, home workspace, ���ʤ��
+ irb��ư�����Ȥ���main object��self�Ȥ���.
---- cb, irb_change_binding [obj]
- ���������ѿ��Υ������פ��㤦������binding�˰ܤ�. obj�����ꤵ�줿
- ����, ����obj��self�Ȥ���.
+--- pushws, irb_pushws, irb_push_workspace [obj]
+ UNIX�����륳�ޥ�ɤ�pushd��Ʊ��.
+
+--- popws, irb_popws, irb_pop_workspace
+ UNIX�����륳�ޥ�ɤ�popd��Ʊ��.
--- irb [obj]
����irb��Ω��������. obj�����ꤵ�줿����, ����obj��self�Ȥ���.
@@ -257,10 +265,22 @@ irb��ĥ���ޥ�ɤ�, ��ñ��̾����Ƭ��`irb_'��Ĥ���̾����ξ����������
--- kill n, irb_kill n
����irb��kill����. n��fg��Ʊ��.
+--- souce, irb_source path
+ UNIX�����륳�ޥ�ɤ�source�Ȼ��Ƥ���. ���ߤδĶ����path��Υ�����
+ �ץȤ�ɾ������.
+
+--- irb_load path, prev
+
+ Ruby��load��irb��.
= �����ƥ��ѿ�
- _ ���η׻��μ¹Է�̤�Ф��Ƥ���(���������ѿ�).
+--- _
+ ���η׻��μ¹Է�̤�Ф��Ƥ���(���������ѿ�).
+___ __
+ �¹Է�̤������Ф��Ƥ���.
+ __[line_no]�ǡ����ιԤǼ¹Ԥ�����̤����뤳�Ȥ��Ǥ���. line_no�����
+ ���ˤϡ��ǿ��η�̤���-line_no���η�̤����뤳�Ȥ��Ǥ���.
= ������