update watch file

[cl-readline.git] / README

diff --git a/README b/README
index 1dbf41db9e0e66b0d02d231026236ab000d61b05..0c252bc7f4f49b2fe6a29850892857e73b32859f 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-CL-READLINE 0.1
+CL-READLINE 0.3.0
 
  CL-READLINE is a simple UFFI-based wrapper for the GNU Readline
  library. 
@@ -7,8 +7,81 @@ CL-READLINE 0.1
  and CMUCL. Other platforms and UFFI compatible implementations should
  work, but may require tweaking.
 
- To use:
+ To load: 
 
-  (asdf:oos 'asdf:load-op 'readline)
-  (rl:readline :prompt "> ")
+       (asdf:oos 'asdf:load-op 'readline)
 
+ CL-READLINE behaviour can be modified via ~/.inputrc, see GNU
+ Readline documentation for details.
+
+
+API
+ 
+  (exported by "READLINE" package, nicknamed "RL")
+
+
+  ADD-COMPLETION
+
+     Add a completion to the custom completion pool.
+
+
+  ADD-HISTORY string
+
+     Adds the given string to history.
+
+
+  CLEAR-COMPLETIONS
+
+     Empty the custom completion pool.
+
+
+  READEXPR &key primary-prompt secondary-prompt history
+
+     primary-prompt   -- a string (default "=> ")
+     secondary-prompt -- a string (default "|      ")
+     history          -- a boolean (default t)
+
+     As READLINE, except reads enough lines to complete a lisp
+     expression.
+
+     Primary-prompt controls the prompt of the first line,
+     secondary prompt the prompt of the rest of the lines.
+
+
+  READLINE &key prompt history
+
+     prompt  -- a string (default "")
+     history -- a boolean (default t)
+
+     Prompt is the prompt displayed to user.
+
+     History controls whether the string read is added to history, or
+     not. Note that history is available in any case. Currently there
+     is no way to erase history. Leading and trailing whitespace is trimmed
+     from string before they are added to history, and strings that consist
+     entirely of whitespace are not saved to history.
+
+     Dispite the cleanups performed on history, strings are returned as
+     read.
+
+
+  USE-CUSTOM-COMPLETE
+
+     Use the custom completion system. 
+
+
+  USE-FILENAME-COMPLETE
+
+     Use the Readline's default filename-completion system.
+
+
+  USE-PACKAGE-COMPLETE name
+
+     Clear current custom completion pool, insert symbols in package
+     designated by NAME to the custom completion pool, and start using
+     the custom completion system.
+
+
+  WITHOUT-ECHO form*
+
+     Runs forms without echoing of input on screen.