path: root/doc/install.texi

@node Installation
@chapter Installation

@menu
* Must needs::
* The easy and quick way::
* From the source's mouth::
* Friends::
@end menu

@node Must needs, The easy and quick way, Installation, Installation
@section Must needs

@cindex supported versions
@cindex versions supported
If Geiser came with any guarantees, you'd break all of them by not using
GNU Emacs @value{EMACS_VERSION} (or better: i regularly use it with a
recent Emacs snapshot) and at least one of the supported Schemes,
namely:

@itemize @bullet
@item
@uref{http://www.gnu.org/software/guile, Guile} @value{GUILE_VERSION} or
better
@item
@uref{http://call-cc.org, Chicken} @value{CHICKEN_VERSION} or better
@item
@uref{https://www.gnu.org/software/mit-scheme/, MIT/GNU Scheme}
@value{MIT_VERSION} or better
@item
@uref{http://synthcode.com/scheme/chibi/, Chibi Scheme}
@value{CHIBI_VERSION} or better
@item
@uref{http://www.scheme.com, Chez Scheme} @value{CHEZ_VERSION} or better
@item
@uref{http://gambitscheme.org/wiki/index.php/Main_Page, Gambit}
@value{GAMBIT_VERSION} or better
@item
@uref{http://www.racket-lang.org, Racket} @value{RACKET_VERSION} or better
@end itemize

Since Geiser supports multiple REPLs, having all of them will just add
to the fun.

You'll also need Geiser itself.  The quickest installation is via its
ELPA package, as described in the next section.  If you prefer to use
the source code directly, it's not that difficult either: just keep on
reading.

@node The easy and quick way, Chicken installation, Must needs, Installation
@section The easy and quick way

@cindex quick install
@cindex ELPA
Did i mention that the easiest way of installing Geiser is using its
@uref{http://emacswiki.org/emacs/ELPA, ELPA} package?  If you're using
Emacs 24, @uref{http://emacswiki.org/emacs/ELPA, ELPA} is already there;
for earlier versions, the page i just linked to twice will tell you
where to find the goodies.

ELPA packages live in repositories accessible via HTTP.  You can find
Geiser's package in either
@uref{http://stable.melpa.org/#/geiser, MELPA stable} or, if you
like living on the bleeding edge,
@uref{http://melpa.org/#/geiser, MELPA} (directly from the git
repo).  To tell Emacs that an ELPA repo exists, you add it to
@code{package-archives}:

@example
(require 'package)
;;; either the stable version:

(add-to-list 'package-archives
  ;; choose either the stable or the latest git version:
  ;; '("melpa-stable" . "http://stable.melpa.org/packages/")
  '("melpa-unstable" . "http://melpa.org/packages/"))

(package-initialize)
@end example

And then installing Geiser is as easy as:

@example
M-x package-install RET geiser RET
@end example

Unless you are using Gambit or Chicken, with that, you are pretty much
all set up.  See @ref{The REPL} to start using Geiser.  If you plan to
use Chicken or Gambit, just keep reading below for a few additional
instructions to set up your environment.

@ifnotinfo
And, by the way, if you prefer to keep reading this manual within Emacs,
@kbd{C-h i m Geiser RET} will bring you to the info version of it that
you just installed!
@end ifnotinfo

@node From the source's mouth, Friends, Gambit installation, Installation
@section Installing from source

@subsubheading Downloading Geiser

@cindex use the source, Luke
The latest release tarballs can be found @releasesref{here}.

If you feel like living on the bleeding edge, just grab Geiser from its
Git repository @uref{http://git.savannah.nongnu.org/cgit/geiser.git/, over
at Savannah}, either with the following incantation:

@example
git clone git://git.sv.gnu.org/geiser.git
@end example

@noindent or, if you happen to live behind a firewall, with the alternative:

@example
git clone http://git.sv.gnu.org/r/geiser.git
@end example

@noindent
You can also follow Geiser's development in
@uref{https://gitlab.com/jaor/geiser, one}
@uref{http://repo.or.cz/w/geiser.git, or}
@uref{http://gitorious.org/geiser, three} mirrors that 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.

@subsubheading Setting it up

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
line to your Emacs initialisation file (be it @file{~/.emacs},
@file{~/.emacs.d/init.el} or any of its moral equivalents):

@example
(load-file "~/lisp/geiser/elisp/geiser.el")
@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
@ifhtml
@ref{quick-start,,go}.
@end ifhtml
@ifnothtml
go (@pxref{The REPL}).
@end ifnothtml

@node Friends,  , From the source's mouth, Installation
@section Friends

Although Geiser does not need them, it plays well with (and is enhanced
by) the following Emacs packages:

@cindex ac-geiser
@cindex autocomplete
@cindex paredit
@cindex company
@cindex quack
@itemize @bullet
@item @uref{http://www.emacswiki.org/emacs/ParEdit, Paredit}.
@anchor{paredit}
Regardless of whether you use Geiser or not, you shouldn't be coding
in any Lisp dialect without the aid of Taylor Campbell's structured
editing mode.
@item @uref{http://company-mode.github.io/, Company}.
Nikolaj Schumacher's and Dmitry Gutov's @code{company-mode} provides a
generic front-end for completion engines (such as Geiser's), with pretty
and automatic completion lists.
@item @uref{https://github.com/xiaohanyu/ac-geiser/, ac-geiser}
If you prefer @code{auto-complete-mode} to @code{company-mode}, Xiao
Hanyu's @code{ac-geiser}, which provides a Geiser plugin for the
popular @uref{https://www.emacswiki.org/emacs/AutoComplete, Emacs Auto
Completion Mode}, is the package for you.  Like Geiser,
@code{ac-geiser} is available in MELPA, and also as an
@code{el-get} package.
@end itemize

@noindent
You just need to install and setup them as usual, for every package's
definition of usual.  Geiser will notice their presence and react
accordingly.

@c Local Variables:
@c mode: texinfo
@c TeX-master: "geiser"
@c End: