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

   1 $Id: INSTALL,v 1.1.1.1 1998-10-07 11:10:57 jareth 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.texi as well
   7 as an on-line info file.
   8
   9
  10 I. Installation
  11
  12  1) Edit the Makefile to reflect the situation at your site. The only
  13     things you will have to change at this stage is the definition of
  14     locallisppath and infodir.  In the locallisppath directory, a
  15     subdirectory with the name `elib' will be created.  All elisp
  16     files of the library will be copied there when you do the actual
  17     installation (see step 2. below).
  18
  19     We suggest you use the directory which is intended for this in the
  20     emacs distribution (usually /usr/local/share/emacs/site-lisp or
  21     something similar) for this.
  22
  23  2) Type `make install' in the source directory. This will
  24     byte-compile all .el-files of the library and create the
  25     subdirectory `elib' in the directory you specified in step 1.
  26     It will also copy both the .el and the .elc files of the library
  27     there.
  28
  29     If you only want to create the compiled elisp files, but don't
  30     want to install them,  you can type `make' instead.
  31
  32  3) Edit the file `default.el' in your emacs lisp directory (usually
  33     /usr/gnu/emacs/lisp or something similar) and enter the contents
  34     of the file `elib-startup.el' into it.  This file was created from
  35     the file `startup_template.el' by the make in step 2.
  36
  37
  38 II. Installation of the on-line manual.
  39
  40  1) Create the info file `elib.info' from elib.texi.  This is done if
  41     you use `make' or `make install'.
  42
  43  2) Move the info file `elib.info' to your standard info directory.
  44     Usually this is /usr/local/share/info or something similar. See
  45     step I.3 above.
  46
  47  3) Edit the file `dir' in the info directory and enter one line
  48     containing a pointer to the info file elib.  The line can, for
  49     instance, look like this:
  50
  51     * Elib: (elib.info).        The Emacs Lisp Library.
  52
  53
  54 III. How to make written documentation from elib.texi
  55
  56 You can also make a typeset manual from the file elib.texi.  Just
  57 follow these steps:
  58
  59  1) If the file texinfo.tex is not properly installed in the path
  60     given by the environment variable $TEXINPUTS, get it and put it in
  61     the same directory as elib.texi.  This file contains macros
  62     used by the TeX formatting program to produce typeset output from
  63     a texinfo file. You can get this for instance from from
  64     prep.ai.mit.edu in the US or from ftp.isy.liu.se in Europe.
  65
  66  2) Run TeX by typing `tex elib.texi'.  You might need to do this
  67     twice to get correct cross references.
  68
  69  3) Convert the resulting device independent file `elib.dvi' to a form
  70     which your printer can output and print it.  If you have
  71     postscript printers there is a program, dvi2ps, which can do this.
  72     There is also a program which comes with TeX, dvips, which you can
  73     use.