[Emacs-diffs] /srv/bzr/emacs/trunk r101201: Improve ELisp manual to fix bug #6929.

[Eli Zaretskii]

------------------------------------------------------------
revno: 101201
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Sat 2010-08-28 11:10:13 +0300
message:
  Improve ELisp manual to fix bug #6929.
  
   display.texi (Fringe Size/Pos): Add a cross-reference to "Layout
   Parameters", where the default fringe width is described.
   frames.texi (Window Frame Parameters, Basic Parameters)
   (Position Parameters, Layout Parameters, Management Parameters)
   (Cursor Parameters, Font and Color Parameters): Add indexing for
   frame parameters.  (Bug#6929)
modified:
  doc/lispref/ChangeLog
  doc/lispref/display.texi
  doc/lispref/frames.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2010-08-25 20:25:32 +0000
+++ b/doc/lispref/ChangeLog     2010-08-28 08:10:13 +0000
@@ -1,3 +1,13 @@
+2010-08-28  Eli Zaretskii  <address@hidden>
+
+       * display.texi (Fringe Size/Pos): Add a cross-reference to "Layout
+       Parameters", where the default fringe width is described.
+
+       * frames.texi (Window Frame Parameters, Basic Parameters)
+       (Position Parameters, Layout Parameters, Management Parameters)
+       (Cursor Parameters, Font and Color Parameters): Add indexing for
+       frame parameters.  (Bug#6929)
+
 2010-08-25  Tom Tromey  <address@hidden>
 
        * vol2.texi (Top): Update.

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2010-08-18 10:35:23 +0000
+++ b/doc/lispref/display.texi  2010-08-28 08:10:13 +0000
@@ -3214,7 +3214,9 @@
   The values of these variables take effect when you display the
 buffer in a window.  If you change them while the buffer is visible,
 you can call @code{set-window-buffer} to display it once again in the
-same window, to make the changes take effect.
+same window, to make the changes take effect.  A buffer that does not
+specify values for these variables will use the default values
+specified for the frame; see @ref{Layout Parameters}.
 
 @defun set-window-fringes window left &optional right outside-margins
 This function sets the fringe widths of window @var{window}.

=== modified file 'doc/lispref/frames.texi'
--- a/doc/lispref/frames.texi   2010-07-29 17:10:41 +0000
+++ b/doc/lispref/frames.texi   2010-08-28 08:10:13 +0000
@@ -461,6 +461,7 @@
 
 @node Window Frame Parameters
 @subsection Window Frame Parameters
address@hidden frame parameters for windowed displays
 
   Just what parameters a frame has depends on what display mechanism
 it uses.  This section describes the parameters that have special
@@ -489,16 +490,19 @@
 frame.  @code{title} and @code{name} are meaningful on all terminals.
 
 @table @code
address@hidden display, a frame parameter
 @item display
 The display on which to open this frame.  It should be a string of the
 form @code{"@var{host}:@address@hidden"}, just like the
 @code{DISPLAY} environment variable.
 
address@hidden display-type, a frame parameter
 @item display-type
 This parameter describes the range of possible colors that can be used
 in this frame.  Its value is @code{color}, @code{grayscale} or
 @code{mono}.
 
address@hidden title, a frame parameter
 @item title
 If a frame has a address@hidden title, it appears in the window
 system's title bar at the top of the frame, and also in the mode line
@@ -507,6 +511,7 @@
 Emacs is not using a window system, and can only display one frame at
 a time.  @xref{Frame Titles}.
 
address@hidden name, a frame parameter
 @item name
 The name of the frame.  The frame name serves as a default for the frame
 title, if the @code{title} parameter is unspecified or @code{nil}.  If
@@ -520,11 +525,13 @@
 
 @node Position Parameters
 @subsubsection Position Parameters
address@hidden window position on display
 
   Position parameters' values are normally measured in pixels, but on
 text-only terminals they count characters or lines instead.
 
 @table @code
address@hidden left, a frame parameter
 @item left
 The position, in pixels, of the left (or right) edge of the frame with
 respect to the left (or right) edge of the screen.  The value may be:
@@ -550,11 +557,13 @@
 be sure the position you specify is not ignored, specify a
 address@hidden value for the @code{user-position} parameter as well.
 
address@hidden top, a frame parameter
 @item top
 The screen position of the top (or bottom) edge, in pixels, with respect
 to the top (or bottom) edge of the screen.  It works just like
 @code{left}, except vertically instead of horizontally.
 
address@hidden icon-left, a frame parameter
 @item icon-left
 The screen position of the left edge @emph{of the frame's icon}, in
 pixels, counting from the left edge of the screen.  This takes effect if
@@ -564,11 +573,13 @@
 a value for @code{icon-top} and vice versa.  The window manager may
 ignore these two parameters.
 
address@hidden icon-top, a frame parameter
 @item icon-top
 The screen position of the top edge @emph{of the frame's icon}, in
 pixels, counting from the top edge of the screen.  This takes effect if
 and when the frame is iconified.
 
address@hidden user-position, a frame parameter
 @item user-position
 When you create a frame and specify its screen position with the
 @code{left} and @code{top} parameters, use this parameter to say whether
@@ -576,6 +587,7 @@
 way by a human user) or merely program-specified (chosen by a program).
 A address@hidden value says the position was user-specified.
 
address@hidden window positions and window managers
 Window managers generally heed user-specified positions, and some heed
 program-specified positions too.  But many ignore program-specified
 positions, placing the window in a default fashion or letting the user
@@ -591,24 +603,31 @@
 
 @node Size Parameters
 @subsubsection Size Parameters
address@hidden window size on display
 
   Size parameters' values are normally measured in pixels, but on
 text-only terminals they count characters or lines instead.
 
 @table @code
address@hidden height, a frame parameter
 @item height
 The height of the frame contents, in characters.  (To get the height in
 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.)
 
address@hidden width, a frame parameter
 @item width
 The width of the frame contents, in characters.  (To get the width in
 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.)
 
address@hidden user-size, a frame parameter
 @item user-size
 This does for the size parameters @code{height} and @code{width} what
-the @code{user-position} parameter (see above) does for the position
-parameters @code{top} and @code{left}.
+the @code{user-position} parameter (@pxref{Position Parameters,
+user-position}) does for the position parameters @code{top} and
address@hidden
 
address@hidden full-screen frames
address@hidden fullscreen, a frame parameter
 @item fullscreen
 Specify that width, height or both shall be maximized.  The value
 @code{fullwidth} specifies that width shall be as wide as possible.
@@ -623,33 +642,42 @@
 
 @node Layout Parameters
 @subsubsection Layout Parameters
address@hidden layout parameters of frames
address@hidden frame layout parameters
 
   These frame parameters enable or disable various parts of the
 frame, or control their sizes.
 
 @table @code
address@hidden border-width, a frame parameter
 @item border-width
 The width in pixels of the frame's border.
 
address@hidden internal-border-width, a frame parameter
 @item internal-border-width
 The distance in pixels between text (or fringe) and the frame's border.
 
address@hidden vertical-scroll-bars, a frame parameter
 @item vertical-scroll-bars
 Whether the frame has scroll bars for vertical scrolling, and which side
 of the frame they should be on.  The possible values are @code{left},
 @code{right}, and @code{nil} for no scroll bars.
 
 @ignore
address@hidden horizontal-scroll-bars, a frame parameter
 @item horizontal-scroll-bars
 Whether the frame has scroll bars for horizontal scrolling
 (address@hidden means yes).  Horizontal scroll bars are not currently
 implemented.
 @end ignore
 
address@hidden scroll-bar-width, a frame parameter
 @item scroll-bar-width
 The width of vertical scroll bars, in pixels, or @code{nil} meaning to
 use the default width.
 
address@hidden left-fringe, a frame parameter
address@hidden right-fringe, a frame parameter
 @item left-fringe
 @itemx right-fringe
 The default width of the left and right fringes of windows in this
@@ -666,22 +694,26 @@
 width by specifying that width as a negative integer.  If both widths are
 negative, only the left fringe gets the specified width.
 
address@hidden menu-bar-lines, a frame parameter
 @item menu-bar-lines
 The number of lines to allocate at the top of the frame for a menu
 bar.  The default is 1.  A value of @code{nil} means don't display a
 menu bar.  @xref{Menu Bar}.  (The X toolkit and GTK allow at most one
 menu bar line; they treat larger values as 1.)
 
address@hidden tool-bar-lines, a frame parameter
 @item tool-bar-lines
 The number of lines to use for the tool bar.  A value of @code{nil}
 means don't display a tool bar.  (GTK and Nextstep allow at most one
 tool bar line; they treat larger values as 1.)
 
address@hidden tool-bar-position, a frame parameter
 @item tool-bar-position
 The position of the tool bar.  Currently only for the GTK tool bar.
 Value can be one of @code{top}, @code{bottom} @code{left}, @code{right}.
 The default is  @code{top}.
 
address@hidden line-spacing, a frame parameter
 @item line-spacing
 Additional space to leave below each text line, in pixels (a positive
 integer).  @xref{Line Height}, for more information.
@@ -694,6 +726,7 @@
 with which buffers have been, or should, be displayed in the frame.
 
 @table @code
address@hidden minibuffer, a frame parameter
 @item minibuffer
 Whether this frame has its own minibuffer.  The value @code{t} means
 yes, @code{nil} means no, @code{only} means this frame is just a
@@ -703,6 +736,7 @@
 This frame parameter takes effect when the frame is created, and can
 not be changed afterwards.
 
address@hidden buffer-predicate, a frame parameter
 @item buffer-predicate
 The buffer-predicate function for this frame.  The function
 @code{other-buffer} uses this predicate (from the selected frame) to
@@ -711,61 +745,73 @@
 each buffer; if the predicate returns a address@hidden value, it
 considers that buffer.
 
address@hidden buffer-list, a frame parameter
 @item buffer-list
-A list of buffers that have been selected in this frame,
-ordered most-recently-selected first.
+A list of buffers that have been selected in this frame, ordered
+most-recently-selected first.
 
address@hidden unsplittable, a frame parameter
 @item unsplittable
 If address@hidden, this frame's window is never split automatically.
 @end table
 
 @node Management Parameters
 @subsubsection Window Management Parameters
address@hidden window manager, and frame parameters
address@hidden window manager interaction, and frame parameters
 
   These frame parameters, meaningful only on window system displays,
 interact with the window manager.
 
 @table @code
address@hidden visibility, a frame parameter
 @item visibility
 The state of visibility of the frame.  There are three possibilities:
 @code{nil} for invisible, @code{t} for visible, and @code{icon} for
 iconified.  @xref{Visibility of Frames}.
 
address@hidden auto-raise, a frame parameter
 @item auto-raise
 Whether selecting the frame raises it (address@hidden means yes).
 
address@hidden auto-lower, a frame parameter
 @item auto-lower
 Whether deselecting the frame lowers it (address@hidden means yes).
 
address@hidden icon-type, a frame parameter
 @item icon-type
 The type of icon to use for this frame when it is iconified.  If the
 value is a string, that specifies a file containing a bitmap to use.
 Any other address@hidden value specifies the default bitmap icon (a
 picture of a gnu); @code{nil} specifies a text icon.
 
address@hidden icon-name, a frame parameter
 @item icon-name
 The name to use in the icon for this frame, when and if the icon
 appears.  If this is @code{nil}, the frame's title is used.
 
address@hidden window-id, a frame parameter
 @item window-id
 The number of the window-system window used by the frame
 to contain the actual Emacs windows.
 
address@hidden outer-window-id, a frame parameter
 @item outer-window-id
 The number of the outermost window-system window used for the whole frame.
 
address@hidden wait-for-wm, a frame parameter
 @item wait-for-wm
 If address@hidden, tell Xt to wait for the window manager to confirm
 geometry changes.  Some window managers, including versions of Fvwm2
 and KDE, fail to confirm, so Xt hangs.  Set this to @code{nil} to
 prevent hanging with those window managers.
 
address@hidden sticky, a frame parameter
 @item sticky
 If address@hidden, the frame is visible on all virtual desktops on systems
 with virtual desktops.
 
 @ignore
address@hidden parent-id, a frame parameter
 @item parent-id
 @c ??? Not yet working.
 The X window number of the window that should be the parent of this one.
@@ -777,10 +823,12 @@
 
 @node Cursor Parameters
 @subsubsection Cursor Parameters
address@hidden cursor, and frame parameters
 
   This frame parameter controls the way the cursor looks.
 
 @table @code
address@hidden cursor-type, a frame parameter
 @item cursor-type
 How to display the cursor.  Legitimate values are:
 
@@ -832,10 +880,12 @@
 
 @node Font and Color Parameters
 @subsubsection Font and Color Parameters
address@hidden font and color, frame parameters
 
   These frame parameters control the use of fonts and colors.
 
 @table @code
address@hidden font-backend, a frame parameter
 @item font-backend
 A list of symbols, specifying the @dfn{font backends} to use for
 drawing fonts in the frame, in order of priority.  On X, there are
@@ -844,10 +894,12 @@
 is only one available font backend, so it does not make sense to
 modify this frame parameter.
 
address@hidden background-mode, a frame parameter
 @item background-mode
 This parameter is either @code{dark} or @code{light}, according
 to whether the background color is a light one or a dark one.
 
address@hidden tty-color-mode, a frame parameter
 @item tty-color-mode
 @cindex standard colors for character terminals
 This parameter overrides the terminal's color support as given by the
@@ -863,6 +915,7 @@
 the value of @code{tty-color-mode-alist}, and the associated number is
 used instead.
 
address@hidden screen-gamma, a frame parameter
 @item screen-gamma
 @cindex gamma correction
 If this is a number, Emacs performs ``gamma correction'' which adjusts
@@ -882,6 +935,7 @@
 that makes colors darker.  A screen gamma value of 1.5 may give good
 results for LCD color displays.
 
address@hidden alpha, a frame parameter
 @item alpha
 @cindex opacity, frame
 @cindex transparency, frame
@@ -909,37 +963,45 @@
 faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}):
 
 @table @code
