summaryrefslogtreecommitdiff
path: root/ext/readline/README
diff options
context:
space:
mode:
Diffstat (limited to 'ext/readline/README')
-rw-r--r--ext/readline/README55
1 files changed, 55 insertions, 0 deletions
diff --git a/ext/readline/README b/ext/readline/README
new file mode 100644
index 00000000000..8a5fe9120f4
--- /dev/null
+++ b/ext/readline/README
@@ -0,0 +1,55 @@
+GNU Readline Libraryを利用するための拡張モジュールです。
+
+require "readline"
+include Readline
+
+line = readline("Prompt> ", TRUE)
+
+のように使用してください。
+
+[Readline]
+
+<モジュール関数>
+
+readline(prompt, add=nil)
+
+ 一行入力を読み込みます。
+ addがTRUEの場合、ヒストリに読み込んだ文字列を追加します。
+
+<クラスメソッド>
+
+completion_proc = proc
+
+ 補完時の動作を決定するProcオブジェクトを指定します。
+ procは引数に入力文字列を取り、候補文字列の配列を返すように
+ してください。
+
+completion_proc
+
+ 補完時の動作を決定するProcオブジェクトを返します。
+
+completion_case_fold = case_fold
+
+ 補完時に大文字小文字を区別しない場合、TRUEを指定します。
+
+completion_case_fold
+
+ 補完時に大文字小文字を区別しない場合、TRUEを返します。
+
+vi_editing_mode
+
+ VIモードになります。
+
+emacs_editing_mode
+
+ Emacsモードになります。
+
+<クラス定数>
+
+HISTORY
+
+ヒストリに対する操作はこの定数を通して行ってください。
+配列と同じように扱えるようになっています。
+
+
+ \ No newline at end of file