r4886: Automatic commit for debian_version_0_2_0-1

[cl-readline.git] / README

diff --git a/README b/README
index 1dbf41db9e0e66b0d02d231026236ab000d61b05..2f536ac620b3b4e2a99ab176379ff2e1bb5a46af 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-CL-READLINE 0.1
+CL-READLINE 0.2.0
 
  CL-READLINE is a simple UFFI-based wrapper for the GNU Readline
  library. 
@@ -7,8 +7,58 @@ 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)
 
+  The interface exported by the package READLINE (nicknamed RL).
+
+Functions:
+
+  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.
+
+  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.
+
+  ADD-HISTORY string
+
+     Adds the given string to history.
+
+  USE-FILENAME-COMPLETE
+
+     Use the Readline's default filename-completion system.
+
+  USE-PACKAGE-COMPLETE name
+
+     Insert symbols in package designated by NAME to the custom
+     completion pool, and start using the custom completion system.
+
+  USE-CUSTOM-COMPLETE
+
+     Use the custom completion system.
+
+  ADD-COMPLETION
+
+     Add a completion to the custom completion pool.
+
+  CLEAR-COMPLETIONS
+
+     Empty the custom completion pool.