ruby/ext/readline
matz f0b77b0cde * ext/tk/lib/tk.rb (TkCore::chooseDirectory): back up wrongly
removed method.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@4175 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2003-07-26 15:03:16 +00:00
..
.cvsignore * configure.in: modify program_prefix only if specified 2002-09-08 09:08:15 +00:00
MANIFEST Rename *.jp to *.ja, since jp is a region code and ja is a language 2001-07-19 05:44:26 +00:00
README Detypo and reword a bit. 2001-07-05 15:47:03 +00:00
README.ja Rename *.jp to *.ja, since jp is a region code and ja is a language 2001-07-19 05:44:26 +00:00
depend ext/*/depend 1999-10-21 07:08:00 +00:00
extconf.rb * ext/readline/readline.c: restore terminal mode 2001-09-06 05:14:06 +00:00
readline.c * ext/tk/lib/tk.rb (TkCore::chooseDirectory): back up wrongly 2003-07-26 15:03:16 +00:00

README

Extension for GNU Readline Library

Example:

  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.