URLs for this file:
  http://angg.twu.net/eev/INSTALL
  http://angg.twu.net/eev/INSTALL.html
Version: 2002may11; copyleft Edrx. License: GPL.
Please help me with the headers! :)




Installation instructions for eev-0.93
======================================

Quick and dirty installation instructions
=========================================

Note: TOO MANY THINGS depend on you unpacking eev's package inside
~/eev/; if you try to place it anywhere else, *IT WILL NOT WORK*!!!!!!
But the installation is quite clean -- nothing in any other directory
will be touched, except for the "dotfiles" step, described below.

Part 1: downloading and unpacking:

  mkdir ~/eev/
  cd    ~/eev/
  wget  http://angg.twu.net/eev/eev-0.93.tar.gz
  tar -xvzf eev-0.93.tar.gz

Part 2: preparing your "dotfiles" (i.e., .bashrc, .cshrc, .emacs,
.gdbinit, .zshrc) for eev:

  cd ~/eev/
  make install-dotfiles

Backups of the current state of these dotfiles will be kept, and there
is an easy way to undo this step; this is described in (too much!)
detail below.

Part 3: trying eev. Start a new shell -- it need to be started after
the "make install-dotfiles" step -- and run Emacs from inside it.
Note: I'm pretty incompetent with XEmacsen; currently I'm only testing
this package on GNU Emacsen. That means: it may not work with XEmacs!
Anyway: if you do either

     emacs ~/eev/e/tutorial.e
or:
     emacs -nw ~/eev/e/tutorial.e

you'll be editing a text that can be used as an interactive tutorial.

That's it.




There used to be ways to test eev without even changing your dotfiles,
and even to run some interactive demos (based on Expect scripts) from
inside ~/eev/, but the documentation on these things is obsolete...


 



Configuring your .emacs/.bashrc/.zshrc/.cshrc/.gdbinit
======================================================

Some "dotfiles" in your system should be changed in order to configure
some programs for eev: Emacs should be instructed to load some elisp
libraries and to activate some features, shells should be prepared to
recognize the "ee" command (that they must treat as a shell function
or as an alias), and so on.

Starting with eev-0.93 these changes can be done with a simple
command:

  make dotfiles-install

Backups of the original files will be kept in files with names like
.emacs_pre-eev, .bashrc_pre-eev, etc. If these backup files already
exist and "make dotfiles-install" is invoked again, the old backup is
left unchanged -- it is not overwritten.

If you want to restore the dotfiles from the backups, there's a
command that does that:

  make dotfiles-restore

# TODO-dotfiles (find-eev "TODO" "dotfiles")





# eevblock-file-format

How the dotfiles are changed: the technical details
===================================================

And about the format of these files in ~/eev/rcfiles/ (I call them
"eevblock files"); this will be better described by examples. Suppose
that ~/eev/rcfiles/.bashrc contains:

  # Beginning of the eev block:
  # End of the eev block.
  comments
  more comments
  ::end of comments::
  this replaces
  the stuff
  in the eevblock

and your ~/.bashrc contains:

  lots of stuff
  # Beginning of the eev block:
  blah blah blah
  stuff
  # End of the eev block.
  more stuff

then running "make dotfiles-install" will change your ~/.bashrc to:

  lots of stuff
  # Beginning of the eev block:
  this replaces
  the stuff
  in the eevblock
  # End of the eev block.
  more stuff

that is, only the "eev block" of ~/.bashrc is modified; the "eev
block" is what is delimited by a line that is the same as the first
one in ~/eev/rcfiles/.bashrc ("# Beginning of the eev block:") and by
another that is the same as the second line in ~/eev/rcfiles/.bashrc
("# End of the eev block."); everything between these two "delimiter
lines" is replaced by the stuff in ~/eev/rcfiles/.bashrc that comes
after the line that says "::end of comments::", and everything in
~/eev/rcfiles/.bashrc between the first two lines and the line that
says "::end of comments::" is treated as just comments, and ignored.

If ~/.bashrc didn't contain an "eev block", then one is added at its
end, preceded by a blank line. That is, if ~/.bashrc had

  This is a .bashrc
  without an eev block

it will become, after "make dotfiles-install",

  This is a .bashrc
  without an eev block

  # Beginning of the eev block:
  this replaces
  the stuff
  in the eevblock
  # End of the eev block.

a backup of the old ~/.bashrc is made in a file named
~/.bashrc_pre-eev, but only if this ~/.bashrc_pre-eev didn't exist
before. This is described above.

Relevank links for following the details:

# (find-eev "Makefile" "dotfiles")
# (find-eev "changer.sh")
# (find-eev "changer.sh" "_pre-eev")
# (find-eev "changer.awk")
# (find-eev "changer.awk")
# (find-eev "rcfiles/")
# (find-eev "rcfiles/.bashrc")
# (find-eev "rcfiles/.cshrc")
# (find-eev "rcfiles/.emacs")
# (find-eev "rcfiles/.gdbinit")
# (find-eev "rcfiles/.zshrc")






Installing other documents in "info" format
===========================================

Sometimes you may want to install some manuals in "info" format in
your machine, and you don't have the permissions (or the intention!)
to do that in a system-wide fashion... The "eev block" of .emacs adds
the directory ~/info to the info-path, so you can just create a
directory ~/info/ and put the relevant files -- like xxx.info.gz,
xxx.info-1.gz, etc -- there. Someday I'll explain that in more
detail...






Things to write about:

installing expect (for eeg and eeg4)
running just the demos
  installing screen and gdb
