summaryrefslogtreecommitdiff
path: root/ext/readline/README
diff options
context:
space:
mode:
authorkouji <kouji@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-08-07 15:06:36 +0000
committerkouji <kouji@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-08-07 15:06:36 +0000
commitfedc035ab81eee9ae814cb6865e34eac6afb58c0 (patch)
tree15c7b0407105556cc6daa7b2dad554bdc9f367e9 /ext/readline/README
parent1504652373a16c8e7eb5d59894c83572ac72b5e7 (diff)
* ext/.document: added readline/readline.c.
* ext/readline/readline.c: changed Copyright. added RDoc. * ext/readline/README.ja: fixed typo. * ext/readline/README: contents was moved RDoc. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@18420 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/readline/README')
-rw-r--r--ext/readline/README68
1 files changed, 8 insertions, 60 deletions
diff --git a/ext/readline/README b/ext/readline/README
index 9bbf325..57c51b5 100644
--- a/ext/readline/README
+++ b/ext/readline/README
@@ -1,62 +1,10 @@
-Extension for GNU Readline Library
+The Readline module provides interface for GNU Readline.
+This module defines a number of methods to facilitate completion
+and accesses input history from the Ruby interpreter.
+This module supported Edit Line(libedit) too.
+libedit is compatible with GNU Readline.
-Example:
+GNU Readline:: http://www.gnu.org/directory/readline.html
+libedit:: http://www.thrysoee.dk/editline/
- require "readline"
- include Readline
-
- line = readline("Prompt> ", true)
-
-[Readline]
-
-<module function>
-
-readline(prompt, add_history=nil)
-
- Reads one line with line editing. The inputted line is added to the
- history if add_history is true.
-
-<class methods>
-
-completion_proc = proc
-
- Specifies a Proc object to determine completion behavior. It
- should take input-string, and return an array of completion
- candidates.
-
-completion_proc
-
- Returns the completion Proc object.
-
-completion_case_fold = bool
-
- Sets whether or not to ignore case on completion.
-
-completion_case_fold
-
- Returns true if completion ignores case.
-
-completion_append_character = char
-
- Specifies a character to be appended on completion.
- Nothing will be appended if an empty string ("") or nil is
- specified.
-
-completion_append_character
-
- Returns a string containing a character to be appended on
- completion. The default is a space (" ").
-
-vi_editing_mode
-
- Specifies VI editing mode.
-
-emacs_editing_mode
-
- Specifies Emacs editing mode.
-
-<class constants>
-
-HISTORY
-
-The history buffer. It behaves just like an array.
+See RDoc for Readline module.