a90a26cbdb82144ce2349be6138ff0875ca6a019
[sbcl.git] / contrib / sb-aclrepl / README
1 INTRODUCTION
2 ============
3
4 The sb-aclrepl module offers an AllegroCL style Read-Eval-Print Loop for
5 SBCL. An AllegroCL style inspector is integrated. Adding an AllegroCL style
6 debugger is planned.
7
8 USAGE
9 =====
10 To start sb-aclrepl as your read-eval-print loop, you must
11 put the following command in your ~/.sbclrc.
12   (require 'sb-aclrepl)
13
14 The reason for this is that, currently, sb-aclrepl must loaded before
15 SBCL's default REPL starts.
16
17 EXAMPLE ~/.sbclrc FILE
18 ======================
19
20 (ignore-errors (require 'sb-aclrepl))
21
22 (when (find-package 'sb-aclrepl)
23   (push :aclrepl *features*))
24
25 #+aclrepl
26 (progn
27   (setq sb-aclrepl:*max-history* 100)
28   (setf (sb-aclrepl:alias "asdc") #'(lambda (sys) (asdf:oos 'asdf:load-op sys)))
29   (sb-aclrepl:alias "l" (sys) (asdf:oos 'asdf:load-op sys))
30   (sb-aclrepl:alias "t" (sys) (asdf:oos 'asdf:test-op sys))
31   ;; The 1 below means that two characaters ("up") are required
32   (sb-aclrepl:alias ("up" 1 "Use package") (package) (use-package package))
33   ;; The 0 below means only the first letter ("r") is required, such as ":r base64"
34   (sb-aclrepl:alias ("require" 0 "Require module") (sys) (require sys))
35 )
36
37 Questions, comments, or bug reports should be sent to Kevin Rosenberg
38 <kevin@rosenberg.net>.