diff options
author | Jose Antonio Ortega Ruiz <jao@gnu.org> | 2010-08-21 00:37:39 +0200 |
---|---|---|
committer | Jose Antonio Ortega Ruiz <jao@gnu.org> | 2010-08-21 00:37:39 +0200 |
commit | 2319ffac96cca89f1df49d49e05da10652ac1afb (patch) | |
tree | 31385f1d5ae68463a7759c92b636c5f2b99850be /doc | |
parent | 103cfbb94a50c608d1c8510970bbfd9278bcd2f3 (diff) | |
download | geiser-2319ffac96cca89f1df49d49e05da10652ac1afb.tar.gz geiser-2319ffac96cca89f1df49d49e05da10652ac1afb.tar.bz2 |
In texinfo, @var is for meta-variables, not regular ones
Diffstat (limited to 'doc')
-rw-r--r-- | doc/fun.texi | 20 | ||||
-rw-r--r-- | doc/repl.texi | 12 |
2 files changed, 16 insertions, 16 deletions
diff --git a/doc/fun.texi b/doc/fun.texi index 71490d5..7fbd545 100644 --- a/doc/fun.texi +++ b/doc/fun.texi @@ -94,7 +94,7 @@ To determine what Scheme implementation corresponds to a given source file, Geiser uses the following algorithm: @enumerate @item -If the file-local variable @var{geiser-scheme-implementation} is +If the file-local variable @code{geiser-scheme-implementation} is 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: @@ -102,7 +102,7 @@ surrounded by @code{-*-} marks, as in: ;; -*- geiser-scheme-implementation: guile -*- @end example @item -If you've customized @var{geiser-active-implementations} so that it's a +If you've customized @code{geiser-active-implementations} so that it's a single-element list (as explained @ref{choosing-impl,,here}), that element is used as the chosen implementation. @item @@ -112,12 +112,12 @@ 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 -@var{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 If we haven't been lucky this far and you have customized -@var{geiser-default-implementation} to the name of a supported +@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 alec: one's always outsmarted @@ -127,7 +127,7 @@ ask you to explicitly choose the Scheme implementation. 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 most impoverishing) is probably limiting the active implementations to a -single one, while customizing @var{geiser-implementations-alist} is the +single one, while customizing @code{geiser-implementations-alist} is the most flexible (and, unsurprisingly, also the most complex). Here's the default value for the latter variable: @example @@ -141,7 +141,7 @@ 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 @var{geiser-implementations-alist} (or replace all of them) by +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 @@ -211,7 +211,7 @@ 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, for some obscure reason, that it be inactive by default, just set -@var{geiser-mode-autodoc-p} to @code{nil} in your customization files. +@code{geiser-mode-autodoc-p} to @code{nil} in your customization files. @img{autodoc-req, right} The way autodoc displays information deserves some explanation. It will first show the name of the module where the @@ -247,16 +247,16 @@ there are no enclosing parenthesis (i hope you see the logic in my madness). You can change the way Geiser displays the module/identifier combo by -customizing @var{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 initialization files. There's also a face -(@var{geiser-font-lock-autodoc-identifier}) that you can customize (for +(@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 (@var{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 diff --git a/doc/repl.texi b/doc/repl.texi index 8a73771..124d509 100644 --- a/doc/repl.texi +++ b/doc/repl.texi @@ -199,7 +199,7 @@ some related tips. 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 -variable @var{geiser-active-implementations} contains a list of those +variable @code{geiser-active-implementations} contains a list of those 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 @@ -210,17 +210,17 @@ forget about the richness of the Scheme ecosystem with something like @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 @var{geiser-guile-binary} and -@var{geiser-racket-binary}, which should be set to a string with the +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. @subsubheading History By default, Geiser won't record duplicates in your input history. If you -prefer it did, just set @var{geiser-repl-history-no-dups-p} to +prefer it did, just set @code{geiser-repl-history-no-dups-p} to @code{nil}. History entries are persistent across REPL sessions: they're saved in implementation-specific files whose location is controlled by -the variable @var{geiser-repl-history-filename}. For example, my Geiser +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") @@ -232,7 +232,7 @@ directory. @subsubheading Autodoc If you happen to love peace and quiet and prefer to keep your REPL's -echo area free from autodoc's noise, @var{geiser-repl-autodoc-p} is the +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 back, on a per REPL basis, using @kbd{C-c C-a}. |