aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/misc/reftex.texi85
1 files changed, 3 insertions, 82 deletions
diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi
index 599252fabf7..f1074d3d143 100644
--- a/doc/misc/reftex.texi
+++ b/doc/misc/reftex.texi
@@ -254,73 +254,6 @@ version 20.2. It has also been bundled and pre-installed with XEmacs
254plug-in package which is available from the @value{XEMACSFTP}. See the 254plug-in package which is available from the @value{XEMACSFTP}. See the
255XEmacs 21.x documentation on package installation for details. 255XEmacs 21.x documentation on package installation for details.
256 256
257Users of earlier Emacs distributions (including Emacs 19) or people
258craving for new features and bugs can get a copy of the @RefTeX{}
259distribution from the maintainer's web page. @xref{Imprint}, for more
260information. The following instructions will guide you through the
261process of installing such a distribution.
262
263@subsection Building and Installing
264
265Note: Currently installation is supported for Emacs only. XEmacs users
266might want to refer to the @RefTeX{} package available through the
267package system of XEmacs.
268
269@subsubheading Installation with make
270
271In order to install RefTeX, unpack the distribution and edit the header
272of the Makefile. Basically, you need to change the path specifications
273for Emacs Lisp files and info files. Also, enter the name of your Emacs
274executable (usually either @samp{emacs} or @samp{xemacs}).
275
276Then, type
277
278@example
279make
280make install
281@end example
282
283to compile and install the code and documentation.
284
285Per default @RefTeX{} is installed in its own subdirectory which might
286not be on your load path. In this case, add it to load path with a
287command like the following, replacing the sample directory with the one
288where @RefTeX{} is installed in your case.
289
290@example
291(add-to-list 'load-path "/path/to/reftex")
292@end example
293
294Put this command into your init file before other @RefTeX{}-related
295settings.
296
297@subsubheading Installation by Hand
298
299If you want to get your hands dirty, there is also the possibility to
300install by manually copying files.
301
302@enumerate a
303@item
304Copy the reftex*.el lisp files to a directory on your load path. Make
305sure that no old copy of @RefTeX{} shadows these files.
306@item
307Byte compile the files. The sequence of compiling should be:
308reftex-var.el, reftex.el, and then all the others.
309@item
310Copy the info file reftex.info to the info directory.
311@end enumerate
312
313@subsection Loading @RefTeX{}
314
315In order to make the most important functions for entering @RefTeX{}
316mode available add the following line to your init file.
317
318@example
319(require 'reftex)
320@end example
321
322@subsection Entering @RefTeX{} Mode
323
324@findex turn-on-reftex 257@findex turn-on-reftex
325@findex reftex-mode 258@findex reftex-mode
326@vindex LaTeX-mode-hook 259@vindex LaTeX-mode-hook
@@ -3259,9 +3192,9 @@ with the @kbd{g} key. To get this behavior, use instead
3259 3192
3260@AUCTeX{} is without doubt the best major mode for editing @TeX{} and @LaTeX{} 3193@AUCTeX{} is without doubt the best major mode for editing @TeX{} and @LaTeX{}
3261files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). 3194files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}).
3262If @AUCTeX{} is not part of your Emacs distribution, you can get 3195You can get it from its home page at @value{AUCTEXSITE}, but since
3263it@footnote{XEmacs 21.x users may want to install the corresponding 3196it is available from GNU ELPA, you can simply install it from @kbd{M-x
3264XEmacs package.} by FTP from the @value{AUCTEXSITE}. 3197list-packages}.
3265 3198
3266@menu 3199@menu
3267* AUCTeX-RefTeX Interface:: How both packages work together 3200* AUCTeX-RefTeX Interface:: How both packages work together
@@ -3611,18 +3544,6 @@ after the @samp{@{step+@}}, also when specifying how to get
3611context. 3544context.
3612 3545
3613@item 3546@item
3614@b{Idle timers in XEmacs}@*
3615@cindex Idle timer restart
3616@vindex reftex-use-itimer-in-xemacs
3617In XEmacs, idle timer restart does not work reliably after fast
3618keystrokes. Therefore @RefTeX{} currently uses the post command
3619hook to start the timer used for automatic crossref information. When
3620this bug gets fixed, a real idle timer can be requested with
3621@lisp
3622(setq reftex-use-itimer-in-xemacs t)
3623@end lisp
3624
3625@item
3626@b{Viper mode}@* 3547@b{Viper mode}@*
3627@cindex Viper mode 3548@cindex Viper mode
3628@cindex Key bindings, problems with Viper mode 3549@cindex Key bindings, problems with Viper mode