aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2018-02-27 19:46:06 +0200
committerEli Zaretskii2018-02-27 19:46:06 +0200
commitbf3535ec7a4a9d962df8974ccb51f4a653350391 (patch)
tree211bf60fd2a00bf3191b48ed35196ec2c79d13af
parentc87d04e05ebeaf9e72eaa81cbd98fb4910772667 (diff)
downloademacs-bf3535ec7a4a9d962df8974ccb51f4a653350391.tar.gz
emacs-bf3535ec7a4a9d962df8974ccb51f4a653350391.zip
More fixes in the Emacs manual
* doc/emacs/xresources.texi (Table of Resources, Lucid Resources): Sort the resources. (Lucid Resources): Add cross-references. (GTK Resource Basics): Fix wording. (GTK styles): Add empty lines in a @table. Suggested by Michael Albinus <michael.albinus@gmx.de> in emacs-manual-bugs@gnu.org.
-rw-r--r--doc/emacs/xresources.texi73
1 files changed, 41 insertions, 32 deletions
diff --git a/doc/emacs/xresources.texi b/doc/emacs/xresources.texi
index 096e747a044..69832fdb60a 100644
--- a/doc/emacs/xresources.texi
+++ b/doc/emacs/xresources.texi
@@ -160,16 +160,16 @@ Width of the frame's external border, in pixels. This has no effect
160if Emacs is compiled with GTK+ support. 160if Emacs is compiled with GTK+ support.
161@end ifnottex 161@end ifnottex
162 162
163@item @code{cursorColor} (class @code{Foreground})
164Text cursor color. If this resource is specified when Emacs starts
165up, Emacs sets its value as the background color of the @code{cursor}
166face (@pxref{Faces}).
167
168@item @code{cursorBlink} (class @code{CursorBlink}) 163@item @code{cursorBlink} (class @code{CursorBlink})
169If the value of this resource is @samp{off} or @samp{false} or 164If the value of this resource is @samp{off} or @samp{false} or
170@samp{0} at startup, Emacs disables Blink Cursor mode (@pxref{Cursor 165@samp{0} at startup, Emacs disables Blink Cursor mode (@pxref{Cursor
171Display}). 166Display}).
172 167
168@item @code{cursorColor} (class @code{Foreground})
169Text cursor color. If this resource is specified when Emacs starts
170up, Emacs sets its value as the background color of the @code{cursor}
171face (@pxref{Faces}).
172
173@item @code{font} (class @code{Font}) 173@item @code{font} (class @code{Font})
174Font name for the @code{default} face (@pxref{Fonts}). You can also 174Font name for the @code{default} face (@pxref{Fonts}). You can also
175specify a fontset name (@pxref{Fontsets}). 175specify a fontset name (@pxref{Fontsets}).
@@ -184,6 +184,13 @@ in which case Emacs tries using all available font backends.
184@item @code{foreground} (class @code{Foreground}) 184@item @code{foreground} (class @code{Foreground})
185Default foreground color for text. 185Default foreground color for text.
186 186
187@item @code{fullscreen} (class @code{Fullscreen})
188The desired fullscreen size. The value can be one of @code{fullboth},
189@code{maximized}, @code{fullwidth} or @code{fullheight}, which
190correspond to the command-line options @samp{-fs}, @samp{-mm},
191@samp{-fw}, and @samp{-fh} (@pxref{Window Size X}). Note that this
192applies to the initial frame only.
193
187@item @code{geometry} (class @code{Geometry}) 194@item @code{geometry} (class @code{Geometry})
188Window size and position. The value should be a size and position 195Window size and position. The value should be a size and position
189specification, of the same form as in the @samp{-g} or 196specification, of the same form as in the @samp{-g} or
@@ -193,18 +200,15 @@ The size applies to all frames in the Emacs session, but the position
193applies only to the initial Emacs frame (or, in the case of a resource 200applies only to the initial Emacs frame (or, in the case of a resource
194for a specific frame name, only that frame). 201for a specific frame name, only that frame).
195 202
196
197Be careful not to specify this resource as @samp{emacs*geometry}, as 203Be careful not to specify this resource as @samp{emacs*geometry}, as
198that may affect individual menus as well as the main Emacs frame. 204that may affect individual menus as well as the main Emacs frame.
199 205
200@item @code{fullscreen} (class @code{Fullscreen})
201The desired fullscreen size. The value can be one of @code{fullboth},
202@code{maximized}, @code{fullwidth} or @code{fullheight}, which
203correspond to the command-line options @samp{-fs}, @samp{-mm},
204@samp{-fw}, and @samp{-fh} (@pxref{Window Size X}). Note that this
205applies to the initial frame only.
206
207@ifnottex 206@ifnottex
207@item @code{horizontalScrollBars} (class @code{ScrollBars})
208If the value of this resource is @samp{off} or @samp{false} or
209@samp{0}, Emacs disables Horizontal Scroll Bar mode at startup
210(@pxref{Scroll Bars}).
211
208@item @code{iconName} (class @code{Title}) 212@item @code{iconName} (class @code{Title})
209Name to display in the icon. 213Name to display in the icon.
210 214
@@ -318,8 +322,8 @@ This is only relevant if your Emacs is built with XIM support. It
318might be useful to turn off XIM on slow X client/server links. 322might be useful to turn off XIM on slow X client/server links.
319 323
320@item @code{verticalScrollBars} (class @code{ScrollBars}) 324@item @code{verticalScrollBars} (class @code{ScrollBars})
321Give frames scroll bars if @samp{on}; don't have scroll bars if 325Give frames scroll bars on the left if @samp{left}, on the right if
322@samp{off}. 326@samp{right}; don't have scroll bars if @samp{off}.
323 327
324@ifnottex 328@ifnottex
325@item @code{visualClass} (class @code{VisualClass}) 329@item @code{visualClass} (class @code{VisualClass})
@@ -346,13 +350,13 @@ resources. @xref{Face Customization}.
346@cindex Lucid Widget X Resources 350@cindex Lucid Widget X Resources
347 351
348 If Emacs is compiled with the X toolkit support using Lucid widgets, 352 If Emacs is compiled with the X toolkit support using Lucid widgets,
349you can use X resources to customize the appearance of the menu bar, 353you can use X resources to customize the appearance of the menu bar
350pop-up menus, and dialog boxes. The resources for the menu bar fall 354(@pxref{Menu Bar}), pop-up menus, and dialog boxes (@pxref{Dialog
351in the @samp{pane.menubar} class (following, as always, either the 355Boxes}). The resources for the menu bar fall in the
352name of the Emacs executable or @samp{Emacs} for all Emacs 356@samp{pane.menubar} class (following, as always, either the name of
353invocations). The resources for the pop-up menu are in the 357the Emacs executable or @samp{Emacs} for all Emacs invocations). The
354@samp{menu*} class. The resources for dialog boxes are in the 358resources for the pop-up menu are in the @samp{menu*} class. The
355@samp{dialog*} class. 359resources for dialog boxes are in the @samp{dialog*} class.
356 360
357 For example, to display menu bar entries with the @samp{Courier-12} 361 For example, to display menu bar entries with the @samp{Courier-12}
358font (@pxref{Fonts}), write this: 362font (@pxref{Fonts}), write this:
@@ -374,12 +378,12 @@ Here is a list of resources for menu bars, pop-up menus, and dialogs:
374Font for menu item text. 378Font for menu item text.
375@item fontSet 379@item fontSet
376Fontset for menu item text. 380Fontset for menu item text.
377@item foreground
378Foreground color.
379@item background 381@item background
380Background color. 382Background color.
381@item buttonForeground 383@item buttonForeground
382Foreground color for a selected item. 384Foreground color for a selected item.
385@item foreground
386Foreground color.
383@ifnottex 387@ifnottex
384@item horizontalSpacing 388@item horizontalSpacing
385Horizontal spacing in pixels between items. Default is 3. 389Horizontal spacing in pixels between items. Default is 3.
@@ -403,14 +407,15 @@ Margin of the menu bar, in characters. Default is 1.
403 407
404 If Emacs is compiled with the X toolkit support using Motif or 408 If Emacs is compiled with the X toolkit support using Motif or
405LessTif widgets, you can use X resources to customize the appearance 409LessTif widgets, you can use X resources to customize the appearance
406of the menu bar, pop-up menus, and dialog boxes. However, the 410of the menu bar (@pxref{Menu Bar}), pop-up menus, and dialog boxes
407resources are organized differently from Lucid widgets. 411(@pxref{Dialog Boxes}). However, the resources are organized
412differently from Lucid widgets.
408 413
409 The resource names for the menu bar are in the @samp{pane.menubar} 414 The resource names for the menu bar are in the @samp{pane.menubar}
410class, and they must be specified in this form: 415class, and they must be specified in this form:
411 416
412@smallexample 417@smallexample
413Emacs.pane.menubar.@var{subwidget}.@var{resource}: @var{value} 418Emacs.pane.menubar.@var{subwidget}.@var{resource}: @var{value}
414@end smallexample 419@end smallexample
415 420
416@noindent 421@noindent
@@ -427,7 +432,7 @@ For example, to specify the font @samp{8x16} for all menu bar items,
427including submenus, write this: 432including submenus, write this:
428 433
429@smallexample 434@smallexample
430Emacs.pane.menubar.*.fontList: 8x16 435Emacs.pane.menubar.*.fontList: 8x16
431@end smallexample 436@end smallexample
432 437
433 Each item in a submenu also has its own name for X resources; for 438 Each item in a submenu also has its own name for X resources; for
@@ -471,7 +476,7 @@ itself, you must first specify the resource for all of them, then
471override the value for submenus alone. Here is an example: 476override the value for submenus alone. Here is an example:
472 477
473@smallexample 478@smallexample
474Emacs.pane.menubar.*.fontList: 8x16 479Emacs.pane.menubar.*.fontList: 9x18
475Emacs.pane.menubar.popup_*.fontList: 8x16 480Emacs.pane.menubar.popup_*.fontList: 8x16
476@end smallexample 481@end smallexample
477 482
@@ -556,7 +561,7 @@ system, see
556@appendixsubsec GTK Resource Basics 561@appendixsubsec GTK Resource Basics
557 562
558 In a GTK+ 2 resource file (usually @file{~/.emacs.d/gtkrc}), the 563 In a GTK+ 2 resource file (usually @file{~/.emacs.d/gtkrc}), the
559simplest kinds of resource settings simply assign a value to a 564simplest kind of a resource setting simply assigns a value to a
560variable. For example, putting the following line in the resource 565variable. For example, putting the following line in the resource
561file changes the font on all GTK+ widgets to @samp{courier-12}: 566file changes the font on all GTK+ widgets to @samp{courier-12}:
562 567
@@ -770,20 +775,24 @@ possible states are:
770@table @code 775@table @code
771@item NORMAL 776@item NORMAL
772This is the default state for widgets. 777This is the default state for widgets.
778
773@item ACTIVE 779@item ACTIVE
774This is the state for a widget that is ready to do something. It is 780This is the state for a widget that is ready to do something. It is
775also for the trough of a scroll bar, i.e., @code{bg[ACTIVE] = "red"} 781also for the trough of a scroll bar, i.e., @code{bg[ACTIVE] = "red"}
776sets the scroll bar trough to red. Buttons that have been armed 782sets the scroll bar trough to red. Buttons that have been armed
777(pressed but not released yet) are in this state. 783(pressed but not released yet) are in this state.
784
778@item PRELIGHT 785@item PRELIGHT
779This is the state for a widget that can be manipulated, when the mouse 786This is the state for a widget that can be manipulated, when the mouse
780pointer is over it---for example when the mouse is over the thumb in 787pointer is over it---for example when the mouse is over the thumb in
781the scroll bar or over a menu item. When the mouse is over a button 788the scroll bar or over a menu item. When the mouse is over a button
782that is not pressed, the button is in this state. 789that is not pressed, the button is in this state.
790
783@item SELECTED 791@item SELECTED
784This is the state for data that has been selected by the user. It can 792This is the state for data that has been selected by the user. It can
785be selected text or items selected in a list. This state is not used 793be selected text or items selected in a list. This state is not used
786in Emacs. 794in Emacs.
795
787@item INSENSITIVE 796@item INSENSITIVE
788This is the state for widgets that are visible, but they cannot be 797This is the state for widgets that are visible, but they cannot be
789manipulated in the usual way---for example, buttons that can't be 798manipulated in the usual way---for example, buttons that can't be
@@ -805,14 +814,14 @@ dialog.
805 814
806@item bg_pixmap[@var{state}] = "@var{pixmap}" 815@item bg_pixmap[@var{state}] = "@var{pixmap}"
807This specifies an image background (instead of a background color). 816This specifies an image background (instead of a background color).
808@var{pixmap} should be the image file name. GTK can use a number of 817@var{pixmap} should be the image file name. GTK+ can use a number of
809image file formats, including XPM, XBM, GIF, JPEG and PNG@. If you 818image file formats, including XPM, XBM, GIF, JPEG and PNG@. If you
810want a widget to use the same image as its parent, use 819want a widget to use the same image as its parent, use
811@samp{<parent>}. If you don't want any image, use @samp{<none>}. 820@samp{<parent>}. If you don't want any image, use @samp{<none>}.
812@samp{<none>} is the way to cancel a background image inherited from a 821@samp{<none>} is the way to cancel a background image inherited from a
813parent style. 822parent style.
814 823
815You can't specify the file by its absolute file name. GTK looks for 824You can't specify the file by its absolute file name. GTK+ looks for
816the pixmap file in directories specified in @code{pixmap_path}. 825the pixmap file in directories specified in @code{pixmap_path}.
817@code{pixmap_path} is a colon-separated list of directories within 826@code{pixmap_path} is a colon-separated list of directories within
818double quotes, specified at the top level in a @file{gtkrc} file 827double quotes, specified at the top level in a @file{gtkrc} file