diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/cheat.texi | 24 | ||||
| -rw-r--r-- | doc/geiser.css | 1 | ||||
| -rw-r--r-- | doc/geiser.texi | 6 | ||||
| -rw-r--r-- | doc/img/repl-mod.png | bin | 13151 -> 17604 bytes | |||
| -rw-r--r-- | doc/install.texi | 2 | ||||
| -rw-r--r-- | doc/intro.texi | 12 | ||||
| -rw-r--r-- | doc/macros.texi | 4 | ||||
| -rw-r--r-- | doc/parens.texi (renamed from doc/fun.texi) | 70 | ||||
| -rw-r--r-- | doc/repl.texi | 116 | ||||
| -rw-r--r-- | doc/thanks.texi | 2 | ||||
| -rw-r--r-- | doc/web.texi | 4 |
12 files changed, 142 insertions, 101 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 247b03d..f2b16bb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -19,7 +19,7 @@ geiser_TEXINFOS = \ intro.texi \ install.texi \ repl.texi \ - fun.texi \ + parens.texi \ cheat.texi \ thanks.texi \ index.texi diff --git a/doc/cheat.texi b/doc/cheat.texi index 6087949..4e81b92 100644 --- a/doc/cheat.texi +++ b/doc/cheat.texi @@ -1,4 +1,4 @@ -@node Cheat sheet, No hacker is an island, Fun between the parens, Top +@node Cheat sheet, No hacker is an island, Between the parens, Top @chapter Cheat sheet @menu @@ -31,6 +31,9 @@ @item C-c C-e C-m @tab geiser-edit-module @tab Ask for a module and open its file +@item C-c C-e C-[ +@tab geiser-squarify +@tab Toggle between () and [] for current form @item @tab @tab @item C-M-x @tab geiser-eval-definition @@ -106,11 +109,17 @@ @tab Kill Scheme process @item C-c C-k @tab geiser-repl-nuke -@tab Nuke REPL: use it if the REPL becomes unresponsive +@tab Soft restart for unresponsive REPL @item M-. @tab geiser-edit-symbol-at-point @tab Edit identifier at point -@item TAB, M-TAB +@item TAB +@tab geiser-completion--tab +@tab Complete, indent or go to next error +@item S-TAB (backtab) +@tab geiser-completion--previous-error +@tab Go to previous error in the REPL buffer +@item M-TAB @tab geiser-completion--complete-symbol @tab Complete identifier at point @item M-`, C-. @@ -171,8 +180,9 @@ @tab Bury buffer @end multitable -@flushright -. -@end flushright - +@ifhtml +@html +<hr> +@end html +@end ifhtml diff --git a/doc/geiser.css b/doc/geiser.css index e0ffb18..d05f909 100644 --- a/doc/geiser.css +++ b/doc/geiser.css @@ -14,6 +14,7 @@ body { } a { color:black; weight=normal } +a:hover { color: #a22 } hr { height:0; color:white } diff --git a/doc/geiser.texi b/doc/geiser.texi index 2e7ef93..0294246 100644 --- a/doc/geiser.texi +++ b/doc/geiser.texi @@ -50,7 +50,7 @@ The document was typeset with * Introduction:: * Installation:: * The REPL:: -* Fun between the parens:: +* Between the parens:: * Cheat sheet:: * No hacker is an island:: * Index:: @@ -78,7 +78,7 @@ The REPL * Autodoc and friends:: * Customization and tips:: -Fun between the parens +Between the parens * Activating Geiser:: * The source and the REPL:: @@ -106,7 +106,7 @@ Cheat sheet @include intro.texi @include install.texi @include repl.texi -@include fun.texi +@include parens.texi @include cheat.texi @include thanks.texi @include index.texi diff --git a/doc/img/repl-mod.png b/doc/img/repl-mod.png Binary files differindex d1060bd..a2dcb10 100644 --- a/doc/img/repl-mod.png +++ b/doc/img/repl-mod.png diff --git a/doc/install.texi b/doc/install.texi index b260504..a4ea362 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -19,7 +19,7 @@ at least one of the supported schemes, which right now are latest and greatest @uref{http://www.gnu.org/software/guile, Guile} 1.9 directly compiled from a recent checkout of @uref{http://www.gnu.org/software/guile/repository.html, its Git -@i{master} branch}. Since Geiser supports multiple @repl{}s, having both +@i{master} branch}. Since Geiser supports multiple REPLs, having both of them will just add to the fun. @cindex use the source, Luke diff --git a/doc/intro.texi b/doc/intro.texi index 0805eca..f26fa7b 100644 --- a/doc/intro.texi +++ b/doc/intro.texi @@ -26,14 +26,14 @@ bulk of the code. @cindex current module @anchor{current-module} While being as generic as possible, the Scheme-Elisp interface makes some assumptions about the capabilities and -interaction mode of the corresponding @repl{}. In particular, Geiser +interaction mode of the corresponding REPL. In particular, Geiser expects the latter to support namespaces in the form of a module system, -and to provide a well defined way to establish the @repl{}'s current +and to provide a well defined way to establish the REPL's current namespace (or module), as well as the current's file module (or namespace). Thus, all evaluations performed by Geiser either in the -@repl{} or in a source code buffer happen in the context of the current +REPL or in a source code buffer happen in the context of the current namespace. Every time you switch to a different file, you're switching -namespaces automatically; at the @repl{}, you must request the switch +namespaces automatically; at the REPL, you must request the switch explicitly (usually just using means provided by the Scheme implementation itself). @@ -76,10 +76,10 @@ Listings of identifiers exported by a given module. @item Listings of callers/callees of procedures. @item -Rudimentary support for debugging (when the @repl{} provides a +Rudimentary support for debugging (when the REPL provides a debugging) and error navigation. @item -Support for multiple, simultaneous @repl{}s. +Support for multiple, simultaneous REPLs. @end itemize In the following pages, i'll try to explain what these features diff --git a/doc/macros.texi b/doc/macros.texi index 712370a..4b235db 100644 --- a/doc/macros.texi +++ b/doc/macros.texi @@ -1,7 +1,3 @@ -@macro repl{} -@acronym{REPL} -@end macro - @macro img{FILE, ALIGN} @ifhtml @html diff --git a/doc/fun.texi b/doc/parens.texi index 76301e2..78149e5 100644 --- a/doc/fun.texi +++ b/doc/parens.texi @@ -1,7 +1,7 @@ -@node Fun between the parens, Cheat sheet, The REPL, Top -@chapter Fun between the parens +@node Between the parens, Cheat sheet, The REPL, Top +@chapter Between the parens -A good @repl{} is a must, but just about half the story of a good Scheme +A good REPL is a must, but just about half the story of a good Scheme hacking environment. Well, perhaps a bit more than a half; but, at any rate, one surely needs also a pleasant way of editing source code. Don't pay attention to naysayers: Emacs comes with an excellent editor @@ -11,7 +11,7 @@ Geiser's support for writing Scheme code adds to Emacs' @code{scheme-mode}, rather than supplanting it; and it does so by means of a minor mode (unimaginatively dubbed @code{geiser-mode}) that defines a bunch of new commands to try and, with the help of the same Scheme -process giving you the @repl{}, make those Scheme buffers come to life. +process giving you the REPL, make those Scheme buffers come to life. @menu * Activating Geiser:: @@ -23,7 +23,7 @@ process giving you the @repl{}, make those Scheme buffers come to life. * Geiser writes for you:: @end menu -@node Activating Geiser, The source and the REPL, Fun between the parens, Fun between the parens +@node Activating Geiser, The source and the REPL, Between the parens, Between the parens @section Activating Geiser @cindex geiser-mode @@ -46,7 +46,7 @@ you how to fix that in a moment. The menu provides a good synopsis of everthing Geiser brings to the party, including those keyboard shortcuts we Emacsers love. If you're seeing the name of your favourite Scheme implementation in the -mode-line, have a running @repl{} and are comfortable with Emacs, you +mode-line, have a running REPL and are comfortable with Emacs, you can stop reading now and, instead, discover Geiser's joys by yourself. I've tried to make Geiser as self-documenting as any self-respecting Emacs package should be. If you follow this route, make sure to take a @@ -61,7 +61,7 @@ If, for some reason i cannot fathom, you prefer @i{geiser-mode} not to be active by default, the following elisp incantation will do the trick: @example -(eval-after-load "geiser-mode" +(eval-after-load "geiser" (remove-hook 'scheme-mode-hook 'turn-on-geiser-mode)) @end example @cindex scheme file extensions @@ -74,20 +74,20 @@ not recognised as such by Emacs, just tell her about it with: @cindex useless wretch Now, @i{geiser-mode} is just a useless wretch unless there's a running Scheme process backing it up. Meaning that virtually all the commands it -provides require a @repl{} up and running, preferably corresponding to +provides require a REPL up and running, preferably corresponding to the correct Scheme implementation. In the following section, we'll see how to make sure that that's actually the case. -@node The source and the REPL, Documentation helpers, Activating Geiser, Fun between the parens +@node The source and the REPL, Documentation helpers, Activating Geiser, Between the parens @section The source and the REPL As i've already mentioned a couple of times, @i{geiser-mode} needs a -running @repl{} to be operative. Thus, a common usage pattern will be +running REPL to be operative. Thus, a common usage pattern will be for you to first call @code{run-geiser} (or one of its variants, see them described @ref{choosing-impl,,here}), and then open Scheme files; but there's nothing wrong in first opening a couple Scheme buffers and -then starting the @repl{} (you can even find it more convenient, since -pressing @kbd{C-c C-z} in a Scheme buffer will start the @repl{} for +then starting the REPL (you can even find it more convenient, since +pressing @kbd{C-c C-z} in a Scheme buffer will start the REPL for you). Since Geiser supports more than one Scheme implementation, though, there's the problem of knowing which of them is to be associated with each Scheme source file. Serviceable as it is, @i{geiser-mode} will try @@ -117,7 +117,7 @@ element is used as the chosen implementation. The contents of the file is scanned for hints on its associated implementation. For instance, files that contain a @code{#lang} directive will be considered Racket source code, while those with a -@code{define-module} form in them will be assigned to a Guile @repl{}. +@code{define-module} form in them will be assigned to a Guile REPL. @item The current buffer's file name is checked against the rules given in @code{geiser-implementations-alist}, and the first match is applied. You @@ -144,7 +144,7 @@ default value for the latter variable: ((regexp "\\.rkt$") racket)) @end example which describes the simple heuristic that files with @file{.scm} as -extension are by default associated to a Guile @repl{} while those +extension are by default associated to a Guile REPL while those ending in @file{.ss} or @file{.rkt} correspond to Racket's implementation (with the caveat that these rules are applied only if the previous heuristics have failed to detect the correct implementation, @@ -166,18 +166,18 @@ first served, this new rule will take precedence over the default ones. @cindex switching to REPL @cindex switching to source @anchor{switching-repl-buff} Once you have a working @i{geiser-mode}, -you can switch from Scheme source buffers to the @repl{} or @kbd{C-c +you can switch from Scheme source buffers to the REPL or @kbd{C-c C-z}. Those shortcuts map to the interactive command @code{switch-to-geiser}. @cindex switching to module If you use a numeric prefix, as in @kbd{C-u C-c C-z}, besides being -teleported to the @repl{}, the latter will switch to the namespace of -the Scheme source file (as if you had used @kbd{C-c C-m} in the @repl{}, +teleported to the REPL, the latter will switch to the namespace of +the Scheme source file (as if you had used @kbd{C-c C-m} in the REPL, with the source file's module as argument; cf. @ref{Switching context}). This command is also bound to @kbd{C-c C-Z}, with a capital zed. -Once you're in the @repl{}, the same @kbd{C-c C-z} shortcut will bring +Once you're in the REPL, the same @kbd{C-c C-z} shortcut will bring you back to the buffer you jumped from, provided you don't kill the Scheme process in between. This is why the command is called @i{switch-to-geiser} instead of @i{switch-to-repl}, and what makes it @@ -198,10 +198,10 @@ a one to one correspondence between paths and modules, while Guile relies on explicit @code{define-module} forms in the source file). Now that we have @code{geiser-mode} happily alive in our Scheme buffers -and communicating with the right @repl{} instance, let us see what it +and communicating with the right REPL instance, let us see what it can do for us, besides jumping to and fro. -@node Documentation helpers, To eval or not to eval, The source and the REPL, Fun between the parens +@node Documentation helpers, To eval or not to eval, The source and the REPL, Between the parens @section Documentation helpers @subsubheading Autodoc redux @@ -209,7 +209,7 @@ can do for us, besides jumping to and fro. @cindex autodoc, in scheme buffers The first thing you will notice by moving around Scheme source is that, every now and then, the echo area lightens up with the same autodoc -messages we know and love from our @repl{} forays. This happens every +messages we know and love from our REPL forays. This happens every time the Scheme process is able to recognise an identifier in the buffer, and provide information either on its value (for variables) or on its arity and the name of its formal arguments (for procedures and @@ -312,7 +312,7 @@ form of a list of its exported identifiers, using @kbd{C-c C-d C-m}, exactly as you would do @ref{repl-mod,,in the REPL}. This commands works with all supported Schemes, no strings attached. -@node To eval or not to eval, To err perchance to debug, Documentation helpers, Fun between the parens +@node To eval or not to eval, To err perchance to debug, Documentation helpers, Between the parens @section To eval or not to eval @cindex philosophy @@ -342,7 +342,7 @@ incremental evaluation. Some people disagree; if you happen to find @uref{http://blog.racket-lang.org/2009/03/drscheme-repl-isnt-lisp.html, their arguments} convincing, you don't have to throw away Geiser together with the baby: @kbd{M-x geiser-restart-repl} will let you -restart the @repl{} as many times as you see fit. +restart the REPL as many times as you see fit. @cindex evaluation @cindex incremental development, not evil @@ -355,7 +355,7 @@ s-expression just before point. @code{geiser-eval-definition}, bound to @kbd{C-M-x}, finds the topmost definition containing point and sends it for evaluation. The variant @code{geiser-eval-definition-and-go} (@kbd{C-c M-e}) works in the same -way, but it also teleports you to @repl{} after the evaluation. +way, but it also teleports you to REPL after the evaluation. @code{geiser-eval-region}, bound to @kbd{C-c C-r}, evals the current region. Again, there's an @i{and go} version available, @@ -368,7 +368,7 @@ perchance to debug}). At the risk of repeating myself, i'll remember you that all these evaluations will take place in the namespace of the module corresponding to the Scheme file from which you're sending your code, which, in -general, will be different from the @repl{}'s current module. And, if +general, will be different from the REPL's current module. And, if all goes according to plan, (re)defined variables and procedures should be immediately visible inside and, if exported, outside their module. @@ -378,7 +378,7 @@ macro-expand them. The corresponding keybindings start with the prefix @kbd{C-r}. The result of the macro expansion always appears in a pop up buffer. -@node To err perchance to debug, Jumping around, To eval or not to eval, Fun between the parens +@node To err perchance to debug, Jumping around, To eval or not to eval, Between the parens @section To err: perchance to debug @cindex to err is schemey @@ -423,7 +423,7 @@ offer no further explanation here. The customization group tune how Geiser interacts with Guile's debugger (and more). Same thing for racketeers and @i{geiser-racket}. -@node Jumping around, Geiser writes for you, To err perchance to debug, Fun between the parens +@node Jumping around, Geiser writes for you, To err perchance to debug, Between the parens @section Jumping around @cindex jumping in scheme buffers @@ -448,7 +448,7 @@ You can control how the destination buffer pops up by setting in the current window), @code{'window} (other window in the same frame) or @code{'frame} (in a new frame). -@node Geiser writes for you, , Jumping around, Fun between the parens +@node Geiser writes for you, , Jumping around, Between the parens @section Geiser writes for you @cindex completion in scheme buffers @@ -476,9 +476,17 @@ smarty pants mode always on in Scheme buffers, customize @code{geiser-mode-smart-tab-p} to @code{t}. @cindex completion for module names -Geiser also knows how to complete module names, but it's not yet smart -enough to infer by context that that's what you want. Instead, you must -use a separate command, bound to @kbd{M-`} (that's a backtick). +Geiser also knows how to complete module names: if no completion for the +prefix at point is found among the currently visible bindings, it will +try to find a module name that matches it. You can also request +explicitly completion only over module names using @kbd{M-`} (that's a +backtick). + +There's also this little command, @code{geiser-squarify}, which will +toggle the delimiters of the innermost list around point between round +and square brackets. It is bound to @kbd{C-c C-e [}. With a numeric +prefix (as in, say, @kbd{M-2 C-c C-e [}), it will perform that many +toggles, forward for positive values and backward for negative ones. @c Local Variables: @c mode: texinfo diff --git a/doc/repl.texi b/doc/repl.texi index b1d3b5a..03fb42a 100644 --- a/doc/repl.texi +++ b/doc/repl.texi @@ -1,4 +1,4 @@ -@node The REPL, Fun between the parens, Installation, Top +@node The REPL, Between the parens, Installation, Top @chapter The REPL @anchor{quick-start} If you've followed the indications in @ref{Setting it up}, your Emacs is @@ -18,14 +18,14 @@ ready, just come back here and proceed to the following sections. @section Starting the REPL @cindex REPL -To start a Scheme @repl{} (meaning, a scheme process offering you a +To start a Scheme REPL (meaning, a scheme process offering you a Read-Eval-Print Loop), Geiser provides the generic interactive command @command{run-geiser}. If you run it (via, as is customary in Emacs, @kbd{M-x run-geiser}, you'll be saluted by a prompt asking which one of the supported implementations you want to launch (yes, you can stop the asking: see @ref{active-implementations,,below}). Tabbing for completion will offer you, as of this writing, @code{guile} and @code{racket}. Just -choose your poison, and a new @repl{} buffer will pop-up. +choose your poison, and a new REPL buffer will pop-up. @imgc{repls} @@ -33,7 +33,7 @@ If all went according to plan, you'll be facing an implementation-dependent banner, followed by an interactive prompt. Going according to plan includes having the executable of the Scheme you chose in your path. If that's not the case, you can tell Emacs where it -is, as described @ref{impl-binary,, below}. Returning to our @repl{}, +is, as described @ref{impl-binary,, below}. Returning to our REPL, the first thing to notice is that the funny prompt is telling you your current module: its name is the part just after the @@ sign (in Guile, that means @code{guile-user}, while Racket's top namespace doesn't have @@ -43,36 +43,58 @@ terminal, with a bunch of add-ons that we'll be reviewing below. You can start typing sexps right there: Geiser will only dispatch them for evaluation when they're complete, and will indent new lines properly until then. It will also keep track of your input, maintaining a history -file that will be reloaded whenever you restart the @repl{}. +file that will be reloaded whenever you restart the REPL. +@subsubheading Connecting to an external Scheme @cindex remote REPL @cindex connect to server -If you use Guile, there's an alternative way of starting a Geiser REPL: -you can connect to a remote Guile process, provided the latter is -running a REPL server. For that to happen, you just need to start your -Guile process (outside Emacs) passing to it the flag @code{--listen}. -Then, come back to Emacs and execute @kbd{M-x connect-to-guile}. You'll -be asked for a host and a port, with suitable default values (Guile's -@code{--listen} flag accepts an optional port as argument (as in -@code{--listen=1969}), if you don't want to use the default). And voila, -you'll have a Geiser REPL that is served by the remote Guile process in -a dedicated thread, meaning that your Guile can go on doing whatever it -was doing while you tinker with it from Emacs. Note, however, -that all Guile threads share the heap, so that you'll be able to -interact with those other threads in the running scheme from Emacs in a -variety of ways. For starters, all you (re)defintions will be visible -everywhere. That's dangerous, but will come in handy when you need to -debug your running webserver. - -Nothing that fanciful this far, but there's more to Geiser's @repl{}. On -to the next section! +There's an alternative way of starting a Geiser REPL: you can connect to +an external Scheme process, provided it's running a REPL server at some +known port. How to make that happen depends on the Scheme implementation. + +@cindex Guile's REPL server +If you use Guile, you just need to start your Guile process (possibly +outside Emacs) passing to it the flag @code{--listen}. This flag accepts +an optional port as argument (as in @code{--listen=1969}), if you don't +want to use the default. + +@cindex Racket's REPL server +In Racket, you have to use the REPL server that comes with Geiser. To +that end, put Geiser's Racket scheme directory in the Racket's +collection search path and invoke @code{start-geiser} (a procedure in +the module @code{geiser/server}) somewhere in your program, passing it +the desired port. This procedure will start the REPL server in a +separate thread. For an example of how to do that, see the script +@file{bin/geiser-racket.sh} in the source distribution, or, if you've +compiled Geiser, @file{bin/geiser-racket-noinst} in the build directory, +or, if you've installed Geiser, @file{geiser-racket} in +@file{<installation-prefix>/bin}. These scripts start a new interactive +Racket that is also running a REPL server (they also load the errortrace +library to provide better diagnostics, but that's not strictly needed). + +With your external Scheme process running and serving, come back to +Emacs and execute @kbd{M-x geiser-connect}, @kbd{M-x connect-to-guile} +or @kbd{M-x connect-to-racket}. You'll be asked for a host and a port, +and, voila, you'll have a Geiser REPL that is served by the remote +Scheme process in a dedicated thread, meaning that your external program +can go on doing whatever it was doing while you tinker with it from +Emacs. Note, however, that all Scheme threads share the heap, so that +you'll be able to interact with those other threads in the running +scheme from Emacs in a variety of ways. For starters, all your +(re)defintions will be visible everywhere. That's dangerous, but will +come in handy when you need to debug your running webserver. + +@cindex remote connections +The connection between Emacs and the Scheme process goes over TCP, so it +can be as remote as you need, perhaps with the intervention of an SSH +tunnel. @node First aids, Switching context, Starting the REPL, The REPL @section First aids @img{repl-menu, right} @cindex REPL commands -A quick way of seeing what else Geiser's @repl{} can do for you, is to +A quick way of seeing what else Geiser's REPL can do for you, is to display the corresponding entry up there in your menu bar. No, i don't normally use menus either; but they can come in handy until you've memorized Geiser's commands, as a learning device. And yes, i usually @@ -97,13 +119,13 @@ mercilessly kill the process (but not before stowing your history in the file system). Unless you're using a remote REPL, that is, in which case both commands will just sever the connection and leave the remote process alone. A softer nuke is performed by @kbd{C-c C-k}: some (rare, -i promise) times, Geiser's @repl{} can get confused by the input +i promise) times, Geiser's REPL can get confused by the input received from then underlying Scheme (specially if you have multiple threads writing to the standard ports), and become irresponsive; you can try this command to try to revive it without killing the process or closing your connection. Finally, if worse comes to worst and the process is dead, @kbd{C-c C-z} will restart it (but the same shortcut, -issued when the @repl{} is alive, will bring you back to the buffer you +issued when the REPL is alive, will bring you back to the buffer you came from, as explained @ref{switching-repl-buff,,here}). The remaining commands are meatier, and deserve sections of their own. @@ -113,14 +135,14 @@ The remaining commands are meatier, and deserve sections of their own. @cindex current module, in REPL In tune with Geiser's @ref{current-module,,modus operandi}, evaluations -in the @repl{} take place in the namespace of the current module. As -noted above, the @repl{}'s prompt tells you the name of the current +in the REPL take place in the namespace of the current module. As +noted above, the REPL's prompt tells you the name of the current module. To switch to a different one, you can use the command @command{switch-to-geiser-module}, bound to @kbd{C-c C-m}. You'll notice that Geiser simply uses a couple of meta-commands provided by the Scheme -@repl{} (the stock @command{,m} in Guile and @command{,enter} in +REPL (the stock @command{,m} in Guile and @command{,enter} in Racket), and that it doesn't even try to hide that fact. That means that -you can freely use said native ways directly at the @repl{}, and Geiser +you can freely use said native ways directly at the REPL, and Geiser will be happy to oblige. @cindex current module, change @@ -139,7 +161,7 @@ a prefix-aware list of available module names. @imgc{mod-completion} -Which brings me to the next group of @repl{} commands. +Which brings me to the next group of REPL commands. @node Completion and error handling, Autodoc and friends, Switching context, The REPL @section Completion and error handling @@ -147,13 +169,14 @@ Which brings me to the next group of @repl{} commands. @cindex completion, module name We've already seen Geiser completion of module names in action at the mini-buffer. You won't be surprised to know that it's also available at -the @repl{} buffer itself. There, you can use either @kbd{C-.} or +the REPL buffer itself. There, you can use either @kbd{C-.} or @kbd{M-`} to complete module names, and @kbd{@key{TAB}} or @kbd{M-@key{TAB}} to complete identifiers. Geiser will know what identifiers are bound in the current module and show you a list of those starting with the prefix at point. Needless to say, this is not a static list, and it will grow as you define or import new bindings in the -namespace at hand. +namespace at hand. If no completion is found, @kbd{@key{TAB}} will try +to complete the prefix after point as a module name. REPL buffers use Emacs' compilation mode to highlight errors reported by the Scheme interpreter, and you can use the @command{next-error} command @@ -164,7 +187,9 @@ evaluation request, if any. If you prefer a not so forgetful REPL, set the customization variable @code{geiser-repl-forget-old-errors-p} to @code{nil}. Note, however, that even when that variable is left as @kbd{t}, you can always jump to an old error by moving to its line at -the REPL and pressing return. +the REPL and pressing @kbd{RET}. When your cursor is away from the last +prompt, @kbd{TAB} will move to the next error in the buffer, and you can +use @kbd{BACKTAB} everywhere to go to the previous one. @node Autodoc and friends, Customization and tips, Completion and error handling, The REPL @section Autodoc and friends @@ -175,7 +200,7 @@ if so, what arguments does it take? Geiser tries to help you answering those questions too. @cindex autodoc, in the REPL -Actually, if you've been playing with the @repl{} as you read, you might +Actually, if you've been playing with the REPL as you read, you might have notice some frantic activity taking place in the minibuffer every now and then. That was Geiser trying to be helpful (while, hopefully, not being clippy), or, more concretely, what i call, for want of a @@ -222,15 +247,16 @@ identifiers exported by a given module: all you need to do is press The list of exported bindings is shown in a buffer belonging to Geiser's documentation browser, of which more details are given in forthcoming -sections (but just perusing it's associated key bindings, by any of the -methods we've already used for the @repl{}, will give you enough -information to use it effectively enough). +sections (but just perusing its associated key bindings, by any of the +methods we've already mentioned, will give you enough information to use +it). Racketeers will be pleased (i hope) to note that contracts are part +of the information displayed. @node Customization and tips, , Autodoc and friends, The REPL @section Customization and tips @cindex REPL customization -The looks and ways of the @repl{} can be fine-tuned via a bunch of +The looks and ways of the REPL can be fine-tuned via a bunch of customization variables. You can see and modify them all in the corresponding customization group (by using the menu entry or the good old @kbd{M-x customize-group geiser-repl}), or by setting them in your @@ -258,7 +284,7 @@ forget about the richness of the Scheme ecosystem with something like @cindex scheme binary @cindex scheme executable path -@anchor{impl-binary} When starting a new @repl{}, Geiser assumes, by +@anchor{impl-binary} When starting a new REPL, Geiser assumes, by default, that the corresponding Scheme binary is in your path. If that's not the case, the variables to tweak are @code{geiser-guile-binary} and @code{geiser-racket-binary}, which should be set to a string with the @@ -279,7 +305,7 @@ for Racket are @code{geiser-racket-collects} and By default, Geiser won't record duplicates in your input history. If you prefer it did, just set @code{geiser-repl-history-no-dups-p} to -@code{nil}. History entries are persistent across @repl{} sessions: +@code{nil}. History entries are persistent across REPL sessions: they're saved in implementation-specific files whose location is controlled by the variable @code{geiser-repl-history-filename}. For example, my Geiser configuration includes the following line: @@ -294,11 +320,11 @@ directory. @cindex autodoc, disabling @cindex peace and quiet -If you happen to love peace and quiet and prefer to keep your @repl{}'s +If you happen to love peace and quiet and prefer to keep your REPL's echo area free from autodoc's noise, @code{geiser-repl-autodoc-p} is the customization variable for you: set it to @code{nil} and autodoc will be -disabled by default in new @repl{}s. You can always bring the fairies -back, on a per @repl{} basis, using @kbd{C-c C-a}. +disabled by default in new REPLs. You can always bring the fairies +back, on a per REPL basis, using @kbd{C-c C-a}. @subsubheading Remote connections diff --git a/doc/thanks.texi b/doc/thanks.texi index e6f0203..4d9662d 100644 --- a/doc/thanks.texi +++ b/doc/thanks.texi @@ -1,6 +1,6 @@ @node No hacker is an island, Index, Cheat sheet, Top @chapter No hacker is an island - +@cindex thanks Andy Wingo, Geiser's first user, has been a continuous source of encouragement and suggestions, and keeps improving Guile and heeding my feature requests. diff --git a/doc/web.texi b/doc/web.texi index 99f5165..828c02d 100644 --- a/doc/web.texi +++ b/doc/web.texi @@ -12,7 +12,7 @@ * Introduction:: * Installation:: * The REPL:: -* Fun between the parens:: +* Between the parens:: * Cheat sheet:: * No hacker is an island:: * Index:: @@ -34,7 +34,7 @@ list</a> @include intro.texi @include install.texi @include repl.texi -@include fun.texi +@include parens.texi @include cheat.texi @include thanks.texi @include index.texi |
