ef7b1e411ed608e28d5d2ed2883526eb37d9cdeb
[sbcl.git] / contrib / sb-aclrepl / sb-aclrepl.texinfo
1 @node sb-aclrepl
2 @section sb-aclrepl
3 @cindex Read-Eval-Print Loop
4 @cindex REPL
5
6 The @code{sb-aclrepl} module offers an AllegroCL style Read-Eval-Print
7 Loop for SBCL. An AllegroCL style inspector is integrated. Adding an
8 AllegroCL style debugger is planned.
9
10 @menu
11 * Usage::                       
12 @end menu
13
14 @node Usage
15 @subsection Usage
16
17 To start @code{sb-aclrepl} as your read-eval-print loop, put the form
18 @lisp
19 (require 'sb-aclrepl)
20 @end lisp
21
22 in your @file{~/.sbclrc} initialization file.
23
24 Here's a longer example of a @file{~/.sbclrc} file that shows off
25 some of the features of @code{sb-aclrepl}:
26
27 @lisp
28 (ignore-errors (require 'sb-aclrepl))
29
30 (when (find-package 'sb-aclrepl)
31   (push :aclrepl cl:*features*))
32 #+aclrepl
33 (progn
34   (setq sb-aclrepl:*max-history* 100)
35   (setf (sb-aclrepl:alias "asdc") 
36        #'(lambda (sys) (asdf:operate 'asdf:compile-op sys)))
37   (sb-aclrepl:alias "l" (sys) (asdf:operate 'asdf:load-op sys))
38   (sb-aclrepl:alias "t" (sys) (asdf:operate 'asdf:test-op sys))
39   ;; The 1 below means that two characaters ("up") are required
40   (sb-aclrepl:alias ("up" 1 "Use package") (package) (use-package package))
41   ;; The 0 below means only the first letter ("r") is required,
42   ;; such as ":r base64"
43   (sb-aclrepl:alias ("require" 0 "Require module") (sys) (require sys))
44   (setq cl:*features* (delete :aclrepl cl:*features*)))
45 @end lisp
46
47 Questions, comments, or bug reports should be sent to Kevin Rosenberg
48 (@email{kevin@@rosenberg.net}).