* Customizing Indentation::
* Custom Macros::
* Odds and Ends::
-* Sample .emacs File::
+* Sample Init File::
* Performance Issues::
* Limitations and Known Bugs::
* FAQ::
This function is not bound to a key by default, but it's intended to be
used on the @kbd{RET} key. If you like the behavior of
@code{newline-and-indent} on @kbd{RET}, you should consider switching to
-this function. @xref{Sample .emacs File}.
+this function. @xref{Sample Init File}.
@item @kbd{M-x c-context-open-line}
@findex c-context-open-line
You can toggle each of these minor modes on and off, and you can
configure @ccmode{} so that it starts up with your favorite
-combination of them (@pxref{Sample .emacs File}). By default, when
+combination of them (@pxref{Sample Init File}). By default, when
you initialize a buffer, electric mode and syntactic-indentation mode
are enabled but the other two modes are disabled.
@vindex initialization-hook (c-)
Hook run only once per Emacs session, when @ccmode{} is initialized.
This is a good place to change key bindings (or add new ones) in any
-of the @ccmode{} key maps. @xref{Sample .emacs File}.
+of the @ccmode{} key maps. @xref{Sample Init File}.
@end defvar
@defvar c-mode-common-hook
Here's a simplified example of what you can add to your @file{.emacs}
file to do things whenever any @ccmode{} language is edited. See the
Emacs manuals for more information on customizing Emacs via hooks.
-@xref{Sample .emacs File}, for a more complete sample @file{.emacs}
+@xref{Sample Init File}, for a more complete sample @file{.emacs}
file.
@example
style. To do this, put the new style's settings into a list with the
following format; the list can then be passed as an argument to the
function @code{c-add-style}. You can see an example of a style
-definition in @ref{Sample .emacs File}.
+definition in @ref{Sample Init File}.
@cindex style definition
@c @defvr {List} style definition
You should use @code{c-set-style} instead.
The sample @file{.emacs} file provides a concrete example of how a new
-style can be added and automatically set. @xref{Sample .emacs File}.
+style can be added and automatically set. @xref{Sample Init File}.
@end defun
@defvar c-style-alist
@end defun
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-@node Odds and Ends, Sample .emacs File, Custom Macros, Top
+@node Odds and Ends, Sample Init File, Custom Macros, Top
@comment node-name, next, previous, up
@chapter Odds and Ends
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-@node Sample .emacs File, Performance Issues, Odds and Ends, Top
+@node Sample Init File, Performance Issues, Odds and Ends, Top
@comment node-name, next, previous, up
-@appendix Sample .emacs File
+@appendix Sample Init File
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Here's a sample .emacs file fragment that might help you along the way.
@end verbatim
@comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-@node Performance Issues, Limitations and Known Bugs, Sample .emacs File, Top
+@node Performance Issues, Limitations and Known Bugs, Sample Init File, Top
@comment node-name, next, previous, up
@chapter Performance Issues
@cindex performance
@end ifnottex
@menu
-* About mairix and mairix.el:: About the mairix search engine and mairix.el
-* Configuring mairix:: How to configure mairix
-* Setting up mairix.el:: Set up mairix.el
-* Using mairix.el:: List of interactive functions
-* Extending mairix.el:: Support your favorite mail reader!
+* About:: About the mairix search engine and mairix.el.
+* Configuring mairix:: How to configure mairix.
+* Setting up the mairix interface:: Set up mairix.el.
+* Using:: List of interactive functions
+* Extending:: Support your favorite mail reader!
* GNU Free Documentation License:: The license for this documentation.
@end menu
-@node About mairix and mairix.el
+@node About
@chapter About mairix and mairix.el
Mairix is a tool for indexing and searching words in locally stored
with RMail, Gnus, or VM as the Emacs mail program. However, it should
also work with Maildir or MH, and it should be very easy to integrate
other Emacs mail programs into @code{mairix.el}
-(@pxref{Extending mairix.el}).
+(@pxref{Extending}).
If you use Gnus with maildir or MH, you should really use the native
Gnus back end @code{nnmairix} instead, since it is more tightly
Note that this may take a few minutes, but every following index will do
the updates incrementally and hence is very fast.
-@node Setting up mairix.el
-@chapter Setting up mairix.el
+@node Setting up the mairix interface
+@chapter Setting up the mairix interface
First, put @code{mairix.el} in your Emacs search path and put
@code{(require 'mairix)} into your @file{.emacs} file. Then, use
nnmairix instead.
If you use another Emacs mail program which is not yet supported by
-mairix.el, it is pretty easy to integrate it. @xref{Extending
-mairix.el}, on how to integrate it into mairix.el.
+mairix.el, it is pretty easy to integrate it. @xref{Extending},
+on how to integrate it into mairix.el.
-Now you should be ready to go. @xref{Using mairix.el}, for the available
-commands.
+Now you should be ready to go. @xref{Using}, for the available commands.
-@node Using mairix.el
+@node Using
@chapter Using mairix.el
There are currently no default key bindings for mairix.el, since those
@end table
-@node Extending mairix.el
+@node Extending
@chapter Extending mairix.el
Your favorite Emacs mail program is not supported? Shame on me. But
* Defining Label Environments:: ... and environments it doesn't.
* Reference Info:: View the label corresponding to a \ref.
* Reference Styles:: Macros to be used instead of \ref.
-* xr (LaTeX package):: References to external documents.
+* LaTeX xr Package:: References to external documents.
Defining Label Environments
Options, Keymaps, Hooks
-* Options (Table of Contents)::
-* Options (Defining Label Environments)::
-* Options (Creating Labels)::
-* Options (Referencing Labels)::
-* Options (Creating Citations)::
-* Options (Index Support)::
-* Options (Viewing Cross-References)::
-* Options (Finding Files)::
-* Options (Optimizations)::
-* Options (Fontification)::
-* Options (Misc)::
+* Options - Table of Contents::
+* Options - Defining Label Environments::
+* Options - Creating Labels::
+* Options - Referencing Labels::
+* Options - Creating Citations::
+* Options - Index Support::
+* Options - Viewing Cross-References::
+* Options - Finding Files::
+* Options - Optimizations::
+* Options - Fontification::
+* Options - Misc::
@end detailmenu
@end menu
@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
-(Fontification)}.
+See also variable @code{reftex-highlight-selection},
+@ref{Options - Fontification}.
@item f
@vindex reftex-toc-follow-mode
@item x
Switch to the @file{*toc*} buffer of an external document. When the
-current document is using the @code{xr} package (@pxref{xr (LaTeX
-package)}), @RefTeX{} will switch to one of the external
-documents.
+current document is using the @code{xr} package (@pxref{LaTeX xr Package}),
+@RefTeX{} will switch to one of the external documents.
@tablesubheading{Automatic recentering}
* Defining Label Environments:: ... and environments it doesn't.
* Reference Info:: View the label corresponding to a \ref.
* Reference Styles:: Macros to be used instead of \ref.
-* xr (LaTeX package):: References to external documents.
+* LaTeX xr Package:: References to external documents.
@end menu
@node Creating Labels
@vindex reftex-insert-label-flags
If you want to change the way certain labels are created, check out the
-variable @code{reftex-insert-label-flags} (@pxref{Options (Creating
-Labels)}).
+variable @code{reftex-insert-label-flags} (@pxref{Options - Creating
+Labels}).
If you are using @AUCTeX{} to write your @LaTeX{} documents, you can
set it up to delegate the creation of labels to
@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 (Misc)}.
+@ref{Options - Misc}.
@vindex reftex-multiref-punctuation
@item m - + ,
@tablesubheading{Controlling what gets displayed}
@vindex reftex-label-menu-flags
The defaults for the following flags can be configured with the variable
-@code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}).
+@code{reftex-label-menu-flags} (@pxref{Options - Referencing Labels}).
@item c
Toggle the display of the one-line label definition context in the
Reference a label from an external document. With the @LaTeX{} package
@code{xr} it is possible to reference labels defined in another
document. This key will switch to the label menu of an external
-document and let you select a label from there (@pxref{xr (LaTeX
-package),,xr}).
+document and let you select a label from there (@pxref{LaTeX xr Package,,xr}).
@end table
@vindex reftex-label-alist
@RefTeX{} can be configured to recognize additional labeled
environments and macros. This is done with the variable
-@code{reftex-label-alist} (@pxref{Options (Defining Label
-Environments)}). If you are not familiar with Lisp, you can use the
+@code{reftex-label-alist} (@pxref{Options - Defining Label
+Environments}). If you are not familiar with Lisp, you can use the
@code{custom} library to configure this rather complex variable. To do
this, use
@code{nil} means to use the text right after the label definition.
@item
For more complex ways of getting context, see the variable
-@code{reftex-label-alist} (@ref{Options (Defining Label
-Environments)}).
+@code{reftex-label-alist} (@ref{Options - Defining Label Environments}).
@end itemize
The following list of strings is used to guess the correct label type
Depending on how you would like the label insertion and selection for
the new environments to work, you might want to add the letters @samp{a}
and @samp{h} to some of the flags in the variables
-@code{reftex-insert-label-flags} (@pxref{Options (Creating Labels)})
-and @code{reftex-label-menu-flags} (@pxref{Options (Referencing
-Labels)}).
+@code{reftex-insert-label-flags} (@pxref{Options - Creating Labels})
+and @code{reftex-label-menu-flags} (@pxref{Options - Referencing Labels}).
@node Quick Equation
these variables are deprecated now. Instead of setting them, the
variable @code{reftex-ref-style-default-list} should be adapted now.
-@node xr (LaTeX package)
+@node LaTeX xr Package
@section @code{xr}: Cross-Document References
@cindex @code{xr}, LaTeX package
@cindex LaTeX packages, @code{xr}
@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
-(Misc)}.
+would. See also variable @code{reftex-highlight-selection},
+@ref{Options - Misc}.
@item m
Mark the current entry. When one or several entries are marked,
The @samp{Find and Index in Document} menu in the phrases buffer also
lists a few options for the indexing process. The options have
-associated customization variables to set the defaults (@pxref{Options
-(Index Support)}). Here is a short explanation of what the options do:
+associated customization variables to set the defaults
+(@pxref{Options - Index Support}). Here is a short explanation of
+what the options do:
@table @i
@item Match Whole Words
@samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for
cross-reference display. This works also for labels defined in an
external document when the current document refers to them through the
-@code{xr} interface (@pxref{xr (LaTeX package)}).
+@code{xr} interface (@pxref{LaTeX xr Package}).
@item @code{\label}
@cindex @code{\label}
use faces only when @code{font-lock} is loaded. This seems to be
reasonable because people who like faces will very likely have it
loaded. If you wish to turn off fontification or change the involved
-faces, see @ref{Options (Fontification)}.
+faces, see @ref{Options - Fontification}.
@node Multifile Documents
@section Multifile Documents
reftex-customize} will get you there.
@menu
-* Options (Table of Contents)::
-* Options (Defining Label Environments)::
-* Options (Creating Labels)::
-* Options (Referencing Labels)::
-* Options (Creating Citations)::
-* Options (Index Support)::
-* Options (Viewing Cross-References)::
-* Options (Finding Files)::
-* Options (Optimizations)::
-* Options (Fontification)::
-* Options (Misc)::
+* Options - Table of Contents::
+* Options - Defining Label Environments::
+* Options - Creating Labels::
+* Options - Referencing Labels::
+* Options - Creating Citations::
+* Options - Index Support::
+* Options - Viewing Cross-References::
+* Options - Finding Files::
+* Options - Optimizations::
+* Options - Fontification::
+* Options - Misc::
* Keymaps and Hooks::
@end menu
-@node Options (Table of Contents)
+@node Options - Table of Contents
@section Table of Contents
@cindex Options, table of contents
@cindex Table of contents, options
(@pxref{Table of Contents}).
@end deffn
-@node Options (Defining Label Environments)
+@node Options - Defining Label Environments
@section Defining Label Environments
@cindex Options, defining label environments
@cindex Defining label environments, options
non-footnote labels.
@end defopt
-@node Options (Creating Labels)
+@node Options - Creating Labels
@section Creating Labels
@cindex Options, creating labels
@cindex Creating labels, options
@end table
@end defopt
-@node Options (Referencing Labels)
+@node Options - Referencing Labels
@section Referencing Labels
@cindex Options, referencing labels
@cindex Referencing labels, options
(@pxref{Referencing Labels}).
@end deffn
-@node Options (Creating Citations)
+@node Options - Creating Citations
@section Creating Citations
@cindex Options, creating citations
@cindex Creating citations, options
@end defopt
-@node Options (Index Support)
+@node Options - Index Support, Options - Viewing Cross-References, Options - Creating Citations, Options
@section Index Support
@cindex Options, Index support
@cindex Index support, options
(@pxref{Index Support}).
@end deffn
-@node Options (Viewing Cross-References)
+@node Options - Viewing Cross-References
@section Viewing Cross-References
@cindex Options, viewing cross-references
@cindex Viewing cross-references, options
scans. In order to clear it, use @kbd{M-x reftex-reset-mode}.
@end defopt
-@node Options (Finding Files)
+@node Options - Finding Files
@section Finding Files
@cindex Options, Finding Files
@cindex Finding files, options
@end defopt
@page
-@node Options (Optimizations)
+@node Options - Optimizations
@section Optimizations
@cindex Options, optimizations
@cindex Optimizations, options
non-@code{nil}.
@end defopt
-@node Options (Fontification)
+@node Options - Fontification
@section Fontification
@cindex Options, fontification
@cindex Fontification, options
Face name for index entries.
@end defopt
-@node Options (Misc)
+@node Options - Misc
@section Miscellaneous
@cindex Options, misc