home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / elib-0.06 / INSTALL < prev    next >
Encoding:
Text File  |  1993-01-24  |  3.3 KB  |  79 lines
  1. $Id: INSTALL,v 0.5 1993/01/16 16:32:34 inge Exp $
  2.  
  3. This file describes the installation of Elib, the GNU emacs lisp
  4. library.  You should install not only the library but also the on-line
  5. documentation so that your users will know how to use it.  You can
  6. also create written documentation from the file elib.texinfo as well
  7. as an on-line info file.
  8.  
  9.  
  10. I. Installation of the library
  11.  
  12.  1) Edit the Makefile to reflect the situation at your site. The only
  13.     thing you will have to change at this stage is the definition of
  14.     LISPDIR.  In this directory, a subdirectory with the name `elib'
  15.     will be created.  All elisp files of the library will be copied
  16.     there when you do the actual installation (see step 2. below). 
  17.     We suggest you use your local elisp directory (usually
  18.     /usr/local/lib/elisp or something similar) for this.
  19.  
  20.  2) Type `make install' in the source directory. This will
  21.     byte-compile all .el-files of the library and create the
  22.     subdirectory `elib' in the directory you specified in step 1.
  23.     It will also copy both the .el and the .elc files of the library
  24.     there.
  25.  
  26.     If you only want to create the compiled elisp files, but don't
  27.     want to install them,  you can type `make elcfiles' instead. 
  28.  
  29.     If you don't want to install the .el-files but only the .elc-files
  30.     (the byte-compiled files), you can type `make install_elc' instead
  31.     of `make install'.
  32.  
  33.  3) Edit the file `default.el' in your emacs lisp directory (usually
  34.     /usr/gnu/emacs/lisp or something similar) and enter the contents
  35.     of the file `elib-startup.el' into it.  This file was created from
  36.     the file `startup_template.el' by the make in step 2. 
  37.  
  38.  
  39. II. Installation of the on-line manual.
  40.  
  41.  1) Create the info file `elib.info' from elib.texinfo.  If you have
  42.     the makeinfo program, you can do it by running it on elib.texinfo. 
  43.     Otherwise you can do it with emacs by running these steps:
  44.      1. Read elib.texinfo into an emacs buffer.
  45.      2. Type M-X texinfo-format-buffer
  46.      3. Save the newly created info file elib.info.
  47.  
  48.  2) Move the info file `elib.info' to your standard info directory.
  49.     Usually this is /usr/gnu/emacs/info or something similar. See step
  50.     3 above.
  51.  
  52.  3) Edit the file `dir' in the info directory and enter one line
  53.     containing a pointer to the info file elib.  The line can, for
  54.     instance, look like this:
  55.  
  56.     * Elib: (elib.info).    The Emacs Lisp Library.
  57.  
  58.  
  59. III. How to make written documentation from elib.texinfo
  60.  
  61. You can also make a typeset manual from the file elib.texinfo.  Just
  62. follow these steps:
  63.  
  64.  1) If the file texinfo.tex is not properly installed in the path
  65.     given by the environment variable $TEXINPUTS, get it and put it in
  66.     the same directory as elib.texinfo.  This file contains macros
  67.     used by the TeX formatting program to produce typeset output from
  68.     a texinfo file. You can get this for instance from from
  69.     prep.ai.mit.edu in the US or from isy.liu.se in Europe.
  70.  
  71.  2) Run TeX by typing `tex elib.texinfo'.  You might need to do this
  72.     twice to get correct cross references.
  73.  
  74.  3) Convert the resulting device independent file `elib.dvi' to a form
  75.     which your printer can output and print it.  If you have
  76.     postscript printers there is a program, dvi2ps, which can do this.
  77.     There is also a program which comes with TeX, dvips, which you can
  78.     use.
  79.