address@hidden font, a frame parameter
 @item font
 The name of the font for displaying text in the frame.  This is a
 string, either a valid font name for your system or the name of an Emacs
 fontset (@pxref{Fontsets}).  It is equivalent to the @code{font}
 attribute of the @code{default} face.
 
address@hidden foreground-color, a frame parameter
 @item foreground-color
 The color to use for the image of a character.  It is equivalent to
 the @code{:foreground} attribute of the @code{default} face.
 
address@hidden background-color, a frame parameter
 @item background-color
 The color to use for the background of characters.  It is equivalent to
 the @code{:background} attribute of the @code{default} face.
 
address@hidden mouse-color, a frame parameter
 @item mouse-color
 The color for the mouse pointer.  It is equivalent to the @code{:background}
 attribute of the @code{mouse} face.
 
address@hidden cursor-color, a frame parameter
 @item cursor-color
 The color for the cursor that shows point.  It is equivalent to the
 @code{:background} attribute of the @code{cursor} face.
 
address@hidden border-color, a frame parameter
 @item border-color
 The color for the border of the frame.  It is equivalent to the
 @code{:background} attribute of the @code{border} face.
 
address@hidden scroll-bar-foreground, a frame parameter
 @item scroll-bar-foreground
 If address@hidden, the color for the foreground of scroll bars.  It is
 equivalent to the @code{:foreground} attribute of the
 @code{scroll-bar} face.
 
address@hidden scroll-bar-background, a frame parameter
 @item scroll-bar-background
 If address@hidden, the color for the background of scroll bars.  It is
 equivalent to the @code{:background} attribute of the