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 @@
[EMAIL PROTECTED] rawfile
[EMAIL PROTECTED] macros.texi
[EMAIL PROTECTED]
[EMAIL PROTECTED]
[EMAIL PROTECTED] ifset
+
[EMAIL PROTECTED] Building and Installing
+
[EMAIL PROTECTED] 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
+
[EMAIL PROTECTED]
+make
+make install
[EMAIL PROTECTED] 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.
+
[EMAIL PROTECTED]
+(add-to-list 'load-path "/path/to/reftex")
[EMAIL PROTECTED] example
+
+Put this command into your init file.
+
[EMAIL PROTECTED] 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.
+
[EMAIL PROTECTED] Installation by Hand
+
+If you want to get your hands dirty, there is also the possibility to
+install by manually copying files.
+
[EMAIL PROTECTED] a
[EMAIL PROTECTED]
+Copy the reftex*.el lisp files to a directory on your load path. Make
+sure that no old copy of @RefTeX{} shadows these files.
[EMAIL PROTECTED]
+Byte compile the files. The sequence of compiling should be:
+reftex-var.el, reftex.el, and then all the others.
[EMAIL PROTECTED]
+Copy the info file reftex.info to the info directory.
[EMAIL PROTECTED] enumerate
+
[EMAIL PROTECTED] Loading @RefTeX{}
+
+In order to make the most important functions for entering @RefTeX{}
+mode available add the following line to your init file.
+
[EMAIL PROTECTED]
+(require 'reftex)
[EMAIL PROTECTED] example
+
[EMAIL PROTECTED] Entering @RefTeX{} Mode
+
[EMAIL PROTECTED] turn-on-reftex
[EMAIL PROTECTED] reftex-mode
[EMAIL PROTECTED] LaTeX-mode-hook
[EMAIL PROTECTED] latex-mode-hook
+To turn @RefTeX{} Mode on and off in a particular buffer, use
[EMAIL PROTECTED] reftex-mode @key{RET}}. To turn on @RefTeX{} Mode for all
+LaTeX files, add the following lines to your @file{.emacs} file:
+
[EMAIL PROTECTED]
+(add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
+(add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode
[EMAIL PROTECTED] example
+
+That's all!
+
+To get started, read the documentation, in particular the
[EMAIL PROTECTED] rawfile
+section RefTeX in a Nutshell in the manual.
[EMAIL PROTECTED] ifset
[EMAIL PROTECTED] rawfile
+summary. (@pxref{RefTeX in a Nutshell})
[EMAIL PROTECTED] ifclear
+
+In order to produce a printed version of the documentation, use
[EMAIL PROTECTED] 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.
+
[EMAIL PROTECTED] Environment
[EMAIL PROTECTED] Finding files
[EMAIL PROTECTED] BibTeX database files, not found
[EMAIL PROTECTED] TeX files, not found
[EMAIL PROTECTED] @code{TEXINPUTS}, environment variable
[EMAIL PROTECTED] @code{BIBINPUTS}, environment variable
+
[EMAIL PROTECTED] needs to access all files which are part of a multifile
+document, and the BibTeX database files requested by the
[EMAIL PROTECTED] 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
[EMAIL PROTECTED] which are also used by @RefTeX{}. However, on some
+systems these variables do not contain the full search path. If
[EMAIL PROTECTED] does not work for you because it cannot find some files,
[EMAIL PROTECTED] rawfile
+see the section Finding Files in the manual.
[EMAIL PROTECTED] ifset
[EMAIL PROTECTED] rawfile
[EMAIL PROTECTED] Files}.
[EMAIL PROTECTED] ifclear
+
[EMAIL PROTECTED] Local Variables:
[EMAIL PROTECTED] mode: texinfo
[EMAIL PROTECTED] TeX-master: t
[EMAIL PROTECTED] End:
_______________________________________________
auctex-commit mailing list
[EMAIL PROTECTED]
http://lists.gnu.org/mailman/listinfo/auctex-commit
