(row_equal_p, update_window_line): Compare fringe bitmaps
[bpt/emacs.git] / man / xresources.texi
index e6451e7..515ad9f 100644 (file)
@@ -46,6 +46,9 @@ collection of related options, for one program or for several programs
 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}.
+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.
 
   Programs define named resources with particular meanings.  They also
 define how to group resources into named classes.  For instance, in
@@ -139,6 +142,7 @@ 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.
+(See the @code{editres} man page for more details.)
 
 @node Table of Resources
 @appendixsec Table of X Resources for Emacs
@@ -201,6 +205,7 @@ Width in pixels of the internal border.
 Additional space (@dfn{leading}) between lines, in pixels.
 
 @item @code{menuBar} (class @code{MenuBar})
+@cindex menu bar
 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.
@@ -249,11 +254,21 @@ useful for debugging X problems.
 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.
 
+@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}.
@@ -378,15 +393,22 @@ In the menu bar, the color of the foreground for a selected item.
 @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.
 @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
 
 @node LessTif Resources
@@ -458,7 +480,7 @@ Emacs.pane.menubar.popup_*.popup_*.Spell Checking.Complete Word: @var{value}
 
 @noindent
 (This should be one long line.)
-  
+
   It's impossible to specify a resource for all the menu-bar items
 without also specifying it for the submenus as well.  So if you want the
 submenu items to look different from the menu bar itself, you must ask
@@ -533,11 +555,16 @@ The color for the border shadow, on the top and the left.
   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 
+@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}.
 
-In these files you first defines a style and then how to apply that style
+  Some GTK themes override these mechanisms, which means that using
+these mechanisms will not work to customize them.  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.
+
+  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:
 
@@ -550,6 +577,21 @@ style "menufont"
 
 widget "*emacs-menuitem*" style "menufont"
 
+@end smallexample
+
+  Here is a more elaborate example, showing how to change the parts of
+the scroll bar:
+
+@smallexample
+style "scroll"
+@{
+  fg[NORMAL] = "red"@ @ @ @ @ # The arrow color.
+  bg[NORMAL] = "yellow"@ @ # The thumb and background around the arrow.
+  bg[ACTIVE] = "blue"@ @ @ @ # The trough color.
+  bg[PRELIGHT] = "white"@ # The thumb color when the mouse is over it.
+@}
+
+widget "*verticalScrollBar*" style "scroll"
 @end smallexample
 
   There are some things you can set without using any style or widget name,
@@ -568,7 +610,7 @@ gtk-font-name = "courier 12"
 
   If GTK at your site is installed under @var{prefix},
 the resource file syntax is fully described in the GTK API
-document 
+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
@@ -586,7 +628,7 @@ You can find the same document online at
 @appendixsubsec GTK widget names
 @cindex GTK widget names
 
-  Widgets are specified by widget class or by widget name. 
+  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
@@ -649,8 +691,8 @@ widget "*menu*" style "my_style"
 @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.  
+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.
@@ -669,7 +711,7 @@ widget_class "GtkWindow.GtkVBox.GtkMenuBar" style "my_style"
 For the scroll bar, the absolute class name is:
 
 @smallexample
-widget_class 
+widget_class
   "GtkWindow.GtkVBox.GtkFixed.GtkVScrollbar"
      style "my_style"
 @end smallexample
@@ -688,10 +730,12 @@ The names for the emacs widgets, and their classes, are:
 @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{verticalScrollbar}
-@tab @code{GtkVScrollbar}
 @item @code{emacs-menuitem}
 @tab anything in menus
 @end multitable
@@ -701,11 +745,11 @@ Thus, for Emacs you can write the two examples above as:
 
 @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
-and dialogs.  The names do not start with @samp{Emacs}, as they are 
+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:
 
@@ -720,7 +764,7 @@ 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 
+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}:
 
@@ -766,7 +810,7 @@ style "default"
   bg_pixmap[NORMAL] = "background.xpm"
   bg_pixmap[INSENSITIVE] = "background.xpm"
   bg_pixmap[ACTIVE] = "background.xpm"
-  bg_pixmap[PRELIGHT] = "<none>" 
+  bg_pixmap[PRELIGHT] = "<none>"
 
 @}
 
@@ -788,7 +832,7 @@ The possible states are
 This is the default state for widgets.
 @item ACTIVE
 This is the state for a widget that is ready to do something.  It is
-also for the trough of a scroll bar, i.e.  @code{bg[ACTIVE] = "red"} 
+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
@@ -817,7 +861,7 @@ editable text, use @code{base} for that.
 
 @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 
+In Emacs, this color is used for the background of the text fields in the
 file dialog.
 
 @item bg_pixmap[@var{state}] = "@var{pixmap}"
@@ -844,7 +888,7 @@ of text in menus and buttons.  It is also 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 
+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}"
@@ -861,7 +905,7 @@ 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{#rrrrggggbbbb}, @code{#rrrgggbbb},
 @code{#rrggbb}, or @code{#rgb}.  In each of these r, g and b are hex digits.
 
 @noindent
@@ -913,3 +957,7 @@ family.  It corresponds to the fifth part of an X font name.  It is one of
 
 @noindent
 @var{size} is a decimal number that describes the font size in points.
+
+@ignore
+   arch-tag: 9b6ff773-48b6-41f6-b2f9-f114b8bdd97f
+@end ignore