3 Geiser is a generic Emacs/Scheme interaction mode, featuring an
4 enhanced REPL and a set of minor modes improving Emacs' basic scheme
5 major mode. The main functionalities provided are:
7 - Evaluation of forms in the namespace of the current module.
10 - Namespace-aware identifier completion (including local bindings,
11 names visible in the current module, and module names).
12 - Autodoc: the echo area shows information about the signature of
13 the procedure/macro around point automatically.
14 - Jump to definition of identifier at point.
15 - Access to documentation (including docstrings when the
16 implementation provides it).
17 - Listings of identifiers exported by a given module.
18 - Listings of callers/callees of procedures.
19 - Rudimentary support for debugging (list of
20 evaluation/compilation error in an Emacs' compilation-mode
22 - Support for inline images in schemes, such as Racket, that treat
23 them as first order values.
25 NOTE: if you're not in a hurry, Geiser's website
26 (http://www.nongnu.org/geiser/) contains a nicer manual, also
27 included in Geiser tarballs as a texinfo file (doc/geiser.info).
31 Geiser needs Emacs 23.2 or better, and at least one of the
32 supported scheme implementations:
33 - Guile 2.0 or better.
34 - PLT Racket 6.0 or better.
35 - Chicken 4.8.0 or better.
36 - MIT/GNU Scheme 9.1.1 or better.
37 - Chibi 0.7.3 or better.
42 The easiest way is to use MELPA, and just type
43 `M-x install-package RET geiser` inside emacs.
45 Geiser can be used either directly from its uninstalled source tree
46 or byte-compiled and installed after performing the standard
47 configure/make/make install dance. See the INSTALL file for more details.
50 These steps are necessary to fully support Chicken Scheme, but are
51 not required for any other scheme.
53 - Install the necessary support eggs:
54 $ chicken-install -s apropos chicken-doc
55 - Update the Chicken documentation database:
56 $ cd `csi -p '(chicken-home)'`
57 $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx
61 The loading invocations above install all supported Scheme
62 implementations. You can list explicitly the ones that you want by
63 setting the variable `geiser-active-implementations' *before*
64 loading geiser.el. For instance:
66 (setq geiser-active-implementations '(chicken guile))
68 On opening a scheme file, Geiser will try to guess its Scheme,
69 defaulting to the first in the list. Use `C-c C-s' to select the
70 implementation by hand (on a per file basis).
72 Check the geiser customization group for some options with:
74 M-x customize-group RET geiser RET
76 In particular, customize `geiser-<impl>-binary', which should point
77 to an executable in your path.
79 To start a REPL, M-x geiser.
81 ** Completion with company-mode
83 Geiser offers identifier and module name completion, bound to
84 M-TAB and M-` respectively. Only names visible in the current
87 While that is cool and all, things are even better: if you have
88 company-mode (http://company-mode.github.io/) installed,
89 Geiser's completion will use it. Just require company-mode and,
90 from then on, any new scheme buffer or REPL will use it.
96 |-------------+-------------------------------------------------|
97 | C-c C-z | Switch to REPL |
98 | C-c C-a | Switch to REPL and current module |
99 | C-c C-s | Specify Scheme implementation for buffer |
100 |-------------+-------------------------------------------------|
101 | M-. | Go to definition of identifier at point |
102 | M-, | Go back to where M-. was last invoked |
103 | C-c C-e m | Ask for a module and open its file |
104 | C-c C-e C-l | Add a given directory to Scheme's load path |
105 | C-c C-e [ | Toggle between () and [] for current form |
106 |-------------+-------------------------------------------------|
107 | C-M-x | Eval definition around point |
108 | C-c M-e | Eval definition around point and switch to REPL |
109 | C-x C-e | Eval sexp before point |
110 | C-c C-r | Eval region |
111 | C-c M-r | Eval region and switch to REPL |
112 | C-c C-b | Eval buffer |
113 | C-c M-b | Eval buffer and switch to REPL |
114 |-------------+-------------------------------------------------|
115 | C-c C-m x | Macro-expand definition around point |
116 | C-c C-m e | Macro-expand sexp before point |
117 | C-c C-m r | Macro-expand region |
118 |-------------+-------------------------------------------------|
119 | C-c C-k | Compile and load current file |
120 |-------------+-------------------------------------------------|
121 | C-c C-d d | See documentation for identifier at point |
122 | C-c C-d s | See short documentation for identifier at point |
123 | C-c C-d i | Look up manual for identifier at point |
124 | C-c C-d m | See a list of a module's exported identifiers |
125 | C-c C-d a | Toggle autodoc mode |
126 |-------------+-------------------------------------------------|
127 | C-c < | Show callers of procedure at point |
128 | C-c > | Show callees of procedure at point |
129 |-------------+-------------------------------------------------|
130 | M-TAB | Complete identifier at point |
131 | M-`, C-. | Complete module name at point |
132 | TAB | Complete identifier at point or indent |
133 | | (If `geiser-mode-smart-tab-p' is t) |
134 |-------------+-------------------------------------------------|
138 |-------------+----------------------------------------------------|
139 | C-c C-z | Start Scheme REPL, or jump to previous buffer |
140 | C-c M-o | Clear scheme output |
141 | C-c C-q | Kill Scheme process |
142 | C-c C-k | Nuke REPL: use it if the REPL becomes unresponsive |
143 |-------------+----------------------------------------------------|
144 | M-. | Edit identifier at point |
145 | TAB, M-TAB | Complete identifier at point |
146 | M-`, C-. | Complete module name at point |
147 | M-p, M-n | Prompt history, matching current prefix |
148 |-------------+----------------------------------------------------|
149 | C-c C-m | Set current module |
150 | C-c C-i | Import module into current namespace |
151 | C-c C-r | Add a given directory to scheme's load path |
152 |-------------+----------------------------------------------------|
153 | C-c C-d C-d | See documentation for symbol at point |
154 | C-c C-d C-m | See documentation for module |
155 | C-c C-d C-a | Toggle autodoc mode |
156 |-------------+----------------------------------------------------|
158 ** In the documentation browser:
160 |----------+----------------------------------------------|
162 | b | Previous page |
163 |----------+----------------------------------------------|
164 | TAB, n | Next link |
165 | S-TAB, p | Previous link |
167 | P | Previous section |
168 |----------+----------------------------------------------|
169 | k | Kill current page and go to previous or next |
170 | g, r | Refresh page |
171 | c | Clear browsing history |
172 |----------+----------------------------------------------|
173 | ., M-. | Edit identifier at point |
174 | z | Switch to REPL |
175 |----------+----------------------------------------------|
177 |----------+----------------------------------------------|
179 ** In backtrace (evaluation/compile result) buffers:
181 - M-g n, M-g p, C-x ` for error navigation.