summaryrefslogtreecommitdiffstats
path: root/ext/readline/README
diff options
context:
space:
mode:
Diffstat (limited to 'ext/readline/README')
-rw-r--r--ext/readline/README51
1 files changed, 24 insertions, 27 deletions
diff --git a/ext/readline/README b/ext/readline/README
index affe51f9e..1eb1f8bb6 100644
--- a/ext/readline/README
+++ b/ext/readline/README
@@ -1,63 +1,60 @@
-GNU Readline Library�����Ѥ��뤿��γ�ĥ�⥸�塼��Ǥ���
+Extension for GNU Readline Library
-require "readline"
-include Readline
+Example:
-line = readline("Prompt> ", TRUE)
+ require "readline"
+ include Readline
-�Τ褦�˻��Ѥ��Ƥ���������
+ line = readline("Prompt> ", true)
[Readline]
-<�⥸�塼��ؿ�>
+<module function>
-readline(prompt, add=nil)
+readline(prompt, add_hostory=nil)
- ������Ϥ��ɤ߹��ߤޤ���
- add��TRUE�ξ�硢�ҥ��ȥ���ɤ߹����ʸ������ɲä��ޤ���
+ Reads one line wit line edit. the line is added to the
+ history also if "add" is true.
-<���饹�᥽�å�>
+<class mehods>
completion_proc = proc
- �䴰����ư�����ꤹ��Proc���֥������Ȥ���ꤷ�ޤ���
- proc�ϰ���������ʸ������ꡢ����ʸ�����������֤��褦��
- ���Ƥ���������
+ Specifies Proc object to determin completion behavior. It
+ shoule take input-string, and return completion candidates.
completion_proc
- �䴰����ư�����ꤹ��Proc���֥������Ȥ��֤��ޤ���
+ Returns the completion Proc object.
-completion_case_fold = case_fold
+completion_case_fold = bool
- �䴰������ʸ����ʸ������̤��ʤ���硢TRUE����ꤷ�ޤ���
+ Sets whether or not to ignore case on completion.
completion_case_fold
- �䴰������ʸ����ʸ������̤��ʤ���硢TRUE���֤��ޤ���
+ Returns true if completion ignores case.
completion_append_character = char
- �䴰�����ղä����ʸ����ʸ����ǻ��ꤷ�ޤ�����Ƭ�ΰ�ʸ����
- ���ꤵ�졢��ʸ���� ("") �ޤ��� nil ����ꤹ��Ȳ����ղ�
- ����ʤ��ʤ�ޤ���
+ Specifies a chacatcter to be appended on completion.
+ Nothing will be appended if empty string ("") or nil is specified.
completion_append_character
- �䴰�����ղä����ʸ����ʸ������֤��ޤ����ǥե���Ȥ�
- ���� (" ") �Ǥ���
+ Returns a string contains a character to be appended on
+ completion. The default is a space (" ").
vi_editing_mode
- VI�⡼�ɤˤʤ�ޤ���
+ Specifies VI editing mode.
emacs_editing_mode
- Emacs�⡼�ɤˤʤ�ޤ���
+ Specifies Emacs editing mode.
-<���饹���>
+<class constants>
HISTORY
-�ҥ��ȥ���Ф������Ϥ���������̤��ƹԤäƤ���������
-�����Ʊ���褦�˰�����褦�ˤʤäƤ��ޤ���
+The history buffer. It behaves just like an array.
OSZAR »