README

   1 CL-READLINE 0.1.1
   2
   3  CL-READLINE is a simple UFFI-based wrapper for the GNU Readline
   4  library.
   5
   6  CL-READLINE has been tested on Debian GNU/Linux under SBCl, SBCL-MT
   7  and CMUCL. Other platforms and UFFI compatible implementations should
   8  work, but may require tweaking.
   9
  10   To load:
  11
  12         (asdf:oos 'asdf:load-op 'readline)
  13
  14   The interface exported by the package READLINE (nicknamed RL).
  15
  16 Functions:
  17
  18   READLINE &key prompt history
  19
  20      prompt  -- a string (default "")
  21      history -- a boolean (default t)
  22
  23      Prompt is the prompt displayed to user.
  24
  25      History controls whether the string read is added to history, or
  26      not. Note that history is available in any case. Currently there
  27      is no way to erase history.
  28
  29   ADD-HISTORY string
  30
  31      Adds the given string to history.
  32
  33   USE-FILENAME-COMPLETE
  34
  35      Use the Readline's default filename-completion system.
  36
  37   USE-CL-COMPLETE
  38
  39      Insert symbols in CL-USER to the custom completion pool,
  40      and start using the custom completion system.
  41
  42   USE-CUSTOM-COMPLETE
  43
  44      Use the custom completion system.
  45
  46   ADD-COMPLETION
  47
  48      Add a completion to the custom completion pool.
  49
  50   CLEAR-COMPLETIONS
  51
  52      Empty the custom completion pool.