Source

reftex / INSTALL

Full commit
This is the INSTALL file of the RefTeX distribution, version 4.9 


1a. INSTALLATION WITH MAKE
==========================

In order to install RefTeX, unpack the distribution and edit the
header of the Makefile.  Basically, you need to change the path
specifications for Emacs lisp files and the info files.  Also, enter
the name of your Emacs executable (usually either `emacs' or
`xemacs').

Then, type 

   make
   make install

to compile and install the code and documentation.

1b. INSTALLATION BY HAND
========================

If you don't have `make' available, you can do the following to
install.
a) Copy the reftex*.el lisp files to a directory on your load path.
   Make sure that no old copy of reftex.el or reftex.elc shadows these 
   files.
b) Byte compile the files.  The sequence of compiling should be:
   reftex-var.el, reftex.el, and then all the others.
c) Copy the info files reftex, reftex-1, reftex-2, reftex-3 to the
   info directory.


2. Copy the following lines into your .emacs file:
==================================================

  (autoload 'reftex-mode     "reftex" "RefTeX Minor Mode" t)
  (autoload 'turn-on-reftex  "reftex" "RefTeX Minor Mode" nil)
  (autoload 'reftex-citation "reftex-cite" "Make citation" nil)
  (autoload 'reftex-index-phrase-mode "reftex-index" "Phrase mode" t)
  (add-hook 'LaTeX-mode-hook 'turn-on-reftex)   ; with AUCTeX LaTeX mode
  (add-hook 'latex-mode-hook 'turn-on-reftex)   ; with Emacs latex mode

That's all!

To get started, read the documentation, in particular the summary
"RefTeX in a Nutshell".  You can find this summary both in the file
NUTSHELL and as part of the TeX-Info documentation.

In order to produce a printed version of the documentation, use
`make dvi' or `make ps' to produce a reftex.dvi or reftex.ps file.

In order to produce the documentation in HTML format, use `make html'.