README

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