README.org

   1 * Overview
   2
   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:
   6
   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.
  24
  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).
  28
  29 * Requirements
  30
  31     Geiser needs Emacs 23.2 or better, and at least one of the
  32     supported scheme implementations:
  33       - Guile 2.2 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.
  38       - Chez 9.4 or better.
  39
  40 * Installation
  41
  42   The easiest way is to use MELPA, and just type
  43   =M-x package-install RET geiser= inside emacs.
  44
  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.
  48
  49 ** Chicken Addendum
  50     These steps are necessary to fully support Chicken Scheme, but are
  51     not required for any other scheme.
  52
  53     - Install the necessary support eggs:
  54
  55 #+BEGIN_EXAMPLE
  56      $ chicken-install -s apropos chicken-doc
  57 #+END_EXAMPLE
  58
  59     - Update the Chicken documentation database:
  60
  61 #+BEGIN_EXAMPLE
  62      $ cd `csi -p '(chicken-home)'`
  63      $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx
  64 #+END_EXAMPLE
  65
  66 * Basic configuration
  67
  68   The loading invocations above install all supported Scheme
  69   implementations. You can list explicitly the ones that you want by
  70   setting the variable =geiser-active-implementations= *before* loading
  71   geiser.el. For instance:
  72
  73 #+BEGIN_SRC elisp
  74     (setq geiser-active-implementations '(chicken guile))
  75 #+END_SRC
  76
  77   On opening a scheme file, Geiser will try to guess its Scheme,
  78   defaulting to the first in the list. Use =C-c C-s= to select the
  79   implementation by hand (on a per file basis).
  80
  81   Check the geiser customization group for some options with:
  82
  83 #+BEGIN_EXAMPLE
  84       M-x customize-group RET geiser RET
  85 #+END_EXAMPLE
  86
  87   In particular, customize =geiser-<impl>-binary=, which should point
  88   to an executable in your path.
  89
  90   To start a REPL, =M-x geiser=.
  91
  92 ** Completion with company-mode
  93
  94     Geiser offers identifier and module name completion, bound to
  95     =M-TAB= and =M-`= respectively. Only names visible in the current
  96     module are offered.
  97
  98     While that is cool and all, things are even better: if you have
  99     [[http://company-mode.github.io/][company mode]] installed, Geiser's completion will use it. Just
 100     require company-mode and, from then on, any new scheme buffer or
 101     REPL will use it.
 102
 103 * Quick key reference
 104
 105 ** In Scheme buffers:
 106
 107    |-------------+--------------------------------------------------|
 108    | C-c C-s     | Specify Scheme implementation for buffer         |
 109    | C-c C-z     | Switch to REPL                                   |
 110    | C-c C-a     | Switch to REPL and current module                |
 111    |             |                                                  |
 112    |-------------+--------------------------------------------------|
 113    | M-.         | Go to definition of identifier at point          |
 114    | M-,         | Go back to where M-. was last invoked            |
 115    | C-c C-e m   | Ask for a module and open its file               |
 116    | C-c C-e C-l | Add a given directory to Scheme's load path      |
 117    | C-c C-e [   | Toggle between () and [] for current form        |
 118    |             |                                                  |
 119    |-------------+--------------------------------------------------|
 120    | C-M-x       | Eval definition around point                     |
 121    | C-c C-c     | 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    | C-c C-b     | Eval buffer                                      |
 127    | C-c M-b     | Eval buffer and switch to REPL                   |
 128    |             |                                                  |
 129    |-------------+--------------------------------------------------|
 130    | C-c C-m x   | Macro-expand definition around point             |
 131    | C-c C-m e   | Macro-expand sexp before point                   |
 132    | C-c C-m r   | Macro-expand region                              |
 133    |             |                                                  |
 134    |-------------+--------------------------------------------------|
 135    | C-c C-k     | Compile and load current buffer                  |
 136    | C-c C-l     | Load scheme file                                 |
 137    | C-u C-c C-k | Compile and load current buffer, restarting REPL |
 138    |             |                                                  |
 139    |-------------+--------------------------------------------------|
 140    | C-c C-d d   | See documentation for identifier at point        |
 141    | C-c C-d s   | See short documentation for identifier at point  |
 142    | C-c C-d i   | Look up manual for identifier at point           |
 143    | C-c C-d m   | See a list of a module's exported identifiers    |
 144    | C-c C-d a   | Toggle autodoc mode                              |
 145    |             |                                                  |
 146    |-------------+--------------------------------------------------|
 147    | C-c <       | Show callers of procedure at point               |
 148    | C-c >       | Show callees of procedure at point               |
 149    |             |                                                  |
 150    |-------------+--------------------------------------------------|
 151    | M-TAB       | Complete identifier at point                     |
 152    | M-`, C-.    | Complete module name at point                    |
 153    | TAB         | Complete identifier at point or indent           |
 154    |             | (If geiser-mode-smart-tab-p is t)                |
 155    |-------------+--------------------------------------------------|
 156
 157 ** In the REPL
 158
 159     |-------------+----------------------------------------------------|
 160     | C-c C-z     | Start Scheme REPL, or jump to previous buffer      |
 161     | C-c M-o     | Clear scheme output                                |
 162     | C-c C-q     | Kill Scheme process                                |
 163     | C-c C-l     | Load scheme file                                   |
 164     | C-c C-k     | Nuke REPL: use it if the REPL becomes unresponsive |
 165     |             |                                                    |
 166     |-------------+----------------------------------------------------|
 167     | M-.         | Edit identifier at point                           |
 168     | TAB, M-TAB  | Complete identifier at point                       |
 169     | M-`, C-.    | Complete module name at point                      |
 170     | M-p, M-n    | Prompt history, matching current prefix            |
 171     |             |                                                    |
 172     |-------------+----------------------------------------------------|
 173     | C-c C-m     | Set current module                                 |
 174     | C-c C-i     | Import module into current namespace               |
 175     | C-c C-r     | Add a given directory to scheme's load path        |
 176     |             |                                                    |
 177     |-------------+----------------------------------------------------|
 178     | C-c C-d C-d | See documentation for symbol at point              |
 179     | C-c C-d C-m | See documentation for module                       |
 180     | C-c C-d C-a | Toggle autodoc mode                                |
 181     |-------------+----------------------------------------------------|
 182
 183 ** In the documentation browser:
 184
 185     |----------+----------------------------------------------|
 186     | f        | Next page                                    |
 187     | b        | Previous page                                |
 188     |          |                                              |
 189     |----------+----------------------------------------------|
 190     | TAB, n   | Next link                                    |
 191     | S-TAB, p | Previous link                                |
 192     | N        | Next section                                 |
 193     | P        | Previous section                             |
 194     |          |                                              |
 195     |----------+----------------------------------------------|
 196     | k        | Kill current page and go to previous or next |
 197     | g, r     | Refresh page                                 |
 198     | c        | Clear browsing history                       |
 199     |          |                                              |
 200     |----------+----------------------------------------------|
 201     | ., M-.   | Edit identifier at point                     |
 202     | z        | Switch to REPL                               |
 203     |          |                                              |
 204     |----------+----------------------------------------------|
 205     | q        | Bury buffer                                  |
 206     |----------+----------------------------------------------|
 207
 208 ** In backtrace (evaluation/compile result) buffers:
 209
 210     - =M-g n=, =M-g p=, =C-x `= for error navigation.
 211     - =q= to bury buffer.