Commands
********
Here is a summary of RefTeX's commands. All commands are available
from the `Ref' menu. For keybindings, see Keybindings..
- Command: reftex-toc
Show the table of contents for the current document. When called
with one ore two `C-u' prefixes, rescan the document first.
- Command: reftex-label
Insert a unique label. With one or two `C-u' prefixes, enforce
document rescan first.
- Command: reftex-reference
Start a selection process to select a label, and insert a
reference to it. With one or two `C-u' prefixes, enforce document
rescan first.
- Command: reftex-citation
Make a citation using BibTeX database files. After prompting for
a regular expression, scans the buffers with BibTeX entries (taken
from the `\bibliography' command or a `thebibliography'
environment) and offers the matching entries for selection. The
selected entry is formated according to `reftex-cite-format' and
inserted into the buffer.
When called with one or two `C-u' prefixes, first rescans the
document. When called with a numeric prefix, make that many
citations. When called with point inside the braces of a `\cite'
command, it will add another key, ignoring the value of
`reftex-cite-format'.
The regular expression uses an expanded syntax: `&&' is interpreted
as `and'. Thus, `aaaa&&bbb' matches entries which contain both
`aaaa' and `bbb'. While entering the regexp, completion on knows
citation keys is possible. `=' is a good regular expression to
match all entries in all files.
- Command: reftex-view-crossref
View cross reference of macro at point. Point must be on the KEY
argument. Works with the macros `\label', `\ref', `\cite',
`\bibitem', `\index' and many derivatives of these. Where it
makes sense, subsequent calls show additional locations. See also
the variable `reftex-view-crossref-extra' and the command
`reftex-view-crossref-from-bibtex'. With one or two `C-u'
prefixes, enforce rescanning of the document. With argument 2,
select the window showing the cross reference.
- Command: reftex-view-crossref-from-bibtex
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 promps upon first use for a buffer in RefTeX mode.
To reset this link to a document, call the function with with a
prefix arg. Calling this function several times find successive
citation locations.
- Command: reftex-create-tags-file
Create TAGS file by running `etags' on the current document. The
TAGS file is also immediately visited with `visit-tags-table'.
- Command: reftex-grep-document
Run grep query through all files related to this document. With
prefix arg, force to rescan document. No active TAGS table is
required.
- Command: reftex-search-document
Regexp search through all files of the current document. Starts
always in the master file. Stops when a match is found. No
active TAGS table is required.
- Command: reftex-query-replace-document
Run a query-replace-regexp of FROM with TO over the entire
document. With prefix arg, replace only word-delimited matches.
No active TAGS table is required.
- Command: reftex-change-label
Query replace FROM with TO in all `\label' and `\ref' commands.
Works on the entire multifile document. No active TAGS table is
required.
- Command: reftex-renumber-simple-labels
Renumber all simple labels in the document to make them
sequentially. Simple labels are the ones created by RefTeX,
consisting only of the prefix and a number. After the command
completes, all these labels will have sequential numbers
throughout the document. Any references to the labels will be
changed as well. For this, RefTeX looks at the arguments of any
macros which either start or end with the string `ref'. This
command should be used with care, in particular in multifile
documents. You should not use it if another document refers to
this one with the `xr' package.
- Command: reftex-find-duplicate-labels
Produce a list of all duplicate labels in the document.
- Command: reftex-customize
Run the customize browser on the RefTeX group.
- Command: reftex-show-commentary
Show the commentary section from `reftex.el'.
- Command: reftex-info
Run info on the top RefTeX node.
- Command: reftex-parse-document
Parse the entire document in order to update the parsing
information.
- Command: reftex-reset-mode
Enforce rebuilding of several internal lists and variables. Also
removes the parse file associated with the current document.