README

   1 CL-READLINE 0.2.0
   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   READEXPR &key primary-prompt secondary-prompt history
  30
  31      primary-prompt   -- a string (default "=> ")
  32      secondary-prompt -- a string (default "|      ")
  33      history          -- a boolean (default t)
  34
  35      As READLINE, except reads enough lines to complete a lisp
  36      expression.
  37
  38      Primary-prompt controls the prompt of the first line,
  39      secondary prompt the prompt of the rest of the lines.
  40
  41   ADD-HISTORY string
  42
  43      Adds the given string to history.
  44
  45   USE-FILENAME-COMPLETE
  46
  47      Use the Readline's default filename-completion system.
  48
  49   USE-PACKAGE-COMPLETE name
  50
  51      Insert symbols in package designated by NAME to the custom
  52      completion pool, and start using the custom completion system.
  53
  54   USE-CUSTOM-COMPLETE
  55
  56      Use the custom completion system.
  57
  58   ADD-COMPLETION
  59
  60      Add a completion to the custom completion pool.
  61
  62   CLEAR-COMPLETIONS
  63
  64      Empty the custom completion pool.