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