stdlib/ext/readline/README

   1 Extension for GNU Readline Library
   2
   3 Example:
   4
   5   require "readline"
   6   include Readline
   7
   8   line = readline("Prompt> ", true)
   9
  10 [Readline]
  11
  12 <module function>
  13
  14 readline(prompt, add_history=nil)
  15
  16   Reads one line with line editing.  The inputted line is added to the
  17   history if add_history is true.
  18
  19 <class methods>
  20
  21 completion_proc = proc
  22
  23   Specifies a Proc object to determine completion behavior.  It
  24   should take input-string, and return an array of completion
  25   candidates.
  26
  27 completion_proc
  28
  29   Returns the completion Proc object.
  30
  31 completion_case_fold = bool
  32
  33   Sets whether or not to ignore case on completion.
  34
  35 completion_case_fold
  36
  37   Returns true if completion ignores case.
  38
  39 completion_append_character = char
  40
  41   Specifies a character to be appended on completion.
  42   Nothing will be appended if an empty string ("") or nil is
  43   specified.
  44
  45 completion_append_character
  46
  47   Returns a string containing a character to be appended on
  48   completion.  The default is a space (" ").
  49
  50 vi_editing_mode
  51
  52   Specifies VI editing mode.
  53
  54 emacs_editing_mode
  55
  56   Specifies Emacs editing mode.
  57
  58 <class constants>
  59
  60 HISTORY
  61
  62 The history buffer.  It behaves just like an array.