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