[AUCTeX-commit] Changes to install.texi

[Ralf Angeli]

CVSROOT:        /sources/auctex
Module name:    reftex
Changes by:     Ralf Angeli <angeli>    07/03/08 22:06:06

Index: install.texi
===================================================================
RCS file: install.texi
diff -N install.texi
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ install.texi        8 Mar 2007 22:06:06 -0000       1.1
@@ -0,0 +1,125 @@
address@hidden rawfile
address@hidden macros.texi
address@hidden
address@hidden
address@hidden ifset
+
address@hidden Building and Installing
+
address@hidden 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 info files.  Also, enter the name of your Emacs
+executable (usually either @samp{emacs} or @samp{xemacs}).
+
+Then, type 
+
address@hidden
+make
+make install
address@hidden example
+
+to compile and install the code and documentation.
+
+Per default @RefTeX{} is installed in its own subdirectory which might
+not be on your load path.  In this case, add it to load path with a
+command like the following, replacing the sample directory with the one
+where @RefTeX{} is installed in your case.
+
address@hidden
+(add-to-list 'load-path "/path/to/reftex")
address@hidden example
+
+Put this command into your init file.
+
address@hidden Installation with install.el
+
+If you don't have @samp{make} available, you can let install.el handle
+installation.  Stefan Monnier has written this neat little file for
+installing all sorts of Emacs extensions as a package.  You can get it
+from @uref{http://www.iro.umontreal.ca/~monnier/elisp/install.el}.
+Follow the instructions in the file in order to install @RefTeX{} with
+it.
+
address@hidden Installation by Hand
+
+If you want to get your hands dirty, there is also the possibility to
+install by manually copying files.
+
address@hidden a
address@hidden
+Copy the reftex*.el lisp files to a directory on your load path.  Make
+sure that no old copy of @RefTeX{} shadows these files.
address@hidden
+Byte compile the files.  The sequence of compiling should be:
+reftex-var.el, reftex.el, and then all the others.
address@hidden
+Copy the info file reftex.info to the info directory.
address@hidden enumerate
+
address@hidden Loading @RefTeX{}
+
+In order to make the most important functions for entering @RefTeX{}
+mode available add the following line to your init file.
+
address@hidden
+(require 'reftex)
address@hidden example
+
address@hidden Entering @RefTeX{} Mode
+
address@hidden turn-on-reftex
address@hidden reftex-mode
address@hidden LaTeX-mode-hook
address@hidden latex-mode-hook
+To turn @RefTeX{} Mode on and off in a particular buffer, use
address@hidden reftex-mode @key{RET}}.  To turn on @RefTeX{} Mode for all
+LaTeX files, add the following lines to your @file{.emacs} file:
+
address@hidden
+(add-hook 'LaTeX-mode-hook 'turn-on-reftex)   ; with AUCTeX LaTeX mode
+(add-hook 'latex-mode-hook 'turn-on-reftex)   ; with Emacs latex mode
address@hidden example
+
+That's all!
+
+To get started, read the documentation, in particular the
address@hidden rawfile
+section RefTeX in a Nutshell in the manual.
address@hidden ifset
address@hidden rawfile
+summary. (@pxref{RefTeX in a Nutshell})
address@hidden ifclear
+
+In order to produce a printed version of the documentation, use
address@hidden pdf} to produce a reftex.pdf file.  Analogously you can use
+the @code{dvi}, @code{ps}, or @code{html} targets to create DVI,
+PostScript or HTML files.
+
address@hidden Environment
address@hidden Finding files
address@hidden BibTeX database files, not found
address@hidden TeX files, not found
address@hidden @code{TEXINPUTS}, environment variable
address@hidden @code{BIBINPUTS}, environment variable
+
address@hidden needs to access all files which are part of a multifile
+document, and the BibTeX database files requested by the
address@hidden command.  To find these files, @RefTeX{} will
+require a search path, i.e. a list of directories to check.  Normally
+this list is stored in the environment variables @code{TEXINPUTS} and
address@hidden which are also used by @RefTeX{}.  However, on some
+systems these variables do not contain the full search path.  If
address@hidden does not work for you because it cannot find some files,
address@hidden rawfile
+see the section Finding Files in the manual.
address@hidden ifset
address@hidden rawfile
address@hidden Files}.
address@hidden ifclear
+
address@hidden Local Variables: 
address@hidden mode: texinfo
address@hidden TeX-master: t
address@hidden End: