summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2010-10-15 18:16:20 +0200
committerJose Antonio Ortega Ruiz <jao@gnu.org>2010-10-15 18:16:20 +0200
commit87d45c87438dcc88515d38b4ffd53275ab8bb65b (patch)
tree03682455586e23751847eafc282316f1bd65f063 /README.org
parentf3d1d1d934fbe92c56718c75fc5344f837f916a8 (diff)
downloadgeiser-87d45c87438dcc88515d38b4ffd53275ab8bb65b.tar.gz
geiser-87d45c87438dcc88515d38b4ffd53275ab8bb65b.tar.bz2
README tweaks
Diffstat (limited to 'README.org')
-rw-r--r--README.org53
1 files changed, 50 insertions, 3 deletions
diff --git a/README.org b/README.org
index 203a877..304ceac 100644
--- a/README.org
+++ b/README.org
@@ -39,30 +39,42 @@
file system. Let's call that place <path-to-geiser>.
- In your .emacs:
+ #+BEGIN_SRC emacs-lisp
(load-file "<path-to-geiser>/elisp/geiser.el")
+ #+END_SRC
*** Byte-compiled
- Create a build directory, `build', say:
+ #+BEGIN_SRC shell
$ cd <path-to-geiser>
$ mkdir build; cd build
+ #+END_SRC
- Configure and make:
+ #+BEGIN_SRC shell
$ ../configure && make
+ #+END_SRC
Now, you can use the byte-compiled Geiser in place by adding to
your .emacs:
+ #+BEGIN_SRC emacs-lisp
(load "<path-to-geiser>/build/elisp/geiser-load")
+ #+END_SRC
or, alternatively, install it with:
- $ make install
+ #+BEGIN_SRC shell
+ $ make install
+ #+END_SRC
(you might need to get root access, depending on your installation
directory) and, instead of the above load forms, require
'geiser-install (not 'geiser, mind you) in your emacs
initialization file:
- (require 'geiser-install)
+ #+BEGIN_SRC emacs-lisp
+ (require 'geiser-install)
+ #+END_SRC
You're ready to go!
@@ -72,7 +84,9 @@
setting the variable `geiser-impl-installed-implementations' *before*
loading geiser.el. For instance:
- (setq geiser-impl-installed-implementations '(racket guile))
+ #+BEGIN_SRC emacs-lisp
+ (setq geiser-impl-installed-implementations '(racket guile))
+ #+END_SRC
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
@@ -104,37 +118,55 @@
|---------------------+-------------------------------------------------|
| C-c C-z | Switch to REPL |
+ |---------------------+-------------------------------------------------|
| C-u C-c C-z | Switch to REPL and current module |
+ |---------------------+-------------------------------------------------|
| 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) |
|---------------------+-------------------------------------------------|
@@ -143,10 +175,13 @@
|-------------+----------------------------------------------------|
| C-c C-z | Start Scheme REPL, or jump to previous buffer |
+ |-------------+----------------------------------------------------|
| C-c C-q | Kill Scheme process |
|-------------+----------------------------------------------------|
| 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 |
@@ -154,11 +189,15 @@
| C-c C-k | Nuke REPL: use it if the REPL becomes unresponsive |
|-------------+----------------------------------------------------|
| C-c C-m | Set current module |
+ |-------------+----------------------------------------------------|
| C-c C-i | Import module into current namespace |
+ |-------------+----------------------------------------------------|
| C-c C-l | Load scheme file |
|-------------+----------------------------------------------------|
| C-c C-d C-d | See documentation for symbol at point |
+ |-------------+----------------------------------------------------|
| C-c C-d C-m | See documentation for module |
+ |-------------+----------------------------------------------------|
| C-c C-d C-a | Toggle autodoc mode |
|-------------+----------------------------------------------------|
@@ -166,13 +205,21 @@
|------------+----------------------------------------------|
| n, f | Next page |
+ |------------+----------------------------------------------|
| p, b | Previous page |
+ |------------+----------------------------------------------|
| TAB, S-TAB | Next/previous link |
+ |------------+----------------------------------------------|
| k | Kill current page and go to previous or next |
+ |------------+----------------------------------------------|
| g, r | Refresh page |
+ |------------+----------------------------------------------|
| c | Clear browsing history |
+ |------------+----------------------------------------------|
| ., M-. | Edit identifier at point |
+ |------------+----------------------------------------------|
| z | Switch to REPL |
+ |------------+----------------------------------------------|
| q | Bury buffer |
|------------+----------------------------------------------|