diff options
Diffstat (limited to 'ext/readline')
-rw-r--r-- | ext/readline/README | 51 | ||||
-rw-r--r-- | ext/readline/README.jp | 63 |
2 files changed, 87 insertions, 27 deletions
diff --git a/ext/readline/README b/ext/readline/README index affe51f9e6..1eb1f8bb64 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. diff --git a/ext/readline/README.jp b/ext/readline/README.jp new file mode 100644 index 0000000000..e342ca4300 --- /dev/null +++ b/ext/readline/README.jp @@ -0,0 +1,63 @@ +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を返します。 + +completion_append_character = char + + 補完時に付加される文字を文字列で指定します。先頭の一文字が + 設定され、空文字列 ("") または nil を指定すると何も付加 + されなくなります。 + +completion_append_character + + 補完時に付加される文字を文字列で返します。デフォルトは + 空白 (" ") です。 + +vi_editing_mode + + VIモードになります。 + +emacs_editing_mode + + Emacsモードになります。 + +<クラス定数> + +HISTORY + +ヒストリに対する操作はこの定数を通して行ってください。 +配列と同じように扱えるようになっています。 |