GNU Info

Info Node: (eshell)Installation

(eshell)Installation


Next: Command basics Prev: What is Eshell? Up: Top
Enter node , (file) or (file)node

Installation
************

   As mentioned above, Eshell comes preinstalled as of Emacs 21.  If
you're using Emacs 20.4 or later, or XEmacs 21, you can download the
most recent version of Eshell from
<http://www.gci-net.com/users/j/johnw/Emacs/eshell.tar.gz>.

   However, if you are using Emacs 21, you may skip this section.

Short Form
==========

   Here's exactly what to do, with no explanation why:

  1. `M-x load-file RET eshell-auto.el RET'.

  2. `ESC : (add-to-list 'load-path "<path where Eshell resides>") RET'.

  3. `ESC : (add-to-list 'load-path "<path where Pcomplete resides>")
     RET'.

  4. `M-x eshell RET'.

     You should see a version banner displayed.

  5. `ls RET'.

     Confirm that you see a file listing.

  6. `eshell-test RET'.

     Confirm that everything runs correctly.  Use `M-x
     eshell-report-bug' if not.

  7. `cd ${dirname (locate-library "eshell-auto")} RET'.

  8. `find-file Makefile RET'.

  9. Edit the Makefile to reflect your site.

 10. `M-x eshell RET'.

 11. `make install RET'.

 12. `find-file $user-init-file RET'.

 13. Add the following lines to your `.emacs' file:

          (add-to-list 'load-path "<directory where you install Eshell>")
          (load "eshell-auto")

 14. `M-x eshell RET'.

 15. `customize-option #'eshell-modules-list RET'.

 16. Select the extension modules you prefer.

 17. Restart Emacs!

 18. `M-x info RET m Eshell RET'.

     Read the manual and enjoy!

Long Form
=========

  1. Before building and installing Eshell, it is important to test
     that it will work properly on your system.  To do this, first load
     the file `eshell-auto', which will define certain autoloads
     required to run Eshell.  This can be done using the command `M-x
     load-file', and then selecting the file `eshell-auto.el'.

  2. In order for Emacs to find Eshell's files, the Eshell directory
     must be added to the `load-path' variable.  This can be done
     within Emacs by typing:

          ESC : (add-to-list 'load-path "<path where Eshell resides>") RET
          ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET

  3. Start Eshell from the distributed sources, using default settings,
     by typing `M-x eshell'.

  4. Verify that Eshell is functional by typing `ls' followed by <RET>.
     You should have already seen a version banner announcing the
     version number of this release, followed by a prompt.

  5. Run the test suite by typing `eshell-test' followed by <RET> in
     the Eshell buffer.  It is important that Emacs be left alone while
     the tests are running, since extraneous command input may cause
     some of the tests to fail (they were never intended to run in the
     background).  If all of the tests pass, Eshell should work just
     fine on your system.  If any of the tests fail, please send e-mail
     to the Eshell maintainer using the command `M-x eshell-report-bug'.

  6. Edit the file `Makefile' in the directory containing the Eshell
     sources to reflect the location of certain Emacs directories at
     your site.  The only things you really have to change are the
     definitions of `lispdir' and `infodir'.  The elisp files will be
     copied to `lispdir', and the info file to `infodir'.

  7. Type `make install' in the directory containing the Eshell sources.
     This will byte-compile all of the `*.el' files and copy both the
     source and compiled versions to the directories specified in the
     previous step.  It will also copy the info file, and add a
     corresponding entry to your `dir' file---if the program
     `install-info' can be found on your system.

     If you only want to create the compiled elisp files, but don't
     want to install them, you can type just `make' instead.

  8. Add the directory into which Eshell was installed to your
     `load-path' variable.  This can be done by adding the following
     line to your `.emacs' file:

          (add-to-list 'load-path "/usr/local/share/emacs/site-lisp/eshell")

     The actual directory on your system may differ.

  9. To install Eshell privately, edit your `.emacs' file; to install
     Eshell site-wide, edit the file `site-start.el' in your
     `site-lisp' directory (usually `/usr/local/share/emacs/site-lisp'
     or something similar).  In either case enter the following line
     into the appropriate file:

          (load "eshell-auto")

 10. Restart Emacs.  After restarting, customize the variable
     `eshell-modules-list'.  This variable selects which Eshell
     extension modules you want to use.  You will find documentation on
     each of those modules in the Info manual.

   If you have TeX installed at your site, you can make a typeset manual
from `eshell.texi'.

  1. Run TeX by typing `texi2dvi eshell.texi'.  (With Emacs 21.1 or
     later, typing `make eshell.dvi' in the `man/' subdirectory of the
     Emacs source distribution will do that.)

  2. Convert the resulting device independent file `eshell.dvi' to a
     form which your printer can output and print it.  If you have a
     postscript printer, there is a program, `dvi2ps', which does that;
     there is also a program which comes together with TeX, `dvips',
     which you can use.  For other printers, use a suitable DVI driver,
     e.g., `dvilj4' for LaserJet-compatible printers.


automatically generated by info2www version 1.2.2.9