diff options
| -rw-r--r-- | doc/cheat.texi | 2 | ||||
| -rw-r--r-- | doc/install.texi | 40 | ||||
| -rw-r--r-- | doc/intro.texi | 16 | ||||
| -rw-r--r-- | doc/parens.texi | 164 | ||||
| -rw-r--r-- | doc/repl.texi | 132 | ||||
| -rw-r--r-- | doc/thanks.texi | 2 | ||||
| -rw-r--r-- | doc/top.texi | 8 |
7 files changed, 182 insertions, 182 deletions
diff --git a/doc/cheat.texi b/doc/cheat.texi index 870c68c..d5affc4 100644 --- a/doc/cheat.texi +++ b/doc/cheat.texi @@ -123,7 +123,7 @@ third key not modified by @key{Control}; e.g., @tab Edit identifier at point @item TAB @tab @code{geiser-repl--tab} -@tab Complete, indent or go to next error +@tab Complete, indent, or go to next error @item S-TAB (backtab) @tab @code{geiser-repl--previous-error} @tab Go to previous error in the REPL buffer diff --git a/doc/install.texi b/doc/install.texi index ae4b9bd..c160f09 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -32,9 +32,9 @@ to the fun. @subsubheading Downloading Geiser @cindex use the source, Luke -You'll also need Geiser itself. The latest release tarball can be found +You'll also need Geiser itself. The latest release tarball can be found @downfile{, here}, while older versions are @uref{@value{DOWN_BASE}/, -here}. Just download @downfile{@value{TARBALL}, @value{TARBALL}} +here}. Just download @downfile{@value{TARBALL}, @value{TARBALL}} and untar it in a directory of your choice. If you feel like living on the bleeding edge, just grab Geiser from its @@ -56,14 +56,14 @@ You can also follow Geiser's development in are kept synchronized with the one at Savannah. Either way, you'll now be in possession of a copy of Geiser's libre -code. I'll follow you into its directory and the next section. +code. I'll follow you into its directory and the next section. @node Setting it up, Friends, Must needs, Installation @section Setting it up -Geiser is ready to be used out of the box without much more ado. For the +Geiser is ready to be used out of the box without much more ado. For the sake of concreteness, let's assume you put its source in the directory -@file{~/lisp/geiser}. All you need to do is to add the following +@file{~/lisp/geiser}. All you need to do is to add the following line to your Emacs initialisation file (be it @file{~/.emacs} or any of its moral equivalents): @example @@ -71,18 +71,18 @@ its moral equivalents): @end example @noindent or simply evaluate that form inside Emacs (you wouldn't kill a friend -just to start using Geiser, would you?). That's it: you're ready to -@ref{quick-start,,go}. If you obtained the Geiser source tree from a +just to start using Geiser, would you?). That's it: you're ready to +@ref{quick-start,,go}. If you obtained the Geiser source tree from a release tarball, you can even continue to read this fine manual inside -Emacs by opening @file{doc/geiser.info} using @kbd{C-u C-h i}. The +Emacs by opening @file{doc/geiser.info} using @kbd{C-u C-h i}. The manual is also available in PDF format @downfile{geiser-manual-@value{STABLE_VERSION}.pdf, here}. @cindex byte-compilation -What? You still here? I promise the above is all that's needed to start -using Geiser. But, in case you are missing your @t{configure/make all +What? You still here? I promise the above is all that's needed to start +using Geiser. But, in case you are missing your @t{configure/make all install} routine, by all means, you can go through those motions to byte -compile and install Geiser too. That is, you enter the source directory +compile and install Geiser too. That is, you enter the source directory and (since we grabbed the development tree) run the customary @i{autogen} script: @example @@ -99,13 +99,13 @@ $ make all <more of the above> @end example Now you have two options: loading the byte-compiled Geiser from the -@file{elisp} subdirectory, or installing it system-wide. To load the +@file{elisp} subdirectory, or installing it system-wide. To load the byte-code from here, add this line to your initialisation file: @example (load "~/lisp/geiser/build/elisp/geiser-load") @end example and eval that form and you're done (you could also restart Emacs, but -killing your friends is widely considered bad form). Yes, that's +killing your friends is widely considered bad form). Yes, that's @code{load} and @file{geiser-load} instead of @code{load-file} and @file{geiser.el}. @@ -114,7 +114,7 @@ If you prefer a system-wide installation, just type: $ sudo make install @end example With the above spell, Geiser will be compiled and installed in a safe -place inside Emacs load path. To load it into Emacs you'll need, +place inside Emacs load path. To load it into Emacs you'll need, @i{instead} of the @code{load-file} form above, the following line in your initialisation file: @example @@ -123,12 +123,12 @@ your initialisation file: @noindent Please note that we're requiring @code{geiser-install}, and @i{not} @code{geiser}, and that there's no @code{load-file} to be seen this -time. There are some ways of fine-tuning this process, mainly by +time. There are some ways of fine-tuning this process, mainly by providing additional arguments in the call to @t{configure}: you'll find those gory details in the file called @file{INSTALL}, right at the root -of the source tree. The installation will also take care of placing this +of the source tree. The installation will also take care of placing this manual, in Info format, where Emacs can find it, so you can continue to -learn about Geiser inside its natural habitat. See you there and into +learn about Geiser inside its natural habitat. See you there and into the next chapter! @node Friends, , Setting it up, Installation @@ -148,7 +148,7 @@ in any Lisp dialect without the aid of Taylor Campbell's structured editing mode. @item @uref{http://nschum.de/src/emacs/company-mode/, Company}. Nikolaj Schumacher's @code{company-mode} provides a generic front-end -for completion engines (such as Geiser's). Very nice if you like that +for completion engines (such as Geiser's). Very nice if you like that kind of thing: judge by yourself with the help of @uref{http://www.screentoaster.com/watch/stU0lSRERIR1pYRFVdXVlRVFFV/company_mode_for_gnu_emacs, this screencast}. @@ -156,12 +156,12 @@ this screencast}. You can still use the many goodies provided by Neil van Dyke's @code{quack-mode}, since most of them are not (yet) available in Geiser. The only caveat might be a conflict between Quack's and Geiser's default -key bindings, which i'm sure you'll manage to tackle just fine. It's +key bindings, which i'm sure you'll manage to tackle just fine. It's also probably a good idea to require @code{quack} @i{after} loading @file{geiser.el} (or requiring a compiled version). @end itemize You just need to install and setup them as usual, for every package's -definition of usual. Geiser will notice their presence and react +definition of usual. Geiser will notice their presence and react accordingly. @c Local Variables: diff --git a/doc/intro.texi b/doc/intro.texi index 8856b84..57e4fb5 100644 --- a/doc/intro.texi +++ b/doc/intro.texi @@ -1,7 +1,7 @@ @node Introduction, Installation, Top, Top @chapter Introduction -Geiser is an Emacs environment to hack and have fun in Scheme. If that's +Geiser is an Emacs environment to hack and have fun in Scheme. If that's enough for you, see @ref{Installation} to get it running and @ref{The REPL} for the fun part. @@ -15,7 +15,7 @@ enough for you, see @ref{Installation} to get it running and @cindex modus operandi As already mentioned, Geiser relies on a running Scheme process to -obtain the information it makes accessible to the programmer. There's +obtain the information it makes accessible to the programmer. There's little effort, on the Elisp side, to understand, say, the module system used by the Scheme implementation at hand; instead, a generic interface between the two worlds is defined, and each supported Scheme includes a @@ -26,23 +26,23 @@ 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 namespace (or module), as well as the current file's module (or -namespace). Thus, all evaluations performed by Geiser either in the +namespace). Thus, all evaluations performed by Geiser either in the 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 +namespace. Every time you switch to a different file, you're switching namespaces automatically; at the REPL, you must request the switch explicitly (usually just using means provided by the Scheme implementation itself). If your favourite Scheme supports the above modus operandi, it has all -that's needed for a bare-bones Geiser mode. But Geiser can, and will, +that's needed for a bare-bones Geiser mode. But Geiser can, and will, use any metadata available: procedure arities and argument lists to display interactive help, documentation strings, location information to jump to definitions, export lists to provide completion, and so on and -so forth. Although this is not an all-or-none proposition (Geiser can +so forth. Although this is not an all-or-none proposition (Geiser can operate with just part of that functionality available), i've initially concentrated in supporting those Schemes with the richest (to my knowledge) introspection capabilities, namely, Guile and Racket. @@ -84,7 +84,7 @@ Support for multiple, simultaneous REPLs. In the following pages, i'll try to explain what these features actually are (i'm just swanking here), and how to use them for your -profit. But, before that, let's see how to install Geiser. +profit. But, before that, let's see how to install Geiser. @c Local Variables: @c mode: texinfo diff --git a/doc/parens.texi b/doc/parens.texi index c8237b4..b241a84 100644 --- a/doc/parens.texi +++ b/doc/parens.texi @@ -2,8 +2,8 @@ @chapter Between the parens 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 +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 included for about any language on Earth, and just the best one when that language is sexpy (especially if you use @ref{paredit,,Paredit}). @@ -29,7 +29,7 @@ process giving you the REPL, make those Scheme buffers come to life. @cindex geiser-mode @img{geiser-mode, right} With Geiser installed following any of the procedures described in @ref{Setting it up}, Emacs will automatically -activate @i{geiser-mode} when opening a Scheme buffer. Geiser also +activate @i{geiser-mode} when opening a Scheme buffer. Geiser also instructs Emacs to consider files with the extension @file{rkt} part of the family, so that, in principle, there's nothing you need to do to ensure that Geiser's extensions will be available, out of the box, when @@ -37,21 +37,21 @@ you start editing Scheme code. Indications that everything is working according to plan include the 'Geiser' minor mode indicator in your mode-line and the appearance of a -new entry for Geiser in the menu bar. If, moreover, the mode-line +new entry for Geiser in the menu bar. If, moreover, the mode-line indicator is the name of a Scheme implementation, you're indeed in a perfect world; otherwise, don't despair and keep on reading: i'll tell you how to fix that in a moment. @cindex geiser-mode commands The menu provides a good synopsis of everything Geiser brings to the -party, including those keyboard shortcuts we Emacsers love. If you're +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 can -stop reading now and, instead, discover Geiser's joys by yourself. I've +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 look at +package should be. If you follow this route, make sure to take a look at Geiser's customization buffers (@kbd{M-x customize-group @key{RET} -geiser}): there's lot of fine-tuning available there. You might also +geiser}): there's lot of fine-tuning available there. You might also want to take a glance at the @ref{Cheat sheet}. Since @i{geiser-mode} is a minor mode, you can toggle it with @@ -70,26 +70,26 @@ 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 +Scheme process backing it up. Meaning that virtually all the commands it provides require a REPL up and running, preferably corresponding to -the correct Scheme implementation. In the following section, we'll see +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, 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 -you). Since Geiser supports more than one Scheme implementation, though, +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 +each Scheme source file. Serviceable as it is, @i{geiser-mode} will try to guess the correct implementation for you, according to the algorithm -described below. If you find that Geiser is already guessing right the +described below. If you find that Geiser is already guessing right the Scheme implementation, feel free to skip to the @ref{switching-repl-buff,,next subsection}. @@ -100,7 +100,7 @@ file, Geiser uses the following algorithm: @enumerate @item If the file-local variable @code{geiser-scheme-implementation} is -defined, its value is used. A common way of setting buffer-local +defined, its value is used. A common way of setting buffer-local variables is to put them in a comment near the beginning of the file, surrounded by @code{-*-} marks, as in: @example @@ -112,12 +112,12 @@ single-element list (as explained @ref{choosing-impl,,here}), that element is used as the chosen implementation. @item The contents of the file is scanned for hints on its associated -implementation. For instance, files that contain a @code{#lang} +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. @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 +@code{geiser-implementations-alist}, and the first match is applied. You can provide your own rules by customizing this variable, as explained below. @item @@ -125,15 +125,15 @@ If we haven't been lucky this far and you have customized @code{geiser-default-implementation} to the name of a supported implementation, we'll follow your lead. @item -See? That's the problem of being a smart aleck: one's always outsmarted -by people around. At this point, @i{geiser-mode} will humbly give up and +See? That's the problem of being a smart aleck: one's always outsmarted +by people around. At this point, @i{geiser-mode} will humbly give up and ask you to explicitly choose the Scheme implementation. @end enumerate As you can see in the list above, there are several ways to influence -Geiser's guessing by mean customizable variables. The most direct (and +Geiser's guessing by mean customizable variables. The most direct (and most impoverishing) is probably limiting the active implementations to a single one, while customizing @code{geiser-implementations-alist} is the -most flexible (and, unsurprisingly, also the most complex). Here's the +most flexible (and, unsurprisingly, also the most complex). Here's the default value for the latter variable: @example (((regexp "\\.scm$") guile) @@ -146,8 +146,8 @@ 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, and that they'll match only if the corresponding implementation is -active). You can add rules to @code{geiser-implementations-alist} (or -replace all of them) by customizing it. Besides regular expressions, you +active). You can add rules to @code{geiser-implementations-alist} (or +replace all of them) by customizing it. Besides regular expressions, you can also use a directory name; for instance, the following snippet: @example (eval-after-load "geiser-impl" @@ -156,7 +156,7 @@ can also use a directory name; for instance, the following snippet: @end example will add a new rule that says that any file inside my @file{/home/jao/prj/frob} directory (or, recursively, any of its -children) is to be assigned to Guile. Since rules are first matched, +children) is to be assigned to Guile. Since rules are first matched, first served, this new rule will take precedence over the default ones. @subsubheading Switching between source files and the REPL @@ -164,7 +164,7 @@ first served, this new rule will take precedence over the default ones. @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 -C-z}. Those shortcuts map to the interactive command +C-z}. Those shortcuts map to the interactive command @code{switch-to-geiser}. @cindex switching to module @@ -176,7 +176,7 @@ 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 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 +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 really handy, if you ask me. @@ -206,14 +206,14 @@ 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 -macros). That information will only be available if the module the -identifier belongs to has been loaded in the running Scheme image. So it +macros). That information will only be available if the module the +identifier belongs to has been loaded in the running Scheme image. So it can be the case that, at first, no autodoc is shown for identifiers -defined in the file you're editing. But as soon as you evaluate them +defined in the file you're editing. But as soon as you evaluate them (either individually or collectively using any of the devices described in @ref{To eval or not to eval}) their signatures will start appearing in the echo area. @@ -222,8 +222,8 @@ in the echo area. @cindex manual autodoc Autodoc activation is controlled by a minor mode, @code{geiser-autodoc}, which you can toggle with @kbd{M-x geiser-autodoc}, or its associated -keyboard shortcut, @kbd{C-c C-d a}. That @t{/A} indicator in the -mode-line is telling you that autodoc is active. If you prefer that it +keyboard shortcut, @kbd{C-c C-d a}. That @t{/A} indicator in the +mode-line is telling you that autodoc is active. If you prefer that it be inactive by default (e.g., because you're connecting to a really remote scheme and want to minimize network exchanges), just set @code{geiser-mode-autodoc-p} to @code{nil} in your customization files. @@ -233,19 +233,19 @@ symbol at point. @cindex autodoc explained @img{autodoc-scm, right} The way autodoc displays information deserves -some explanation. It will first show the name of the module where the +some explanation. It will first show the name of the module where the identifier at hand is defined, followed by a colon and the identifier -itself. If the latter corresponds to a procedure or macro, it will be +itself. If the latter corresponds to a procedure or macro, it will be followed by a list of argument names, starting with the ones that are -required. Then there comes a list of optional arguments, if any, -enclosed in parenthesis. When an optional argument has a default value +required. Then there comes a list of optional arguments, if any, +enclosed in parenthesis. When an optional argument has a default value (or a form defining its default value), autodoc will display it after -the argument name. When the optional arguments are keywords, their names -are prefixed with ``#:'' (i.e., their names @i{are} keywords). An +the argument name. When the optional arguments are keywords, their names +are prefixed with ``#:'' (i.e., their names @i{are} keywords). An ellipsis (@dots{}) serves as a marker of an indeterminate number of parameters, as is the case with @i{rest} arguments or when autodoc cannot fathom the exact number of arguments (this is often the case with -macros defined using @code{syntax-case}). Another way in which autodoc +macros defined using @code{syntax-case}). Another way in which autodoc displays its ignorance is by using an underscore to display parameters whose name is beyond its powers. @@ -257,41 +257,41 @@ In those cases, autodoc shows all known signatures (using the above rules for each one) separated by a vertical bar (|). As you have already noticed, the whole autodoc message is enclosed in -parenthesis. After all, we're talking about Scheme here. +parenthesis. After all, we're talking about Scheme here. @cindex autodoc for variables @img{autodoc-var, right} Finally, life is much easier when your cursor is on a symbol corresponding to a plain variable: you'll see in the echo area its name, preceded by the module where it's defined, and followed -by its value, with an intervening arrow for greater effect. This time, +by its value, with an intervening arrow for greater effect. This time, there are no enclosing parenthesis (i hope you see the logic in my madness). @cindex autodoc customized You can change the way Geiser displays the module/identifier combo by -customizing @code{geiser-autodoc-identifier-format}. For example, if you +customizing @code{geiser-autodoc-identifier-format}. For example, if you wanted a tilde surrounded by spaces instead of a colon as a separator, you would write something like @example (setq geiser-autodoc-identifier-format "%s ~ %s") @end example -in your Emacs initialisation files. There's also a face +in your Emacs initialisation files. There's also a face (@code{geiser-font-lock-autodoc-identifier}) that you can customize (for instance, with @kbd{M-x customize-face}) to change the appearance of the -text. And another one (@code{geiser-font-lock-autodoc-current-arg}) that +text. And another one (@code{geiser-font-lock-autodoc-current-arg}) that controls how the current argument position is highlighted. @subsubheading Other documentation commands @anchor{doc-browser}Sometimes, autodoc won't provide enough information -for you to understand what a function does. In those cases, you can ask +for you to understand what a function does. In those cases, you can ask Geiser to ask the running Scheme for further information on a given identifier or module. @cindex documentation for symbol @cindex docstrings, maybe For symbols, the incantation is @kbd{M-x geiser-doc-symbol-at-point}, or -@kbd{C-c C-d C-d} for short. If the associated Scheme supports +@kbd{C-c C-d C-d} for short. If the associated Scheme supports docstrings (as, for instance, Guile does), you'll be teleported to a new Emacs buffer displaying Geiser's documentation browser, filled with information about the identifier, including its docstring (if any; @@ -301,9 +301,9 @@ that they're used everywhere). @imgc{docstring} Pressing @kbd{q} in the documentation buffer will bring you back, -enlightened, to where you were. There's also a handful of other +enlightened, to where you were. There's also a handful of other navigation commands available in that buffer, which you can discover by -means of its menu or via the good old @kbd{C-h m} command. And feel free +means of its menu or via the good old @kbd{C-h m} command. And feel free to use the navigation buttons and hyperlinks that justify my calling this buffer a documentation browser. @@ -319,10 +319,10 @@ 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}. In both cases, the documentation browser will show a couple of buttons -giving you access to further documentation. First, you'll see a button +giving you access to further documentation. First, you'll see a button named @i{source}: pressing it you'll jump to the symbol's definition. The second button, dubbed @i{manual}, will open the Scheme -implementation's manual page for the symbol at hand. For Racket, that +implementation's manual page for the symbol at hand. For Racket, that will open your web browser displaying the corresponding reference's page (using Emacs' @code{browser-url} command), while in Guile a lookup will be performed in the texinfo manual. @@ -340,28 +340,28 @@ navigation commands available in the documentation browser. @cindex philosophy @cindex incremental development -One of Geiser's main goals is to facilitate incremental development. You +One of Geiser's main goals is to facilitate incremental development. You might have noticed that i've made a big fuss of Geiser's ability to recognize context, by being aware of the namespace where its operations happen. That awareness is especially important when evaluating code in your -scheme buffers, using the commands described below. They allow you to +scheme buffers, using the commands described below. They allow you to send code to the running Scheme with a granularity ranging from whole -files to single s-expressions. That code will be evaluated in the module +files to single s-expressions. That code will be evaluated in the module associated with the file you're editing, allowing you to redefine values and procedures to your heart's (and other modules') content. @cindex incremental development, evil Macros are, of course, another kettle of fish: one needs to re-evaluate -uses of a macro after redefining it. That's not a limitation imposed by +uses of a macro after redefining it. That's not a limitation imposed by Geiser, but a consequence of how macros work in Scheme (and other -Lisps). There's also the risk that you lose track of what's actually -defined and what's not during a given session. But, +Lisps). There's also the risk that you lose track of what's actually +defined and what's not during a given session. But, @uref{http://programming-musings.org/2009/03/29/from-my-cold-prying-hands/,in my opinion}, those are limitations we lispers are aware of, and they don't force us to throw the baby with the bathwater and ditch -incremental evaluation. Some people disagree; if you happen to find +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 @@ -376,12 +376,12 @@ commands performing incremental evaluation in Geiser. 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 +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. @code{geiser-eval-region}, bound to @kbd{C-c C-r}, evals the current -region. Again, there's an @i{and go} version available, +region. Again, there's an @i{and go} version available, @code{geiser-eval-region-and-go}, bound to @kbd{C-c M-r}. For all the commands above, the result of the evaluation is displayed in @@ -391,14 +391,14 @@ perchance to debug}). At the risk of repeating myself, i'll remind 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 all +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. Besides evaluating expressions, definitions and regions, you can also -macro-expand them. The corresponding key bindings start with the prefix +macro-expand them. The corresponding key bindings start with the prefix @kbd{C-c C-m} and end, respectively, with @kbd{C-e}, @kbd{C-x} and -@kbd{C-r}. The result of the macro expansion always appears in a pop up +@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, Between the parens @@ -420,15 +420,15 @@ jump to the offending spot; or invoke Emacs' stock commands @imgc{eval-error} The Racket backtrace also highlights the exception type, making it -click-able. Following the link will open the documentation corresponding -to said exception type. Both the error and exception link faces are +click-able. Following the link will open the documentation corresponding +to said exception type. Both the error and exception link faces are customizable (@code{geiser-font-lock-error-link} and @code{geiser-font-lock-doc-link}). On the other hand, Guile's reaction to evaluation errors is different: -it enters the debugger in its REPL. Accordingly, the REPL buffer will +it enters the debugger in its REPL. Accordingly, the REPL buffer will pop up if your evaluation fails in a Guile file, and the error message -and backtrace will be displayed in there, again click-able and all. But +and backtrace will be displayed in there, again click-able and all. But there you have the debugger at your disposal, with the REPL's current module set to that of the offender, and a host of special debugging commands that are described in Guile's fine documentation. @@ -436,14 +436,14 @@ commands that are described in Guile's fine documentation. @imgc{guile-eval-error} In addition, Guile will sometimes report warnings for otherwise -successful evaluations. In those cases, it won't enter the debugger, and +successful evaluations. In those cases, it won't enter the debugger, and Geiser will report the warnings in a debug buffer, as it does for -Racket. You can control how picky Guile is reporting warnings by +Racket. You can control how picky Guile is reporting warnings by customizing the variable @code{geiser-guile-warning-level}, whose detailed docstring (which see, using, e.g. @kbd{C-h v}) allows me to -offer no further explanation here. The customization group +offer no further explanation here. The customization group @i{geiser-guile} is also worth a glance, for a couple of options to -fine-tune how Geiser interacts with Guile's debugger (and more). Same +fine-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, Between the parens @@ -453,15 +453,15 @@ thing for racketeers and @i{geiser-racket}. This one feature is as sweet as easy to explain: @kbd{M-.} (@code{geiser-edit-symbol-at-point}) will open the file where the identifier around point is defined and land your point on its -definition. To return to where you were, press @kbd{M-,} -(@code{geiser-pop-symbol-stack}). This command works also for module +definition. To return to where you were, press @kbd{M-,} +(@code{geiser-pop-symbol-stack}). This command works also for module names: Geiser first tries to locate a definition for the identifier at point and, if that fails, a module with that name; if the latter succeeds, the file where the module is defined will pop up. Sometimes, the underlying Scheme will tell Geiser only the file where the symbol is defined, but Geiser will use some heuristics (read, -regular expressions) to locate the exact line and bring you there. Thus, +regular expressions) to locate the exact line and bring you there. Thus, if you find Geiser systematically missing your definitions, send a message to the mailing list and we'll try to make the algorithm smarter. @@ -476,10 +476,10 @@ or @code{'frame} (in a new frame). @cindex completion in scheme buffers No self-respecting programming mode would be complete without -completion. In geiser-mode, identifier completion is bound to +completion. In geiser-mode, identifier completion is bound to @kbd{M-@key{TAB}}, and will offer all visible identifiers starting with -the prefix before point. Visible here means all symbols imported or -defined in the current namespace plus locally bound ones. E.g., if +the prefix before point. Visible here means all symbols imported or +defined in the current namespace plus locally bound ones. E.g., if you're at the end of the following partial expression: @example @@ -492,10 +492,10 @@ and press @kbd{M-@key{TAB}}, one of the possible completions will be @cindex partial completion After obtaining the list of completions from the running Scheme, Geiser -uses the standard Emacs completion machinery to display them. That +uses the standard Emacs completion machinery to display them. That means, among other things, that partial completion is available: just try to complete @code{d-s} or @code{w-o-t-s} to see why this is a good -thing. Partial completion won't work if you have disabled it globally in +thing. Partial completion won't work if you have disabled it globally in your Emacs configuration: if you don't know what i'm talking about, never mind: Geiser's partial completion will work for you out of the box. @@ -504,21 +504,21 @@ box. If you find the @kbd{M} modifier annoying, you always have the option to activate @code{geiser-smart-tab-mode}, which will make the @key{TAB} key double duty as the regular Emacs indentation command (when the cursor is -not near a symbol) and Geiser's completion function. If you want this +not near a symbol) and Geiser's completion function. If you want this 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: 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 +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). Besides completion, 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 +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. diff --git a/doc/repl.texi b/doc/repl.texi index 99742ff..3b722c2 100644 --- a/doc/repl.texi +++ b/doc/repl.texi @@ -2,7 +2,7 @@ @chapter The REPL @anchor{quick-start} If you've followed the indications in @ref{Setting it up}, your Emacs is -now ready to start playing. Otherwise, i'll wait for you: when you're +now ready to start playing. Otherwise, i'll wait for you: when you're ready, just come back here and proceed to the following sections. @menu @@ -20,11 +20,11 @@ ready, just come back here and proceed to the following sections. @cindex REPL 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, +@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 +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. @imgc{repls} @@ -32,17 +32,17 @@ choose your poison, and a new REPL buffer will pop-up. 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, +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, 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 -a name; cf. @ref{Switching context} below). Other than that, this is +a name; cf. @ref{Switching context} below). Other than that, this is pretty much equivalent to having a command-line interpreter in a -terminal, with a bunch of add-ons that we'll be reviewing below. You can +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 +until then. It will also keep track of your input, maintaining a history file that will be reloaded whenever you restart the REPL. @subsubheading Connecting to an external Scheme @@ -50,38 +50,38 @@ file that will be reloaded whenever you restart the REPL. @cindex connect to server 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. +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 +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 +In Racket, you have to use the REPL server that comes with Geiser. To that end, put Geiser's Racket @file{scheme} directory in 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 +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 +@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, +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 +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)definitions will be visible everywhere. That's dangerous, but will +Scheme from Emacs in a variety of ways. For starters, all your +(re)definitions will be visible everywhere. That's dangerous, but will come in handy when you need to debug your running web server. @cindex remote connections @@ -95,9 +95,9 @@ tunnel. @img{repl-menu, right} @cindex REPL commands 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 +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 +memorized Geiser's commands, as a learning device. And yes, i usually run Emacs inside a terminal, but one can always use @uref{http://www.emacswiki.org/emacs/LaCarte, La Carte} to access the menus in a convenient enough fashion. @@ -105,20 +105,20 @@ menus in a convenient enough fashion. Or just press @kbd{C-h m} and be done with that. Among the commands at your disposal, we find the familiar input -navigation keys, with a couple twists. By default, @kbd{M-p} and -@kbd{M-n} are bound to @i{matching} items in your input history. That +navigation keys, with a couple twists. By default, @kbd{M-p} and +@kbd{M-n} are bound to @i{matching} items in your input history. That is, they'll find the previous or next sexp that starts with the current input prefix (defined as the text between the end of the prompt and your -current position, a.k.a. @dfn{point}, in the buffer). For going up and +current position, a.k.a. @dfn{point}, in the buffer). For going up and down the list unconditionally, just use @kbd{C-c M-p} and @kbd{C-c M-n}. In addition, navigation is sexp-based rather than line-based. There are also a few commands to twiddle with the Scheme process. @kbd{C-c C-q} will gently ask it to quit, while @kbd{C-u C-c C-q} will 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 +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. If worse comes to worst and the process is dead, @kbd{C-c +process alone. 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 came from, as explained @ref{switching-repl-buff,,here}). @@ -130,28 +130,28 @@ 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 +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 +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 -Racket), and that it doesn't even try to hide that fact. That means that +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 will be happy to oblige. @cindex current module, change Once you enter a new module, only those bindings visible in its -namespace will be available to your evaluations. All Schemes supported +namespace will be available to your evaluations. All Schemes supported by Geiser provide a way to import new modules in the current namespace. Again, there's a Geiser command, @command{geiser-repl-import-module}, to -invoke such functionality, bound this time to @kbd{C-c C-i}. And, again, +invoke such functionality, bound this time to @kbd{C-c C-i}. And, again, you'll see Geiser just introducing the native incantation for you, and you're free to use such incantations by hand whenever you want. One convenience provided by these two Geiser commands is that completion is available when introducing the new module name, using the -@kbd{@key{TAB}} key. Pressing it at the command's prompt will offer you +@kbd{@key{TAB}} key. Pressing it at the command's prompt will offer you a prefix-aware list of available module names. @imgc{mod-completion} @@ -163,26 +163,26 @@ Which brings me to the next group of REPL commands. @cindex completion, at the REPL 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 +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 @kbd{M-`} to complete module names, and @kbd{@key{TAB}} or -@kbd{M-@key{TAB}} to complete identifiers. Geiser will know what +@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 +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. If no completion is found, @kbd{@key{TAB}} will try +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 -(@kbd{M-g n}) to jump to their location. By default, every time you +(@kbd{M-g n}) to jump to their location. By default, every time you enter a new expression for evaluation old error messages are forgotten, so that @kbd{M-g n} will always jump to errors related to the last -evaluation request, if any. If you prefer a not so forgetful REPL, set +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 +@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 @kbd{RET}. When your cursor is away from the last +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. @@ -190,16 +190,16 @@ use @kbd{BACKTAB} everywhere to go to the previous one. @section Autodoc and friends Oftentimes, there's more you'll want to know about an identifier -besides its name: what module does it belong to? is it a procedure and, -if so, what arguments does it take? Geiser tries to help you answering +besides its name: what module does it belong to? is it a procedure and, +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 have notice some frantic activity taking place in the minibuffer every -now and then. That was Geiser trying to be helpful (while, hopefully, +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 -better name, its @dfn{autodoc} mode. Whenever it's active (did you +better name, its @dfn{autodoc} mode. Whenever it's active (did you notice that @i{A} in the mode-line?), Geiser's gerbils will be scanning what you type and showing (unless you silent them with @kbd{C-c C-a}) information about the identifier nearest to point. @@ -207,17 +207,17 @@ information about the identifier nearest to point. @imgc{repl-autodoc} If that identifier corresponds to a variable visible in the current -namespace, you'll see the module it belongs to and its value. For +namespace, you'll see the module it belongs to and its value. For procedures and macros, autodoc will display, instead of their value, the argument names (or an underscore if Geiser cannot determine the name -used in the definition). Optional arguments are surrounded by -parenthesis. When the optional argument has a default value, it's -represented by a list made up of its name and that value. When the +used in the definition). Optional arguments are surrounded by +parenthesis. When the optional argument has a default value, it's +represented by a list made up of its name and that value. When the argument is a keyword argument, its name has ``#:'' as a prefix. @cindex help on identifier If that's not enough documentation for you, @kbd{C-c C-d d} will open a -separate documentation buffer with help on the symbol at point. This +separate documentation buffer with help on the symbol at point. This buffer will contain implementation-specific information about the identifier (e.g., its docstring for Guile, or its contract, if any, for Racket), and a handy button to open the corresponding manual entry for @@ -235,15 +235,15 @@ name. The list of exported bindings is shown, again, in a buffer belonging to Geiser's documentation browser, where you have at your disposal a bunch of navigation commands listed in @xref{Documentation browser,,our -cheat-sheet}. We'll have a bit more to say about the documentation +cheat-sheet}. We'll have a bit more to say about the documentation browser in @xref{doc-browser,,a later section}. @cindex jump, at the REPL If that's still not enough, Geiser can jump, via @kbd{M-.}, to the -symbol's definition. A buffer with the corresponding file will pop up, -with its point resting upon the identifier's defining form. When you're -done inspecting, @kbd{M-,} will bring you back to where you were. As we -will see, these commands are also available in Scheme buffers. @kbd{M-.} +symbol's definition. A buffer with the corresponding file will pop up, +with its point resting upon the identifier's defining form. When you're +done inspecting, @kbd{M-,} will bring you back to where you were. As we +will see, these commands are also available in Scheme buffers. @kbd{M-.} also works for modules: if your point is on an unambiguous module name, the file where it's defined will be opened for you. @@ -252,7 +252,7 @@ the file where it's defined will be opened for you. @cindex REPL customization 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 +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 Emacs initialisation files (as a rule, all knobs in Geiser are tunable @@ -267,9 +267,9 @@ some related tips. @anchor{choosing-impl} Instead of using the generic @command{run-geiser} command, you can start directly your Scheme of choice via @command{run-racket} or -@command{run-guile}. @anchor{active-implementations} In addition, the +@command{run-guile}. @anchor{active-implementations} In addition, the variable @code{geiser-active-implementations} contains a list of those -Schemes Geiser should be aware of. Thus, if you happen to be, say, a +Schemes Geiser should be aware of. Thus, if you happen to be, say, a racketeer not to be beguiled by other schemes, you can tell Geiser to forget about the richness of the Scheme ecosystem with something like @example @@ -280,7 +280,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 -default, that the corresponding Scheme binary is in your path. If that's +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 full path to the requisite binary. @@ -289,20 +289,20 @@ full path to the requisite binary. @cindex scheme init file @cindex GUILE_LOAD_PATH @cindex PLTCOLLECTS -You can also specify a couple more initialisation parameters. For Guile, +You can also specify a couple more initialisation parameters. For Guile, @code{geiser-guile-load-path} is a list of paths to add to its load path when it's started, while @code{geiser-guile-init-file} is the path to an -initialisation file to be loaded on start-up. The equivalent variables +initialisation file to be loaded on start-up. The equivalent variables for Racket are @code{geiser-racket-collects} and @code{geiser-racket-init-file}. @subsubheading History -By default, Geiser won't record duplicates in your input history. If you +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 +controlled by the variable @code{geiser-repl-history-filename}. For example, my Geiser configuration includes the following line: @example (setq geiser-repl-history-filename "~/.emacs.d/geiser-history") @@ -318,7 +318,7 @@ directory. 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 REPLs. You can always bring the fairies +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 4d9662d..c9be7e7 100644 --- a/doc/thanks.texi +++ b/doc/thanks.texi @@ -25,7 +25,7 @@ answer my inquiries, but provided almost instant fixes to the few issues i found. Thanks also to the PLT and Guile communities, for showing me that -Geiser was not only possible, but a pleasure to hack on. And to the +Geiser was not only possible, but a pleasure to hack on. And to the Slime hackers, who led the way. diff --git a/doc/top.texi b/doc/top.texi index 2f218c4..ce6f024 100644 --- a/doc/top.texi +++ b/doc/top.texi @@ -8,14 +8,14 @@ to make Scheme hacking inside Emacs (even more) fun. @cindex corpses @cindex philosophy Or, to be precise, what @uref{http://hacks-galore.org/jao, i} consider -fun. Geiser is thus my humble contribution to the dynamic school of +fun. Geiser is thus my humble contribution to the dynamic school of expression, and a reaction against what i perceive as a derailment, in -modern times, of standard Scheme towards the static camp. Because i +modern times, of standard Scheme towards the static camp. Because i prefer growing and healing to poking at corpses, the continuously -running Scheme interpreter takes the center of the stage in Geiser. A +running Scheme interpreter takes the center of the stage in Geiser. A bundle of Elisp shims orchestrates the dialog between the Scheme interpreter, Emacs and, ultimately, the schemer, giving her access to -live metadata. Here's how. +live metadata. Here's how. @c Local Variables: @c mode: texinfo |