\input texinfo @c -*-texinfo-*-
@c %**start of header
-@setfilename ../reftex
+@setfilename ../info/reftex
@settitle RefTeX User Manual
-@dircategory Editors
+@dircategory Emacs
@direntry
* RefTeX: (reftex). Emacs support for LaTeX cross-references and citations.
@end direntry
@synindex ky cp
@syncodeindex vr cp
@syncodeindex fn cp
-@set VERSION 4.12
-@set EDITION 4.12
-@set DATE March 2000
+@set VERSION 4.15
+@set EDITION 4.15
+@set DATE November 2000
@set AUTHOR Carsten Dominik
@set AUTHOR-EMAIL dominik@@astro.uva.nl
@set MAINTAINER Carsten Dominik
This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for
@b{Ref@TeX{}} @value{VERSION}@refill
-Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
+Copyright (c) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
-Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
-
-@ignore
-Permission is granted to process this file through TeX
-and print the results, provided the printed document
-carries a copying permission notice identical to this
-one except for the removal of this paragraph (this
-paragraph not being relevant to the printed manual).
-
-@end ignore
-Permission is granted to copy and distribute modified
-versions of this manual under the conditions for
-verbatim copying, provided that the entire resulting
-derive work is distributed under the terms of a permission
-notice identical to this one.
-
-Permission is granted to copy and distribute
-translations of this manual into another language,
-under the above conditions for modified versions,
-except that this permission notice may be stated in a
-translation approved by the Free Software Foundation.
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU
+Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
@end ifinfo
@titlepage
@author by Carsten Dominik
@page
-Copyright @copyright{} 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
+Copyright @copyright{} 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
@sp 2
This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for
@sp 2
-Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
-
-Permission is granted to copy and distribute modified
-versions of this manual under the conditions for
-verbatim copying, provided that the entire resulting
-derive work is distributed under the terms of a permission
-notice identical to this one.
-
-Permission is granted to copy and distribute
-translations of this manual into another language,
-under the above conditions for modified versions,
-except that this permission notice may be stated in a
-translation approved by the Free Software Foundation.
-
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU
+Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
@end titlepage
@page
the window configuration before @code{reftex-toc} (@kbd{C-c =}) was
called.@refill
-@item mouse-2
+@item Mouse-2
@vindex reftex-highlight-selection
Clicking with mouse button 2 on a line has the same effect as @key{RET}.
See also variable @code{reftex-highlight-selection}, @ref{Options
selection process was started. When entries have been marked, @key{RET}
references all marked labels.@refill
-@item mouse-2
+@item Mouse-2
@vindex reftex-highlight-selection
Clicking with mouse button 2 on a label will accept it like @key{RET}
would. See also variable @code{reftex-highlight-selection}, @ref{Options
@cindex Displaying cross-references
@cindex Viewing cross-references
@kindex C-c &
-@kindex S-mouse-2
+@kindex S-Mouse-2
When point is idle on the argument of a @code{\ref} macro, the echo area
will display some information about the label referenced there. Note
Insert a citation referencing the article at point into the buffer from
which the selection process was started.@refill
-@item mouse-2
+@item Mouse-2
@vindex reftex-highlight-selection
Clicking with mouse button 2 on a citation will accept it like @key{RET}
would. See also variable @code{reftex-highlight-selection}, @ref{Options
@cindex Citation info
@cindex Viewing citations
@kindex C-c &
-@kindex S-mouse-2
+@kindex S-Mouse-2
@findex reftex-view-crossref
@findex reftex-mouse-view-crossref
@findex reftex-view-crossref
@findex reftex-mouse-view-crossref
@kindex C-c &
-@kindex S-mouse-2
+@kindex S-Mouse-2
@b{Ref@TeX{}} can display cross--referencing information. This means,
if two document locations are linked, @b{Ref@TeX{}} can display the
The feature is invoked by pressing @kbd{C-c &}
(@code{reftex-view-crossref}) while point is on the @var{key} argument
of a macro involved in cross--referencing. You can also click with
-@kbd{S-mouse-2} on the macro argument. Here is what will happen for
+@kbd{S-Mouse-2} on the macro argument. Here is what will happen for
individual classes of macros:@refill
@table @asis
@kindex C-c )
@kindex C-c [
@kindex C-c &
-@kindex S-mouse-2
+@kindex S-Mouse-2
@kindex C-c /
@kindex C-c \
@kindex C-c |
@kbd{C-c )} @code{reftex-reference}
@kbd{C-c [} @code{reftex-citation}
@kbd{C-c &} @code{reftex-view-crossref}
-@kbd{S-mouse-2} @code{reftex-mouse-view-crossref}
+@kbd{S-Mouse-2} @code{reftex-mouse-view-crossref}
@kbd{C-c /} @code{reftex-index-selection-or-word}
@kbd{C-c \} @code{reftex-index-phrase-selection-or-word}
@kbd{C-c |} @code{reftex-index-visit-phrases-buffer}
@kbd{C-c >} @code{reftex-display-index}
@end example
-Note that the @kbd{S-mouse-2} binding is only provided if this key is
+Note that the @kbd{S-Mouse-2} binding is only provided if this key is
not already used by some other package. @b{Ref@TeX{}} will not override an
-existing binding to @kbd{S-mouse-2}.@refill
+existing binding to @kbd{S-Mouse-2}.@refill
Personally, I also bind some functions in the users @kbd{C-c} map for
easier access.@refill
@lisp
(setq reftex-use-external-file-finders t)
(setq reftex-external-file-finders
- '(("tex" "kpsewhich -format=.tex %f")
- ("bib" "kpsewhich -format=.bib %f")))
+ '(("tex" . "kpsewhich -format=.tex %f")
+ ("bib" . "kpsewhich -format=.bib %f")))
@end lisp
@end itemize
Once you have written a document with labels, references and citations,
it can be nice to read it like a hypertext document. @b{Ref@TeX{}} has
support for that: @code{reftex-view-crossref} (bound to @kbd{C-c
-&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}), and
+&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-Mouse-2}), and
@code{reftex-search-document}. A somewhat fancier interface with mouse
highlighting is provided (among other things) by Peter S. Galbraith's
@file{bib-cite.el}. There is some overlap in the functionalities of
View location in a LaTeX document which cites the BibTeX entry at point.
Since BibTeX files can be used by many LaTeX documents, this function
prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this
-link to a document, call the function with with a prefix arg. Calling
+link to a document, call the function with a prefix arg. Calling
this function several times find successive citation locations.
@end deffn
@end example
@var{macro-re} is matched against the macro. @var{search-re} is the
regexp used to search for cross references. @samp{%s} in this regexp is
-replaced with with the macro argument at point. @var{highlight} is an
+replaced with the macro argument at point. @var{highlight} is an
integer indicating which subgroup of the match should be highlighted.
@end defopt
@item
New option @code{reftex-highlight-selection}.
@item
-@kbd{mouse-2} can be used to select in selection and @file{*toc*}
+@kbd{Mouse-2} can be used to select in selection and @file{*toc*}
buffers.@refill
@item
Fixed some problems regarding the interaction with VIPER mode.
Fixed bug with empty context strings.
@item
@code{reftex-mouse-view-crossref} is now bound by default at
-@kbd{S-mouse-2}.@refill
+@kbd{S-Mouse-2}.@refill
@end itemize
@noindent @b{Version 3.23}
@item
Support for @file{bibentry} citation style.
@end itemize
+@noindent @b{Version 4.15}
+@itemize @bullet
+@item
+Small bug fixes.
+@item
+Improved interaction with Emacs LaTeX mode.
+@end itemize
@node Index, , , Top
@unnumbered Index