diff options
| author | Eli Zaretskii | 2010-08-28 11:10:13 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2010-08-28 11:10:13 +0300 |
| commit | 4abe5bf64a4608d2ede0b1124decb5ad63822d9f (patch) | |
| tree | 8f6012f2a3fe169e20019b0a9c6dc382bd3ee83f | |
| parent | 26446e2c7e5c26f44f25f8eeef3aead3d1865cc3 (diff) | |
| download | emacs-4abe5bf64a4608d2ede0b1124decb5ad63822d9f.tar.gz emacs-4abe5bf64a4608d2ede0b1124decb5ad63822d9f.zip | |
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)
| -rw-r--r-- | doc/lispref/ChangeLog | 10 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 72 |
3 files changed, 80 insertions, 6 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 65ad13b18ac..cd99c701ac2 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,13 @@ | |||
| 1 | 2010-08-28 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * display.texi (Fringe Size/Pos): Add a cross-reference to "Layout | ||
| 4 | Parameters", where the default fringe width is described. | ||
| 5 | |||
| 6 | * frames.texi (Window Frame Parameters, Basic Parameters) | ||
| 7 | (Position Parameters, Layout Parameters, Management Parameters) | ||
| 8 | (Cursor Parameters, Font and Color Parameters): Add indexing for | ||
| 9 | frame parameters. (Bug#6929) | ||
| 10 | |||
| 1 | 2010-08-25 Tom Tromey <tromey@redhat.com> | 11 | 2010-08-25 Tom Tromey <tromey@redhat.com> |
| 2 | 12 | ||
| 3 | * vol2.texi (Top): Update. | 13 | * vol2.texi (Top): Update. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 716efbd9059..a565b4dd6ff 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -3214,7 +3214,9 @@ width from the window's frame. | |||
| 3214 | The values of these variables take effect when you display the | 3214 | The values of these variables take effect when you display the |
| 3215 | buffer in a window. If you change them while the buffer is visible, | 3215 | buffer in a window. If you change them while the buffer is visible, |
| 3216 | you can call @code{set-window-buffer} to display it once again in the | 3216 | you can call @code{set-window-buffer} to display it once again in the |
| 3217 | same window, to make the changes take effect. | 3217 | same window, to make the changes take effect. A buffer that does not |
| 3218 | specify values for these variables will use the default values | ||
| 3219 | specified for the frame; see @ref{Layout Parameters}. | ||
| 3218 | 3220 | ||
| 3219 | @defun set-window-fringes window left &optional right outside-margins | 3221 | @defun set-window-fringes window left &optional right outside-margins |
| 3220 | This function sets the fringe widths of window @var{window}. | 3222 | This function sets the fringe widths of window @var{window}. |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index a54a65b0743..78b4178bb21 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -461,6 +461,7 @@ Line Arguments for Emacs Invocation, emacs, The GNU Emacs Manual}. | |||
| 461 | 461 | ||
| 462 | @node Window Frame Parameters | 462 | @node Window Frame Parameters |
| 463 | @subsection Window Frame Parameters | 463 | @subsection Window Frame Parameters |
| 464 | @cindex frame parameters for windowed displays | ||
| 464 | 465 | ||
| 465 | Just what parameters a frame has depends on what display mechanism | 466 | Just what parameters a frame has depends on what display mechanism |
| 466 | it uses. This section describes the parameters that have special | 467 | it uses. This section describes the parameters that have special |
| @@ -489,16 +490,19 @@ terminal frames. | |||
| 489 | frame. @code{title} and @code{name} are meaningful on all terminals. | 490 | frame. @code{title} and @code{name} are meaningful on all terminals. |
| 490 | 491 | ||
| 491 | @table @code | 492 | @table @code |
| 493 | @vindex display, a frame parameter | ||
| 492 | @item display | 494 | @item display |
| 493 | The display on which to open this frame. It should be a string of the | 495 | The display on which to open this frame. It should be a string of the |
| 494 | form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the | 496 | form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the |
| 495 | @code{DISPLAY} environment variable. | 497 | @code{DISPLAY} environment variable. |
| 496 | 498 | ||
| 499 | @vindex display-type, a frame parameter | ||
| 497 | @item display-type | 500 | @item display-type |
| 498 | This parameter describes the range of possible colors that can be used | 501 | This parameter describes the range of possible colors that can be used |
| 499 | in this frame. Its value is @code{color}, @code{grayscale} or | 502 | in this frame. Its value is @code{color}, @code{grayscale} or |
| 500 | @code{mono}. | 503 | @code{mono}. |
| 501 | 504 | ||
| 505 | @vindex title, a frame parameter | ||
| 502 | @item title | 506 | @item title |
| 503 | If a frame has a non-@code{nil} title, it appears in the window | 507 | If a frame has a non-@code{nil} title, it appears in the window |
| 504 | system's title bar at the top of the frame, and also in the mode line | 508 | system's title bar at the top of the frame, and also in the mode line |
| @@ -507,6 +511,7 @@ of windows in that frame if @code{mode-line-frame-identification} uses | |||
| 507 | Emacs is not using a window system, and can only display one frame at | 511 | Emacs is not using a window system, and can only display one frame at |
| 508 | a time. @xref{Frame Titles}. | 512 | a time. @xref{Frame Titles}. |
| 509 | 513 | ||
| 514 | @vindex name, a frame parameter | ||
| 510 | @item name | 515 | @item name |
| 511 | The name of the frame. The frame name serves as a default for the frame | 516 | The name of the frame. The frame name serves as a default for the frame |
| 512 | title, if the @code{title} parameter is unspecified or @code{nil}. If | 517 | title, if the @code{title} parameter is unspecified or @code{nil}. If |
| @@ -520,11 +525,13 @@ looking up X resources for the frame. | |||
| 520 | 525 | ||
| 521 | @node Position Parameters | 526 | @node Position Parameters |
| 522 | @subsubsection Position Parameters | 527 | @subsubsection Position Parameters |
| 528 | @cindex window position on display | ||
| 523 | 529 | ||
| 524 | Position parameters' values are normally measured in pixels, but on | 530 | Position parameters' values are normally measured in pixels, but on |
| 525 | text-only terminals they count characters or lines instead. | 531 | text-only terminals they count characters or lines instead. |
| 526 | 532 | ||
| 527 | @table @code | 533 | @table @code |
| 534 | @vindex left, a frame parameter | ||
| 528 | @item left | 535 | @item left |
| 529 | The position, in pixels, of the left (or right) edge of the frame with | 536 | The position, in pixels, of the left (or right) edge of the frame with |
| 530 | respect to the left (or right) edge of the screen. The value may be: | 537 | respect to the left (or right) edge of the screen. The value may be: |
| @@ -550,11 +557,13 @@ Some window managers ignore program-specified positions. If you want to | |||
| 550 | be sure the position you specify is not ignored, specify a | 557 | be sure the position you specify is not ignored, specify a |
| 551 | non-@code{nil} value for the @code{user-position} parameter as well. | 558 | non-@code{nil} value for the @code{user-position} parameter as well. |
| 552 | 559 | ||
| 560 | @vindex top, a frame parameter | ||
| 553 | @item top | 561 | @item top |
| 554 | The screen position of the top (or bottom) edge, in pixels, with respect | 562 | The screen position of the top (or bottom) edge, in pixels, with respect |
| 555 | to the top (or bottom) edge of the screen. It works just like | 563 | to the top (or bottom) edge of the screen. It works just like |
| 556 | @code{left}, except vertically instead of horizontally. | 564 | @code{left}, except vertically instead of horizontally. |
| 557 | 565 | ||
| 566 | @vindex icon-left, a frame parameter | ||
| 558 | @item icon-left | 567 | @item icon-left |
| 559 | The screen position of the left edge @emph{of the frame's icon}, in | 568 | The screen position of the left edge @emph{of the frame's icon}, in |
| 560 | pixels, counting from the left edge of the screen. This takes effect if | 569 | pixels, counting from the left edge of the screen. This takes effect if |
| @@ -564,11 +573,13 @@ If you specify a value for this parameter, then you must also specify | |||
| 564 | a value for @code{icon-top} and vice versa. The window manager may | 573 | a value for @code{icon-top} and vice versa. The window manager may |
| 565 | ignore these two parameters. | 574 | ignore these two parameters. |
| 566 | 575 | ||
| 576 | @vindex icon-top, a frame parameter | ||
| 567 | @item icon-top | 577 | @item icon-top |
| 568 | The screen position of the top edge @emph{of the frame's icon}, in | 578 | The screen position of the top edge @emph{of the frame's icon}, in |
| 569 | pixels, counting from the top edge of the screen. This takes effect if | 579 | pixels, counting from the top edge of the screen. This takes effect if |
| 570 | and when the frame is iconified. | 580 | and when the frame is iconified. |
| 571 | 581 | ||
| 582 | @vindex user-position, a frame parameter | ||
| 572 | @item user-position | 583 | @item user-position |
| 573 | When you create a frame and specify its screen position with the | 584 | When you create a frame and specify its screen position with the |
| 574 | @code{left} and @code{top} parameters, use this parameter to say whether | 585 | @code{left} and @code{top} parameters, use this parameter to say whether |
| @@ -576,6 +587,7 @@ the specified position was user-specified (explicitly requested in some | |||
| 576 | way by a human user) or merely program-specified (chosen by a program). | 587 | way by a human user) or merely program-specified (chosen by a program). |
| 577 | A non-@code{nil} value says the position was user-specified. | 588 | A non-@code{nil} value says the position was user-specified. |
| 578 | 589 | ||
| 590 | @cindex window positions and window managers | ||
| 579 | Window managers generally heed user-specified positions, and some heed | 591 | Window managers generally heed user-specified positions, and some heed |
| 580 | program-specified positions too. But many ignore program-specified | 592 | program-specified positions too. But many ignore program-specified |
| 581 | positions, placing the window in a default fashion or letting the user | 593 | positions, placing the window in a default fashion or letting the user |
| @@ -591,24 +603,31 @@ parameters represent the user's stated preference; otherwise, use | |||
| 591 | 603 | ||
| 592 | @node Size Parameters | 604 | @node Size Parameters |
| 593 | @subsubsection Size Parameters | 605 | @subsubsection Size Parameters |
| 606 | @cindex window size on display | ||
| 594 | 607 | ||
| 595 | Size parameters' values are normally measured in pixels, but on | 608 | Size parameters' values are normally measured in pixels, but on |
| 596 | text-only terminals they count characters or lines instead. | 609 | text-only terminals they count characters or lines instead. |
| 597 | 610 | ||
| 598 | @table @code | 611 | @table @code |
| 612 | @vindex height, a frame parameter | ||
| 599 | @item height | 613 | @item height |
| 600 | The height of the frame contents, in characters. (To get the height in | 614 | The height of the frame contents, in characters. (To get the height in |
| 601 | pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) | 615 | pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) |
| 602 | 616 | ||
| 617 | @vindex width, a frame parameter | ||
| 603 | @item width | 618 | @item width |
| 604 | The width of the frame contents, in characters. (To get the width in | 619 | The width of the frame contents, in characters. (To get the width in |
| 605 | pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) | 620 | pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) |
| 606 | 621 | ||
| 622 | @vindex user-size, a frame parameter | ||
| 607 | @item user-size | 623 | @item user-size |
| 608 | This does for the size parameters @code{height} and @code{width} what | 624 | This does for the size parameters @code{height} and @code{width} what |
| 609 | the @code{user-position} parameter (see above) does for the position | 625 | the @code{user-position} parameter (@pxref{Position Parameters, |
| 610 | parameters @code{top} and @code{left}. | 626 | user-position}) does for the position parameters @code{top} and |
| 627 | @code{left}. | ||
| 611 | 628 | ||
| 629 | @cindex full-screen frames | ||
| 630 | @vindex fullscreen, a frame parameter | ||
| 612 | @item fullscreen | 631 | @item fullscreen |
| 613 | Specify that width, height or both shall be maximized. The value | 632 | Specify that width, height or both shall be maximized. The value |
| 614 | @code{fullwidth} specifies that width shall be as wide as possible. | 633 | @code{fullwidth} specifies that width shall be as wide as possible. |
| @@ -623,33 +642,42 @@ covers the whole screen. | |||
| 623 | 642 | ||
| 624 | @node Layout Parameters | 643 | @node Layout Parameters |
| 625 | @subsubsection Layout Parameters | 644 | @subsubsection Layout Parameters |
| 645 | @cindex layout parameters of frames | ||
| 646 | @cindex frame layout parameters | ||
| 626 | 647 | ||
| 627 | These frame parameters enable or disable various parts of the | 648 | These frame parameters enable or disable various parts of the |
| 628 | frame, or control their sizes. | 649 | frame, or control their sizes. |
| 629 | 650 | ||
| 630 | @table @code | 651 | @table @code |
| 652 | @vindex border-width, a frame parameter | ||
| 631 | @item border-width | 653 | @item border-width |
| 632 | The width in pixels of the frame's border. | 654 | The width in pixels of the frame's border. |
| 633 | 655 | ||
| 656 | @vindex internal-border-width, a frame parameter | ||
| 634 | @item internal-border-width | 657 | @item internal-border-width |
| 635 | The distance in pixels between text (or fringe) and the frame's border. | 658 | The distance in pixels between text (or fringe) and the frame's border. |
| 636 | 659 | ||
| 660 | @vindex vertical-scroll-bars, a frame parameter | ||
| 637 | @item vertical-scroll-bars | 661 | @item vertical-scroll-bars |
| 638 | Whether the frame has scroll bars for vertical scrolling, and which side | 662 | Whether the frame has scroll bars for vertical scrolling, and which side |
| 639 | of the frame they should be on. The possible values are @code{left}, | 663 | of the frame they should be on. The possible values are @code{left}, |
| 640 | @code{right}, and @code{nil} for no scroll bars. | 664 | @code{right}, and @code{nil} for no scroll bars. |
| 641 | 665 | ||
| 642 | @ignore | 666 | @ignore |
| 667 | @vindex horizontal-scroll-bars, a frame parameter | ||
| 643 | @item horizontal-scroll-bars | 668 | @item horizontal-scroll-bars |
| 644 | Whether the frame has scroll bars for horizontal scrolling | 669 | Whether the frame has scroll bars for horizontal scrolling |
| 645 | (non-@code{nil} means yes). Horizontal scroll bars are not currently | 670 | (non-@code{nil} means yes). Horizontal scroll bars are not currently |
| 646 | implemented. | 671 | implemented. |
| 647 | @end ignore | 672 | @end ignore |
| 648 | 673 | ||
| 674 | @vindex scroll-bar-width, a frame parameter | ||
| 649 | @item scroll-bar-width | 675 | @item scroll-bar-width |
| 650 | The width of vertical scroll bars, in pixels, or @code{nil} meaning to | 676 | The width of vertical scroll bars, in pixels, or @code{nil} meaning to |
| 651 | use the default width. | 677 | use the default width. |
| 652 | 678 | ||
| 679 | @vindex left-fringe, a frame parameter | ||
| 680 | @vindex right-fringe, a frame parameter | ||
| 653 | @item left-fringe | 681 | @item left-fringe |
| 654 | @itemx right-fringe | 682 | @itemx right-fringe |
| 655 | The default width of the left and right fringes of windows in this | 683 | The default width of the left and right fringes of windows in this |
| @@ -666,22 +694,26 @@ fringe. However, you can force one fringe or the other to a precise | |||
| 666 | width by specifying that width as a negative integer. If both widths are | 694 | width by specifying that width as a negative integer. If both widths are |
| 667 | negative, only the left fringe gets the specified width. | 695 | negative, only the left fringe gets the specified width. |
| 668 | 696 | ||
| 697 | @vindex menu-bar-lines, a frame parameter | ||
| 669 | @item menu-bar-lines | 698 | @item menu-bar-lines |
| 670 | The number of lines to allocate at the top of the frame for a menu | 699 | The number of lines to allocate at the top of the frame for a menu |
| 671 | bar. The default is 1. A value of @code{nil} means don't display a | 700 | bar. The default is 1. A value of @code{nil} means don't display a |
| 672 | menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one | 701 | menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one |
| 673 | menu bar line; they treat larger values as 1.) | 702 | menu bar line; they treat larger values as 1.) |
| 674 | 703 | ||
| 704 | @vindex tool-bar-lines, a frame parameter | ||
| 675 | @item tool-bar-lines | 705 | @item tool-bar-lines |
| 676 | The number of lines to use for the tool bar. A value of @code{nil} | 706 | The number of lines to use for the tool bar. A value of @code{nil} |
| 677 | means don't display a tool bar. (GTK and Nextstep allow at most one | 707 | means don't display a tool bar. (GTK and Nextstep allow at most one |
| 678 | tool bar line; they treat larger values as 1.) | 708 | tool bar line; they treat larger values as 1.) |
| 679 | 709 | ||
| 710 | @vindex tool-bar-position, a frame parameter | ||
| 680 | @item tool-bar-position | 711 | @item tool-bar-position |
| 681 | The position of the tool bar. Currently only for the GTK tool bar. | 712 | The position of the tool bar. Currently only for the GTK tool bar. |
| 682 | Value can be one of @code{top}, @code{bottom} @code{left}, @code{right}. | 713 | Value can be one of @code{top}, @code{bottom} @code{left}, @code{right}. |
| 683 | The default is @code{top}. | 714 | The default is @code{top}. |
| 684 | 715 | ||
| 716 | @vindex line-spacing, a frame parameter | ||
| 685 | @item line-spacing | 717 | @item line-spacing |
| 686 | Additional space to leave below each text line, in pixels (a positive | 718 | Additional space to leave below each text line, in pixels (a positive |
| 687 | integer). @xref{Line Height}, for more information. | 719 | integer). @xref{Line Height}, for more information. |
| @@ -694,6 +726,7 @@ integer). @xref{Line Height}, for more information. | |||
| 694 | with which buffers have been, or should, be displayed in the frame. | 726 | with which buffers have been, or should, be displayed in the frame. |
| 695 | 727 | ||
| 696 | @table @code | 728 | @table @code |
| 729 | @vindex minibuffer, a frame parameter | ||
| 697 | @item minibuffer | 730 | @item minibuffer |
| 698 | Whether this frame has its own minibuffer. The value @code{t} means | 731 | Whether this frame has its own minibuffer. The value @code{t} means |
| 699 | yes, @code{nil} means no, @code{only} means this frame is just a | 732 | yes, @code{nil} means no, @code{only} means this frame is just a |
| @@ -703,6 +736,7 @@ frame), the frame uses that minibuffer. | |||
| 703 | This frame parameter takes effect when the frame is created, and can | 736 | This frame parameter takes effect when the frame is created, and can |
| 704 | not be changed afterwards. | 737 | not be changed afterwards. |
| 705 | 738 | ||
| 739 | @vindex buffer-predicate, a frame parameter | ||
| 706 | @item buffer-predicate | 740 | @item buffer-predicate |
| 707 | The buffer-predicate function for this frame. The function | 741 | The buffer-predicate function for this frame. The function |
| 708 | @code{other-buffer} uses this predicate (from the selected frame) to | 742 | @code{other-buffer} uses this predicate (from the selected frame) to |
| @@ -711,61 +745,73 @@ decide which buffers it should consider, if the predicate is not | |||
| 711 | each buffer; if the predicate returns a non-@code{nil} value, it | 745 | each buffer; if the predicate returns a non-@code{nil} value, it |
| 712 | considers that buffer. | 746 | considers that buffer. |
| 713 | 747 | ||
| 748 | @vindex buffer-list, a frame parameter | ||
| 714 | @item buffer-list | 749 | @item buffer-list |
| 715 | A list of buffers that have been selected in this frame, | 750 | A list of buffers that have been selected in this frame, ordered |
| 716 | ordered most-recently-selected first. | 751 | most-recently-selected first. |
| 717 | 752 | ||
| 753 | @vindex unsplittable, a frame parameter | ||
| 718 | @item unsplittable | 754 | @item unsplittable |
| 719 | If non-@code{nil}, this frame's window is never split automatically. | 755 | If non-@code{nil}, this frame's window is never split automatically. |
| 720 | @end table | 756 | @end table |
| 721 | 757 | ||
| 722 | @node Management Parameters | 758 | @node Management Parameters |
| 723 | @subsubsection Window Management Parameters | 759 | @subsubsection Window Management Parameters |
| 724 | @cindex window manager, and frame parameters | 760 | @cindex window manager interaction, and frame parameters |
| 725 | 761 | ||
| 726 | These frame parameters, meaningful only on window system displays, | 762 | These frame parameters, meaningful only on window system displays, |
| 727 | interact with the window manager. | 763 | interact with the window manager. |
| 728 | 764 | ||
| 729 | @table @code | 765 | @table @code |
| 766 | @vindex visibility, a frame parameter | ||
| 730 | @item visibility | 767 | @item visibility |
| 731 | The state of visibility of the frame. There are three possibilities: | 768 | The state of visibility of the frame. There are three possibilities: |
| 732 | @code{nil} for invisible, @code{t} for visible, and @code{icon} for | 769 | @code{nil} for invisible, @code{t} for visible, and @code{icon} for |
| 733 | iconified. @xref{Visibility of Frames}. | 770 | iconified. @xref{Visibility of Frames}. |
| 734 | 771 | ||
| 772 | @vindex auto-raise, a frame parameter | ||
| 735 | @item auto-raise | 773 | @item auto-raise |
| 736 | Whether selecting the frame raises it (non-@code{nil} means yes). | 774 | Whether selecting the frame raises it (non-@code{nil} means yes). |
| 737 | 775 | ||
| 776 | @vindex auto-lower, a frame parameter | ||
| 738 | @item auto-lower | 777 | @item auto-lower |
| 739 | Whether deselecting the frame lowers it (non-@code{nil} means yes). | 778 | Whether deselecting the frame lowers it (non-@code{nil} means yes). |
| 740 | 779 | ||
| 780 | @vindex icon-type, a frame parameter | ||
| 741 | @item icon-type | 781 | @item icon-type |
| 742 | The type of icon to use for this frame when it is iconified. If the | 782 | The type of icon to use for this frame when it is iconified. If the |
| 743 | value is a string, that specifies a file containing a bitmap to use. | 783 | value is a string, that specifies a file containing a bitmap to use. |
| 744 | Any other non-@code{nil} value specifies the default bitmap icon (a | 784 | Any other non-@code{nil} value specifies the default bitmap icon (a |
| 745 | picture of a gnu); @code{nil} specifies a text icon. | 785 | picture of a gnu); @code{nil} specifies a text icon. |
| 746 | 786 | ||
| 787 | @vindex icon-name, a frame parameter | ||
| 747 | @item icon-name | 788 | @item icon-name |
| 748 | The name to use in the icon for this frame, when and if the icon | 789 | The name to use in the icon for this frame, when and if the icon |
| 749 | appears. If this is @code{nil}, the frame's title is used. | 790 | appears. If this is @code{nil}, the frame's title is used. |
| 750 | 791 | ||
| 792 | @vindex window-id, a frame parameter | ||
| 751 | @item window-id | 793 | @item window-id |
| 752 | The number of the window-system window used by the frame | 794 | The number of the window-system window used by the frame |
| 753 | to contain the actual Emacs windows. | 795 | to contain the actual Emacs windows. |
| 754 | 796 | ||
| 797 | @vindex outer-window-id, a frame parameter | ||
| 755 | @item outer-window-id | 798 | @item outer-window-id |
| 756 | The number of the outermost window-system window used for the whole frame. | 799 | The number of the outermost window-system window used for the whole frame. |
| 757 | 800 | ||
| 801 | @vindex wait-for-wm, a frame parameter | ||
| 758 | @item wait-for-wm | 802 | @item wait-for-wm |
| 759 | If non-@code{nil}, tell Xt to wait for the window manager to confirm | 803 | If non-@code{nil}, tell Xt to wait for the window manager to confirm |
| 760 | geometry changes. Some window managers, including versions of Fvwm2 | 804 | geometry changes. Some window managers, including versions of Fvwm2 |
| 761 | and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to | 805 | and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to |
| 762 | prevent hanging with those window managers. | 806 | prevent hanging with those window managers. |
| 763 | 807 | ||
| 808 | @vindex sticky, a frame parameter | ||
| 764 | @item sticky | 809 | @item sticky |
| 765 | If non-@code{nil}, the frame is visible on all virtual desktops on systems | 810 | If non-@code{nil}, the frame is visible on all virtual desktops on systems |
| 766 | with virtual desktops. | 811 | with virtual desktops. |
| 767 | 812 | ||
| 768 | @ignore | 813 | @ignore |
| 814 | @vindex parent-id, a frame parameter | ||
| 769 | @item parent-id | 815 | @item parent-id |
| 770 | @c ??? Not yet working. | 816 | @c ??? Not yet working. |
| 771 | The X window number of the window that should be the parent of this one. | 817 | The X window number of the window that should be the parent of this one. |
| @@ -777,10 +823,12 @@ it and see if it works.) | |||
| 777 | 823 | ||
| 778 | @node Cursor Parameters | 824 | @node Cursor Parameters |
| 779 | @subsubsection Cursor Parameters | 825 | @subsubsection Cursor Parameters |
| 826 | @cindex cursor, and frame parameters | ||
| 780 | 827 | ||
| 781 | This frame parameter controls the way the cursor looks. | 828 | This frame parameter controls the way the cursor looks. |
| 782 | 829 | ||
| 783 | @table @code | 830 | @table @code |
| 831 | @vindex cursor-type, a frame parameter | ||
| 784 | @item cursor-type | 832 | @item cursor-type |
| 785 | How to display the cursor. Legitimate values are: | 833 | How to display the cursor. Legitimate values are: |
| 786 | 834 | ||
| @@ -832,10 +880,12 @@ and bar becomes a narrower bar). | |||
| 832 | 880 | ||
| 833 | @node Font and Color Parameters | 881 | @node Font and Color Parameters |
| 834 | @subsubsection Font and Color Parameters | 882 | @subsubsection Font and Color Parameters |
| 883 | @cindex font and color, frame parameters | ||
| 835 | 884 | ||
| 836 | These frame parameters control the use of fonts and colors. | 885 | These frame parameters control the use of fonts and colors. |
| 837 | 886 | ||
| 838 | @table @code | 887 | @table @code |
| 888 | @vindex font-backend, a frame parameter | ||
| 839 | @item font-backend | 889 | @item font-backend |
| 840 | A list of symbols, specifying the @dfn{font backends} to use for | 890 | A list of symbols, specifying the @dfn{font backends} to use for |
| 841 | drawing fonts in the frame, in order of priority. On X, there are | 891 | drawing fonts in the frame, in order of priority. On X, there are |
| @@ -844,10 +894,12 @@ driver) and @code{xft} (the Xft font driver). On other systems, there | |||
| 844 | is only one available font backend, so it does not make sense to | 894 | is only one available font backend, so it does not make sense to |
| 845 | modify this frame parameter. | 895 | modify this frame parameter. |
| 846 | 896 | ||
| 897 | @vindex background-mode, a frame parameter | ||
| 847 | @item background-mode | 898 | @item background-mode |
| 848 | This parameter is either @code{dark} or @code{light}, according | 899 | This parameter is either @code{dark} or @code{light}, according |
| 849 | to whether the background color is a light one or a dark one. | 900 | to whether the background color is a light one or a dark one. |
| 850 | 901 | ||
| 902 | @vindex tty-color-mode, a frame parameter | ||
| 851 | @item tty-color-mode | 903 | @item tty-color-mode |
| 852 | @cindex standard colors for character terminals | 904 | @cindex standard colors for character terminals |
| 853 | This parameter overrides the terminal's color support as given by the | 905 | This parameter overrides the terminal's color support as given by the |
| @@ -863,6 +915,7 @@ If the parameter's value is a symbol, it specifies a number through | |||
| 863 | the value of @code{tty-color-mode-alist}, and the associated number is | 915 | the value of @code{tty-color-mode-alist}, and the associated number is |
| 864 | used instead. | 916 | used instead. |
| 865 | 917 | ||
| 918 | @vindex screen-gamma, a frame parameter | ||
| 866 | @item screen-gamma | 919 | @item screen-gamma |
| 867 | @cindex gamma correction | 920 | @cindex gamma correction |
| 868 | If this is a number, Emacs performs ``gamma correction'' which adjusts | 921 | If this is a number, Emacs performs ``gamma correction'' which adjusts |
| @@ -882,6 +935,7 @@ If your monitor displays colors too light, you should specify a | |||
| 882 | that makes colors darker. A screen gamma value of 1.5 may give good | 935 | that makes colors darker. A screen gamma value of 1.5 may give good |
| 883 | results for LCD color displays. | 936 | results for LCD color displays. |
| 884 | 937 | ||
| 938 | @vindex alpha, a frame parameter | ||
| 885 | @item alpha | 939 | @item alpha |
| 886 | @cindex opacity, frame | 940 | @cindex opacity, frame |
| 887 | @cindex transparency, frame | 941 | @cindex transparency, frame |
| @@ -909,37 +963,45 @@ automatically equivalent to particular face attributes of particular | |||
| 909 | faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): | 963 | faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): |
| 910 | 964 | ||
| 911 | @table @code | 965 | @table @code |
| 966 | @vindex font, a frame parameter | ||
| 912 | @item font | 967 | @item font |
| 913 | The name of the font for displaying text in the frame. This is a | 968 | The name of the font for displaying text in the frame. This is a |
| 914 | string, either a valid font name for your system or the name of an Emacs | 969 | string, either a valid font name for your system or the name of an Emacs |
| 915 | fontset (@pxref{Fontsets}). It is equivalent to the @code{font} | 970 | fontset (@pxref{Fontsets}). It is equivalent to the @code{font} |
| 916 | attribute of the @code{default} face. | 971 | attribute of the @code{default} face. |
| 917 | 972 | ||
| 973 | @vindex foreground-color, a frame parameter | ||
| 918 | @item foreground-color | 974 | @item foreground-color |
| 919 | The color to use for the image of a character. It is equivalent to | 975 | The color to use for the image of a character. It is equivalent to |
| 920 | the @code{:foreground} attribute of the @code{default} face. | 976 | the @code{:foreground} attribute of the @code{default} face. |
| 921 | 977 | ||
| 978 | @vindex background-color, a frame parameter | ||
| 922 | @item background-color | 979 | @item background-color |
| 923 | The color to use for the background of characters. It is equivalent to | 980 | The color to use for the background of characters. It is equivalent to |
| 924 | the @code{:background} attribute of the @code{default} face. | 981 | the @code{:background} attribute of the @code{default} face. |
| 925 | 982 | ||
| 983 | @vindex mouse-color, a frame parameter | ||
| 926 | @item mouse-color | 984 | @item mouse-color |
| 927 | The color for the mouse pointer. It is equivalent to the @code{:background} | 985 | The color for the mouse pointer. It is equivalent to the @code{:background} |
| 928 | attribute of the @code{mouse} face. | 986 | attribute of the @code{mouse} face. |
| 929 | 987 | ||
| 988 | @vindex cursor-color, a frame parameter | ||
| 930 | @item cursor-color | 989 | @item cursor-color |
| 931 | The color for the cursor that shows point. It is equivalent to the | 990 | The color for the cursor that shows point. It is equivalent to the |
| 932 | @code{:background} attribute of the @code{cursor} face. | 991 | @code{:background} attribute of the @code{cursor} face. |
| 933 | 992 | ||
| 993 | @vindex border-color, a frame parameter | ||
| 934 | @item border-color | 994 | @item border-color |
| 935 | The color for the border of the frame. It is equivalent to the | 995 | The color for the border of the frame. It is equivalent to the |
| 936 | @code{:background} attribute of the @code{border} face. | 996 | @code{:background} attribute of the @code{border} face. |
| 937 | 997 | ||
| 998 | @vindex scroll-bar-foreground, a frame parameter | ||
| 938 | @item scroll-bar-foreground | 999 | @item scroll-bar-foreground |
| 939 | If non-@code{nil}, the color for the foreground of scroll bars. It is | 1000 | If non-@code{nil}, the color for the foreground of scroll bars. It is |
| 940 | equivalent to the @code{:foreground} attribute of the | 1001 | equivalent to the @code{:foreground} attribute of the |
| 941 | @code{scroll-bar} face. | 1002 | @code{scroll-bar} face. |
| 942 | 1003 | ||
| 1004 | @vindex scroll-bar-background, a frame parameter | ||
| 943 | @item scroll-bar-background | 1005 | @item scroll-bar-background |
| 944 | If non-@code{nil}, the color for the background of scroll bars. It is | 1006 | If non-@code{nil}, the color for the background of scroll bars. It is |
| 945 | equivalent to the @code{:background} attribute of the | 1007 | equivalent to the @code{:background} attribute of the |