README

   1 CL-READLINE 0.3.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  CL-READLINE behaviour can be modified via ~/.inputrc, see GNU
  15  Readline documentation for details.
  16
  17
  18 API
  19
  20   (exported by "READLINE" package, nicknamed "RL")
  21
  22
  23   ADD-COMPLETION
  24
  25      Add a completion to the custom completion pool.
  26
  27
  28   ADD-HISTORY string
  29
  30      Adds the given string to history.
  31
  32
  33   CLEAR-COMPLETIONS
  34
  35      Empty the custom completion pool.
  36
  37
  38   READEXPR &key primary-prompt secondary-prompt history
  39
  40      primary-prompt   -- a string (default "=> ")
  41      secondary-prompt -- a string (default "|      ")
  42      history          -- a boolean (default t)
  43
  44      As READLINE, except reads enough lines to complete a lisp
  45      expression.
  46
  47      Primary-prompt controls the prompt of the first line,
  48      secondary prompt the prompt of the rest of the lines.
  49
  50
  51   READLINE &key prompt history
  52
  53      prompt  -- a string (default "")
  54      history -- a boolean (default t)
  55
  56      Prompt is the prompt displayed to user.
  57
  58      History controls whether the string read is added to history, or
  59      not. Note that history is available in any case. Currently there
  60      is no way to erase history. Leading and trailing whitespace is trimmed
  61      from string before they are added to history, and strings that consist
  62      entirely of whitespace are not saved to history.
  63
  64      Dispite the cleanups performed on history, strings are returned as
  65      read.
  66
  67
  68   USE-CUSTOM-COMPLETE
  69
  70      Use the custom completion system.
  71
  72
  73   USE-FILENAME-COMPLETE
  74
  75      Use the Readline's default filename-completion system.
  76
  77
  78   USE-PACKAGE-COMPLETE name
  79
  80      Clear current custom completion pool, insert symbols in package
  81      designated by NAME to the custom completion pool, and start using
  82      the custom completion system.
  83
  84
  85   WITHOUT-ECHO form*
  86
  87      Runs forms without echoing of input on screen.