Installation

This section describes the installation of Elib, the GNU emacs lisp library. You should install not only the library itself, but also the on-line documentation so that your users will know how to use it. You can create typeset documentation from the file `elib.texinfo' as well as an on-line info file. The following steps are also described in the file `INSTALL' in the source directory.

• Library installation: How to install Elib on your system.
• On-line manual installation: How to install the on-line manual.
• Typeset manual installation: How to create typeset documentation about Elib.

Installation of the elisp library

1. Edit the file `Makefile' to reflect the situation at your site. The only thing you will have to change at this stage is the definition of LISPDIR. In this directory, a subdirectory with the name `elib' will be created. All elisp files of the library will be copied there when you do the actual installation (see step 2. below). We suggest you use your local elisp directory (usually `/usr/local/lib/elisp' or something similar) for this.
2. Type `make install' in the source directory. This will byte-compile all .el files of the library and create the subdirectory `elib' in the directory you specified in step 1. It will also copy both the .el and the .elc files of the library there. If you don't want to install the .el files but only the .elc files (the byte-compiled files), you can type `make install_elc' instead of `make install'. If you only want to create the compiled elisp files, but don't want to install them, you can type `make elcfiles' instead. This is what happens if you only type `make' without parameters.
3. Edit the file `default.el' in your emacs lisp directory (usually `/usr/gnu/emacs/lisp' or something similar) and enter the contents of the file `elib-startup.el' into it. This file was created from the file `startup_template.el' by the make in step 2. It contains an additional entry in the variable load-path, which determines the path where emacs looks for elisp files (ending in .el or .elc).

Installation of the on-line manual.

1. Create the info file `elib.info' from `elib.texinfo'. If you have the makeinfo program, you can do this by running it on `elib.texinfo'. Otherwise you can do it with emacs by running these steps:
   1. Read `elib.texinfo' into an emacs buffer.
   2. Type `M-X texinfo-format-buffer'
   3. Save the newly created info file `elib'.
2. Move the info file `elib.info' to your standard info directory. Usually this is is the directory `/usr/gnu/emacs/info' or something similar. (See step 3 above).
3. Edit the file `dir' in the info directory and enter one line to contain a pointer to the info file `elib'. The line can, for instance, look like this:

   * Elib: (elib.info).     The Emacs Lisp Library.
   

How to make typeset documentation from elib.texinfo

You can also make a typeset manual from the file `elib.texinfo'. To to this, you must have the TeX text formatting program installed. Just follow these steps:

1. If the file `texinfo.tex' is not properly installed in the path given by the environment variable TEXINPUTS, get it and put it in the same directory as `elib.texinfo' (the source directory of elib). This file contains macros used by the TeX text formatting program to produce typeset output from a texinfo file. You can get this from, e.g., prep.ai.mit.edu in the US or from isy.liu.se in Europe.
2. Run TeX by typing `tex elib.texinfo'. You might need to do this twice to get all cross references correct. If you have the texindex program, you can create a sorted index by typing `texindex elib.??' between the two TeX passes. If you don't do this, you still get a typeset manual, but you will not get the index.
3. Convert the resulting device independent file `elib.dvi' to a form which your printer can output and print it. If you have a postscript printer there is a program, dvi2ps, which can do this. There is also a program which comes together with TeX, dvips, which you can use.