cgit.sxemacs.org Git - packages/blob - xemacs-packages/eshell/INSTALL

   1 Installing Eshell
   2 =================
   3
   4 THE SHORT FORM
   5 --------------
   6
   7 Here's exactly what to do, with no explanation why.
   8
   9   1. M-x load-file RET eshell-auto.el RET
  10   2. ESC : (add-to-list 'load-path "<path where Eshell resides>") RET
  11   3. ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET
  12   4. M-x eshell RET             ; should see a version banner displayed
  13   5. ls RET                     ; confirm that you see a file listing
  14   6. eshell-test RET            ; confirm that everything runs correctly
  15                                 ; use `M-x eshell-report-bug' if not
  16   7. cd ${dirname (locate-library "eshell-auto")} RET
  17   8. find-file Makefile RET
  18   9. [edit the Makefile to reflect your site]
  19  10. M-x eshell RET
  20  11. make install RET
  21  12. find-file $user-init-file RET
  22  13. [add the following lines to your .emacs file]
  23        (add-to-list 'load-path "<directory where you install Eshell>")
  24        (load "eshell-auto")
  25  14. M-x eshell RET
  26  15. customize-option #'eshell-modules-list RET
  27  16. [select the extension modules you prefer]
  28  17. [restart Emacs!]
  29  18. M-x info RET m Eshell RET  ; read the manual and enjoy!
  30
  31 THE LONG FORM
  32 -------------
  33
  34  1. Before building and installing Eshell, it is important to test
  35     that it will work properly on your system.  To do this, first load
  36     `eshell-auto', which will define certain autoloads required to run
  37     Eshell.  This can be done using the command `M-x load-file', and
  38     then selecting the file "eshell-auto.el".
  39
  40  2. In order for Emacs to find Eshell's files, the Eshell directory
  41     must be added to the `load-path' variable.  This can be done
  42     within Emacs by typing:
  43
  44     ESC : (add-to-list 'load-path "<path where Eshell resides>") RET
  45     ESC : (add-to-list 'load-path "<path where Pcomplete resides>") RET
  46
  47  2. Start Eshell from the distributed sources, using default settings,
  48     by typing `M-x eshell'.
  49
  50  3. Verify that Eshell is functional by typing "ls" followed by RET.
  51     You should have already seen a version banner announcing the
  52     version number of this release, followed by a prompt.
  53
  54  4. Run the test suite by typing "eshell-test" followed by RET in the
  55     Eshell buffer.  It is important that Emacs be left alone while the
  56     tests are running, since extraneous command input may cause some
  57     of the tests to fail (they were never intended to run in the
  58     background).  If all of the tests pass, Eshell should work just
  59     fine on your system.  If any of the tests fail, please send e-mail
  60     to the Eshell maintainer using the command `M-x eshell-report-bug'.
  61
  62  5. Edit the file `Makefile' in the directory containing the Eshell
  63     sources to reflect the location of certain Emacs dircetories at
  64     your site.  The only things you really have to change are the
  65     definitions of `lispdir' and `infodir'.  The elisp files will be
  66     copied to `lispdir', and the info file to `infodir'.
  67
  68  6. Type `make install' in the directory containing the Eshell
  69     sources.  This will byte-compile all of the `.el' files and copy
  70     both the source and compiled versions to the directories specified
  71     in the previous step.  It will also copy the info file, and add a
  72     corresponding entry to your "dir" file -- if install-info can be
  73     found.
  74
  75     If you only want to create the compiled elisp files, but don't
  76     want to install them, you can type just `make' instead.
  77
  78  7. Add the directory into which Eshell was installed to your
  79     `load-path' variable.  This can be done by adding the following
  80     line to your .emacs file:
  81
  82     (add-to-list 'load-path "/usr/local/share/emacs/site-lisp/eshell")
  83
  84     The actual directory on your system may differ.
  85
  86  8. To install Eshell privately, edit your .emacs file; to install
  87     Eshell site-wide, edit the file `site-start.el' in your site-lisp
  88     directory (usually `/usr/local/share/emacs/site-lisp' or something
  89     similar).  In either case enter the following line into the
  90     appropriate file:
  91
  92     (load "eshell-auto")
  93
  94  9. Restart Emacs.  After restarting, customize the variable
  95     `eshell-modules-list'.  This variable selects which Eshell
  96     extension modules you want to use.  You will find documentation on
  97     each of those modules in the Info manual.
  98
  99 10. Read the Info manual.  Although Eshell behaves like most ordinary
 100     shells, it has other advanced features and Lisp integration
 101     facilities that require a more thorough presentation than these
 102     meager notes.
 103
 104 How to make typeset documentation from eshell.doci
 105 ======================================================
 106
 107    If you have TeX installed at your site, you can make a typeset
 108 manual from `eshell.doci' by typing "make eshell.dvi".  If you prefer
 109 a postscript version of this file, use "make eshell.ps" instead.