diff options
| author | Michael Albinus | 2018-02-23 15:30:19 +0100 |
|---|---|---|
| committer | Michael Albinus | 2018-02-23 15:30:19 +0100 |
| commit | 2dc24d5536abce1eb252dc2695a22371227166c5 (patch) | |
| tree | 5691caa876fd1c44d05719226684aa11ce0f4b45 /doc/lispref | |
| parent | 76f5242838c84bcaf5003b18a31104114930f197 (diff) | |
| download | emacs-2dc24d5536abce1eb252dc2695a22371227166c5.tar.gz emacs-2dc24d5536abce1eb252dc2695a22371227166c5.zip | |
Fix @findex and @vindex entries in manuals
* doc/emacs/building.texi:
* doc/emacs/calendar.texi:
* doc/emacs/cmdargs.texi:
* doc/emacs/mini.texi:
* doc/emacs/misc.texi:
* doc/emacs/trouble.texi:
* doc/emacs/windows.texi:
* doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/edebug.texi:
* doc/lispref/frames.texi:
* doc/lispref/os.texi:
* doc/lispref/windows.texi:
* doc/misc/cc-mode.texi:
* doc/misc/dired-x.texi:
* doc/misc/ediff.texi:
* doc/misc/mh-e.texi:
* doc/misc/pcl-cvs.texi:
* doc/misc/reftex.texi:
* doc/misc/sc.texi:
* doc/misc/vhdl-mode.texi:
* doc/misc/viper.texi: Fix @findex and @vindex entries.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/edebug.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 168 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 30 |
4 files changed, 101 insertions, 101 deletions
diff --git a/doc/lispref/edebug.texi b/doc/lispref/edebug.texi index b58f8aaa4f4..5af48fe0963 100644 --- a/doc/lispref/edebug.texi +++ b/doc/lispref/edebug.texi | |||
| @@ -158,7 +158,7 @@ display a list of all Edebug commands. | |||
| 158 | into it, to invoke Edebug at the proper places. | 158 | into it, to invoke Edebug at the proper places. |
| 159 | 159 | ||
| 160 | @kindex C-M-x | 160 | @kindex C-M-x |
| 161 | @findex eval-defun (Edebug) | 161 | @findex eval-defun @r{(Edebug)} |
| 162 | When you invoke command @kbd{C-M-x} (@code{eval-defun}) with a | 162 | When you invoke command @kbd{C-M-x} (@code{eval-defun}) with a |
| 163 | prefix argument on a function definition, it instruments the | 163 | prefix argument on a function definition, it instruments the |
| 164 | definition before evaluating it. (This does not modify the source | 164 | definition before evaluating it. (This does not modify the source |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 43fdd8f9d54..c2fa1094821 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -1391,20 +1391,20 @@ text terminals. | |||
| 1391 | frame. @code{title} and @code{name} are meaningful on all terminals. | 1391 | frame. @code{title} and @code{name} are meaningful on all terminals. |
| 1392 | 1392 | ||
| 1393 | @table @code | 1393 | @table @code |
| 1394 | @vindex display, a frame parameter | 1394 | @vindex display@r{, a frame parameter} |
| 1395 | @item display | 1395 | @item display |
| 1396 | The display on which to open this frame. It should be a string of the | 1396 | The display on which to open this frame. It should be a string of the |
| 1397 | form @samp{@var{host}:@var{dpy}.@var{screen}}, just like the | 1397 | form @samp{@var{host}:@var{dpy}.@var{screen}}, just like the |
| 1398 | @env{DISPLAY} environment variable. @xref{Multiple Terminals}, for | 1398 | @env{DISPLAY} environment variable. @xref{Multiple Terminals}, for |
| 1399 | more details about display names. | 1399 | more details about display names. |
| 1400 | 1400 | ||
| 1401 | @vindex display-type, a frame parameter | 1401 | @vindex display-type@r{, a frame parameter} |
| 1402 | @item display-type | 1402 | @item display-type |
| 1403 | This parameter describes the range of possible colors that can be used | 1403 | This parameter describes the range of possible colors that can be used |
| 1404 | in this frame. Its value is @code{color}, @code{grayscale} or | 1404 | in this frame. Its value is @code{color}, @code{grayscale} or |
| 1405 | @code{mono}. | 1405 | @code{mono}. |
| 1406 | 1406 | ||
| 1407 | @vindex title, a frame parameter | 1407 | @vindex title@r{, a frame parameter} |
| 1408 | @item title | 1408 | @item title |
| 1409 | If a frame has a non-@code{nil} title, it appears in the window | 1409 | If a frame has a non-@code{nil} title, it appears in the window |
| 1410 | system's title bar at the top of the frame, and also in the mode line | 1410 | system's title bar at the top of the frame, and also in the mode line |
| @@ -1413,7 +1413,7 @@ of windows in that frame if @code{mode-line-frame-identification} uses | |||
| 1413 | Emacs is not using a window system, and can only display one frame at | 1413 | Emacs is not using a window system, and can only display one frame at |
| 1414 | a time. @xref{Frame Titles}. | 1414 | a time. @xref{Frame Titles}. |
| 1415 | 1415 | ||
| 1416 | @vindex name, a frame parameter | 1416 | @vindex name@r{, a frame parameter} |
| 1417 | @item name | 1417 | @item name |
| 1418 | The name of the frame. The frame name serves as a default for the frame | 1418 | The name of the frame. The frame name serves as a default for the frame |
| 1419 | title, if the @code{title} parameter is unspecified or @code{nil}. If | 1419 | title, if the @code{title} parameter is unspecified or @code{nil}. If |
| @@ -1424,7 +1424,7 @@ If you specify the frame name explicitly when you create the frame, the | |||
| 1424 | name is also used (instead of the name of the Emacs executable) when | 1424 | name is also used (instead of the name of the Emacs executable) when |
| 1425 | looking up X resources for the frame. | 1425 | looking up X resources for the frame. |
| 1426 | 1426 | ||
| 1427 | @vindex explicit-name, a frame parameter | 1427 | @vindex explicit-name@r{, a frame parameter} |
| 1428 | @item explicit-name | 1428 | @item explicit-name |
| 1429 | If the frame name was specified explicitly when the frame was created, | 1429 | If the frame name was specified explicitly when the frame was created, |
| 1430 | this parameter will be that name. If the frame wasn't explicitly | 1430 | this parameter will be that name. If the frame wasn't explicitly |
| @@ -1446,7 +1446,7 @@ frame's parent frame. (Note that none of these parameters is meaningful | |||
| 1446 | on TTY frames.) | 1446 | on TTY frames.) |
| 1447 | 1447 | ||
| 1448 | @table @code | 1448 | @table @code |
| 1449 | @vindex left, a frame parameter | 1449 | @vindex left@r{, a frame parameter} |
| 1450 | @item left | 1450 | @item left |
| 1451 | The position, in pixels, of the left outer edge of the frame with | 1451 | The position, in pixels, of the left outer edge of the frame with |
| 1452 | respect to the left edge of the frame's display or parent frame. It can | 1452 | respect to the left edge of the frame's display or parent frame. It can |
| @@ -1521,13 +1521,13 @@ of the display, workarea or parent frame edge. They are also returned | |||
| 1521 | as such by functions like @code{frame-parameters} and restored as such | 1521 | as such by functions like @code{frame-parameters} and restored as such |
| 1522 | by the desktop saving routines. | 1522 | by the desktop saving routines. |
| 1523 | 1523 | ||
| 1524 | @vindex top, a frame parameter | 1524 | @vindex top@r{, a frame parameter} |
| 1525 | @item top | 1525 | @item top |
| 1526 | The screen position of the top (or bottom) edge, in pixels, with respect | 1526 | The screen position of the top (or bottom) edge, in pixels, with respect |
| 1527 | to the top (or bottom) edge of the display or parent frame. It works | 1527 | to the top (or bottom) edge of the display or parent frame. It works |
| 1528 | just like @code{left}, except vertically instead of horizontally. | 1528 | just like @code{left}, except vertically instead of horizontally. |
| 1529 | 1529 | ||
| 1530 | @vindex icon-left, a frame parameter | 1530 | @vindex icon-left@r{, a frame parameter} |
| 1531 | @item icon-left | 1531 | @item icon-left |
| 1532 | The screen position of the left edge of the frame's icon, in pixels, | 1532 | The screen position of the left edge of the frame's icon, in pixels, |
| 1533 | counting from the left edge of the screen. This takes effect when the | 1533 | counting from the left edge of the screen. This takes effect when the |
| @@ -1535,13 +1535,13 @@ frame is iconified, if the window manager supports this feature. If | |||
| 1535 | you specify a value for this parameter, then you must also specify a | 1535 | you specify a value for this parameter, then you must also specify a |
| 1536 | value for @code{icon-top} and vice versa. | 1536 | value for @code{icon-top} and vice versa. |
| 1537 | 1537 | ||
| 1538 | @vindex icon-top, a frame parameter | 1538 | @vindex icon-top@r{, a frame parameter} |
| 1539 | @item icon-top | 1539 | @item icon-top |
| 1540 | The screen position of the top edge of the frame's icon, in pixels, | 1540 | The screen position of the top edge of the frame's icon, in pixels, |
| 1541 | counting from the top edge of the screen. This takes effect when the | 1541 | counting from the top edge of the screen. This takes effect when the |
| 1542 | frame is iconified, if the window manager supports this feature. | 1542 | frame is iconified, if the window manager supports this feature. |
| 1543 | 1543 | ||
| 1544 | @vindex user-position, a frame parameter | 1544 | @vindex user-position@r{, a frame parameter} |
| 1545 | @item user-position | 1545 | @item user-position |
| 1546 | When you create a frame and specify its screen position with the | 1546 | When you create a frame and specify its screen position with the |
| 1547 | @code{left} and @code{top} parameters, use this parameter to say whether | 1547 | @code{left} and @code{top} parameters, use this parameter to say whether |
| @@ -1562,7 +1562,7 @@ value for this parameter if the values of the @code{left} and @code{top} | |||
| 1562 | parameters represent the user's stated preference; otherwise, use | 1562 | parameters represent the user's stated preference; otherwise, use |
| 1563 | @code{nil}. | 1563 | @code{nil}. |
| 1564 | 1564 | ||
| 1565 | @vindex z-group, a frame parameter | 1565 | @vindex z-group@r{, a frame parameter} |
| 1566 | @item z-group | 1566 | @item z-group |
| 1567 | This parameter specifies a relative position of the frame's | 1567 | This parameter specifies a relative position of the frame's |
| 1568 | window-system window in the stacking (Z-) order of the frame's display. | 1568 | window-system window in the stacking (Z-) order of the frame's display. |
| @@ -1589,7 +1589,7 @@ graphical displays, the @code{default} face determines the actual pixel | |||
| 1589 | sizes of these character units (@pxref{Face Attributes}). | 1589 | sizes of these character units (@pxref{Face Attributes}). |
| 1590 | 1590 | ||
| 1591 | @table @code | 1591 | @table @code |
| 1592 | @vindex width, a frame parameter | 1592 | @vindex width@r{, a frame parameter} |
| 1593 | @item width | 1593 | @item width |
| 1594 | This parameter specifies the width of the frame. It can be specified as | 1594 | This parameter specifies the width of the frame. It can be specified as |
| 1595 | in the following ways: | 1595 | in the following ways: |
| @@ -1635,19 +1635,19 @@ width of the frame's text area in characters as an integer rounded, if | |||
| 1635 | necessary, to a multiple of the frame's default character width. That | 1635 | necessary, to a multiple of the frame's default character width. That |
| 1636 | value is also used by the desktop saving routines. | 1636 | value is also used by the desktop saving routines. |
| 1637 | 1637 | ||
| 1638 | @vindex height, a frame parameter | 1638 | @vindex height@r{, a frame parameter} |
| 1639 | @item height | 1639 | @item height |
| 1640 | This parameter specifies the height of the frame. It works just like | 1640 | This parameter specifies the height of the frame. It works just like |
| 1641 | @code{width}, except vertically instead of horizontally. | 1641 | @code{width}, except vertically instead of horizontally. |
| 1642 | 1642 | ||
| 1643 | @vindex user-size, a frame parameter | 1643 | @vindex user-size@r{, a frame parameter} |
| 1644 | @item user-size | 1644 | @item user-size |
| 1645 | This does for the size parameters @code{height} and @code{width} what | 1645 | This does for the size parameters @code{height} and @code{width} what |
| 1646 | the @code{user-position} parameter (@pxref{Position Parameters, | 1646 | the @code{user-position} parameter (@pxref{Position Parameters, |
| 1647 | user-position}) does for the position parameters @code{top} and | 1647 | user-position}) does for the position parameters @code{top} and |
| 1648 | @code{left}. | 1648 | @code{left}. |
| 1649 | 1649 | ||
| 1650 | @vindex min-width, a frame parameter | 1650 | @vindex min-width@r{, a frame parameter} |
| 1651 | @item min-width | 1651 | @item min-width |
| 1652 | This parameter specifies the minimum native width (@pxref{Frame | 1652 | This parameter specifies the minimum native width (@pxref{Frame |
| 1653 | Geometry}) of the frame, in characters. Normally, the functions that | 1653 | Geometry}) of the frame, in characters. Normally, the functions that |
| @@ -1658,7 +1658,7 @@ non-@code{nil} allows to make a frame narrower than that with the | |||
| 1658 | consequence that any components that do not fit will be clipped by the | 1658 | consequence that any components that do not fit will be clipped by the |
| 1659 | window manager. | 1659 | window manager. |
| 1660 | 1660 | ||
| 1661 | @vindex min-height, a frame parameter | 1661 | @vindex min-height@r{, a frame parameter} |
| 1662 | @item min-height | 1662 | @item min-height |
| 1663 | This parameter specifies the minimum native height (@pxref{Frame | 1663 | This parameter specifies the minimum native height (@pxref{Frame |
| 1664 | Geometry}) of the frame, in characters. Normally, the functions that | 1664 | Geometry}) of the frame, in characters. Normally, the functions that |
| @@ -1673,7 +1673,7 @@ fit will be clipped by the window manager. | |||
| 1673 | @cindex fullheight frames | 1673 | @cindex fullheight frames |
| 1674 | @cindex fullwidth frames | 1674 | @cindex fullwidth frames |
| 1675 | @cindex maximized frames | 1675 | @cindex maximized frames |
| 1676 | @vindex fullscreen, a frame parameter | 1676 | @vindex fullscreen@r{, a frame parameter} |
| 1677 | @item fullscreen | 1677 | @item fullscreen |
| 1678 | This parameter specifies whether to maximize the frame's width, height | 1678 | This parameter specifies whether to maximize the frame's width, height |
| 1679 | or both. Its value can be @code{fullwidth}, @code{fullheight}, | 1679 | or both. Its value can be @code{fullwidth}, @code{fullheight}, |
| @@ -1704,7 +1704,7 @@ Full-screen on macOS hides both the tool-bar and the menu-bar, however | |||
| 1704 | both will be displayed if the mouse pointer is moved to the top of the | 1704 | both will be displayed if the mouse pointer is moved to the top of the |
| 1705 | screen. | 1705 | screen. |
| 1706 | 1706 | ||
| 1707 | @vindex fullscreen-restore, a frame parameter | 1707 | @vindex fullscreen-restore@r{, a frame parameter} |
| 1708 | @item fullscreen-restore | 1708 | @item fullscreen-restore |
| 1709 | This parameter specifies the desired fullscreen state of the frame | 1709 | This parameter specifies the desired fullscreen state of the frame |
| 1710 | after invoking the @code{toggle-frame-fullscreen} command (@pxref{Frame | 1710 | after invoking the @code{toggle-frame-fullscreen} command (@pxref{Frame |
| @@ -1723,14 +1723,14 @@ file as, for example | |||
| 1723 | This will give a new frame full height after typing in it @key{F11} for | 1723 | This will give a new frame full height after typing in it @key{F11} for |
| 1724 | the first time. | 1724 | the first time. |
| 1725 | 1725 | ||
| 1726 | @vindex fit-frame-to-buffer-margins, a frame parameter | 1726 | @vindex fit-frame-to-buffer-margins@r{, a frame parameter} |
| 1727 | @item fit-frame-to-buffer-margins | 1727 | @item fit-frame-to-buffer-margins |
| 1728 | This parameter allows to override the value of the option | 1728 | This parameter allows to override the value of the option |
| 1729 | @code{fit-frame-to-buffer-margins} when fitting this frame to the buffer | 1729 | @code{fit-frame-to-buffer-margins} when fitting this frame to the buffer |
| 1730 | of its root window with @code{fit-frame-to-buffer} (@pxref{Resizing | 1730 | of its root window with @code{fit-frame-to-buffer} (@pxref{Resizing |
| 1731 | Windows}). | 1731 | Windows}). |
| 1732 | 1732 | ||
| 1733 | @vindex fit-frame-to-buffer-sizes, a frame parameter | 1733 | @vindex fit-frame-to-buffer-sizes@r{, a frame parameter} |
| 1734 | @item fit-frame-to-buffer-sizes | 1734 | @item fit-frame-to-buffer-sizes |
| 1735 | This parameter allows to override the value of the option | 1735 | This parameter allows to override the value of the option |
| 1736 | @code{fit-frame-to-buffer-sizes} when fitting this frame to the buffer | 1736 | @code{fit-frame-to-buffer-sizes} when fitting this frame to the buffer |
| @@ -1748,38 +1748,38 @@ Windows}). | |||
| 1748 | frame, or control their sizes. | 1748 | frame, or control their sizes. |
| 1749 | 1749 | ||
| 1750 | @table @code | 1750 | @table @code |
| 1751 | @vindex border-width, a frame parameter | 1751 | @vindex border-width@r{, a frame parameter} |
| 1752 | @item border-width | 1752 | @item border-width |
| 1753 | The width in pixels of the frame's outer border (@pxref{Frame Geometry}). | 1753 | The width in pixels of the frame's outer border (@pxref{Frame Geometry}). |
| 1754 | 1754 | ||
| 1755 | @vindex internal-border-width, a frame parameter | 1755 | @vindex internal-border-width@r{, a frame parameter} |
| 1756 | @item internal-border-width | 1756 | @item internal-border-width |
| 1757 | The width in pixels of the frame's internal border (@pxref{Frame | 1757 | The width in pixels of the frame's internal border (@pxref{Frame |
| 1758 | Geometry}). | 1758 | Geometry}). |
| 1759 | 1759 | ||
| 1760 | @vindex vertical-scroll-bars, a frame parameter | 1760 | @vindex vertical-scroll-bars@r{, a frame parameter} |
| 1761 | @item vertical-scroll-bars | 1761 | @item vertical-scroll-bars |
| 1762 | Whether the frame has scroll bars (@pxref{Scroll Bars}) for vertical | 1762 | Whether the frame has scroll bars (@pxref{Scroll Bars}) for vertical |
| 1763 | scrolling, and which side of the frame they should be on. The possible | 1763 | scrolling, and which side of the frame they should be on. The possible |
| 1764 | values are @code{left}, @code{right}, and @code{nil} for no scroll bars. | 1764 | values are @code{left}, @code{right}, and @code{nil} for no scroll bars. |
| 1765 | 1765 | ||
| 1766 | @vindex horizontal-scroll-bars, a frame parameter | 1766 | @vindex horizontal-scroll-bars@r{, a frame parameter} |
| 1767 | @item horizontal-scroll-bars | 1767 | @item horizontal-scroll-bars |
| 1768 | Whether the frame has scroll bars for horizontal scrolling (@code{t} and | 1768 | Whether the frame has scroll bars for horizontal scrolling (@code{t} and |
| 1769 | @code{bottom} mean yes, @code{nil} means no). | 1769 | @code{bottom} mean yes, @code{nil} means no). |
| 1770 | 1770 | ||
| 1771 | @vindex scroll-bar-width, a frame parameter | 1771 | @vindex scroll-bar-width@r{, a frame parameter} |
| 1772 | @item scroll-bar-width | 1772 | @item scroll-bar-width |
| 1773 | The width of vertical scroll bars, in pixels, or @code{nil} meaning to | 1773 | The width of vertical scroll bars, in pixels, or @code{nil} meaning to |
| 1774 | use the default width. | 1774 | use the default width. |
| 1775 | 1775 | ||
| 1776 | @vindex scroll-bar-height, a frame parameter | 1776 | @vindex scroll-bar-height@r{, a frame parameter} |
| 1777 | @item scroll-bar-height | 1777 | @item scroll-bar-height |
| 1778 | The height of horizontal scroll bars, in pixels, or @code{nil} meaning | 1778 | The height of horizontal scroll bars, in pixels, or @code{nil} meaning |
| 1779 | to use the default height. | 1779 | to use the default height. |
| 1780 | 1780 | ||
| 1781 | @vindex left-fringe, a frame parameter | 1781 | @vindex left-fringe@r{, a frame parameter} |
| 1782 | @vindex right-fringe, a frame parameter | 1782 | @vindex right-fringe@r{, a frame parameter} |
| 1783 | @item left-fringe | 1783 | @item left-fringe |
| 1784 | @itemx right-fringe | 1784 | @itemx right-fringe |
| 1785 | The default width of the left and right fringes of windows in this | 1785 | The default width of the left and right fringes of windows in this |
| @@ -1791,19 +1791,19 @@ these two frame parameters, the return value is always an integer. | |||
| 1791 | When using @code{set-frame-parameter}, passing a @code{nil} value | 1791 | When using @code{set-frame-parameter}, passing a @code{nil} value |
| 1792 | imposes an actual default value of 8 pixels. | 1792 | imposes an actual default value of 8 pixels. |
| 1793 | 1793 | ||
| 1794 | @vindex right-divider-width, a frame parameter | 1794 | @vindex right-divider-width@r{, a frame parameter} |
| 1795 | @item right-divider-width | 1795 | @item right-divider-width |
| 1796 | The width (thickness) reserved for the right divider (@pxref{Window | 1796 | The width (thickness) reserved for the right divider (@pxref{Window |
| 1797 | Dividers}) of any window on the frame, in pixels. A value of zero means | 1797 | Dividers}) of any window on the frame, in pixels. A value of zero means |
| 1798 | to not draw right dividers. | 1798 | to not draw right dividers. |
| 1799 | 1799 | ||
| 1800 | @vindex bottom-divider-width, a frame parameter | 1800 | @vindex bottom-divider-width@r{, a frame parameter} |
| 1801 | @item bottom-divider-width | 1801 | @item bottom-divider-width |
| 1802 | The width (thickness) reserved for the bottom divider (@pxref{Window | 1802 | The width (thickness) reserved for the bottom divider (@pxref{Window |
| 1803 | Dividers}) of any window on the frame, in pixels. A value of zero means | 1803 | Dividers}) of any window on the frame, in pixels. A value of zero means |
| 1804 | to not draw bottom dividers. | 1804 | to not draw bottom dividers. |
| 1805 | 1805 | ||
| 1806 | @vindex menu-bar-lines frame parameter | 1806 | @vindex menu-bar-lines@r{, a frame parameter} |
| 1807 | @item menu-bar-lines | 1807 | @item menu-bar-lines |
| 1808 | The number of lines to allocate at the top of the frame for a menu bar | 1808 | The number of lines to allocate at the top of the frame for a menu bar |
| 1809 | (@pxref{Menu Bar}). The default is one if Menu Bar mode is enabled and | 1809 | (@pxref{Menu Bar}). The default is one if Menu Bar mode is enabled and |
| @@ -1814,25 +1814,25 @@ even when the menu bar wraps to two or more lines. In that case, the | |||
| 1814 | (@pxref{Frame Geometry}) allows to derive whether the menu bar actually | 1814 | (@pxref{Frame Geometry}) allows to derive whether the menu bar actually |
| 1815 | occupies one or more lines. | 1815 | occupies one or more lines. |
| 1816 | 1816 | ||
| 1817 | @vindex tool-bar-lines frame parameter | 1817 | @vindex tool-bar-lines@r{, a frame parameter} |
| 1818 | @item tool-bar-lines | 1818 | @item tool-bar-lines |
| 1819 | The number of lines to use for the tool bar (@pxref{Tool Bar}). The | 1819 | The number of lines to use for the tool bar (@pxref{Tool Bar}). The |
| 1820 | default is one if Tool Bar mode is enabled and zero otherwise. | 1820 | default is one if Tool Bar mode is enabled and zero otherwise. |
| 1821 | @xref{Tool Bars,,,emacs, The GNU Emacs Manual}. This value may change | 1821 | @xref{Tool Bars,,,emacs, The GNU Emacs Manual}. This value may change |
| 1822 | whenever the tool bar wraps (@pxref{Frame Layout}). | 1822 | whenever the tool bar wraps (@pxref{Frame Layout}). |
| 1823 | 1823 | ||
| 1824 | @vindex tool-bar-position frame parameter | 1824 | @vindex tool-bar-position@r{, a frame parameter} |
| 1825 | @item tool-bar-position | 1825 | @item tool-bar-position |
| 1826 | The position of the tool bar when Emacs was built with GTK+. Its value | 1826 | The position of the tool bar when Emacs was built with GTK+. Its value |
| 1827 | can be one of @code{top}, @code{bottom} @code{left}, @code{right}. The | 1827 | can be one of @code{top}, @code{bottom} @code{left}, @code{right}. The |
| 1828 | default is @code{top}. | 1828 | default is @code{top}. |
| 1829 | 1829 | ||
| 1830 | @vindex line-spacing, a frame parameter | 1830 | @vindex line-spacing@r{, a frame parameter} |
| 1831 | @item line-spacing | 1831 | @item line-spacing |
| 1832 | Additional space to leave below each text line, in pixels (a positive | 1832 | Additional space to leave below each text line, in pixels (a positive |
| 1833 | integer). @xref{Line Height}, for more information. | 1833 | integer). @xref{Line Height}, for more information. |
| 1834 | 1834 | ||
| 1835 | @vindex no-special-glyphs, a frame parameter | 1835 | @vindex no-special-glyphs@r{, a frame parameter} |
| 1836 | @item no-special-glyphs | 1836 | @item no-special-glyphs |
| 1837 | If this is non-@code{nil}, it suppresses the display of any truncation | 1837 | If this is non-@code{nil}, it suppresses the display of any truncation |
| 1838 | and continuation glyphs (@pxref{Truncation}) for all buffers displayed | 1838 | and continuation glyphs (@pxref{Truncation}) for all buffers displayed |
| @@ -1851,7 +1851,7 @@ Windows}). | |||
| 1851 | with which buffers have been, or should, be displayed in the frame. | 1851 | with which buffers have been, or should, be displayed in the frame. |
| 1852 | 1852 | ||
| 1853 | @table @code | 1853 | @table @code |
| 1854 | @vindex minibuffer, a frame parameter | 1854 | @vindex minibuffer@r{, a frame parameter} |
| 1855 | @item minibuffer | 1855 | @item minibuffer |
| 1856 | Whether this frame has its own minibuffer. The value @code{t} means | 1856 | Whether this frame has its own minibuffer. The value @code{t} means |
| 1857 | yes, @code{nil} means no, @code{only} means this frame is just a | 1857 | yes, @code{nil} means no, @code{only} means this frame is just a |
| @@ -1867,7 +1867,7 @@ minibuffer window to @code{t} and vice-versa, or from @code{t} to | |||
| 1867 | @code{nil}. If the parameter specifies a minibuffer window already, | 1867 | @code{nil}. If the parameter specifies a minibuffer window already, |
| 1868 | setting it to @code{nil} has no effect. | 1868 | setting it to @code{nil} has no effect. |
| 1869 | 1869 | ||
| 1870 | @vindex buffer-predicate, a frame parameter | 1870 | @vindex buffer-predicate@r{, a frame parameter} |
| 1871 | @item buffer-predicate | 1871 | @item buffer-predicate |
| 1872 | The buffer-predicate function for this frame. The function | 1872 | The buffer-predicate function for this frame. The function |
| 1873 | @code{other-buffer} uses this predicate (from the selected frame) to | 1873 | @code{other-buffer} uses this predicate (from the selected frame) to |
| @@ -1876,12 +1876,12 @@ decide which buffers it should consider, if the predicate is not | |||
| 1876 | each buffer; if the predicate returns a non-@code{nil} value, it | 1876 | each buffer; if the predicate returns a non-@code{nil} value, it |
| 1877 | considers that buffer. | 1877 | considers that buffer. |
| 1878 | 1878 | ||
| 1879 | @vindex buffer-list, a frame parameter | 1879 | @vindex buffer-list@r{, a frame parameter} |
| 1880 | @item buffer-list | 1880 | @item buffer-list |
| 1881 | A list of buffers that have been selected in this frame, ordered | 1881 | A list of buffers that have been selected in this frame, ordered |
| 1882 | most-recently-selected first. | 1882 | most-recently-selected first. |
| 1883 | 1883 | ||
| 1884 | @vindex unsplittable, a frame parameter | 1884 | @vindex unsplittable@r{, a frame parameter} |
| 1885 | @item unsplittable | 1885 | @item unsplittable |
| 1886 | If non-@code{nil}, this frame's window is never split automatically. | 1886 | If non-@code{nil}, this frame's window is never split automatically. |
| 1887 | @end table | 1887 | @end table |
| @@ -1895,40 +1895,40 @@ If non-@code{nil}, this frame's window is never split automatically. | |||
| 1895 | These parameters supply forms of interactions between different frames. | 1895 | These parameters supply forms of interactions between different frames. |
| 1896 | 1896 | ||
| 1897 | @table @code | 1897 | @table @code |
| 1898 | @vindex parent-frame, a frame parameter | 1898 | @vindex parent-frame@r{, a frame parameter} |
| 1899 | @item parent-frame | 1899 | @item parent-frame |
| 1900 | If non-@code{nil}, this means that this frame is a child frame | 1900 | If non-@code{nil}, this means that this frame is a child frame |
| 1901 | (@pxref{Child Frames}), and this parameter specifies its parent frame. | 1901 | (@pxref{Child Frames}), and this parameter specifies its parent frame. |
| 1902 | If @code{nil}, this means that this frame is a normal, top-level frame. | 1902 | If @code{nil}, this means that this frame is a normal, top-level frame. |
| 1903 | 1903 | ||
| 1904 | @vindex delete-before, a frame parameter | 1904 | @vindex delete-before@r{, a frame parameter} |
| 1905 | @item delete-before | 1905 | @item delete-before |
| 1906 | If non-@code{nil}, this parameter specifies another frame whose deletion | 1906 | If non-@code{nil}, this parameter specifies another frame whose deletion |
| 1907 | will automatically trigger the deletion of this frame. @xref{Deleting | 1907 | will automatically trigger the deletion of this frame. @xref{Deleting |
| 1908 | Frames}. | 1908 | Frames}. |
| 1909 | 1909 | ||
| 1910 | @vindex mouse-wheel-frame, a frame parameter | 1910 | @vindex mouse-wheel-frame@r{, a frame parameter} |
| 1911 | @item mouse-wheel-frame | 1911 | @item mouse-wheel-frame |
| 1912 | If non-@code{nil}, this parameter specifies the frame whose windows will | 1912 | If non-@code{nil}, this parameter specifies the frame whose windows will |
| 1913 | be scrolled whenever the mouse wheel is scrolled with the mouse pointer | 1913 | be scrolled whenever the mouse wheel is scrolled with the mouse pointer |
| 1914 | hovering over this frame, see @ref{Mouse Commands,,, emacs, The GNU | 1914 | hovering over this frame, see @ref{Mouse Commands,,, emacs, The GNU |
| 1915 | Emacs Manual}. | 1915 | Emacs Manual}. |
| 1916 | 1916 | ||
| 1917 | @vindex no-other-frame, a frame parameter | 1917 | @vindex no-other-frame@r{, a frame parameter} |
| 1918 | @item no-other-frame | 1918 | @item no-other-frame |
| 1919 | If this is non-@code{nil}, then this frame is not eligible as candidate | 1919 | If this is non-@code{nil}, then this frame is not eligible as candidate |
| 1920 | for the functions @code{next-frame}, @code{previous-frame} | 1920 | for the functions @code{next-frame}, @code{previous-frame} |
| 1921 | (@pxref{Finding All Frames}) and @code{other-frame}, see @ref{Frame | 1921 | (@pxref{Finding All Frames}) and @code{other-frame}, see @ref{Frame |
| 1922 | Commands,,, emacs, The GNU Emacs Manual}. | 1922 | Commands,,, emacs, The GNU Emacs Manual}. |
| 1923 | 1923 | ||
| 1924 | @vindex auto-hide-function, a frame parameter | 1924 | @vindex auto-hide-function@r{, a frame parameter} |
| 1925 | @item auto-hide-function | 1925 | @item auto-hide-function |
| 1926 | When this parameter specifies a function, that function will be called | 1926 | When this parameter specifies a function, that function will be called |
| 1927 | instead of the function specified by the variable | 1927 | instead of the function specified by the variable |
| 1928 | @code{frame-auto-hide-function} when quitting the frame's only window | 1928 | @code{frame-auto-hide-function} when quitting the frame's only window |
| 1929 | (@pxref{Quitting Windows}) and there are other frames left. | 1929 | (@pxref{Quitting Windows}) and there are other frames left. |
| 1930 | 1930 | ||
| 1931 | @vindex minibuffer-exit, a frame parameter | 1931 | @vindex minibuffer-exit@r{, a frame parameter} |
| 1932 | @item minibuffer-exit | 1932 | @item minibuffer-exit |
| 1933 | When this parameter is non-@code{nil}, Emacs will by default make this | 1933 | When this parameter is non-@code{nil}, Emacs will by default make this |
| 1934 | frame invisible whenever the minibuffer (@pxref{Minibuffers}) is exited. | 1934 | frame invisible whenever the minibuffer (@pxref{Minibuffers}) is exited. |
| @@ -1937,7 +1937,7 @@ Alternatively, it can specify the functions @code{iconify-frame} and | |||
| 1937 | disappear automatically (similar to how Emacs deals with a window) when | 1937 | disappear automatically (similar to how Emacs deals with a window) when |
| 1938 | exiting the minibuffer. | 1938 | exiting the minibuffer. |
| 1939 | 1939 | ||
| 1940 | @vindex keep-ratio, a frame parameter | 1940 | @vindex keep-ratio@r{, a frame parameter} |
| 1941 | @item keep-ratio | 1941 | @item keep-ratio |
| 1942 | This parameter is currently meaningful for child frames (@pxref{Child | 1942 | This parameter is currently meaningful for child frames (@pxref{Child |
| 1943 | Frames}) only. If it is non-@code{nil}, then Emacs will try to keep the | 1943 | Frames}) only. If it is non-@code{nil}, then Emacs will try to keep the |
| @@ -1977,29 +1977,29 @@ Frames}) that come without window manager decorations. If necessary, | |||
| 1977 | they can be used for undecorated top-level frames as well. | 1977 | they can be used for undecorated top-level frames as well. |
| 1978 | 1978 | ||
| 1979 | @table @code | 1979 | @table @code |
| 1980 | @vindex drag-internal-border, a frame parameter | 1980 | @vindex drag-internal-border@r{, a frame parameter} |
| 1981 | @item drag-internal-border | 1981 | @item drag-internal-border |
| 1982 | If non-@code{nil}, the frame can be resized by dragging its internal | 1982 | If non-@code{nil}, the frame can be resized by dragging its internal |
| 1983 | borders, if present, with the mouse. | 1983 | borders, if present, with the mouse. |
| 1984 | 1984 | ||
| 1985 | @vindex drag-with-header-line, a frame parameter | 1985 | @vindex drag-with-header-line@r{, a frame parameter} |
| 1986 | @item drag-with-header-line | 1986 | @item drag-with-header-line |
| 1987 | If non-@code{nil}, the frame can be moved with the mouse by dragging the | 1987 | If non-@code{nil}, the frame can be moved with the mouse by dragging the |
| 1988 | header line of its topmost window. | 1988 | header line of its topmost window. |
| 1989 | 1989 | ||
| 1990 | @vindex drag-with-mode-line, a frame parameter | 1990 | @vindex drag-with-mode-line@r{, a frame parameter} |
| 1991 | @item drag-with-mode-line | 1991 | @item drag-with-mode-line |
| 1992 | If non-@code{nil}, the frame can be moved with the mouse by dragging the | 1992 | If non-@code{nil}, the frame can be moved with the mouse by dragging the |
| 1993 | mode line of its bottommost window. Note that such a frame is not | 1993 | mode line of its bottommost window. Note that such a frame is not |
| 1994 | allowed to have its own minibuffer window. | 1994 | allowed to have its own minibuffer window. |
| 1995 | 1995 | ||
| 1996 | @vindex snap-width, a frame parameter | 1996 | @vindex snap-width@r{, a frame parameter} |
| 1997 | @item snap-width | 1997 | @item snap-width |
| 1998 | A frame that is moved with the mouse will ``snap'' at the border(s) of | 1998 | A frame that is moved with the mouse will ``snap'' at the border(s) of |
| 1999 | the display or its parent frame whenever it is dragged as near to such | 1999 | the display or its parent frame whenever it is dragged as near to such |
| 2000 | an edge as the number of pixels specified by this parameter. | 2000 | an edge as the number of pixels specified by this parameter. |
| 2001 | 2001 | ||
| 2002 | @vindex top-visible, a frame parameter | 2002 | @vindex top-visible@r{, a frame parameter} |
| 2003 | @item top-visible | 2003 | @item top-visible |
| 2004 | If this parameter is a number, the top edge of the frame never appears | 2004 | If this parameter is a number, the top edge of the frame never appears |
| 2005 | above the top edge of its display or parent frame. Moreover, as many | 2005 | above the top edge of its display or parent frame. Moreover, as many |
| @@ -2010,7 +2010,7 @@ dragging a child frame with a non-@code{nil} | |||
| 2010 | @code{drag-with-header-line} parameter completely out of the area | 2010 | @code{drag-with-header-line} parameter completely out of the area |
| 2011 | of its parent frame. | 2011 | of its parent frame. |
| 2012 | 2012 | ||
| 2013 | @vindex bottom-visible, a frame parameter | 2013 | @vindex bottom-visible@r{, a frame parameter} |
| 2014 | @item bottom-visible | 2014 | @item bottom-visible |
| 2015 | If this parameter is a number, the bottom edge of the frame never | 2015 | If this parameter is a number, the bottom edge of the frame never |
| 2016 | appears below the bottom edge of its display or parent frame. Moreover, | 2016 | appears below the bottom edge of its display or parent frame. Moreover, |
| @@ -2032,66 +2032,66 @@ interaction with the window manager or window system. They have no | |||
| 2032 | effect on text terminals. | 2032 | effect on text terminals. |
| 2033 | 2033 | ||
| 2034 | @table @code | 2034 | @table @code |
| 2035 | @vindex visibility, a frame parameter | 2035 | @vindex visibility@r{, a frame parameter} |
| 2036 | @item visibility | 2036 | @item visibility |
| 2037 | The state of visibility of the frame. There are three possibilities: | 2037 | The state of visibility of the frame. There are three possibilities: |
| 2038 | @code{nil} for invisible, @code{t} for visible, and @code{icon} for | 2038 | @code{nil} for invisible, @code{t} for visible, and @code{icon} for |
| 2039 | iconified. @xref{Visibility of Frames}. | 2039 | iconified. @xref{Visibility of Frames}. |
| 2040 | 2040 | ||
| 2041 | @vindex auto-raise, a frame parameter | 2041 | @vindex auto-raise@r{, a frame parameter} |
| 2042 | @item auto-raise | 2042 | @item auto-raise |
| 2043 | If non-@code{nil}, Emacs automatically raises the frame when it is | 2043 | If non-@code{nil}, Emacs automatically raises the frame when it is |
| 2044 | selected. Some window managers do not allow this. | 2044 | selected. Some window managers do not allow this. |
| 2045 | 2045 | ||
| 2046 | @vindex auto-lower, a frame parameter | 2046 | @vindex auto-lower@r{, a frame parameter} |
| 2047 | @item auto-lower | 2047 | @item auto-lower |
| 2048 | If non-@code{nil}, Emacs automatically lowers the frame when it is | 2048 | If non-@code{nil}, Emacs automatically lowers the frame when it is |
| 2049 | deselected. Some window managers do not allow this. | 2049 | deselected. Some window managers do not allow this. |
| 2050 | 2050 | ||
| 2051 | @vindex icon-type, a frame parameter | 2051 | @vindex icon-type@r{, a frame parameter} |
| 2052 | @item icon-type | 2052 | @item icon-type |
| 2053 | The type of icon to use for this frame. If the value is a string, | 2053 | The type of icon to use for this frame. If the value is a string, |
| 2054 | that specifies a file containing a bitmap to use; @code{nil} specifies | 2054 | that specifies a file containing a bitmap to use; @code{nil} specifies |
| 2055 | no icon (in which case the window manager decides what to show); any | 2055 | no icon (in which case the window manager decides what to show); any |
| 2056 | other non-@code{nil} value specifies the default Emacs icon. | 2056 | other non-@code{nil} value specifies the default Emacs icon. |
| 2057 | 2057 | ||
| 2058 | @vindex icon-name, a frame parameter | 2058 | @vindex icon-name@r{, a frame parameter} |
| 2059 | @item icon-name | 2059 | @item icon-name |
| 2060 | The name to use in the icon for this frame, when and if the icon | 2060 | The name to use in the icon for this frame, when and if the icon |
| 2061 | appears. If this is @code{nil}, the frame's title is used. | 2061 | appears. If this is @code{nil}, the frame's title is used. |
| 2062 | 2062 | ||
| 2063 | @vindex window-id, a frame parameter | 2063 | @vindex window-id@r{, a frame parameter} |
| 2064 | @item window-id | 2064 | @item window-id |
| 2065 | The ID number which the graphical display uses for this frame. Emacs | 2065 | The ID number which the graphical display uses for this frame. Emacs |
| 2066 | assigns this parameter when the frame is created; changing the | 2066 | assigns this parameter when the frame is created; changing the |
| 2067 | parameter has no effect on the actual ID number. | 2067 | parameter has no effect on the actual ID number. |
| 2068 | 2068 | ||
| 2069 | @vindex outer-window-id, a frame parameter | 2069 | @vindex outer-window-id@r{, a frame parameter} |
| 2070 | @item outer-window-id | 2070 | @item outer-window-id |
| 2071 | The ID number of the outermost window-system window in which the frame | 2071 | The ID number of the outermost window-system window in which the frame |
| 2072 | exists. As with @code{window-id}, changing this parameter has no | 2072 | exists. As with @code{window-id}, changing this parameter has no |
| 2073 | actual effect. | 2073 | actual effect. |
| 2074 | 2074 | ||
| 2075 | @vindex wait-for-wm, a frame parameter | 2075 | @vindex wait-for-wm@r{, a frame parameter} |
| 2076 | @item wait-for-wm | 2076 | @item wait-for-wm |
| 2077 | If non-@code{nil}, tell Xt to wait for the window manager to confirm | 2077 | If non-@code{nil}, tell Xt to wait for the window manager to confirm |
| 2078 | geometry changes. Some window managers, including versions of Fvwm2 | 2078 | geometry changes. Some window managers, including versions of Fvwm2 |
| 2079 | and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to | 2079 | and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to |
| 2080 | prevent hanging with those window managers. | 2080 | prevent hanging with those window managers. |
| 2081 | 2081 | ||
| 2082 | @vindex sticky, a frame parameter | 2082 | @vindex sticky@r{, a frame parameter} |
| 2083 | @item sticky | 2083 | @item sticky |
| 2084 | If non-@code{nil}, the frame is visible on all virtual desktops on systems | 2084 | If non-@code{nil}, the frame is visible on all virtual desktops on systems |
| 2085 | with virtual desktops. | 2085 | with virtual desktops. |
| 2086 | 2086 | ||
| 2087 | @vindex inhibit-double-buffering, a frame parameter | 2087 | @vindex inhibit-double-buffering@r{, a frame parameter} |
| 2088 | @item inhibit-double-buffering | 2088 | @item inhibit-double-buffering |
| 2089 | If non-@code{nil}, the frame is drawn to the screen without double | 2089 | If non-@code{nil}, the frame is drawn to the screen without double |
| 2090 | buffering. Emacs normally attempts to use double buffering, where | 2090 | buffering. Emacs normally attempts to use double buffering, where |
| 2091 | available, to reduce flicker. Set this property if you experience | 2091 | available, to reduce flicker. Set this property if you experience |
| 2092 | display bugs or pine for that retro, flicker-y feeling. | 2092 | display bugs or pine for that retro, flicker-y feeling. |
| 2093 | 2093 | ||
| 2094 | @vindex skip-taskbar, a frame parameter | 2094 | @vindex skip-taskbar@r{, a frame parameter} |
| 2095 | @item skip-taskbar | 2095 | @item skip-taskbar |
| 2096 | If non-@code{nil}, this tells the window manager to remove the frame's | 2096 | If non-@code{nil}, this tells the window manager to remove the frame's |
| 2097 | icon from the taskbar associated with the frame's display and inhibit | 2097 | icon from the taskbar associated with the frame's display and inhibit |
| @@ -2100,13 +2100,13 @@ On MS-Windows, iconifying such a frame will "roll in" its window-system | |||
| 2100 | window at the bottom of the desktop. Some window managers may not honor | 2100 | window at the bottom of the desktop. Some window managers may not honor |
| 2101 | this parameter. | 2101 | this parameter. |
| 2102 | 2102 | ||
| 2103 | @vindex no-focus-on-map, a frame parameter | 2103 | @vindex no-focus-on-map@r{, a frame parameter} |
| 2104 | @item no-focus-on-map | 2104 | @item no-focus-on-map |
| 2105 | If non-@code{nil}, this means that the frame does not want to receive | 2105 | If non-@code{nil}, this means that the frame does not want to receive |
| 2106 | input focus when it is mapped (@pxref{Visibility of Frames}). Some | 2106 | input focus when it is mapped (@pxref{Visibility of Frames}). Some |
| 2107 | window managers may not honor this parameter. | 2107 | window managers may not honor this parameter. |
| 2108 | 2108 | ||
| 2109 | @vindex no-accept-focus, a frame parameter | 2109 | @vindex no-accept-focus@r{, a frame parameter} |
| 2110 | @item no-accept-focus | 2110 | @item no-accept-focus |
| 2111 | If non-@code{nil}, this means that the frame does not want to receive | 2111 | If non-@code{nil}, this means that the frame does not want to receive |
| 2112 | input focus via explicit mouse clicks or when moving the mouse into it | 2112 | input focus via explicit mouse clicks or when moving the mouse into it |
| @@ -2116,7 +2116,7 @@ This may have the unwanted side-effect that a user cannot scroll a | |||
| 2116 | non-selected frame with the mouse. Some window managers may not honor | 2116 | non-selected frame with the mouse. Some window managers may not honor |
| 2117 | this parameter. | 2117 | this parameter. |
| 2118 | 2118 | ||
| 2119 | @vindex undecorated, a frame parameter | 2119 | @vindex undecorated@r{, a frame parameter} |
| 2120 | @item undecorated | 2120 | @item undecorated |
| 2121 | If non-@code{nil}, this frame's window-system window is drawn without | 2121 | If non-@code{nil}, this frame's window-system window is drawn without |
| 2122 | decorations, like the title, minimize/maximize boxes and external | 2122 | decorations, like the title, minimize/maximize boxes and external |
| @@ -2131,7 +2131,7 @@ decorations. Some window managers may not honor these hints. | |||
| 2131 | NS builds consider the tool bar to be a decoration, and therefore hide | 2131 | NS builds consider the tool bar to be a decoration, and therefore hide |
| 2132 | it on an undecorated frame. | 2132 | it on an undecorated frame. |
| 2133 | 2133 | ||
| 2134 | @vindex override-redirect, a frame parameter | 2134 | @vindex override-redirect@r{, a frame parameter} |
| 2135 | @item override-redirect | 2135 | @item override-redirect |
| 2136 | @cindex override redirect frames | 2136 | @cindex override redirect frames |
| 2137 | If non-@code{nil}, this means that this is an @dfn{override redirect} | 2137 | If non-@code{nil}, this means that this is an @dfn{override redirect} |
| @@ -2142,7 +2142,7 @@ usually drawn on top of all other frames. Setting this parameter has | |||
| 2142 | no effect on MS-Windows. | 2142 | no effect on MS-Windows. |
| 2143 | 2143 | ||
| 2144 | @ignore | 2144 | @ignore |
| 2145 | @vindex parent-id, a frame parameter | 2145 | @vindex parent-id@r{, a frame parameter} |
| 2146 | @item parent-id | 2146 | @item parent-id |
| 2147 | @c ??? Not yet working. | 2147 | @c ??? Not yet working. |
| 2148 | The X window number of the window that should be the parent of this one. | 2148 | The X window number of the window that should be the parent of this one. |
| @@ -2151,7 +2151,7 @@ application's window. (It is not certain this will be implemented; try | |||
| 2151 | it and see if it works.) | 2151 | it and see if it works.) |
| 2152 | @end ignore | 2152 | @end ignore |
| 2153 | 2153 | ||
| 2154 | @vindex ns-appearance, a frame parameter | 2154 | @vindex ns-appearance@r{, a frame parameter} |
| 2155 | @item ns-appearance | 2155 | @item ns-appearance |
| 2156 | Only available on macOS, if set to @code{dark} draw this frame's | 2156 | Only available on macOS, if set to @code{dark} draw this frame's |
| 2157 | window-system window using the ``vibrant dark'' theme, otherwise use | 2157 | window-system window using the ``vibrant dark'' theme, otherwise use |
| @@ -2159,7 +2159,7 @@ the system default. The ``vibrant dark'' theme can be used to set the | |||
| 2159 | toolbar and scrollbars to a dark appearance when using an Emacs theme | 2159 | toolbar and scrollbars to a dark appearance when using an Emacs theme |
| 2160 | with a dark background. | 2160 | with a dark background. |
| 2161 | 2161 | ||
| 2162 | @vindex ns-transparent-titlebar, a frame parameter | 2162 | @vindex ns-transparent-titlebar@r{, a frame parameter} |
| 2163 | @item ns-transparent-titlebar | 2163 | @item ns-transparent-titlebar |
| 2164 | Only available on macOS, if non-@code{nil}, set the titlebar and | 2164 | Only available on macOS, if non-@code{nil}, set the titlebar and |
| 2165 | toolbar to be transparent. This effectively sets the background color | 2165 | toolbar to be transparent. This effectively sets the background color |
| @@ -2174,7 +2174,7 @@ of both to match the Emacs background color. | |||
| 2174 | This frame parameter controls the way the cursor looks. | 2174 | This frame parameter controls the way the cursor looks. |
| 2175 | 2175 | ||
| 2176 | @table @code | 2176 | @table @code |
| 2177 | @vindex cursor-type, a frame parameter | 2177 | @vindex cursor-type@r{, a frame parameter} |
| 2178 | @item cursor-type | 2178 | @item cursor-type |
| 2179 | How to display the cursor. Legitimate values are: | 2179 | How to display the cursor. Legitimate values are: |
| 2180 | 2180 | ||
| @@ -2252,7 +2252,7 @@ variable do not take effect immediately, only when you specify the | |||
| 2252 | These frame parameters control the use of fonts and colors. | 2252 | These frame parameters control the use of fonts and colors. |
| 2253 | 2253 | ||
| 2254 | @table @code | 2254 | @table @code |
| 2255 | @vindex font-backend, a frame parameter | 2255 | @vindex font-backend@r{, a frame parameter} |
| 2256 | @item font-backend | 2256 | @item font-backend |
| 2257 | A list of symbols, specifying the @dfn{font backends} to use for | 2257 | A list of symbols, specifying the @dfn{font backends} to use for |
| 2258 | drawing fonts in the frame, in order of priority. On X, there are | 2258 | drawing fonts in the frame, in order of priority. On X, there are |
| @@ -2263,12 +2263,12 @@ currently two available font backends: @code{gdi} and | |||
| 2263 | Manual}). On other systems, there is only one available font backend, | 2263 | Manual}). On other systems, there is only one available font backend, |
| 2264 | so it does not make sense to modify this frame parameter. | 2264 | so it does not make sense to modify this frame parameter. |
| 2265 | 2265 | ||
| 2266 | @vindex background-mode, a frame parameter | 2266 | @vindex background-mode@r{, a frame parameter} |
| 2267 | @item background-mode | 2267 | @item background-mode |
| 2268 | This parameter is either @code{dark} or @code{light}, according | 2268 | This parameter is either @code{dark} or @code{light}, according |
| 2269 | to whether the background color is a light one or a dark one. | 2269 | to whether the background color is a light one or a dark one. |
| 2270 | 2270 | ||
| 2271 | @vindex tty-color-mode, a frame parameter | 2271 | @vindex tty-color-mode@r{, a frame parameter} |
| 2272 | @item tty-color-mode | 2272 | @item tty-color-mode |
| 2273 | @cindex standard colors for character terminals | 2273 | @cindex standard colors for character terminals |
| 2274 | This parameter overrides the terminal's color support as given by the | 2274 | This parameter overrides the terminal's color support as given by the |
| @@ -2284,7 +2284,7 @@ If the parameter's value is a symbol, it specifies a number through | |||
| 2284 | the value of @code{tty-color-mode-alist}, and the associated number is | 2284 | the value of @code{tty-color-mode-alist}, and the associated number is |
| 2285 | used instead. | 2285 | used instead. |
| 2286 | 2286 | ||
| 2287 | @vindex screen-gamma, a frame parameter | 2287 | @vindex screen-gamma@r{, a frame parameter} |
| 2288 | @item screen-gamma | 2288 | @item screen-gamma |
| 2289 | @cindex gamma correction | 2289 | @cindex gamma correction |
| 2290 | If this is a number, Emacs performs gamma correction which adjusts | 2290 | If this is a number, Emacs performs gamma correction which adjusts |
| @@ -2304,7 +2304,7 @@ If your monitor displays colors too light, you should specify a | |||
| 2304 | that makes colors darker. A screen gamma value of 1.5 may give good | 2304 | that makes colors darker. A screen gamma value of 1.5 may give good |
| 2305 | results for LCD color displays. | 2305 | results for LCD color displays. |
| 2306 | 2306 | ||
| 2307 | @vindex alpha, a frame parameter | 2307 | @vindex alpha@r{, a frame parameter} |
| 2308 | @item alpha | 2308 | @item alpha |
| 2309 | @cindex opacity, frame | 2309 | @cindex opacity, frame |
| 2310 | @cindex transparency, frame | 2310 | @cindex transparency, frame |
| @@ -2335,45 +2335,45 @@ automatically equivalent to particular face attributes of particular | |||
| 2335 | faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): | 2335 | faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): |
| 2336 | 2336 | ||
| 2337 | @table @code | 2337 | @table @code |
| 2338 | @vindex font, a frame parameter | 2338 | @vindex font@r{, a frame parameter} |
| 2339 | @item font | 2339 | @item font |
| 2340 | The name of the font for displaying text in the frame. This is a | 2340 | The name of the font for displaying text in the frame. This is a |
| 2341 | string, either a valid font name for your system or the name of an Emacs | 2341 | string, either a valid font name for your system or the name of an Emacs |
| 2342 | fontset (@pxref{Fontsets}). It is equivalent to the @code{font} | 2342 | fontset (@pxref{Fontsets}). It is equivalent to the @code{font} |
| 2343 | attribute of the @code{default} face. | 2343 | attribute of the @code{default} face. |
| 2344 | 2344 | ||
| 2345 | @vindex foreground-color, a frame parameter | 2345 | @vindex foreground-color@r{, a frame parameter} |
| 2346 | @item foreground-color | 2346 | @item foreground-color |
| 2347 | The color to use for the image of a character. It is equivalent to | 2347 | The color to use for the image of a character. It is equivalent to |
| 2348 | the @code{:foreground} attribute of the @code{default} face. | 2348 | the @code{:foreground} attribute of the @code{default} face. |
| 2349 | 2349 | ||
| 2350 | @vindex background-color, a frame parameter | 2350 | @vindex background-color@r{, a frame parameter} |
| 2351 | @item background-color | 2351 | @item background-color |
| 2352 | The color to use for the background of characters. It is equivalent to | 2352 | The color to use for the background of characters. It is equivalent to |
| 2353 | the @code{:background} attribute of the @code{default} face. | 2353 | the @code{:background} attribute of the @code{default} face. |
| 2354 | 2354 | ||
| 2355 | @vindex mouse-color, a frame parameter | 2355 | @vindex mouse-color@r{, a frame parameter} |
| 2356 | @item mouse-color | 2356 | @item mouse-color |
| 2357 | The color for the mouse pointer. It is equivalent to the @code{:background} | 2357 | The color for the mouse pointer. It is equivalent to the @code{:background} |
| 2358 | attribute of the @code{mouse} face. | 2358 | attribute of the @code{mouse} face. |
| 2359 | 2359 | ||
| 2360 | @vindex cursor-color, a frame parameter | 2360 | @vindex cursor-color@r{, a frame parameter} |
| 2361 | @item cursor-color | 2361 | @item cursor-color |
| 2362 | The color for the cursor that shows point. It is equivalent to the | 2362 | The color for the cursor that shows point. It is equivalent to the |
| 2363 | @code{:background} attribute of the @code{cursor} face. | 2363 | @code{:background} attribute of the @code{cursor} face. |
| 2364 | 2364 | ||
| 2365 | @vindex border-color, a frame parameter | 2365 | @vindex border-color@r{, a frame parameter} |
| 2366 | @item border-color | 2366 | @item border-color |
| 2367 | The color for the border of the frame. It is equivalent to the | 2367 | The color for the border of the frame. It is equivalent to the |
| 2368 | @code{:background} attribute of the @code{border} face. | 2368 | @code{:background} attribute of the @code{border} face. |
| 2369 | 2369 | ||
| 2370 | @vindex scroll-bar-foreground, a frame parameter | 2370 | @vindex scroll-bar-foreground@r{, a frame parameter} |
| 2371 | @item scroll-bar-foreground | 2371 | @item scroll-bar-foreground |
| 2372 | If non-@code{nil}, the color for the foreground of scroll bars. It is | 2372 | If non-@code{nil}, the color for the foreground of scroll bars. It is |
| 2373 | equivalent to the @code{:foreground} attribute of the | 2373 | equivalent to the @code{:foreground} attribute of the |
| 2374 | @code{scroll-bar} face. | 2374 | @code{scroll-bar} face. |
| 2375 | 2375 | ||
| 2376 | @vindex scroll-bar-background, a frame parameter | 2376 | @vindex scroll-bar-background@r{, a frame parameter} |
| 2377 | @item scroll-bar-background | 2377 | @item scroll-bar-background |
| 2378 | If non-@code{nil}, the color for the background of scroll bars. It is | 2378 | If non-@code{nil}, the color for the background of scroll bars. It is |
| 2379 | equivalent to the @code{:background} attribute of the | 2379 | equivalent to the @code{:background} attribute of the |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 42be60449de..5dbdbdb9431 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -1301,7 +1301,7 @@ or rounding errors occur. | |||
| 1301 | @section Time Zone Rules | 1301 | @section Time Zone Rules |
| 1302 | @cindex time zone rules | 1302 | @cindex time zone rules |
| 1303 | 1303 | ||
| 1304 | @vindex TZ, environment variable | 1304 | @vindex TZ@r{, environment variable} |
| 1305 | The default time zone is determined by the @env{TZ} environment | 1305 | The default time zone is determined by the @env{TZ} environment |
| 1306 | variable. @xref{System Environment}. For example, you can tell Emacs | 1306 | variable. @xref{System Environment}. For example, you can tell Emacs |
| 1307 | to default to Universal Time with @code{(setenv "TZ" "UTC0")}. If | 1307 | to default to Universal Time with @code{(setenv "TZ" "UTC0")}. If |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 687d5971920..75651b99fde 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -5014,43 +5014,43 @@ code: | |||
| 5014 | 5014 | ||
| 5015 | @table @code | 5015 | @table @code |
| 5016 | @item delete-window | 5016 | @item delete-window |
| 5017 | @vindex delete-window, a window parameter | 5017 | @vindex delete-window@r{, a window parameter} |
| 5018 | This parameter affects the execution of @code{delete-window} | 5018 | This parameter affects the execution of @code{delete-window} |
| 5019 | (@pxref{Deleting Windows}). | 5019 | (@pxref{Deleting Windows}). |
| 5020 | 5020 | ||
| 5021 | @item delete-other-windows | 5021 | @item delete-other-windows |
| 5022 | @vindex delete-other-windows, a window parameter | 5022 | @vindex delete-other-windows@r{, a window parameter} |
| 5023 | This parameter affects the execution of @code{delete-other-windows} | 5023 | This parameter affects the execution of @code{delete-other-windows} |
| 5024 | (@pxref{Deleting Windows}). | 5024 | (@pxref{Deleting Windows}). |
| 5025 | 5025 | ||
| 5026 | @item no-delete-other-windows | 5026 | @item no-delete-other-windows |
| 5027 | @vindex no-delete-other-windows, a window parameter | 5027 | @vindex no-delete-other-windows@r{, a window parameter} |
| 5028 | This parameter marks the window as not deletable by | 5028 | This parameter marks the window as not deletable by |
| 5029 | @code{delete-other-windows} (@pxref{Deleting Windows}). | 5029 | @code{delete-other-windows} (@pxref{Deleting Windows}). |
| 5030 | 5030 | ||
| 5031 | @item split-window | 5031 | @item split-window |
| 5032 | @vindex split-window, a window parameter | 5032 | @vindex split-window@r{, a window parameter} |
| 5033 | This parameter affects the execution of @code{split-window} | 5033 | This parameter affects the execution of @code{split-window} |
| 5034 | (@pxref{Splitting Windows}). | 5034 | (@pxref{Splitting Windows}). |
| 5035 | 5035 | ||
| 5036 | @item other-window | 5036 | @item other-window |
| 5037 | @vindex other-window, a window parameter | 5037 | @vindex other-window@r{, a window parameter} |
| 5038 | This parameter affects the execution of @code{other-window} | 5038 | This parameter affects the execution of @code{other-window} |
| 5039 | (@pxref{Cyclic Window Ordering}). | 5039 | (@pxref{Cyclic Window Ordering}). |
| 5040 | 5040 | ||
| 5041 | @item no-other-window | 5041 | @item no-other-window |
| 5042 | @vindex no-other-window, a window parameter | 5042 | @vindex no-other-window@r{, a window parameter} |
| 5043 | This parameter marks the window as not selectable by @code{other-window} | 5043 | This parameter marks the window as not selectable by @code{other-window} |
| 5044 | (@pxref{Cyclic Window Ordering}). | 5044 | (@pxref{Cyclic Window Ordering}). |
| 5045 | 5045 | ||
| 5046 | @item clone-of | 5046 | @item clone-of |
| 5047 | @vindex clone-of, a window parameter | 5047 | @vindex clone-of@r{, a window parameter} |
| 5048 | This parameter specifies the window that this one has been cloned | 5048 | This parameter specifies the window that this one has been cloned |
| 5049 | from. It is installed by @code{window-state-get} (@pxref{Window | 5049 | from. It is installed by @code{window-state-get} (@pxref{Window |
| 5050 | Configurations}). | 5050 | Configurations}). |
| 5051 | 5051 | ||
| 5052 | @item window-preserved-size | 5052 | @item window-preserved-size |
| 5053 | @vindex window-preserved-size, a window parameter | 5053 | @vindex window-preserved-size@r{, a window parameter} |
| 5054 | This parameter specifies a buffer, a direction where @code{nil} means | 5054 | This parameter specifies a buffer, a direction where @code{nil} means |
| 5055 | vertical and @code{t} horizontal, and a size in pixels. If this window | 5055 | vertical and @code{t} horizontal, and a size in pixels. If this window |
| 5056 | displays the specified buffer and its size in the indicated direction | 5056 | displays the specified buffer and its size in the indicated direction |
| @@ -5060,7 +5060,7 @@ parameter is installed and updated by the function | |||
| 5060 | @code{window-preserve-size} (@pxref{Preserving Window Sizes}). | 5060 | @code{window-preserve-size} (@pxref{Preserving Window Sizes}). |
| 5061 | 5061 | ||
| 5062 | @item quit-restore | 5062 | @item quit-restore |
| 5063 | @vindex quit-restore, a window parameter | 5063 | @vindex quit-restore@r{, a window parameter} |
| 5064 | This parameter is installed by the buffer display functions | 5064 | This parameter is installed by the buffer display functions |
| 5065 | (@pxref{Choosing Window}) and consulted by @code{quit-restore-window} | 5065 | (@pxref{Choosing Window}) and consulted by @code{quit-restore-window} |
| 5066 | (@pxref{Quitting Windows}). It contains four elements: | 5066 | (@pxref{Quitting Windows}). It contains four elements: |
| @@ -5092,18 +5092,18 @@ See the description of @code{quit-restore-window} in @ref{Quitting | |||
| 5092 | Windows} for details. | 5092 | Windows} for details. |
| 5093 | 5093 | ||
| 5094 | @item window-side window-slot | 5094 | @item window-side window-slot |
| 5095 | @vindex window-side, a window parameter | 5095 | @vindex window-side@r{, a window parameter} |
| 5096 | @vindex window-slot, a window parameter | 5096 | @vindex window-slot@r{, a window parameter} |
| 5097 | These parameters are used for implementing side windows (@pxref{Side | 5097 | These parameters are used for implementing side windows (@pxref{Side |
| 5098 | Windows}). | 5098 | Windows}). |
| 5099 | 5099 | ||
| 5100 | @item window-atom | 5100 | @item window-atom |
| 5101 | @vindex window-atom, a window parameter | 5101 | @vindex window-atom@r{, a window parameter} |
| 5102 | This parameter is used for implementing atomic windows, see @ref{Atomic | 5102 | This parameter is used for implementing atomic windows, see @ref{Atomic |
| 5103 | Windows}. | 5103 | Windows}. |
| 5104 | 5104 | ||
| 5105 | @item mode-line-format | 5105 | @item mode-line-format |
| 5106 | @vindex mode-line-format, a window parameter | 5106 | @vindex mode-line-format@r{, a window parameter} |
| 5107 | This parameter replaces the value of the buffer-local variable | 5107 | This parameter replaces the value of the buffer-local variable |
| 5108 | @code{mode-line-format} (@pxref{Mode Line Basics}) of this window's | 5108 | @code{mode-line-format} (@pxref{Mode Line Basics}) of this window's |
| 5109 | buffer whenever this window is displayed. The symbol @code{none} means | 5109 | buffer whenever this window is displayed. The symbol @code{none} means |
| @@ -5112,7 +5112,7 @@ contents of the mode line on other windows showing this buffer are not | |||
| 5112 | affected. | 5112 | affected. |
| 5113 | 5113 | ||
| 5114 | @item header-line-format | 5114 | @item header-line-format |
| 5115 | @vindex header-line-format, a window parameter | 5115 | @vindex header-line-format@r{, a window parameter} |
| 5116 | This parameter replaces the value of the buffer-local variable | 5116 | This parameter replaces the value of the buffer-local variable |
| 5117 | @code{header-line-format} (@pxref{Mode Line Basics}) of this window's | 5117 | @code{header-line-format} (@pxref{Mode Line Basics}) of this window's |
| 5118 | buffer whenever this window is displayed. The symbol @code{none} means | 5118 | buffer whenever this window is displayed. The symbol @code{none} means |
| @@ -5121,7 +5121,7 @@ contents of the header line on other windows showing this buffer are not | |||
| 5121 | affected. | 5121 | affected. |
| 5122 | 5122 | ||
| 5123 | @item min-margins | 5123 | @item min-margins |
| 5124 | @vindex min-margins, a window parameter | 5124 | @vindex min-margins@r{, a window parameter} |
| 5125 | The value of this parameter is a cons cell whose @sc{car} and @sc{cdr}, | 5125 | The value of this parameter is a cons cell whose @sc{car} and @sc{cdr}, |
| 5126 | if non-@code{nil}, specify the minimum values (in columns) for the left | 5126 | if non-@code{nil}, specify the minimum values (in columns) for the left |
| 5127 | and right margin of this window. When present, Emacs will use these | 5127 | and right margin of this window. When present, Emacs will use these |