| blob | 14d11a87506e1d30d4adc8c04e76f84db8934b1f |
1 * Overview
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.
8 - Macro expansion.
9 - File/module loading.
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
21 buffer).
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).
29 * Requirements
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 5.3 or better.
36 * Installation
37 Geiser can be used either directly from its uninstalled source tree
38 or byte-compiled and installed after perfoming the standard
39 configure/make/make install dance.
41 *** In place
42 - Extract the tarball or clone the git repository anywhere in your
43 file system. Let's call that place <path-to-geiser>.
44 - In your .emacs:
46 (load-file "<path-to-geiser>/elisp/geiser.el")
48 *** Byte-compiled
49 - Create a build directory, `build', say:
50 $ cd <path-to-geiser>
51 $ mkdir build; cd build
52 - Configure and make:
53 $ ../configure && make
55 Now, you can use the byte-compiled Geiser in place by adding to
56 your .emacs:
58 (load "<path-to-geiser>/build/elisp/geiser-load")
60 or, alternatively, install it with:
62 $ make install
64 (you might need to get root access, depending on your installation
65 directory) and, instead of the above load forms, require
66 'geiser-install (not 'geiser, mind you) in your emacs
67 initialization file:
69 (require 'geiser-install)
71 You're ready to go!
73 * Basic configuration
74 The loading invocations above install all supported Scheme
75 implementations. You can list explicitly the ones that you want by
76 setting the variable `geiser-impl-installed-implementations' *before*
77 loading geiser.el. For instance:
79 (setq geiser-impl-installed-implementations '(racket guile))
81 On opening a scheme file, Geiser will try to guess its Scheme,
82 defaulting to the first in the list. Use `C-c C-s' to select the
83 implementation by hand (on a per file basis).
85 Check the geiser customization group for some options with:
87 M-x customize-group RET geiser RET
89 In particular, customize `geiser-<impl>-binary', which should point
90 to an executable in your path.
92 To start a REPL, M-x geiser.
94 *** Completion with company-mode
95 Geiser offers identifier and module name completion, bound to
96 M-TAB and M-` respectively. Only names visible in the current
97 module are offered.
99 While that is cool and all, things are even better: if you have
100 company-mode (http://nschum.de/src/emacs/company-mode/) installed,
101 Geiser's completion will use it. Just require company-mode and,
102 from then on, any new scheme buffer or REPL will use it. If you
103 didn't know about Nikolaj Schumacher's awesome mode, check this
104 screencast: http://goo.gl/yxLQ.
106 * Quick key reference
108 *** In Scheme buffers:
110 |-------------+-------------------------------------------------|
111 | C-c C-z | Switch to REPL |
112 | C-c C-a | Switch to REPL and current module |
113 | C-c C-s | Specify Scheme implementation for buffer |
114 |-------------+-------------------------------------------------|
115 | M-. | Go to definition of identifier at point |
116 | M-, | Go back to where M-. was last invoked |
117 | C-c C-e m | Ask for a module and open its file |
118 | C-c C-e C-l | Add a given directory to Scheme's load path |
119 | C-c C-e [ | Toggle between () and [] for current form |
120 |-------------+-------------------------------------------------|
121 | C-M-x | Eval definition around point |
122 | C-c M-e | Eval definition around point and switch to REPL |
123 | C-x C-e | Eval sexp before point |
124 | C-c C-r | Eval region |
125 | C-c M-r | Eval region and switch to REPL |
126 |-------------+-------------------------------------------------|
127 | C-c C-m x | Macro-expand definition around point |
128 | C-c C-m e | Macro-expand sexp before point |
129 | C-c C-m r | Marcro-expand region |
130 |-------------+-------------------------------------------------|
131 | C-c C-k | Compile and load current file |
132 |-------------+-------------------------------------------------|
133 | C-c C-d d | See documentation for identifier at point |
134 | C-c C-d s | See short documentation for identifier at point |
135 | C-c C-d i | Look up manual for identifier at point |
136 | C-c C-d m | See a list of a module's exported identifiers |
137 | C-c C-d a | Toggle autodoc mode |
138 |-------------+-------------------------------------------------|
139 | C-c < | Show callers of procedure at point |
140 | C-c > | Show callees of procedure at point |
141 |-------------+-------------------------------------------------|
142 | M-TAB | Complete identifier at point |
143 | M-`, C-. | Complete module name at point |
144 | TAB | Complete identifier at point or indent |
145 | | (If `geiser-mode-smart-tab-p' is t) |
146 |-------------+-------------------------------------------------|
148 *** In the REPL
150 |-------------+----------------------------------------------------|
151 | C-c C-z | Start Scheme REPL, or jump to previous buffer |
152 | C-c C-q | Kill Scheme process |
153 | C-c C-k | Nuke REPL: use it if the REPL becomes unresponsive |
154 |-------------+----------------------------------------------------|
155 | M-. | Edit identifier at point |
156 | TAB, M-TAB | Complete identifier at point |
157 | M-`, C-. | Complete module name at point |
158 | M-p, M-n | Prompt history, matching current prefix |
159 |-------------+----------------------------------------------------|
160 | C-c C-m | Set current module |
161 | C-c C-i | Import module into current namespace |
162 | C-c C-r | Add a given directory to scheme's load path |
163 |-------------+----------------------------------------------------|
164 | C-c C-d C-d | See documentation for symbol at point |
165 | C-c C-d C-m | See documentation for module |
166 | C-c C-d C-a | Toggle autodoc mode |
167 |-------------+----------------------------------------------------|
169 *** In the documentation browser:
171 |----------+----------------------------------------------|
172 | f | Next page |
173 | b | Previous page |
174 |----------+----------------------------------------------|
175 | TAB, n | Next link |
176 | S-TAB, p | Previous link |
177 | N | Next section |
178 | P | Previous section |
179 |----------+----------------------------------------------|
180 | k | Kill current page and go to previous or next |
181 | g, r | Refresh page |
182 | c | Clear browsing history |
183 |----------+----------------------------------------------|
184 | ., M-. | Edit identifier at point |
185 | z | Switch to REPL |
186 |----------+----------------------------------------------|
187 | q | Bury buffer |
188 |----------+----------------------------------------------|
190 *** In backtrace (evaluation/compile result) buffers:
192 - M-g n, M-g p, C-x ` for error navigation.
193 - q to bury buffer.