1.0.2.5:
[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 @c FIXME: I wanted to use @registeredsymbol{}, but that's 
7 @c only available in Texinfo 4.7.  sigh.
8 The @code{sb-aclrepl} module offers an Allegro CL-style
9 Read-Eval-Print Loop for SBCL, with integrated inspector.  Adding a
10 debugger interface is planned.
11
12 @subsection Usage
13
14 To start @code{sb-aclrepl} as your read-eval-print loop, put the form
15 @lisp
16 (require 'sb-aclrepl)
17 @end lisp
18
19 in your @file{~/.sbclrc} initialization file.
20
21 @subsection Example Initialization
22
23 Here's a longer example of a @file{~/.sbclrc} file that shows off
24 some of the features of @code{sb-aclrepl}:
25
26 @lisp
27 (ignore-errors (require 'sb-aclrepl))
28
29 (when (find-package 'sb-aclrepl)
30   (push :aclrepl cl:*features*))
31 #+aclrepl
32 (progn
33   (setq sb-aclrepl:*max-history* 100)
34   (setf (sb-aclrepl:alias "asdc") 
35        #'(lambda (sys) (asdf:operate 'asdf:compile-op sys)))
36   (sb-aclrepl:alias "l" (sys) (asdf:operate 'asdf:load-op sys))
37   (sb-aclrepl:alias "t" (sys) (asdf:operate 'asdf:test-op sys))
38   ;; The 1 below means that two characaters ("up") are required
39   (sb-aclrepl:alias ("up" 1 "Use package") (package) (use-package package))
40   ;; The 0 below means only the first letter ("r") is required,
41   ;; such as ":r base64"
42   (sb-aclrepl:alias ("require" 0 "Require module") (sys) (require sys))
43   (setq cl:*features* (delete :aclrepl cl:*features*)))
44 @end lisp
45
46 Questions, comments, or bug reports should be sent to Kevin Rosenberg
47 (@email{kevin@@rosenberg.net}).
48
49 @subsection Credits
50
51 Allegro CL is a registered trademark of Franz Inc.