aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--man/reftex.texi57
1 files changed, 28 insertions, 29 deletions
diff --git a/man/reftex.texi b/man/reftex.texi
index 12c4ce6e416..9dc34f08b2e 100644
--- a/man/reftex.texi
+++ b/man/reftex.texi
@@ -7,9 +7,9 @@
7@syncodeindex fn cp 7@syncodeindex fn cp
8 8
9@c Version and Contact Info 9@c Version and Contact Info
10@set VERSION 4.28 10@set VERSION 4.30
11@set EDITION 4.28 11@set EDITION 4.30
12@set DATE May 2005 12@set DATE September 2005
13@set AUCTEXSITE @uref{http://www.nongnu.org/auctex/,AUCTeX distribution site} 13@set AUCTEXSITE @uref{http://www.nongnu.org/auctex/,AUCTeX distribution site}
14@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/,maintainers webpage} 14@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/,maintainers webpage}
15@set MAINTAINER Carsten Dominik 15@set MAINTAINER Carsten Dominik
@@ -25,8 +25,7 @@ citations and indices for LaTeX documents with Emacs.
25This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for 25This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for
26@b{Ref@TeX{}} @value{VERSION} 26@b{Ref@TeX{}} @value{VERSION}
27 27
28Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 28Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005 Free Software Foundation, Inc.
29 2005 Free Software Foundation, Inc.
30 29
31@quotation 30@quotation
32Permission is granted to copy, distribute and/or modify this document 31Permission is granted to copy, distribute and/or modify this document
@@ -154,7 +153,7 @@ Citations
154* Citation Info:: View the corresponding database entry. 153* Citation Info:: View the corresponding database entry.
155* Chapterbib and Bibunits:: Multiple bibliographies in a Document. 154* Chapterbib and Bibunits:: Multiple bibliographies in a Document.
156* Citations Outside LaTeX:: How to make citations in Emails etc. 155* Citations Outside LaTeX:: How to make citations in Emails etc.
157* BibTeX Database Subsets:: Extract parts of a big database. 156* BibTeX Database Subsets:: Extract parts of a big database.
158 157
159Index Support 158Index Support
160 159
@@ -1669,7 +1668,7 @@ support for citations helps to select the correct key quickly.
1669* Citation Info:: View the corresponding database entry. 1668* Citation Info:: View the corresponding database entry.
1670* Chapterbib and Bibunits:: Multiple bibliographies in a Document. 1669* Chapterbib and Bibunits:: Multiple bibliographies in a Document.
1671* Citations Outside LaTeX:: How to make citations in Emails etc. 1670* Citations Outside LaTeX:: How to make citations in Emails etc.
1672* BibTeX Database Subsets:: Extract parts of a big database. 1671* BibTeX Database Subsets:: Extract parts of a big database.
1673@end menu 1672@end menu
1674 1673
1675@node Creating Citations, Citation Styles, , Citations 1674@node Creating Citations, Citation Styles, , Citations
@@ -1773,12 +1772,12 @@ separate @code{\cite} macro for each of it.
1773@item e 1772@item e
1774Create a new BibTeX database file which contains all @i{marked} entries 1773Create a new BibTeX database file which contains all @i{marked} entries
1775in the selection buffer. If no entries are marked, all entries are 1774in the selection buffer. If no entries are marked, all entries are
1776selected. 1775selected.
1777 1776
1778@item E 1777@item E
1779Create a new BibTeX database file which contains all @i{unmarked} 1778Create a new BibTeX database file which contains all @i{unmarked}
1780entries in the selection buffer. If no entries are marked, all entries 1779entries in the selection buffer. If no entries are marked, all entries
1781are selected. 1780are selected.
1782 1781
1783@item @key{TAB} 1782@item @key{TAB}
1784Enter a citation key with completion. This may also be a key which does 1783Enter a citation key with completion. This may also be a key which does
@@ -3212,7 +3211,7 @@ way.
3212 3211
3213Before calling a @b{Ref@TeX{}} function, the style hook should always 3212Before calling a @b{Ref@TeX{}} function, the style hook should always
3214test for the availability of the function, so that the style file will 3213test for the availability of the function, so that the style file will
3215also work for people who do not use @b{Ref@TeX{}}. 3214also work for people who do not use @b{Ref@TeX{}}.
3216 3215
3217Additions made with style files in the way described below remain local 3216Additions made with style files in the way described below remain local
3218to the current document. For example, if one package uses AMSTeX, the 3217to the current document. For example, if one package uses AMSTeX, the
@@ -3493,7 +3492,7 @@ With @i{Viper} mode prior to Vipers version 3.01, you need to protect
3493 3492
3494@b{Ref@TeX{}} was written by @i{Carsten Dominik} 3493@b{Ref@TeX{}} was written by @i{Carsten Dominik}
3495@email{dominik@@science.uva.nl}, with contributions by @i{Stephen 3494@email{dominik@@science.uva.nl}, with contributions by @i{Stephen
3496Eglen}. @b{Ref@TeX{}} is currently maintained by 3495Eglen}. @b{Ref@TeX{}} is currently maintained by
3497 3496
3498@noindent 3497@noindent
3499Carsten Dominik <dominik@@science.uva.nl> 3498Carsten Dominik <dominik@@science.uva.nl>
@@ -3713,7 +3712,7 @@ Produce a list of all duplicate labels in the document.
3713Create a new BibTeX database file with all entries referenced in document. 3712Create a new BibTeX database file with all entries referenced in document.
3714The command prompts for a filename and writes the collected entries to 3713The command prompts for a filename and writes the collected entries to
3715that file. Only entries referenced in the current document with 3714that file. Only entries referenced in the current document with
3716any @code{\cite}-like macros are used. 3715any @code{\cite}-like macros are used.
3717The sequence in the new file is the same as it was in the old database. 3716The sequence in the new file is the same as it was in the old database.
3718@end deffn 3717@end deffn
3719 3718
@@ -3818,7 +3817,7 @@ only in that frame. So when creating that frame (with @kbd{d} key in an
3818ordinary TOC window), the automatic recentering is turned on. When the 3817ordinary TOC window), the automatic recentering is turned on. When the
3819frame gets destroyed, automatic recentering is turned off again. 3818frame gets destroyed, automatic recentering is turned off again.
3820 3819
3821This feature can be turned on and off from the menu 3820This feature can be turned on and off from the menu
3822(Ref->Options). 3821(Ref->Options).
3823@end defopt 3822@end defopt
3824 3823
@@ -3928,7 +3927,7 @@ group which contains all labels.
3928This may also be a function to do local parsing and identify point to be 3927This may also be a function to do local parsing and identify point to be
3929in a non-standard label environment. The function must take an 3928in a non-standard label environment. The function must take an
3930argument @var{bound} and limit backward searches to this value. It 3929argument @var{bound} and limit backward searches to this value. It
3931should return either @code{nil} or a cons cell @code{(@var{function} 3930should return either nil or a cons cell @code{(@var{function}
3932. @var{position})} with the function symbol and the position where the 3931. @var{position})} with the function symbol and the position where the
3933special environment starts. See the Info documentation for an 3932special environment starts. See the Info documentation for an
3934example. 3933example.
@@ -4085,7 +4084,7 @@ special packages like fancyref) are being used. RefTeX can and by
4085default does parse around each label to detect the correct label type, 4084default does parse around each label to detect the correct label type,
4086but this process can be slow when a document contains thousands of 4085but this process can be slow when a document contains thousands of
4087labels. If you use label prefixes consistently, you may speed up 4086labels. If you use label prefixes consistently, you may speed up
4088document parsing by setting this variable to a non-@code{nil} value. RefTeX 4087document parsing by setting this variable to a non-nil value. RefTeX
4089will then compare the label prefix with the prefixes found in 4088will then compare the label prefix with the prefixes found in
4090`reftex-label-alist' and derive the correct label type in this way. 4089`reftex-label-alist' and derive the correct label type in this way.
4091Possible values for this option are: 4090Possible values for this option are:
@@ -4094,7 +4093,7 @@ Possible values for this option are:
4094t @r{This means to trust any label prefixes found.} 4093t @r{This means to trust any label prefixes found.}
4095regexp @r{If a regexp, only prefixes matched by the regexp are trusted.} 4094regexp @r{If a regexp, only prefixes matched by the regexp are trusted.}
4096list @r{List of accepted prefixes, as strings. The colon is part of} 4095list @r{List of accepted prefixes, as strings. The colon is part of}
4097 @r{the prefix, e.g. ("fn:" "eqn:" "item:").} 4096 @r{the prefix, e.g. ("fn:" "eqn:" "item:").}
4098nil @r{Never trust a label prefix.} 4097nil @r{Never trust a label prefix.}
4099@end example 4098@end example
4100The only disadvantage of using this feature is that the label context 4099The only disadvantage of using this feature is that the label context
@@ -4650,7 +4649,7 @@ case.
4650 4649
4651@defopt reftex-index-verify-function 4650@defopt reftex-index-verify-function
4652A function which is called at each match during global indexing. 4651A function which is called at each match during global indexing.
4653If the function returns @code{nil}, the current match is skipped. 4652If the function returns nil, the current match is skipped.
4654@end defopt 4653@end defopt
4655 4654
4656@defopt reftex-index-phrases-skip-indexed-matches 4655@defopt reftex-index-phrases-skip-indexed-matches
@@ -4770,10 +4769,10 @@ escapes.
4770 4769
4771@defopt reftex-revisit-to-echo 4770@defopt reftex-revisit-to-echo
4772Non-@code{nil} means, automatic citation display will revisit files if 4771Non-@code{nil} means, automatic citation display will revisit files if
4773necessary. When @code{nil}, citation display in echo area will only 4772necessary. When nil, citation display in echo area will only be active
4774be active for cached echo strings (see @code{reftex-cache-cite-echo}), 4773for cached echo strings (see @code{reftex-cache-cite-echo}), or for
4775or for BibTeX database files which are already visited by a live 4774BibTeX database files which are already visited by a live associated
4776associated buffers. 4775buffers.
4777@end defopt 4776@end defopt
4778 4777
4779@defopt reftex-cache-cite-echo 4778@defopt reftex-cache-cite-echo
@@ -5114,7 +5113,7 @@ See the AUCTeX documentation for more information.
5114 5113
5115@defopt reftex-revisit-to-follow 5114@defopt reftex-revisit-to-follow
5116Non-@code{nil} means, follow-mode will revisit files if necessary. 5115Non-@code{nil} means, follow-mode will revisit files if necessary.
5117When @code{nil}, follow-mode will be suspended for stuff in unvisited files. 5116When nil, follow-mode will be suspended for stuff in unvisited files.
5118@end defopt 5117@end defopt
5119 5118
5120@defopt reftex-allow-detached-macro-args 5119@defopt reftex-allow-detached-macro-args
@@ -5178,11 +5177,11 @@ Fixed bug with @samp{%F} in a label prefix. Added new escapes
5178 5177
5179@noindent @b{Version 4.24} 5178@noindent @b{Version 4.24}
5180@itemize @bullet 5179@itemize @bullet
5181@item 5180@item
5182Inserting citation commands now prompts for optional arguments 5181Inserting citation commands now prompts for optional arguments
5183when called with a prefix argument. Related new options are 5182when called with a prefix argument. Related new options are
5184@code{reftex-cite-prompt-optional-args} and 5183@code{reftex-cite-prompt-optional-args} and
5185@code{reftex-cite-cleanup-optional-args}. 5184@code{reftex-cite-cleanup-optional-args}.
5186@item 5185@item
5187New option @code{reftex-trust-label-prefix}. Configure this variable 5186New option @code{reftex-trust-label-prefix}. Configure this variable
5188if you'd like RefTeX to base its classification of labels on prefixes. 5187if you'd like RefTeX to base its classification of labels on prefixes.
@@ -5190,7 +5189,7 @@ This can speed-up document parsing, but may in some cases reduce the
5190quality of the context used by RefTeX to describe a label. 5189quality of the context used by RefTeX to describe a label.
5191@item 5190@item
5192Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations} 5191Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations}
5193is non-@code{nil}. 5192is non-nil.
5194@item 5193@item
5195Fixed bugs in indexing: Case-sensitive search, quotes before and/or 5194Fixed bugs in indexing: Case-sensitive search, quotes before and/or
5196after words. Disabbled indexing in comment lines. 5195after words. Disabbled indexing in comment lines.
@@ -5198,7 +5197,7 @@ after words. Disabbled indexing in comment lines.
5198 5197
5199@noindent @b{Version 4.22} 5198@noindent @b{Version 4.22}
5200@itemize @bullet 5199@itemize @bullet
5201@item 5200@item
5202New command @code{reftex-create-bibtex-file} to create a new database 5201New command @code{reftex-create-bibtex-file} to create a new database
5203with all entries referenced in the current document. 5202with all entries referenced in the current document.
5204@item 5203@item
@@ -5208,7 +5207,7 @@ from entries marked in a citation selection buffer.
5208 5207
5209@noindent @b{Version 4.21} 5208@noindent @b{Version 4.21}
5210@itemize @bullet 5209@itemize @bullet
5211@item 5210@item
5212Renaming labels from the toc buffer with key @kbd{M-%}. 5211Renaming labels from the toc buffer with key @kbd{M-%}.
5213@end itemize 5212@end itemize
5214 5213
@@ -5424,7 +5423,7 @@ File search further refined. New option @code{reftex-file-extensions}.
5424document, all labels and associated context. New keys @kbd{i}, @kbd{l}, 5423document, all labels and associated context. New keys @kbd{i}, @kbd{l},
5425and @kbd{c}. New options @code{reftex-toc-include-labels}, 5424and @kbd{c}. New options @code{reftex-toc-include-labels},
5426@code{reftex-toc-include-context}, 5425@code{reftex-toc-include-context},
5427@code{reftex-toc-include-file-boundaries}. 5426@code{reftex-toc-include-file-boundaries}.
5428@end itemize 5427@end itemize
5429 5428
5430@noindent @b{Version 3.41} 5429@noindent @b{Version 3.41}
@@ -5537,7 +5536,7 @@ New option @code{reftex-cache-cite-echo}.
5537@kbd{M-x reftex-reset-mode} now also removes the file with parsing 5536@kbd{M-x reftex-reset-mode} now also removes the file with parsing
5538info. 5537info.
5539@item 5538@item
5540Default of @code{reftex-revisit-to-follow} changed to @code{nil}. 5539Default of @code{reftex-revisit-to-follow} changed to nil.
5541@end itemize 5540@end itemize
5542 5541
5543@noindent @b{Version 3.24} 5542@noindent @b{Version 3.24}