@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, 2007 Free Software Foundation, Inc.
@c See file emacs.texi for copying conditions.
-@node X Resources, Antinews, Command Arguments, Top
+@node X Resources, Antinews, Emacs Invocation, Top
@appendix X Options and Resources
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}. X resources are the only way to customize
-tooltip windows and LessTif menus, since the libraries that implement
-them don't provide for customization through Emacs. This appendix
-describes the X resources that Emacs recognizes and how to use them.
+@xref{MS-Windows Registry}. Likewise, Emacs on MacOS Carbon 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 widgets, including the menu-bar, scroll-bar, and dialog boxes.
+This is because the libraries that implement these don't provide for
+customization through Emacs. GTK+ widgets use a separate system of
+@ifnottex
+``GTK resources'', which we will also describe.
+@end ifnottex
+@iftex
+``GTK resources.'' In this chapter we describe the most commonly used
+resource specifications. For full documentation, see the online
+manual.
+
+@c Add xref for LessTif/Motif menu resources.
+@end iftex
+
@menu
* Resources:: Using X resources with Emacs (in general).
(optionally even for all programs).
@cindex Registry (MS-Windows)
- MS-Windows systems don't support @file{~/.Xdefaults} files, but
-Emacs compiled for Windows looks for X resources in the Windows
-Registry, under the key @samp{HKEY_CURRENT_USER\SOFTWARE\GNU\Emacs}
-and then under the key @samp{HKEY_LOCAL_MACHINE\SOFTWARE\GNU\Emacs}.
+ MS-Windows systems do not support @file{~/.Xdefaults} files, so
+instead Emacs compiled for Windows looks for X resources in the
+Windows Registry, first 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 scroll
+bars are native widgets on MS-Windows, so they are only customizable
+via the system-wide settings in the Display Control Panel. You can
+also set resources using the @samp{-xrm} command line option (see
+below.)
+
+@iftex
+ Applications such as Emacs look for resources with specific names
+and their particular meanings. Case distinctions are significant in
+these names. Each resource specification in @file{~/.Xdefaults}
+states the name of the program and the name of the resource. For
+Emacs, the program name is @samp{Emacs}. It looks like this:
+@example
+Emacs.borderWidth: 2
+@end example
+@end iftex
+@ifnottex
Programs define named resources with particular meanings. They also
define how to group resources into named classes. For instance, in
Emacs, the @samp{internalBorder} resource controls the width of the
@samp{BorderWidth} class. Case distinctions are significant in these
names.
+ Every resource definition is associated with a specific program
+name---the name of the executable file that you ran. For Emacs, that
+is normally @samp{emacs}. To specify a definition for all instances
+of Emacs, regardless of their names, use @samp{Emacs}.
+
In @file{~/.Xdefaults}, you can specify a value for a single resource
on one line, like this:
emacs.BorderWidth: 2
emacs.borderWidth: 4
@end example
+@end ifnottex
The order in which the lines appear in the file does not matter.
Also, command-line options always override the X resources file.
- The string @samp{emacs} in the examples above is also a resource
-name. It actually represents the name of the executable file that you
-invoke to run Emacs. If Emacs is installed under a different name, it
-looks for resources under that name instead of @samp{emacs}.
+@ifnottex
+Here is a list of X command-line options and their corresponding
+resource names.
@table @samp
@item -name @var{name}
One way to experiment with the effect of different resource settings
is to use the @code{editres} program. Select @samp{Get Tree} from the
+@end ifnottex
+@iftex
+ You can experiment with the effect of different resource settings
+with the @code{editres} program. Select @samp{Get Tree} from the
+@end iftex
@samp{Commands} menu, then click on an Emacs frame. This will display
a tree showing the structure of X toolkit widgets used in an Emacs
frame. Select one of them, such as @samp{menubar}, then select
@samp{Show Resource Box} from the @samp{Commands} menu. This displays
-a list of all the meaningful X resources and allows you to edit them.
-Changes take effect immediately if you click on the @samp{Apply} button.
+a list of all the meaningful X resources for that widget, and allows
+you to edit them. Changes take effect when you click on the
+@samp{Apply} button. (See the @code{editres} man page for more
+details.)
@node Table of Resources
@appendixsec Table of X Resources for Emacs
@item @code{background} (class @code{Background})
Background color name.
+@ifnottex
@item @code{bitmapIcon} (class @code{BitmapIcon})
Use a bitmap icon (a picture of a gnu) if @samp{on}, let the window
manager choose an icon if @samp{off}.
+@end ifnottex
@item @code{borderColor} (class @code{BorderColor})
Color name for the external border.
+@ifnottex
@item @code{borderWidth} (class @code{BorderWidth})
Width in pixels of the external border.
+@end ifnottex
@item @code{cursorColor} (class @code{Foreground})
Color name for text cursor (point).
+@ifnottex
+@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.
+@end ifnottex
+
@item @code{font} (class @code{Font})
-Font name for text (or fontset name, @pxref{Fontsets}).
+Font name (or fontset name, @pxref{Fontsets}) for @code{default} font.
@item @code{foreground} (class @code{Foreground})
Color name for text.
name, only that frame). However, the size, if specified here, applies to
all frames.
+@ifnottex
@item @code{fullscreen} (class @code{Fullscreen})
The desired fullscreen size. The value can be one of @code{fullboth},
@code{fullwidth} or @code{fullheight}, which correspond to
the command-line options @samp{-fs}, @samp{-fw}, and @samp{-fh}
(@pxref{Window Size X}).
-Note that this applies to all frames created, not just the initial
-one.
+Note that this applies to the initial frame only.
+@end ifnottex
@item @code{iconName} (class @code{Title})
Name to display in the icon.
Additional space (@dfn{leading}) between lines, in pixels.
@item @code{menuBar} (class @code{MenuBar})
-Give frames menu bars if @samp{on}; don't have menu bars if
-@samp{off}. @xref{Lucid Resources}, and @ref{LessTif Resources}, for
-how to control the appearance of the menu bar if you have one.
+@cindex menu bar
+Give frames menu bars if @samp{on}; don't have menu bars if @samp{off}.
+@ifnottex
+@xref{Lucid Resources}, and @ref{LessTif Resources},
+@end ifnottex
+@iftex
+@xref{Lucid Resources},
+@end iftex
+for how to control the appearance of the menu bar if you have one.
+@ifnottex
@item @code{minibuffer} (class @code{Minibuffer})
If @samp{none}, don't make a minibuffer in this frame.
It will use a separate minibuffer frame instead.
@item @code{paneFont} (class @code{Font})
@cindex font for menus
Font name for menu pane titles, in non-toolkit versions of Emacs.
+@end ifnottex
@item @code{pointerColor} (class @code{Foreground})
Color of the mouse cursor.
+@ifnottex
@item @code{privateColormap} (class @code{PrivateColormap})
If @samp{on}, use a private color map, in the case where the ``default
visual'' of class PseudoColor and Emacs is using it.
@item @code{reverseVideo} (class @code{ReverseVideo})
Switch foreground and background default colors if @samp{on}, use colors as
specified if @samp{off}.
+@end ifnottex
@item @code{screenGamma} (class @code{ScreenGamma})
@cindex gamma correction
Gamma correction for colors, equivalent to the frame parameter
@code{screen-gamma}.
+@item @code{scrollBarWidth} (class @code{ScrollBarWidth})
+@cindex scrollbar width
+The scroll bar width in pixels, equivalent to the frame parameter
+@code{scroll-bar-width}.
+
+@ifnottex
@item @code{selectionFont} (class @code{SelectionFont})
Font name for pop-up menu items, in non-toolkit versions of Emacs. (For
toolkit versions, see @ref{Lucid Resources}, also see @ref{LessTif
@cindex synchronous X mode
Run Emacs in synchronous mode if @samp{on}. Synchronous mode is
useful for debugging X problems.
+@end ifnottex
@item @code{title} (class @code{Title})
Name to display in the title bar of the initial Emacs frame.
@item @code{toolBar} (class @code{ToolBar})
+@cindex tool bar
Number of lines to reserve for the tool bar. A zero value suppresses
the tool bar. If the value is non-zero and
@code{auto-resize-tool-bars} is non-@code{nil}, the tool bar's size
will be changed automatically so that all tool bar items are visible.
+ If the value of @code{auto-resize-tool-bars} is @code{grow-only},
+the tool bar expands automatically, but does not contract automatically.
+To contract the tool bar, you must redraw the frame by entering @kbd{C-l}.
+
+@item @code{useXIM} (class @code{UseXIM})
+@cindex XIM
+@cindex X input methods
+@cindex input methods, X
+Turn off use of X input methods (XIM) if @samp{false} or @samp{off}.
+This is only relevant if your Emacs is actually built with XIM
+support. It is potentially useful to turn off XIM for efficiency,
+especially slow X client/server links.
@item @code{verticalScrollBars} (class @code{ScrollBars})
Give frames scroll bars if @samp{on}; don't have scroll bars if
@samp{off}.
+
+@ifnottex
+@item @code{visualClass} (class @code{VisualClass})
+Specify the ``visual'' that X should use. This tells X how to handle
+colors.
+
+The value should start with one of @samp{TrueColor},
+@samp{PseudoColor}, @samp{DirectColor}, @samp{StaticColor},
+@samp{GrayScale}, and @samp{StaticGray}, followed by
+@samp{-@var{depth}}, where @var{depth} is the number of color planes.
+Most terminals only allow a few ``visuals,'' and the @samp{dpyinfo}
+program outputs information saying which ones.
+@end ifnottex
@end table
@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
@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
@cindex Menu X Resources (Lucid widgets)
@cindex Lucid Widget X Resources
+@ifnottex
If the Emacs installed at your site was built to use the X toolkit
with the Lucid menu widgets, then the menu bar is a separate widget and
has its own resources. The resource names contain @samp{pane.menubar}
@noindent
For example, to specify the font @samp{8x16} for the menu-bar items,
write this:
+@end ifnottex
+@iftex
+ If the Emacs installed at your site was built to use the X toolkit
+with the Lucid menu widgets, then the menu bar is a separate widget
+and has its own resources. The resource specifications start with
+@samp{Emacs.pane.menubar}---for instance, to specify the font
+@samp{8x16} for the menu-bar items, write this:
+@end iftex
@example
Emacs.pane.menubar.font: 8x16
@noindent
Resources for @emph{non-menubar} toolkit pop-up menus have
-@samp{menu*}, in like fashion. For example, to specify the font
-@samp{8x16} for the pop-up menu items, write this:
+@samp{menu*} instead of @samp{pane.menubar}. For example, to specify
+the font @samp{8x16} for the pop-up menu items, write this:
@example
Emacs.menu*.font: 8x16
@end example
@noindent
-For dialog boxes, use @samp{dialog} instead of @samp{menu}:
+For dialog boxes, use @samp{dialog*}:
@example
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
+@code{XCreateFontSet}. To enable multilingual menu text you specify a
+@code{fontSet} resource instead of the font resource. If both
+@code{font} and @code{fontSet} resources are specified, the
+@code{fontSet} resource is used.
+
+ Thus, to specify @samp{-*-helvetica-medium-r-*--*-120-*-*-*-*-*-*,*}
+for both the popup and menu bar menus, write this:
+
+@example
+Emacs*menu*fontSet: -*-helvetica-medium-r-*--*-120-*-*-*-*-*-*,*
+@end example
+
+@noindent
+The @samp{*menu*} as a wildcard matches @samp{pane.menubar} and
+@samp{menu@dots{}}.
+
Experience shows that on some systems you may need to add
@samp{shell.}@: before the @samp{pane.menubar} or @samp{menu*}. On
-some other systems, you must not add @samp{shell.}.
+some other systems, you must not add @samp{shell.}. The generic wildcard
+approach should work on both kinds of systems.
Here is a list of the specific resources for menu bars and pop-up menus:
@table @code
@item font
Font for menu item text.
+@item fontSet
+Fontset for menu item text.
@item foreground
Color of the foreground.
@item background
Color of the background.
@item buttonForeground
In the menu bar, the color of the foreground for a selected item.
+@ifnottex
@item horizontalSpacing
Horizontal spacing in pixels between items. Default is 3.
@item verticalSpacing
-Vertical spacing in pixels between items. Default is 1.
+Vertical spacing in pixels between items. Default is 2.
@item arrowSpacing
Horizontal spacing between the arrow (which indicates a submenu) and
the associated text. Default is 10.
@item shadowThickness
-Thickness of shadow line around the widget.
+Thickness of shadow line around the widget. Default is 1.
+
+Also determines the thickness of shadow lines around other objects,
+for instance 3D buttons and arrows. If you have the impression that
+the arrows in the menus do not stand out clearly enough or that the
+difference between ``in'' and ``out'' buttons is difficult to see, set
+this to 2. If you have no problems with visibility, the default
+probably looks better. The background color may also have some effect
+on the contrast.
+@end ifnottex
@item margin
-The margin of the menu bar, in characters. The default of 4 makes the
-menu bar appear like the LessTif/Motif one.
+The margin of the menu bar, in characters. Default is 1.
@end table
+@ifnottex
@node LessTif Resources
@appendixsec LessTif Menu X Resources
@cindex Menu X Resources (LessTif widgets)
@item topShadowColor
The color for the border shadow, on the top and the left.
@end table
+@end ifnottex
@node GTK resources
@appendixsec GTK resources
+@iftex
+ The most common way to customize the GTK widgets Emacs uses (menus, dialogs
+tool bars and scroll bars) is by choosing an appropriate theme, for example
+with the GNOME theme selector. You can also do Emacs specific customization
+by inserting GTK style directives in the file @file{~/.emacs.d/gtkrc}. Some GTK
+themes ignore customizations in @file{~/.emacs.d/gtkrc} so not everything
+works with all themes. To customize Emacs font, background, faces, etc., use
+the normal X resources (@pxref{Resources}). We will present some examples of
+customizations here, but for a more detailed description, see the online manual
+
+ The first example is just one line. It changes the font on all GTK widgets
+to courier with size 12:
+
+@smallexample
+gtk-font-name = "courier 12"
+@end smallexample
+
+ The thing to note is that the font name is not an X font name, like
+-*-helvetica-medium-r-*--*-120-*-*-*-*-*-*, but a Pango font name. A Pango
+font name is basically of the format "family style size", where the style
+is optional as in the case above. A name with a style could be for example:
+
+@smallexample
+gtk-font-name = "helvetica bold 10"
+@end smallexample
+
+ To customize widgets you first define a style and then apply the style to
+the widgets. Here is an example that sets the font for menus, but not
+for other widgets:
+
+@smallexample
+# @r{Define the style @samp{menufont}.}
+style "menufont"
+@{
+ font_name = "helvetica bold 14" # This is a Pango font name
+@}
+
+# @r{Specify that widget type @samp{*emacs-menuitem*} uses @samp{menufont}.}
+widget "*emacs-menuitem*" style "menufont"
+@end smallexample
+
+The widget name in this example contains wildcards, so the style will be
+applied to all widgets that match "*emacs-menuitem*". The widgets are
+named by the way they are contained, from the outer widget to the inner widget.
+So to apply the style "my_style" (not shown) with the full, absolute name, for
+the menubar and the scroll bar in Emacs we use:
+
+@smallexample
+widget "Emacs.pane.menubar" style "my_style"
+widget "Emacs.pane.emacs.verticalScrollBar" style "my_style"
+@end smallexample
+
+But to avoid having to type it all, wildcards are often used. @samp{*}
+matches zero or more characters and @samp{?} matches one character. So "*"
+matches all widgets.
+
+ Each widget has a class (for example GtkMenuItem) and a name (emacs-menuitem).
+You can assign styles by name or by class. In this example we have used the
+class:
+
+@smallexample
+style "menufont"
+@{
+ font_name = "helvetica bold 14"
+@}
+
+widget_class "*GtkMenuBar" style "menufont"
+@end smallexample
+
+@noindent
+The names and classes for the GTK widgets Emacs uses are:
+
+@multitable {@code{verticalScrollbar plus}} {@code{GtkFileSelection} and some}
+@item @code{emacs-filedialog}
+@tab @code{GtkFileSelection}
+@item @code{emacs-dialog}
+@tab @code{GtkDialog}
+@item @code{Emacs}
+@tab @code{GtkWindow}
+@item @code{pane}
+@tab @code{GtkVHbox}
+@item @code{emacs}
+@tab @code{GtkFixed}
+@item @code{verticalScrollBar}
+@tab @code{GtkVScrollbar}
+@item @code{emacs-toolbar}
+@tab @code{GtkToolbar}
+@item @code{menubar}
+@tab @code{GtkMenuBar}
+@item @code{emacs-menuitem}
+@tab anything in menus
+@end multitable
+
+ GTK absolute names are quite strange when it comes to menus
+and dialogs. The names do not start with @samp{Emacs}, as they are
+free-standing windows and not contained (in the GTK sense) by the
+Emacs GtkWindow. To customize the dialogs and menus, use wildcards like this:
+
+@smallexample
+widget "*emacs-dialog*" style "my_dialog_style"
+widget "*emacs-filedialog* style "my_file_style"
+widget "*emacs-menuitem* style "my_menu_style"
+@end smallexample
+
+ If you specify a customization in @file{~/.emacs.d/gtkrc}, then it
+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 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}:
+
+@smallexample
+widget_class "*Menu*" style "my_menu_style"
+@end smallexample
+
+ Here is a more elaborate example, showing how to change the parts of
+the scroll bar:
+
+@smallexample
+style "scroll"
+@{
+ fg[NORMAL] = "red"@ @ @ @ @ # @r{The arrow color.}
+ bg[NORMAL] = "yellow"@ @ # @r{The thumb and background around the arrow.}
+ bg[ACTIVE] = "blue"@ @ @ @ # @r{The trough color.}
+ bg[PRELIGHT] = "white"@ # @r{The thumb color when the mouse is over it.}
+@}
+
+widget "*verticalScrollBar*" style "scroll"
+@end smallexample
+@end iftex
+
+@ifnottex
@cindex GTK resources and customization
@cindex resource files for GTK
@cindex @file{~/.gtkrc-2.0} file
@cindex @file{~/.emacs.d/gtkrc} file
- If the Emacs installed at your site was built to use the GTK widget set,
-then the menu bar, scroll bar and the dialogs can be customized with
-the standard GTK @file{~/.gtkrc-2.0} file or with the Emacs specific
-@file{~/.emacs.d/gtkrc} file; note that these files are only for
-customizing specific GTK widget features. To customize Emacs font,
-background, faces etc., use the normal X resources, see @ref{Resources}.
+ If Emacs was built to use the GTK widget set, then the menu bar, tool bar,
+scroll bar and the dialogs are customized with the standard GTK
+customization file, @file{~/.gtkrc-2.0}, or with the Emacs specific
+file @file{~/.emacs.d/gtkrc}. We recommend that you use
+@file{~/.emacs.d/gtkrc} for customizations, since @file{~/.gtkrc-2.0}
+seems to be ignored when running GConf with GNOME. These files apply
+only to GTK widget features. To customize Emacs font, background,
+faces, etc., use the normal X resources (@pxref{Resources}).
-In these files you first defines a style and then how to apply that style
-to widgets (@pxref{GTK widget names}). Here is an example of how to
-change the font for Emacs menus:
+ Some GTK themes override these mechanisms, which means that using
+these mechanisms will not work to customize them.
+
+ In these files you first define a style and say what it means; then
+you specify to apply the style to various widget types (@pxref{GTK
+widget names}). Here is an example of how to change the font for
+Emacs menus:
@smallexample
-# This is a comment.
+# @r{Define the style @samp{menufont}.}
style "menufont"
@{
font_name = "helvetica bold 14" # This is a Pango font name
@}
+# @r{Specify that widget type @samp{*emacs-menuitem*} uses @samp{menufont}.}
widget "*emacs-menuitem*" style "menufont"
-
@end smallexample
- There are some things you can set without using any style or widget name,
-which affect GTK as a whole. Most of these are poorly documented, but can
-be found in the `Properties' section of the documentation page for
-@code{GtkSetting}, in the GTK document references below.
+ Here is a more elaborate example, showing how to change the parts of
+the scroll bar:
+
+@smallexample
+style "scroll"
+@{
+ fg[NORMAL] = "red"@ @ @ @ @ # @r{The arrow color.}
+ bg[NORMAL] = "yellow"@ @ # @r{The thumb and background around the arrow.}
+ bg[ACTIVE] = "blue"@ @ @ @ # @r{The trough color.}
+ bg[PRELIGHT] = "white"@ # @r{The thumb color when the mouse is over it.}
+@}
+
+widget "*verticalScrollBar*" style "scroll"
+@end smallexample
-One property of interest is @code{gtk-font-name} which sets the default
-font for GTK; you must use Pango font names (@pxref{GTK styles}). A
-@file{~/.gtkrc-2.0} file that 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"
@end smallexample
-
- If GTK at your site is installed under @var{prefix},
-the resource file syntax is fully described in the GTK API
-document
-@file{@var{prefix}/share/gtk-doc/html/gtk/gtk-resource-files.html}.
-@var{prefix} is usually @file{/usr} or @file{/usr/local}.
-You can find the same document online at
+ The GTK resources file is fully described in the GTK API document.
+This can be found in
+@file{@var{prefix}/share/gtk-doc/html/gtk/gtk-resource-files.html},
+where @file{prefix} is the directory in which the GTK libraries were
+installed (usually @file{/usr} or @file{/usr/local}). You can also
+find the document online, at
@uref{http://developer.gnome.org/doc/API/2.0/gtk/gtk-Resource-Files.html}.
-
@menu
* GTK widget names:: How widgets in GTK are named in general.
-* GTK names in Emacs:: GTK widget names in Emacs.
+* GTK Names in Emacs:: GTK widget names in Emacs.
* GTK styles:: What can be customized in a GTK widget.
@end menu
-
@node GTK widget names
@appendixsubsec GTK widget names
@cindex GTK widget names
- Widgets are specified by widget class or by widget name.
-The widget class is the type of the widget, for example @code{GtkMenuBar}.
-The widget name is the name given to a specific widget within a program.
-A widget always have a class but it is not mandatory to give a name to
-a widget. Absolute names are sequences of widget names or
-widget classes, corresponding to hierarchies of widgets embedded within
-other widgets. For example, if a @code{GtkWindow} contains a @code{GtkVBox}
-which in turn contains a @code{GtkMenuBar}, the absolute class name
-is @code{GtkWindow.GtkVBox.GtkMenuBar}.
+ A GTK widget is specified by its @dfn{widget class} and
+@dfn{widget name}. The widget class is the type of the widget: for
+example, @code{GtkMenuBar}. The widget name is the name given to a
+specific widget. A widget always has a class, but need not have a
+name.
-@noindent
-If the widgets are named ``top'', ``box'' and ``menubar'', the absolute
-widget name is @code{top.box.menubar},
+ @dfn{Absolute names} are sequences of widget names or widget
+classes, corresponding to hierarchies of widgets embedded within
+other widgets. For example, if a @code{GtkWindow} named @code{top}
+contains a @code{GtkVBox} named @code{box}, which in turn contains
+a @code{GtkMenuBar} called @code{menubar}, the absolute class name
+of the menu-bar widget is @code{GtkWindow.GtkVBox.GtkMenuBar}, and
+its absolute widget name is @code{top.box.menubar}.
When assigning a style to a widget, you can use the absolute class
name or the absolute widget name.
-There are two commands: @code{widget_class} will assign a style to
-widgets, matching only against the absolute class name.
-The command @code{widget} will match the absolute widget name,
-but if there is no name for a widget in the hierarchy, the class is matched.
-These commands require the absolute name and the style name to be
-within double quotes. These commands are written at the top level in a
-@file{~/.gtkrc-2.0} file, like this:
+
+ There are two commands to specify changes for widgets:
+
+@table @asis
+@item @code{widget_class}
+specifies a style for widgets based on the absolute class name.
+
+@item @code{widget}
+specifies a style for widgets based on the absolute class name,
+or just the class.
+@end table
+
+@noindent
+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
style "menufont"
widget_class "GtkWindow.GtkVBox.GtkMenuBar" style "menufont"
@end smallexample
-
- Matching of absolute names is done with shell ``glob'' syntax, that is
-@samp{*} matches zero or more characters and @samp{?} matches one character.
-So the following would assign @code{base_style} to all widgets:
+ Matching of absolute names uses shell wildcard syntax: @samp{*}
+matches zero or more characters and @samp{?} matches one character.
+This example assigns @code{base_style} to all widgets:
@smallexample
widget "*" style "base_style"
@end smallexample
Given the absolute class name @code{GtkWindow.GtkVBox.GtkMenuBar}
-and the corresponding absolute widget name @code{top.box.menubar},
-the following all assign @code{my_style} to the menu bar:
+and the corresponding absolute widget name @code{top.box.menubar}, all
+these examples specify @code{my_style} for the menu bar:
@smallexample
widget_class "GtkWindow.GtkVBox.GtkMenuBar" style "my_style"
widget "*menu*" style "my_style"
@end smallexample
-@node GTK names in Emacs
-@appendixsubsec GTK names in Emacs
+@node GTK Names in Emacs
+@appendixsubsec GTK Widget Names in Emacs
@cindex GTK widget names
@cindex GTK widget classes
- In Emacs the top level widget for a frame is a @code{GtkWindow} that
-contains a @code{GtkVBox}. The @code{GtkVBox} contains the
-@code{GtkMenuBar} and a @code{GtkFixed} widget.
-The vertical scroll bars, @code{GtkVScrollbar},
-are contained in the @code{GtkFixed} widget.
-The text you write in Emacs is drawn in the @code{GtkFixed} widget.
+ In Emacs, the top level widget for a frame is a @code{GtkWindow}
+that contains a @code{GtkVBox}. The @code{GtkVBox} contains the
+@code{GtkMenuBar} and a @code{GtkFixed} widget. The vertical scroll
+bars, @code{GtkVScrollbar}, are contained in the @code{GtkFixed}
+widget. The text you write in Emacs is drawn in the @code{GtkFixed}
+widget.
Dialogs in Emacs are @code{GtkDialog} widgets. The file dialog is a
@code{GtkFileSelection} widget.
@tab @code{GtkVHbox}
@item @code{emacs}
@tab @code{GtkFixed}
-@item @code{verticalScrollbar}
+@item @code{verticalScrollBar}
@tab @code{GtkVScrollbar}
@item @code{emacs-toolbar}
@tab @code{GtkToolbar}
@smallexample
widget "Emacs.pane.menubar" style "my_style"
-widget "Emacs.pane.emacs.verticalScrollbar" style "my_style"
+widget "Emacs.pane.emacs.verticalScrollBar" style "my_style"
@end smallexample
GTK absolute names are quite strange when it comes to menus
widget "*emacs-menuitem* style "my_menu_style"
@end smallexample
- An alternative is to put customization into @file{~/.emacs.d/gtkrc}.
-This file is only read by Emacs, so anything in @file{~/.emacs.d/gtkrc}
-affects Emacs but leaves other applications unaffected.
-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 does 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}:
+ If you specify a customization in @file{~/.emacs.d/gtkrc}, then it
+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 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}:
@smallexample
widget_class "*Menu*" style "my_menu_style"
@cindex GTK styles
In a GTK style you specify the appearance widgets shall have. You
-can specify foreground and background color, background pixmap and font.
-The edit widget (where you edit the text) in Emacs is a GTK widget,
-but trying to specify a style for the edit widget will have no effect.
-This is so that Emacs compiled for GTK is compatible with Emacs compiled
-for other X toolkits. The settings for foreground, background and font
-for the edit widget is taken from the X resources; @pxref{Resources}.
-Here is an example of two style declarations, ``default'' and ``ruler'':
+can specify foreground and background color, background pixmap and
+font. The edit widget (where you edit the text) in Emacs is a GTK
+widget, but trying to specify a style for the edit widget will have no
+effect. This is so that Emacs compiled for GTK is compatible with
+Emacs compiled for other X toolkits. The settings for foreground,
+background and font for the edit widget is taken from the X resources;
+@pxref{Resources}. Here is an example of two style declarations,
+@samp{default} and @samp{ruler}:
@smallexample
-
pixmap_path "/usr/share/pixmaps:/usr/include/X11/pixmaps"
style "default"
@end smallexample
- The style ``ruler'' inherits from ``default''. This way you can build
+ The style @samp{ruler} inherits from @samp{default}. This way you can build
on existing styles. The syntax for fonts and colors is described below.
- As this example shows, it is possible to specify several values
-for foreground and background depending on which state the widget has.
-The possible states are
+ As this example shows, it is possible to specify several values for
+foreground and background depending on the widget's @dfn{state}. The
+possible states are:
+
@table @code
@item NORMAL
This is the default state for widgets.
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 like they normally can. For example, buttons that can't be
-pressed and menu items that can't be selected.
-Text for menu items that are not available can be set to yellow with
-@code{fg[INSENSITIVE] = "yellow"}.
+manipulated in the usual way---for example, buttons that can't be
+pressed, and disabled menu items. To display disabled menu items in
+yellow, use @code{fg[INSENSITIVE] = "yellow"}.
@end table
-Here are the things that can go in a style declaration:
+ Here are the things that can go in a style declaration:
@table @code
@item bg[@var{state}] = @var{color}
-This is the background color widgets use. This background is not used for
-editable text, use @code{base} for that.
+This specifies the background color for the widget. Note that
+editable text doesn't use @code{bg}; it uses @code{base} instead.
@item base[@var{state}] = @var{color}
-This is the background color for editable text.
-In Emacs, this color is used for the background of the text fields in the
-file dialog.
+This specifies the background color for editable text. In Emacs, this
+color is used for the background of the text fields in the file
+dialog.
@item bg_pixmap[@var{state}] = "@var{pixmap}"
-You can specify a pixmap to be used instead of the background color.
-@var{pixmap} is a file name. GTK can use a number of file formats,
-including XPM, XBM, GIF, JPEG and PNG. If you want a widget to use the same
-pixmap as its parent, use @samp{<parent>}. If you don't want any
-pixmap use @samp{<none>}. Using @samp{<none>} can be useful
-if your style inherits a style that does specify a pixmap.
-
- GTK looks for the pixmap in directories specified in @code{pixmap_path}.
-It is not possible to refer to a file by its absolute path name.
-@code{pixmap_path} is a colon-separated list of directories within double
-quotes, specified at the top level in a @file{gtkrc} file (i.e. not inside
-a style definition; see example above):
+This specifies an image background (instead of a background color).
+@var{pixmap} should be the image file name. GTK can use a number of
+image file formats, including XPM, XBM, GIF, JPEG and PNG. If you
+want a widget to use the same image as its parent, use
+@samp{<parent>}. If you don't want any image, use @samp{<none>}.
+@samp{<none>} is the way to cancel a background image inherited from a
+parent style.
+
+You can't specify the file by its absolute file name. GTK looks for
+the pixmap file in directories specified in @code{pixmap_path}.
+@code{pixmap_path} is a colon-separated list of directories within
+double quotes, specified at the top level in a @file{gtkrc} file
+(i.e. not inside a style definition; see example above):
@smallexample
pixmap_path "/usr/share/pixmaps:/usr/include/X11/pixmaps"
@end smallexample
@item fg[@var{state}] = @var{color}
-This is the foreground color widgets use. This is the color
-of text in menus and buttons. It is also the color for the arrows in the
-scroll bar. For editable text, use @code{text}.
+This specifies the foreground color for widgets to use. It is the
+color of text in menus and buttons, and the color for the arrows in
+the scroll bar. For editable text, use @code{text}.
@item text[@var{state}] = @var{color}
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 is the font a widget shall use. @var{font} is a Pango font name,
-for example ``Sans Italic 10'', ``Helvetica Bold 12'', ``Courier 14'',
-``Times 18''. See below for exact syntax. The names are case insensitive.
+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.
@end table
- Colors are specified in three ways, a name, a hexadecimal form or
-an RGB triplet.
+ There are three ways to specify a color: by name, in hexadecimal
+form, and with an RGB triplet.
@noindent
A color name is written within double quotes, for example @code{"red"}.
@noindent
-A hexadecimal form is written within double quotes. There are four forms,
-@code{#rrrrggggbbbb}, @code{#rrrgggbbb},
-@code{#rrggbb}, or @code{#rgb}. In each of these r, g and b are hex digits.
+Hexadecimal form is the same as in X:
+@code{#@var{rrrr}@var{gggg}@var{bbbb}}, where all three color specs
+must have the same number of hex digits (1, 2, 3 or 4).
@noindent
-An RGB triplet looks like @code{@{ r, g, b @}}, where r, g and b are either
-integers in the range 0-65535 or floats in the range 0.0-1.0.
+An RGB triplet looks like @code{@{ @var{r}, @var{g}, @var{b} @}},
+where @var{r}, @var{g} and @var{b} are either integers in the range
+0-65535 or floats in the range 0.0-1.0.
Pango font names have the form ``@var{family-list} @var{style-options}
-@var{size}''.
+@var{size}.''
@cindex Pango font name
@noindent
@var{family-list} is a comma separated list of font families optionally
@end smallexample
@noindent
-the family name is ``times''.
+the family name is @samp{times}.
@noindent
@var{style-options} is a whitespace separated list of words where each word
@noindent
A `style' corresponds to the fourth part of an X font name. In X font
-names it is the character ``r'', ``i'' or ``o''; in Pango font names the
-corresponding values are @code{normal}, @code{italic}, or @code{oblique}.
+names it is the character @samp{r}, @samp{i} or @samp{o}; in Pango
+font names the corresponding values are @code{normal}, @code{italic},
+or @code{oblique}.
@noindent
A `variant' is either @code{normal} or @code{small-caps}.
@noindent
@var{size} is a decimal number that describes the font size in points.
+@end ifnottex
+
+@ignore
+ arch-tag: 9b6ff773-48b6-41f6-b2f9-f114b8bdd97f
+@end ignore