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
  23 * Supported scheme implementations
  24
  25     - Guile 2.0 (not released yet: use the latest git master branch).
  26     - PLT Racket 5.0.1 or better.
  27
  28 * Installation
  29   Geiser can be used either directly from its uninstalled source tree
  30   or byte-compiled and installed after perfoming the standard
  31   configure/make/make install dance.
  32
  33 *** In place
  34     - Extract the tarball or clone the git repository anywhere in your
  35       file system. Let's call that place <path-to-geiser>.
  36     - In your .emacs:
  37
  38       (load-file "<path-to-geiser>/elisp/geiser.el")
  39
  40 *** Byte-compiled
  41     - Create a build directory, `build', say:
  42       $ cd <path-to-geiser>
  43       $ mkdir build; cd build
  44     - Configure and make:
  45       $ ../configure && make
  46     - Install it with:
  47       $ make install
  48
  49     (you might need to get root access, depending on your installation
  50     directory) and require 'geiser-install (not 'geiser, mind you) in
  51     your emacs initialization file:
  52
  53       (require 'geiser-install)
  54
  55     You're ready to go!
  56
  57 * Basic configuration
  58   The loading invocations above install all supported Scheme
  59   implementations. You can list explicitly the ones that you want by
  60   setting the variable `geiser-impl-installed-implementations' *before*
  61   loading geiser.el. For instance:
  62
  63       (setq geiser-impl-installed-implementations '(racket guile))
  64
  65    On opening a scheme file, Geiser will try to guess its Scheme,
  66    defaulting to the first in the list. Use `C-c C-s' to select the
  67    implementation by hand (on a per file basis).
  68
  69   Check the geiser customization group for some options with:
  70
  71       M-x customize-group RET geiser RET
  72
  73   In particular, customize `geiser-repl-<impl>-binary' (in
  74   geiser-repl), which should point to an executable in your path.
  75
  76   To start a REPL, M-x geiser.
  77
  78 *** Completion with company-mode
  79     Geiser offers identifier and module name completion, bound to
  80     M-TAB and M-` respectively. Only names visible in the current
  81     module are offered.
  82
  83     While that is cool and all, things are even better: if you have
  84     [[http://nschum.de/src/emacs/company-mode/][company-mode]] installed, Geiser's completion will use it. Just
  85     require company-mode and, from then on, any new scheme buffer or
  86     REPL will use it. If you didn't know about Nikolaj Schumacher's
  87     awesome mode, check [[http://www.screentoaster.com/watch/stU0lSRERIR1pYRFVdXVlRVFFV/company_mode_for_gnu_emacs][this screencast]].
  88
  89 * Quick key reference
  90
  91 *** In Scheme buffers:
  92
  93     |---------------------+-------------------------------------------------|
  94     | C-c C-z             | Switch to REPL                                  |
  95     | C-u C-c C-z         | Switch to REPL and current module               |
  96     | C-c C-s             | Specify Scheme implementation for buffer        |
  97     |---------------------+-------------------------------------------------|
  98     | M-.                 | Go to definition of identifier at point         |
  99     | M-,                 | Go back to where M-. was last invoked           |
 100     | C-c C-e m           | Ask for a module and open its file              |
 101     |---------------------+-------------------------------------------------|
 102     | C-M-x               | Eval definition around point                    |
 103     | C-c M-e             | Eval definition around point and switch to REPL |
 104     | C-x C-e             | Eval sexp before point                          |
 105     | C-c C-r             | Eval region                                     |
 106     | C-c M-r             | Eval region and switch to REPL                  |
 107     |---------------------+-------------------------------------------------|
 108     | C-c C-m x           | Macro-expand definition around point            |
 109     | C-c C-m e           | Macro-expand sexp before point                  |
 110     | C-c C-m r           | Marcro-expand region                            |
 111     | C-u C-c C-m [x,e,r] | (With prefix, macro expansions are recursive)   |
 112     |---------------------+-------------------------------------------------|
 113     | C-c C-k             | Compile and load current file                   |
 114     | C-c C-l             | Load current file                               |
 115     |---------------------+-------------------------------------------------|
 116     | C-c C-d d           | See documentation for identifier at point       |
 117     | C-c C-d m           | See a list of a module's exported identifiers   |
 118     | C-c C-d a           | Toggle autodoc mode                             |
 119     |---------------------+-------------------------------------------------|
 120     | C-c<                | Show callers of procedure at point              |
 121     | C-c>                | Show callees of procedure at point              |
 122     | C-c C-x f           | See a generic's methods signatures              |
 123     |---------------------+-------------------------------------------------|
 124     | M-TAB               | Complete identifier at point                    |
 125     | M-`, C-.            | Complete module name at point                   |
 126     | TAB                 | Complete identifier at point or indent          |
 127     |                     | (If `geiser-mode-smart-tab-p' is t)             |
 128     |---------------------+-------------------------------------------------|
 129
 130 *** In the REPL
 131
 132     |-------------+----------------------------------------------------|
 133     | C-c C-z     | Start Scheme REPL, or jump to previous buffer      |
 134     | C-c C-q     | Kill Scheme process                                |
 135     |-------------+----------------------------------------------------|
 136     | M-.         | Edit identifier at point                           |
 137     | TAB, M-TAB  | Complete identifier at point                       |
 138     | M-`, C-.    | Complete module name at point                      |
 139     |-------------+----------------------------------------------------|
 140     | M-p, M-n    | Prompt history, matching current prefix            |
 141     |-------------+----------------------------------------------------|
 142     | C-c C-k     | Nuke REPL: use it if the REPL becomes unresponsive |
 143     |-------------+----------------------------------------------------|
 144     | C-c C-m     | Set current module                                 |
 145     | C-c C-i     | Import module into current namespace               |
 146     | C-c C-l     | Load scheme file                                   |
 147     |-------------+----------------------------------------------------|
 148     | C-c C-d C-d | See documentation for symbol at point              |
 149     | C-c C-d C-m | See documentation for module                       |
 150     | C-c C-d C-a | Toggle autodoc mode                                |
 151     |-------------+----------------------------------------------------|
 152
 153 *** In the documentation browser:
 154
 155     |------------+----------------------------------------------|
 156     | n, f       | Next page                                    |
 157     | p, b       | Previous page                                |
 158     | TAB, S-TAB | Next/previous link                           |
 159     | k          | Kill current page and go to previous or next |
 160     | g, r       | Refresh page                                 |
 161     | c          | Clear browsing history                       |
 162     | ., M-.     | Edit identifier at point                     |
 163     | z          | Switch to REPL                               |
 164     | q          | Bury buffer                                  |
 165     |------------+----------------------------------------------|
 166
 167 *** In backtrace (evaluation/compile result) buffers:
 168
 169     - TAB, M-TAB for error navigation.
 170     - q to bury buffer.