better to put them in @file{default.el}, so that users can more easily
override them.
-@cindex site-lisp directories
+@cindex @file{site-lisp} directories
You can place @file{default.el} and @file{site-start.el} in any of
the directories which Emacs searches for Lisp libraries. The variable
@code{load-path} (@pxref{Lisp Libraries}) specifies these directories.
@node Image-Dired
@section Viewing Image Thumbnails in Dired
-@cindex image-dired mode
-@cindex image-dired
+@cindex @code{image-dired} mode
+@cindex @code{image-dired}
Image-Dired is a facility for browsing image files. It provides viewing
the images either as thumbnails or in full size, either inside Emacs
background.
@cindex background color
-@cindex default face
+@cindex @code{default face}
You can customize a face to alter its attributes, and save those
customizations for future Emacs sessions. @xref{Face Customization},
for details.
of its attributes are specified. Its background color is also used as
the frame's background color. @xref{Colors}.
-@cindex cursor face
+@cindex @code{cursor} face
Another special face is the @code{cursor} face. On graphical
displays, the background color of this face is used to draw the text
cursor. None of the other attributes of this face have any effect;
@item fixed-pitch-serif
This face is like @code{fixed-pitch}, except the font has serifs and
looks more like traditional typewriting.
-@cindex variable-pitch face
+@cindex @code{variable-pitch} face
@item variable-pitch
This face forces use of a variable-width font.
-@cindex shadow face
+@cindex @code{shadow} face
@item shadow
This face is used for making the text less noticeable than the surrounding
ordinary text. Usually this can be achieved by using shades of gray in
@table @code
@item mode-line
-@cindex mode-line face
+@cindex @code{mode-line} face
@cindex faces for mode lines
This face is used for the mode line of the currently selected window,
and for menu bars when toolkit menus are not used. By default, it's
drawn with shadows for a raised effect on graphical displays, and
drawn as the inverse of the default face on non-windowed terminals.
@item mode-line-inactive
-@cindex mode-line-inactive face
+@cindex @code{mode-line-inactive} face
Like @code{mode-line}, but used for mode lines of the windows other
than the selected one (if @code{mode-line-in-non-selected-windows} is
non-@code{nil}). This face inherits from @code{mode-line}, so changes
in that face affect mode lines in all windows.
@item mode-line-highlight
-@cindex mode-line-highlight face
+@cindex @code{mode-line-highlight} face
Like @code{highlight}, but used for mouse-sensitive portions of text
on mode lines. Such portions of text typically pop up tooltips
(@pxref{Tooltips}) when the mouse pointer hovers above them.
@item mode-line-buffer-id
-@cindex mode-line-buffer-id face
+@cindex @code{mode-line-buffer-id} face
This face is used for buffer identification parts in the mode line.
@item header-line
-@cindex header-line face
+@cindex @code{header-line} face
Similar to @code{mode-line} for a window's header line, which appears
at the top of a window just as the mode line appears at the bottom.
Most windows do not have a header line---only some special modes, such
Info mode, create one.
@item header-line-highlight
-@cindex header-line-highlight face
+@cindex @code{header-line-highlight} face
Similar to @code{highlight} and @code{mode-line-highlight}, but used
for mouse-sensitive portions of text on header lines. This is a
separate face because the @code{header-line} face might be customized
in a way that does not interact well with @code{highlight}.
@item vertical-border
-@cindex vertical-border face
+@cindex @code{vertical-border} face
This face is used for the vertical divider between windows on text
terminals.
@item minibuffer-prompt
This face determines the colors and font of Emacs's menus. @xref{Menu
Bars}.
@item tty-menu-enabled-face
-@cindex faces for text-mode menus
+@cindex faces for @code{text-mode} menus
@cindex TTY menu faces
This face is used to display enabled menu items on text-mode
terminals.
cases, this @dfn{trailing whitespace} has no effect, but sometimes it
can be a nuisance.
-@cindex trailing-whitespace face
+@cindex @code{trailing-whitespace} face
You can make trailing whitespace at the end of a line visible by
setting the buffer-local variable @code{show-trailing-whitespace} to
@code{t}. Then Emacs displays trailing whitespace, using the face
@cindex non-breaking space
@cindex non-breaking hyphen
@cindex soft hyphen
-@cindex escape-glyph face
-@cindex nobreak-space face
+@cindex @code{escape-glyph} face
+@cindex @code{nobreak-space} face
Some non-@acronym{ASCII} characters have the same appearance as an
@acronym{ASCII} space or hyphen (minus) character. Such characters
can cause problems if they are entered into a buffer without your
@cindex glyphless characters
@cindex characters with no font glyphs
-@cindex glyphless-char face
+@cindex @code{glyphless-char} face
On graphical displays, some characters may have no glyphs in any of
the fonts available to Emacs. These @dfn{glyphless characters} are
normally displayed as boxes containing the hexadecimal character code.
@cindex curly quotes, and terminal capabilities
@cindex curved quotes, and terminal capabilities
-@cindex homoglyph face
+@cindex @code{homoglyph} face
Emacs tries to determine if the curved quotes @samp{‘} and @samp{’}
can be displayed on the current display. By default, if this seems to
@code{display-line-numbers-width} to a large enough value, to avoid
occasional miscalculations of space reserved for the line numbers.
-@cindex line-number face
+@cindex @code{line-number} face
The line numbers are displayed in a special face @code{line-number}.
The current line number is displayed in a different face,
@code{line-number-current-line}, so you can make the current line's
feature in individual cases by quoting the file name with @samp{/:}
(@pxref{Quoted File Names}).
-@cindex ange-ftp
+@cindex @code{ange-ftp}
Remote file access through FTP is handled by the Ange-FTP package, which
is documented in the following. Remote file access through the other
methods is handled by the Tramp package, which has its own manual.
@node Frame Parameters
@section Frame Parameters
-@cindex default-frame-alist
+@vindex default-frame-alist
You can control the default appearance and behavior of all frames by
specifying a default list of @dfn{frame parameters} in the variable
For a list of frame parameters and their effects, see @ref{Frame
Parameters,,, elisp, The Emacs Lisp Reference Manual}.
-@cindex initial-frame-alist
+@vindex initial-frame-alist
You can also specify a list of frame parameters which apply to just
the initial frame, by customizing the variable
@code{initial-frame-alist}.
bottom when the end of the buffer is shown. You cannot over-scroll
when the entire buffer is visible.
-@cindex scroll-bar face
+@cindex @code{scroll-bar} face
The visual appearance of the scroll bars is controlled by the
@code{scroll-bar} face. (Some toolkits, such as GTK and MS-Windows,
ignore this face; the scroll-bar appearance there can only be
@table @kbd
@findex mouse-set-secondary
@kindex M-Drag-mouse-1
-@cindex secondary-selection face
+@cindex @code{secondary-selection} face
@item M-Drag-mouse-1
Set the secondary selection, with one end at the place where you press
down the button, and the other end at the place where you release it
@node Log Buffer
@subsection Features of the Log Entry Buffer
-@cindex C-c C-c @r{(Log Edit mode)}
+@kindex C-c C-c @r{(Log Edit mode)}
@findex log-edit-done
When you tell VC to commit a change, it pops up a buffer named
@file{*vc-log*}. In this buffer, you should write a @dfn{log entry}
@code{unoconv} tool is needed.}, and displaying those images.
@findex doc-view-toggle-display
-@cindex doc-view-minor-mode
+@findex doc-view-minor-mode
When you visit a document file that can be displayed with DocView
mode, Emacs automatically uses DocView mode @footnote{The needed
external tools for the document type must be available, and Emacs must
@node MS-DOS and MULE
@subsection International Support on MS-DOS
-@cindex international support @r{(MS-DOS)}
+@cindex international support (MS-DOS)
Emacs on MS-DOS supports the same international character sets as it
does on GNU, Unix and other platforms
codepage for Emacs to use by setting the variable @code{dos-codepage} in
your init file.
-@cindex language environment, automatic selection on @r{MS-DOS}
+@cindex language environment, automatic selection on MS-DOS
Multibyte Emacs supports only certain DOS codepages: those which can
display Far-Eastern scripts, like the Japanese codepage 932, and those
that encode a single ISO 8859 character set.
code 231 in the standard Latin-1 character set, but the corresponding
DOS codepage 850 uses code 135 for this glyph.}
-@cindex mode line @r{(MS-DOS)}
+@cindex mode line (MS-DOS)
All the @code{cp@var{nnn}} coding systems use the letter @samp{D}
(for ``DOS'') as their mode-line mnemonic. Since both the terminal
coding system and the default coding system for file I/O are set to
the program that invoked @command{emacsclient}.
@end enumerate
-@cindex emacsclient, on MS-Windows
+@cindex @command{emacsclient}, on MS-Windows
Note that, due to limitations of MS-Windows, Emacs cannot have both
GUI and text-mode frames in the same session. It also cannot open
text-mode frames on more than a single @dfn{Command Prompt} window,
cursor moves to just after the first @samp{FOO}.
@cindex faces for highlighting search matches
-@cindex isearch face
+@cindex @code{isearch} face
At each step, Emacs highlights the @dfn{current match}---the buffer
text that matches the search string---using the @code{isearch} face
(@pxref{Faces}). @xref{Search Customizations}, for various options
@node Error in Isearch
@subsection Errors in Incremental Search
-@cindex isearch-fail face
+@cindex @code{isearch-fail} face
If your string is not found at all, the echo area says @samp{Failing
I-Search}, and the cursor moves past the place where Emacs found as
much of your string as it could. Thus, if you search for @samp{FOOT},
reused.
@cindex faces for highlighting query replace
-@cindex query-replace face
-@cindex lazy-highlight face, in replace
+@cindex @code{query-replace} face
+@cindex @code{lazy-highlight} face, in replace
@vindex query-replace-highlight
@vindex query-replace-lazy-highlight
@vindex query-replace-show-replacement
@cindex lazy highlighting customizations
@vindex isearch-lazy-highlight
-@cindex lazy-highlight face
+@cindex @code{lazy-highlight} face
The other matches for the search string that are visible on display
are highlighted using the @code{lazy-highlight} face. Setting the
variable @code{isearch-lazy-highlight} to @code{nil} disables this
@cindex soft newline
@cindex newlines, hard and soft
-@cindex use-hard-newlines
+@findex use-hard-newlines
In Enriched mode, Emacs distinguishes between two different kinds of
newlines, @dfn{hard} newlines and @dfn{soft} newlines. You can also
enable or disable this feature in other buffers, by typing @kbd{M-x
@node Service
@section How To Get Help with GNU Emacs
@cindex help in using Emacs
-@cindex help-gnu-emacs mailing list
-@cindex gnu.emacs.help newsgroup
+@cindex @samp{help-gnu-emacs} mailing list
+@cindex @samp{gnu.emacs.help} newsgroup
If you need help installing, using or changing GNU Emacs, there are
two ways to find it:
@node New insert-buffer
@subsection New Body for @code{insert-buffer}
@findex insert-buffer@r{, new version body}
-@cindex new version body for insert-buffer
+@cindex new version body for @code{insert-buffer}
The body in the GNU Emacs 22 version is more confusing than the original.
@result{} "-23.5"
@end example
-@cindex int-to-string
+@cindex @code{int-to-string}
@code{int-to-string} is a semi-obsolete alias for this function.
See also the function @code{format} in @ref{Formatting Strings}.
controlled by the user option @code{mouse-1-click-follows-link}.
@xref{Mouse References,,, emacs, The GNU Emacs Manual}.
-@cindex follow-link (text or overlay property)
+@kindex follow-link @r{(text or overlay property)}
To set up the link so that it obeys
@code{mouse-1-click-follows-link}, you must either (1) apply a
@code{follow-link} text or overlay property to the link text, or (2)
@cindex BOCM
@cindex history
-@cindex awk-mode.el
-@cindex c-mode.el
-@cindex c++-mode.el
+@cindex @file{awk-mode.el}
+@cindex @file{c-mode.el}
+@cindex @file{c++-mode.el}
Welcome to @ccmode{}, a GNU Emacs mode for editing files containing C,
C++, Objective-C, Java, CORBA IDL (and the variants CORBA PSDL and
@section What does @file{M-x @var{command}} mean?
@cindex Extended commands
@cindex Commands, extended
-@cindex M-x, meaning of
+@cindex @kbd{M-x}, meaning of
@kbd{M-x @var{command}} means type @kbd{M-x}, then type the name of the
command, then type @key{RET}. (@xref{Basic keys}, if you're not sure
considered the parent of the current instance. Default is @code{nil}.
@end deftp
-@cindex clone
+@cindex @code{clone}
To use this class, inherit from it with your own class.
To make a new instance that inherits from and existing instance of your
class, use the @code{clone} method with additional parameters
to specify local values.
-@cindex slot-unbound
+@cindex @code{slot-unbound}
The @code{eieio-instance-inheritor} class works by causing cloned
objects to have all slots unbound. This class' @code{slot-unbound}
method will cause references to unbound slots to be redirected to the
@deftp {Class} eieio-speedbar buttontype buttonface
Enables base speedbar display for a class.
-@cindex speedbar-make-tag-line
+@cindex @code{speedbar-make-tag-line}
The slot @var{buttontype} is any of the symbols allowed by the
function @code{speedbar-make-tag-line} for the @var{exp-button-type}
argument @xref{Extending,,,speedbar}.
@code{mm-uu-emacs-sources-regexp}.
@item diff
-@vindex diff
+@findex diff
@vindex mm-uu-diff-groups-regexp
Patches. This is intended for groups where diffs of committed files
are automatically sent to. It only works in groups matching
@code{mm-uu-diff-groups-regexp}.
@item verbatim-marks
-@cindex verbatim-marks
+@findex verbatim-marks
Slrn-style verbatim marks.
@item LaTeX
-@cindex LaTeX
+@findex LaTeX
LaTeX documents. It only works in groups matching
@code{mm-uu-tex-groups-regexp}.
@node Interface Functions
@chapter Interface Functions
@cindex interface functions
-@cindex mail-parse
+@cindex @code{mail-parse}
The @code{mail-parse} library is an abstraction over the actual
low-level libraries that are described in the next chapter.
The server has to support @acronym{NOV} for any of this to work.
-@cindex Gmane, gnus-fetch-old-headers
+@cindex Gmane, @code{gnus-fetch-old-headers}
This feature can seriously impact performance it ignores all locally
cached header entries. Setting it to @code{t} for groups for a server
that doesn't expire articles (such as news.gmane.org), leads to very
article buffer.
@item gnus-widen-article-window
-@cindex gnus-widen-article-window
+@vindex gnus-widen-article-window
If non-@code{nil}, selecting the article buffer with the @kbd{h}
command will ``widen'' the article window to take the entire frame.
@table @code
@item hfy-style-assoc
-@cindex hfy-style-assoc
+@cindex @code{hfy-style-assoc}
@anchor{hfy-style-assoc}
An assoc representing/describing an Emacs face. Properties may be repeated,
@end lisp
@item hfy-sheet-assoc
-@cindex hfy-sheet-assoc
+@cindex @code{hfy-sheet-assoc}
@anchor{hfy-sheet-assoc}
An assoc with elements of the form @samp{(face-name style-name . style-string)}.
@end lisp
@item hfy-facemap-assoc
-@cindex hfy-facemap-assoc
+@cindex @code{hfy-facemap-assoc}
@anchor{hfy-facemap-assoc}
An assoc of @code{(point . @var{face-symbol})} or
@cindex CORBA (Common Object Request Broker Architecture)
@cindex Interface Definition Language
@cindex Interactive Data Language
-@cindex cc-mode.el
+@cindex @file{cc-mode.el}
@cindex @file{idl.el}
@cindex @file{idl-shell.el}
@cindex Feature overview
@node Passphrase caching
@subsection Passphrase caching
-@cindex gpg-agent
+@cindex @command{gpg-agent}
Message with EasyPG internally calls GnuPG (the @command{gpg} or
@command{gpgsm} command) to perform
data encryption, and in certain cases (decrypting or signing for
@uref{http://quimby.gnus.org/circus/face/}.}.
@cindex @command{uncompface}
-@cindex Emacs, packages, x-face
+@cindex Emacs, packages, @samp{x-face}
@cindex Unix commands, @command{uncompface}
-@cindex x-face package
+@cindex @samp{x-face} package
@vindex mh-show-xface
Next is the traditional @samp{X-Face:} header field@footnote{The
leave out the @samp{xterm -e} if you use @command{mhlist} or
@command{mhstore}.}.
-@cindex Emacs, packages, mm-decode
-@cindex mm-decode package
+@cindex Emacs, packages, @samp{mm-decode}
+@cindex @samp{mm-decode} package
@findex mh-toggle-mh-decode-mime-flag
@kindex ; (semicolon)
@vindex mh-decode-mime-flag
faces and not. When faces are enabled, the printed message will look
very similar to the message in the MH-Show buffer.
-@cindex ps-print package
-@cindex Emacs, packages, ps-print
+@cindex @samp{ps-print} package
+@cindex Emacs, packages, @samp{ps-print}
MH-E uses the @samp{ps-print} package to do the printing, so you can
customize the printing further by going to the @samp{ps-print}
option to delete the window containing the original message after
yanking it to make more room on your screen for your reply.
-@cindex Emacs, packages, supercite
-@cindex supercite package
+@cindex Emacs, packages, @samp{supercite}
+@cindex @samp{supercite} package
@kindex r
@vindex mail-citation-hook
@vindex mh-yank-behavior
for the next hook function. The standard prefix
@code{mh-ins-buf-prefix} is not added if this hook is set.
-@cindex Emacs, packages, trivial-cite
-@cindex trivial-cite package
+@cindex Emacs, packages, @samp{trivial-cite}
+@cindex @samp{trivial-cite} package
@vindex mh-yank-behavior
For example, if you use the hook function
@end cartouche
@i{MH-E @sc{mime} draft ready to send}
-@cindex undo effects of mh-mml-to-mime
+@cindex undo effects of @code{mh-mml-to-mime}
This action can be undone by running @kbd{C-_} (@code{undo}).
@cindex @command{mhn}
@cindex MH commands, @command{mhbuild}
@cindex MH commands, @command{mhn}
-@cindex undo effects of mh-mh-to-mime
+@cindex undo effects of @code{mh-mh-to-mime}
@findex mh-mh-to-mime
@findex mh-mh-to-mime-undo
@kindex C-c C-e
@node MRU Bookmarks
@section MRU Bookmarks mode
-@cindex semantic-mru-bookmark-mode
+@cindex @code{semantic-mru-bookmark-mode}
Semantic MRU Bookmarks mode is a minor mode that keeps track of the
tags you have edited, allowing you to quickly return to them later
@node Highlight Func Mode
@section Highlight Func Mode
-@cindex semantic-highlight-func-mode
+@cindex @code{semantic-highlight-func-mode}
Semantic Highlight Function minor mode highlights the declaration line
of the current function or tag (that is to say, the first line that
@node Tag Decoration Mode
@section Tag Decoration Mode
-@cindex semantic-decoration-mode
+@cindex @code{semantic-decoration-mode}
Semantic Tag Decoration mode ``decorates'' each tag based on certain
arbitrary features of that tag. Decorations are specified using the
@node Uses of defadvice in @acronym{SES}
@section Uses of defadvice in @acronym{SES}
-@cindex defadvice
-@cindex undo-more
-@cindex copy-region-as-kill
-@cindex yank
+@findex defadvice
+@findex undo-more
+@findex copy-region-as-kill
+@findex yank
@table @code
@item undo-more
@node Remote processes
@section Integration with other Emacs packages
-@cindex compile
-@cindex recompile
+@cindex @code{compile}
+@cindex @code{recompile}
@value{tramp} supports starting new running processes on the remote
host for discovering remote file names. Emacs packages on the remote
@subsection Running @code{shell} on a remote host
-@cindex shell
+@cindex @code{shell}
Set @option{explicit-shell-file-name} to the appropriate shell name
when using @value{tramp} between two hosts with different operating
@subsection Running @code{shell-command} on a remote host
-@cindex shell-command
+@cindex @code{shell-command}
@code{shell-command} executes commands synchronously or asynchronously
on remote hosts and displays output in buffers on the local
@subsection Running @code{eshell} on a remote host
-@cindex eshell
+@cindex @code{eshell}
@value{tramp} is integrated into @file{eshell.el}, which enables
interactive eshell sessions on remote hosts at the command prompt.
@anchor{Running a debugger on a remote host}
@subsection Running a debugger on a remote host
-@cindex gud
-@cindex gdb
-@cindex perldb
+@cindex @code{gud}
+@cindex @code{gdb}
+@cindex @code{perldb}
@file{gud.el} provides a unified interface to symbolic debuggers
@ifinfo
@subsection Running remote processes on MS Windows hosts
-@cindex winexe
-@cindex powershell
+@cindex @command{winexe}
+@cindex @command{powershell}
@command{winexe} runs processes on a remote MS Windows host, and
@value{tramp} can use it for @code{process-file} and
@chapter Customizing Indentation
@cindex Customizing Indentation
-@cindex vhdl-set-offset
+@cindex @code{vhdl-set-offset}
@cindex set-offset (vhdl-)
The @code{vhdl-offsets-alist} variable is where you customize all your
indentations. You simply need to decide what additional offset you want
describe how to set up basic editing configurations. @xref{Styles}, for
an explanation of how to set up named styles.
-@cindex vhdl-basic-offset
+@cindex @code{vhdl-basic-offset}
@cindex basic-offset (vhdl-)
As mentioned previously, the variable @code{vhdl-offsets-alist} is an
association list between syntactic symbols and the offsets to be applied
projects / emacs.git / commitdiff