]> code.delx.au - gnu-emacs/blobdiff - man/xresources.texi
(enum event_kind) [MAC_OS]: Update comment for MAC_APPLE_EVENT.
[gnu-emacs] / man / xresources.texi
index 3b55edfa5b37a9b867a4f6f10b60d84e9376d76d..ce6709ad7649c11bc058730b147bf4d9c3fcd6eb 100644 (file)
@@ -1,5 +1,6 @@
 @c This is part of the Emacs manual.
-@c Copyright (C) 1987,93,94,95,1997,2001,03 Free Software Foundation, Inc.
+@c Copyright (C) 1987, 1993, 1994, 1995, 1997, 2001, 2002, 2003,
+@c   2004, 2005, 2006 Free Software Foundation, Inc.
 @c See file emacs.texi for copying conditions.
 @node X Resources, Antinews, Emacs Invocation, Top
 @appendix X Options and Resources
@@ -7,7 +8,8 @@
   You can customize some X-related aspects of Emacs behavior using X
 resources, as is usual for programs that use X.  On MS-Windows, you
 can customize some of the same aspects using the system registry.
-@xref{MS-Windows Registry}.
+@xref{MS-Windows Registry}.  Likewise, the Mac Carbon port emulates X
+resources using the Preferences system.  @xref{Mac Environment Variables}.
 
   When Emacs is built using an `X toolkit', such as Lucid or LessTif,
 you need to use X resources to customize the appearance of the
@@ -52,7 +54,8 @@ Registry, under the key @samp{HKEY_CURRENT_USER\SOFTWARE\GNU\Emacs}
 and then under the key @samp{HKEY_LOCAL_MACHINE\SOFTWARE\GNU\Emacs}.
 The menu and scrollbars are native widgets on MS-Windows, so they are
 only customizable via the system-wide settings in the Display Control
-Panel.
+Panel.  You can also set resources using the @samp{-xrm} command line
+option (see below.)
 
   Programs define named resources with particular meanings.  They also
 define how to group resources into named classes.  For instance, in
@@ -174,6 +177,10 @@ Width in pixels of the external border.
 @item @code{cursorColor} (class @code{Foreground})
 Color name for text cursor (point).
 
+@item @code{cursorBlink} (class @code{CursorBlink})
+Specifies whether to make the cursor blink. The default is @samp{on}.  Use
+@samp{off} or @samp{false} to turn cursor blinking off.
+
 @item @code{font} (class @code{Font})
 Font name for text (or fontset name, @pxref{Fontsets}).
 
@@ -294,12 +301,10 @@ program outputs information saying which ones.
 @node Face Resources
 @appendixsec X Resources for Faces
 
-  You can also use resources to customize the appearance of particular
+  You can use resources to customize the appearance of particular
 faces (@pxref{Faces}):
 
 @table @code
-@item @var{face}.attributeFont
-Font for face @var{face}.
 @item @var{face}.attributeForeground
 Foreground color for face @var{face}.
 @item @var{face}.attributeBackground
@@ -307,49 +312,45 @@ Background color for face @var{face}.
 @item @var{face}.attributeUnderline
 Underline flag for face @var{face}.  Use @samp{on} or @samp{true} for
 yes.
+@item @var{face}.attributeStrikeThrough
+@itemx @var{face}.attributeOverline
+@itemx @var{face}.attributeBox
+@itemx @var{face}.attributeInverse
+Likewise, for other boolean font attributes.
+@item @var{face}.attributeStipple
+The name of a pixmap data file to use for the stipple pattern, or
+@code{false} to not use stipple for the face @var{face}.
+@item @var{face}.attributeBackgroundPixmap
+The background pixmap for the face @var{face}.  Should be a name of a
+pixmap file or @code{false}.
+@item @var{face}.attributeFont
+Font name (full XFD name or valid X abbreviation) for face @var{face}.
+Instead of this, you can specify the font through separate attributes.
+@end table
+
+  Instead of using @code{attributeFont} to specify a font name, you can
+select a font through these separate attributes:
+
+@table @code
 @item @var{face}.attributeFamily
 Font family for face @var{face}.
-@item @var{face}.attributeWidth
-Relative proportional width of the font to use for face @var{face}.
-It should be one of @code{ultra-condensed}, @code{extra-condensed},
-@code{condensed}, @code{semi-condensed}, @code{normal},
-@code{semi-expanded}, @code{expanded}, @code{extra-expanded}, or
-@code{ultra-expanded}.
 @item @var{face}.attributeHeight
 Height of the font to use for face @var{face}: either an integer
 specifying the height in units of 1/10@dmn{pt}, or a floating point
 number that specifies a scale factor to scale the underlying face's
 default font, or a function to be called with the default height which
 will return a new height.
-@item @var{face}.attributeWeight
-A weight to use for the face @var{face}.  It must be one of
-@code{ultra-bold}, @code{extra-bold}, @code{bold},
-@code{semi-bold}, @code{normal}, @code{semi-light}, @code{light},
-@code{extra-light}, @code{ultra-light}.
-@item @var{face}.attributeSlant
-The slant to use for the font of face @var{face}.  It must be one of
-@code{italic}, @code{oblique}, @code{normal},
-@code{reverse-italic}, or @code{reverse-oblique}.
-@item @var{face}.attributeStrikeThrough
-Whether the face @var{face} should be drawn with a line striking
-through the characters.
-@item @var{face}.attributeOverline
-Whether the characters in the face @var{face} should be overlined.
-@item @var{face}.attributeBox
-Whether to draw a box around the characters in face @var{face}.
-@item @var{face}.attributeInverse
-Whether to display the characters in face @var{face} in inverse
-video.
-@item @var{face}.attributeStipple
-The name of a pixmap data file to use for the stipple pattern, or
-@code{false} to not use stipple for the face @var{face}.
-@item @var{face}.attributeBackgroundPixmap
-The background pixmap for the face @var{face}.  Should be a name of a
-pixmap file or @code{false}.
+@item @var{face}.attributeWidth
+@itemx @var{face}.attributeWeight
+@itemx @var{face}.attributeSlant
+Each of these resources corresponds to a like-named font attribute,
+and you write the resource value the same as the symbol you would use
+for the font attribute value.
 @item @var{face}.attributeBold
-Whether to draw the characters in the face @var{face} as bold.
+Bold flag for face @var{face}---instead of @code{attributeWeight}.  Use @samp{on} or @samp{true} for
+yes.
 @item @var{face}.attributeItalic
-Whether to draw the characters in the face @var{face} as italic.
+Italic flag for face @var{face}---instead of @code{attributeSlant}.
 @end table
 
 @node Lucid Resources
@@ -391,6 +392,19 @@ For dialog boxes, use @samp{dialog} instead of @samp{menu}:
 Emacs.dialog*.font:    8x16
 @end example
 
+@noindent
+The Lucid menus can display multilingual text in your locale.  For more 
+information about fontsets see the man page for XCreateFontSet.  To enable
+multilingual menu text you specify a fontSet resource instead of the font
+resource.  If both font and fontSet resources are specified, the fontSet
+resource is used.  To specify
+@samp{-*-helvetica-medium-r-*--*-120-*-*-*-*-*-*,*} for both the popup and
+menu bar menus, write this:
+
+@example
+Emacs*fontSet:  -*-helvetica-medium-r-*--*-120-*-*-*-*-*-*,*
+@end example
+
 @noindent
 Experience shows that on some systems you may need to add
 @samp{shell.}@: before the @samp{pane.menubar} or @samp{menu*}.  On
@@ -401,6 +415,8 @@ some other systems, you must not add @samp{shell.}.
 @table @code
 @item font
 Font for menu item text.
+@item fontSet
+Fontset for menu item text.
 @item foreground
 Color of the foreground.
 @item background
@@ -612,10 +628,10 @@ style "scroll"
 widget "*verticalScrollBar*" style "scroll"
 @end smallexample
 
-  There are also parameters that affect GTK as a whole.  For example, the property
-@c @code{gtk-font-name} sets the default font for GTK.  You must use
-@c Pango font names (@pxref{GTK styles}).  A GTK resources file that
-@c just sets a default font looks like this:
+  There are also parameters that affect GTK as a whole.  For example,
+the property @code{gtk-font-name} sets the default font for GTK.  You
+must use Pango font names (@pxref{GTK styles}).  A GTK resources file
+that just sets a default font looks like this:
 
 @smallexample
 gtk-font-name = "courier 12"
@@ -668,8 +684,8 @@ or just the class.
 @end table
 
 @noindent
-You must soecify the class and the style in double-quotes, and put
-these commands at the top level in a @file{~/.gtkrc-2.0} file, like
+You must specify the class and the style in double-quotes, and put
+these commands at the top level in the GTK customization file, like
 this:
 
 @smallexample
@@ -782,7 +798,7 @@ widget "*emacs-menuitem* style "my_menu_style"
 automatically applies only to Emacs, since other programs don't read
 that file.  For example, the drop down menu in the file dialog can not
 be customized by any absolute widget name, only by an absolute class
-name.  This is so because the widgets in the drop down menu do not
+name.  This is because the widgets in the drop down menu do not
 have names and the menu is not contained in the Emacs GtkWindow.  To
 have all menus in Emacs look the same, use this in
 @file{~/.emacs.d/gtkrc}:
@@ -856,14 +872,14 @@ also for the trough of a scroll bar, i.e.  @code{bg[ACTIVE] = "red"}
 sets the scroll bar trough to red.  Buttons that have been pressed but
 not released yet (``armed'') are in this state.
 @item PRELIGHT
-This is the state when widgets that can be manipulated have the mouse
-pointer over them.  For example when the mouse is over the thumb in the
-scroll bar or over a menu item.  When the mouse is over a button that
-is not pressed, the button is in this state.
+This is the state for a widget that can be manipulated, when the mouse
+pointer is over it---for example when the mouse is over the thumb in
+the scroll bar or over a menu item.  When the mouse is over a button
+that is not pressed, the button is in this state.
 @item SELECTED
-This is the state when some data has been selected by the user.  It can
-be selected text or items selected in a list.
-There is no place in Emacs where this setting has any effect.
+This is the state for data that has been selected by the user.  It can
+be selected text or items selected in a list.  This state is not used
+in Emacs.
 @item INSENSITIVE
 This is the state for widgets that are visible, but they can not be
 manipulated in the usual way---for example, buttons that can't be
@@ -912,7 +928,7 @@ This is the color for editable text.  In Emacs, this color is used for the
 text fields in the file dialog.
 
 @item font_name = "@var{font}"
-This specifies the the font for text in the widget.  @var{font} is a
+This specifies the font for text in the widget.  @var{font} is a
 Pango font name, for example @samp{Sans Italic 10}, @samp{Helvetica
 Bold 12}, @samp{Courier 14}, @samp{Times 18}.  See below for exact
 syntax.  The names are case insensitive.