xemacs-beta: man/xemacs/custom.texi comparison

comparison man/xemacs/custom.texi @ 1137:c6facab13185

[xemacs-hg @ 2002-12-03 10:35:06 by didierv] new function `set-face-background-pixmap-file'

author	didierv
date	Tue, 03 Dec 2002 10:35:17 +0000
parents	732270854293
children	55834f418dfb

comparison

equal deleted inserted replaced

-:14f3ffacd8be
+:c6facab13185
 [ ] Italic: [Toggle]  off (nil)
 [ ] Underline: [Toggle]  off (nil)
 [ ] Foreground: white       (sample)
 [ ] Background: blue        (sample)
 [ ] Inverse: [Toggle]  off (nil)
 [ ] Stipple:
 [ ] Font Family:
 [ ] Size:
 [ ] Strikethru: off
 @end smallexample
 Each face attribute has its own line.  The @samp{[@var{x}]} field
 before the attribute name indicates whether the attribute is
 @c Is this true for XEmacs?
 @c  On a black-and-white display, the colors you can use for the
 @c background are @samp{black}, @samp{white}, @samp{gray}, @samp{gray1},
 @c and @samp{gray3}.  Emacs supports these shades of gray by using
 @c background stipple patterns instead of a color.
 @c
 Setting, saving and resetting a face work like the same operations for
 options (@pxref{Changing an Option}).
 A face can specify different appearances for different types of
 display.  For example, a face can make text red on a color display, but
 @item M-x customize-group @key{RET} @var{group} @key{RET}
 Set up a customization buffer with just one group, @var{group}.
 @item M-x customize-apropos @key{RET} @var{regexp} @key{RET}
 Set up a customization buffer with all the options, faces and groups
 that match @var{regexp}.
 @item M-x customize-saved
 Set up a customization buffer containing all options and faces that you
 have saved with customization buffers.
 @item M-x customize-customized
 Set up a customization buffer containing all options and faces that you
 have customized but not saved.
 Note also that comments in the file begin with and end with the same
 strings.  Presumably the file contains code in a language which is
 enough like Lisp for Lisp mode to be useful but in which comments
 start and end differently.  The prefix and suffix are used in the local
 variables list to make the list look like several lines of comments when
 the compiler or interpreter for that language reads the file.
 The start of the local variables list must be no more than 3000
 characters from the end of the file, and must be in the last page if the
 file is divided into pages.  Otherwise, Emacs will not notice it is
 there.  The purpose is twofold: a stray @samp{Local Variables:}@: not in
 To start defining a keyboard macro, type @kbd{C-x (}
 (@code{start-kbd-macro}).  From then on, anything you type continues to be
 executed, but also becomes part of the definition of the macro.  @samp{Def}
 appears in the mode line to remind you of what is going on.  When you are
 finished, the @kbd{C-x )} command (@code{end-kbd-macro}) terminates the
 definition, without becoming part of it.
 For example,
 @example
 C-x ( M-f foo C-x )
 all major modes except those that have their own overriding local
 definitions for the same key.  Or you can change the current buffer's
 local map, which affects all buffers using the same major mode.
 @menu
 * Interactive Rebinding::      Changing Key Bindings Interactively
 * Programmatic Rebinding::     Changing Key Bindings Programmatically
 * Key Bindings Using Strings:: Using Strings for Changing Key Bindings
 @end menu
 @node Interactive Rebinding
 @subsubsection Changing Key Bindings Interactively
 @findex global-set-key
 @findex local-unset-key
 @table @kbd
 @item M-x global-set-key @key{RET} @var{key} @var{cmd} @key{RET}
 Defines @var{key} globally to run @var{cmd}.
 @item M-x local-set-key @key{RET} @var{keys} @var{cmd} @key{RET}
 Defines @var{key} locally (in the major mode now in effect) to run
 @var{cmd}.
 @item M-x local-unset-key @key{RET} @var{keys} @key{RET}
 Removes the local binding of @var{key}.
 @end table
 @item  @code{(global-set-key @var{keys} @var{cmd})}
 Defines @var{keys} globally to run @var{cmd}.
 @item @code{(define-key @var{keymap} @var{keys} @var{def})}
 Defines @var{keys} to run @var{def} in the keymap @var{keymap}.
 @end table
 @var{keymap} is a keymap object.
 @var{keys} is the sequence of keystrokes to bind.
 @var{def} is anything that can be a key's definition:
 sequences as strings.  However, the preferred method is to use the
 representations of key sequences as vectors of keystrokes.
 @xref{Keystrokes}, for more information about the rules for constructing
 key sequences.
 Emacs allows you to abbreviate representations for key sequences in
 most places where there is no ambiguity.
 Here are some rules for abbreviation:
 @itemize @bullet
 @item
 Here are some examples of programmatically binding keys:
 @example
 ;;;  Bind @code{my-command} to @key{f1}
 (global-set-key 'f1 'my-command)
 ;;;  Bind @code{my-command} to @kbd{Shift-f1}
 (global-set-key '(shift f1) 'my-command)
 ;;; Bind @code{my-command} to @kbd{C-c Shift-f1}
 (global-set-key '[(control c) (shift f1)] 'my-command)
 ;;; Bind @code{my-command} to the middle mouse button.
 (global-set-key 'button2 'my-command)
 ;;; Bind @code{my-command} to @kbd{@key{META} @key{CTL} @key{Right Mouse Button}}
 @comment ;;
 @comment (global-set-key '(meta control delete) 'my-command)
 @comment (global-set-key '(meta control backspace) 'my-command)
 @comment (global-set-key '(meta control h) 'my-command)
 @comment (global-set-key '(meta control H) 'my-command)
 @comment
 @comment ;; note that this binds two key sequences: ``control-j'' and ``linefeed''.
 @comment ;;
 @comment (global-set-key "\^J" 'my-command)
 @node Key Bindings Using Strings
 @subsubsection Using Strings for Changing Key Bindings
 For backward compatibility, you can still use strings to represent
 key sequences.  Thus you can use commands like the following:
 @example
 ;;; Bind @code{end-of-line} to @kbd{C-f}
 (global-set-key "\C-f" 'end-of-line)
 @end example
 Note, however, that in some cases you may be binding more than one
 key sequence by using a single command.  This situation can
 arise because in ASCII, @kbd{C-i} and @key{TAB} have
 the same representation.  Therefore, when Emacs sees:
 @example
 (global-set-key "\C-i" 'end-of-line)
 Here is a table of pairs of key sequences that behave in a
 similar fashion:
 @example
 control h      backspace
 control l      clear
 control i      tab
 control m      return
 control j      linefeed
 control [      escape
 control @@      control space
 @end example
 @node Disabling
 other things, strings of audio-data.  When @code{ding} is called with
 one of the symbols, the associated sound data is played instead of the
 standard beep.  This only works if you are logged in on the console of a
 machine with audio hardware. To listen to a sound of the provided type,
 call the function @code{play-sound} with the argument @var{sound}. You
 can also set the volume of the sound with the optional argument
 @var{volume}.@refill
 @cindex ding
 Each element of @code{sound-alist} is a list describing a sound.
 The first element of the list is the name of the sound being defined.
 Subsequent elements of the list are alternating keyword/value pairs:
 @table @code
 @item sound
 A string of raw sound data, or the name of another sound to play.
 The symbol @code{t} here means use the default X beep.
 @item volume
 An integer from 0-100, defaulting to @code{bell-volume}.
 with 100 being loudest, which controls how loud the sounds emacs makes
 should be.  Elements of the @code{sound-alist} may override this value.
 This variable applies to the standard X bell sound as well as sound files.
 If the symbol @code{t} is in place of a sound-string, Emacs uses the
 default X beep.  This allows you to define beep-types of
 different volumes even when not running on the console.
 @findex load-sound-file
 You can add things to this list by calling the function
 @code{load-sound-file}, which reads in an audio-file and adds its data to
 Completion was not possible
 @item y-or-n-p
 You type something other than the required @code{y} or @code{n}
 @item yes-or-no-p
 You type something other than @code{yes} or @code{no}
 @end table
 @comment  node-name,  next,  previous,  up
 @node Faces
 Swap the foreground and background colors of the given @var{face}.
 @item M-x make-face-bold
 Make the font of the given @var{face} bold.  When called from a
 program, returns @code{nil} if this is not possible.
 @item M-x make-face-bold-italic
 Make the font of the given @var{face} bold italic.
 When called from a program, returns @code{nil} if not possible.
 @item M-x make-face-italic
 Make the font of the given @var{face} italic.
 When called from a program, returns @code{nil} if not possible.
 @item M-x make-face-unbold
 Make the font of the given @var{face} non-bold.
 When called from a program, returns @code{nil} if not possible.
 @item M-x make-face-unitalic
 Make the font of the given @var{face} non-italic.
 When called from a program, returns @code{nil} if not possible.
 @item M-x make-face-larger
 Make the font of the given @var{face} a little larger.
 When called from a program, returns @code{nil} if not possible.
 @item M-x make-face-smaller
 Make the font of the given @var{face} a little smaller.
 When called from a program, returns @code{nil} if not possible.
 @item M-x set-face-background
 Change the background color of the given @var{face}.
 @item M-x set-face-background-pixmap
 Change the background pixmap of the given @var{face}.
-@item M-x set-face-font
+@item M-x set-face-background-pixmap-file
+A simpler version but with filename completion.
+@item M-x set-face-font
 Change the font of the given @var{face}.
 @item M-x set-face-foreground
 Change the foreground color of the given @var{face}.
 @item M-x set-face-underline-p
 Change whether the given @var{face} is underlined.
 @findex invert-face
 You can exchange the foreground and background color of the selected
 @var{face} with the function @code{invert-face}. If the face does not
 specify both foreground and background, then its foreground and
 background are set to the background and foreground of the default face.
 When calling this from a program, you can supply the optional argument
 @var{frame} to specify which frame is affected; otherwise, all frames
 are affected.
 @findex set-face-background
 You can set the background color of the specified @var{face} with the
 function @code{set-face-background}.  The argument @code{color} should
 be a string, the name of a color.  When called from a program, if the
 optional @var{frame} argument is provided, the face is changed only
 in that frame; otherwise, it is changed in all frames.
 @findex set-face-background-pixmap
 You can set the background pixmap of the specified @var{face} with the
 function @code{set-face-background-pixmap}.  The pixmap argument
 resource.
 If the environment variable @b{XBMLANGPATH} is set, then it is consulted
 before the @code{x-bitmap-file-path} variable.
+@findex set-face-background-pixmap
+Alternately, you can use a simpler version of
+@code{set-face-background-pixmap} called
+@code{set-face-background-pixmap-file}. This function does not give you
+as much control on the pixmap instanciator, but provides filename
+completion.
 @findex set-face-font
 You can set the font of the specified @var{face} with the function
 @code{set-face-font}.  The @var{font} argument should be a string, the
 name of a font.  When called from a program, if the
 optional @var{frame} argument is provided, the face is changed only
 in that frame; otherwise, it is changed in all frames.
 @findex set-face-foreground
 You can set the foreground color of the specified @var{face} with the
 function @code{set-face-foreground}.  The argument @var{color} should be
 a string, the name of a color.  If the optional @var{frame} argument is
 provided, the face is changed only in that frame; otherwise, it is
 changed in all frames.
 backwards compatibility.  The variable @var{x-emacs-application-class}
 may be consulted to determine the application class being used.
 The examples in this section assume the application class is @samp{Emacs}.
 The Emacs resources are generally set per-frame. Each Emacs frame can have
 its own name or the same name as another, depending on the name passed to the
 @code{make-frame} function.
 You can specify resources for all frames with the syntax:
 @example
 For the first frame created, the position of the frame is taken from the
 ApplicationShell (@code{Emacs.geometry}) if it is specified, otherwise
 from the geometry of the frame.
 @item
 For subsequent frames, the position is taken only from the frame, and
 never from the ApplicationShell.
 @end itemize
 This is rather complicated, but it does seem to provide the most
 intuitive behavior with respect to the default sizes and positions of
 @item @code{iconic} (class @code{Iconic}): boolean
 Whether this frame should appear in the iconified state.
 @item @code{internalBorderWidth} (class @code{InternalBorderWidth}): int
 How many blank pixels to leave between the text and the edge of the
 window.
 @item @code{interline} (class @code{Interline}): int
 How many pixels to leave between each line (may not be implemented).
 These are the faces that the left and right annotation margins are
 displayed in.
 @item zmacs-region
 This is the face that mouse selections are displayed in.
 @item isearch
 This is the face that the matched text being searched for is displayed
 in.
 @item info-node
 @example
 Emacs*menubar*font: *-courier-medium-r-*-*-*-120-*-*-*-*-*-*
 @end example
 If both the Lucid Motif-lookalike menu widgets and X Font Sets are
 configured to allow multilingual menubars, then one uses
 @example
 *menubar*FontSet:       -*-helvetica-bold-r-*-*-*-120-*-*-*-*-iso8859-*, \
 -*-*-*-*-*-*-*-120-*-jisx0208.1983-0
 XLFD is acceptable; specifying more than one for a given registry
 (language) is also allowed.  When X Font Sets are configured, some .font
 resources (eg, menubars) are ignored in favor of the corresponding
 .fontSet resources.
 If the Motif library is being used, then one would have to use
 @example
 Emacs*menubar*fontList: *-courier-medium-r-*-*-*-120-*-*-*-*-*-*
 @end example
 because the Motif library uses the @code{fontList} resource name instead
 of @code{font}, which has subtly different semantics.
 The same is true of the scrollbars: They accept whichever resources are
 appropriate for the toolkit in use.

Mercurial > hg > xemacs-beta

comparison man/xemacs/custom.texi @ 1137:c6facab13185