* Overview Geiser is a generic Emacs/Scheme interaction mode, featuring an enhanced REPL and a set of minor modes improving Emacs' basic scheme major mode. The main functionalities provided are: - Evaluation of forms in the namespace of the current module. - Macro expansion. - File/module loading. - Namespace-aware identifier completion (including local bindings, names visible in the current module, and module names). - Autodoc: the echo area shows information about the signature of the procedure/macro around point automatically. - Jump to definition of identifier at point. - Access to documentation (including docstrings when the implementation provides it). - Listings of identifiers exported by a given module. - Listings of callers/callees of procedures. - Rudimentary support for debugging (list of evaluation/compilation error in an Emacs' compilation-mode buffer). * Supported scheme implementations - Guile 1.9.3 or better. - PLT Scheme 4.1.5.5 or better. * Installation Geiser can be used either directly from its uninstalled source tree or byte-compiled and installed after perfoming the standard configure/make/make install dance. *** In place - Extract the tarball or clone the git repository anywhere in your file system. Let's call that place . - In your .emacs: (load-file "/elisp/geiser.el") *** Byte-compiled - Create a build directory, `build', say: $ cd $ mkdir build; cd build - Configure and make: $ ../configure && make You'll have a directory called "elisp" which contains Geiser's elisp bytecode. Now, you can either use it in place, with the .emacs incantation: (load-file "/build/elisp/geiser.elc") or install it with: $ make install and require 'geiser-install (not 'geiser, mind you) in your emacs initialization file: (require 'geiser-install) You're ready to go! * Basic configuration The loading invocations above install all supported Scheme implementations. You can list explicitly the ones that you want by setting the variable `geiser-impl-installed-implementations' *before* loading geiser.el. For instance: (setq geiser-impl-installed-implementations '(plt guile)) On opening a scheme file, Geiser will try to guess its Scheme, defaulting to the first in the list. Use `C-c C-s' to select the implementation by hand (on a per file basis). Check the geiser customization group for some options with: M-x customize-group RET geiser RET In particular, customize `geiser-repl--binary' (in geiser-repl), which should point to an executable in your path. To start a REPL, M-x geiser. *** Completion with company-mode Geiser offers identifier and module name completion, bound to M-TAB and M-` respectively. Only names visible in the current module are offered. While that is cool and all, things are even better: if you have [[http://nschum.de/src/emacs/company-mode/][company-mode]] installed, Geiser's completion will use it. Just require company-mode and, from then on, any new scheme buffer or REPL will use it. If you didn't know about Nikolaj Schumacher's awesome mode, check [[http://www.screentoaster.com/watch/stU0lSRERIR1pYRFVdXVlRVFFV/company_mode_for_gnu_emacs][this screencast]]. * Quick key reference *** In Scheme buffers: |---------------------+-------------------------------------------------| | C-c C-z | Switch to REPL | | C-c C-s | Specify Scheme implementation for buffer | |---------------------+-------------------------------------------------| | M-. | Go to definition of identifier at point | | M-, | Go back to where M-. was last invoked | | C-c C-e m | Ask for a module and open its file | |---------------------+-------------------------------------------------| | C-M-x | Eval definition around point | | C-c M-e | Eval definition around point and switch to REPL | | C-x C-e | Eval sexp before point | | C-c C-r | Eval region | | C-c M-r | Eval region and switch to REPL | |---------------------+-------------------------------------------------| | C-c C-m x | Macro-expand definition around point | | C-c C-m e | Macro-expand sexp before point | | C-c C-m r | Marcro-expand region | | C-u C-c C-m [x,e,r] | (With prefix, macro expansions are recursive) | |---------------------+-------------------------------------------------| | C-c C-k | Compile and load current file | | C-c C-l | Load current file | |---------------------+-------------------------------------------------| | C-c C-d d | See documentation for identifier at point | | C-c C-d m | See a list of a module's exported identifiers | | C-c C-d a | Toggle autodoc mode | |---------------------+-------------------------------------------------| | C-c< | Show callers of procedure at point | | C-c> | Show callees of procedure at point | | C-c C-x f | See a generic's methods signatures | |---------------------+-------------------------------------------------| | M-TAB | Complete identifier at point | | M-`, C-. | Complete module name at point | | TAB | Complete identifier at point or indent | | | (If `geiser-mode-smart-tab-p' is t) | |---------------------+-------------------------------------------------| *** In the REPL |----------------+----------------------------------------------------| | C-c C-z, C-c z | Start Scheme REPL (if it's not running) | |----------------+----------------------------------------------------| | M-. | Edit identifier at point | | TAB, M-TAB | Complete identifier at point | | M-`, C-. | Complete module name at point | |----------------+----------------------------------------------------| | M-p, M-n | Prompt history, matching current prefix | |----------------+----------------------------------------------------| | C-c C-k, C-c k | Nuke REPL: use it if the REPL becomes unresponsive | |----------------+----------------------------------------------------| | C-c l | Load scheme file | |----------------+----------------------------------------------------| | C-c d | See documentation for identifier at point | | C-c m | See module documentation | | C-c a | Toggle autodoc mode | |----------------+----------------------------------------------------| *** In the documentation browser: |-----------+----------------------------------------------| | n/p | next/previous page | | l | previous page | | SPC/S-SPC | scroll up/down | | TAB/S-TAB | next/previous link | | k | kill current page and go to previous or next | | r | refresh page | | c | clean browsing history | | M-. | edit identifier at point | | C-cz | switch to REPL | | q | bury buffer | |-----------+----------------------------------------------| *** In backtrace (evaluation/compile result) buffers: - Default error navigation keys used by Emacs' compilation mode (e.g. M-g n, M-g p for next/previous error). - q to bury buffer.