[Emacs-diffs] Changes to emacs/doc/lispref/display.texi,v

[Miles Bader]

CVSROOT:        /cvsroot/emacs
Module name:    emacs
Changes by:     Miles Bader <miles>     08/06/01 05:04:25

Index: doc/lispref/display.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/doc/lispref/display.texi,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -b -r1.12 -r1.13
--- doc/lispref/display.texi    20 Apr 2008 13:38:00 -0000      1.12
+++ doc/lispref/display.texi    1 Jun 2008 05:04:24 -0000       1.13
@@ -2365,6 +2365,61 @@
   When multiple overlays cover one character, an overlay with higher
 priority overrides those with lower priority.  @xref{Overlays}.
 
address@hidden face-remapping-alist
+  This variable is used for buffer-local or global changes in the
+appearance of a face, for instance making the @code{default} face a
+variable-pitch face in a particular buffer.
+
+  Its value should be an alist, whose elements have the form
address@hidden(@var{face} @var{remapping...})}.  This causes Emacs to display
+text using the face @var{face} using @var{remapping...} instead of
address@hidden's global definition.  @var{remapping...} may be any face
+specification suitable for a @code{face} text property, usually a face
+name, but also perhaps a property list of face attribute/value pairs.
address@hidden Properties}.
+
+  To affect display only in a single buffer,
address@hidden should be made buffer-local.
+
+Two points bear emphasizing:
+
address@hidden
address@hidden
+The new definition @var{remapping...} is the complete
+specification of how to display @var{face}---it entirely replaces,
+rather than augmenting or modifying, the normal definition of that
+face.
+
address@hidden
+If @var{remapping...} recursively references the same face name
address@hidden, either directly remapping entry, or via the
address@hidden:inherit} attribute of some other face in
address@hidden, then that reference uses normal frame-wide
+definition of @var{face} instead of the ``remapped'' definition.
+
+For instance, if the @code{mode-line} face is remapped using this
+entry in @code{face-remapping-alist}:
address@hidden
+(mode-line italic mode-line)
address@hidden example
address@hidden
+then the new definition of the @code{mode-line} face inherits from the
address@hidden face, and the @emph{normal} (non-remapped) definition of
address@hidden face.
address@hidden enumerate
+
+  A typical use of the @code{face-remapping-alist} is to change a
+buffer's @code{default} face; for example, the following changes a
+buffer's @code{default} face to use the @code{variable-pitch} face,
+with the height doubled:
+
address@hidden
+(set (make-local-variable 'face-remapping-alist)
+     '((default variable-pitch :height 2.0)))
address@hidden example
+
address@hidden defvar
+
 @node Font Selection
 @subsection Font Selection