aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/frames.texi50
-rw-r--r--doc/lispref/display.texi76
-rw-r--r--doc/lispref/elisp.texi1
-rw-r--r--doc/lispref/text.texi5
-rw-r--r--doc/misc/efaq.texi15
-rw-r--r--doc/misc/texinfo.tex70
6 files changed, 187 insertions, 30 deletions
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 35b3f83ab33..383ae7fd6ee 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1152,11 +1152,11 @@ change the variable @code{x-gtk-file-dialog-help-text} to @code{nil}.
1152@section Tooltips 1152@section Tooltips
1153@cindex tooltips 1153@cindex tooltips
1154 1154
1155 @dfn{Tooltips} are small windows that display text information at 1155 @dfn{Tooltips} are small special frames that display text
1156the current mouse position. They activate when there is a pause in 1156information at the current mouse position. They activate when there
1157mouse movement over some significant piece of text in a window, or the 1157is a pause in mouse movement over some significant piece of text in a
1158mode line, or some other part of the Emacs frame such as a tool bar 1158window, or the mode line, or some other part of the Emacs frame such
1159button or menu item. 1159as a tool bar button or menu item.
1160 1160
1161@findex tooltip-mode 1161@findex tooltip-mode
1162 You can toggle the use of tooltips with the command @kbd{M-x 1162 You can toggle the use of tooltips with the command @kbd{M-x
@@ -1164,11 +1164,41 @@ tooltip-mode}. When Tooltip mode is disabled, the help text is
1164displayed in the echo area instead. To control the use of tooltips at 1164displayed in the echo area instead. To control the use of tooltips at
1165startup, customize the variable @code{tooltip-mode}. 1165startup, customize the variable @code{tooltip-mode}.
1166 1166
1167@vindex tooltip-delay 1167The following variables provide customization options for tooltip
1168 The variables @code{tooltip-delay} specifies how long Emacs should 1168display:
1169wait before displaying a tooltip. For additional customization 1169
1170options for displaying tooltips, use @kbd{M-x customize-group 1170@vtable @code
1171@key{RET} tooltip @key{RET}}. 1171@item tooltip-delay
1172This variable specifies how long Emacs should wait before displaying
1173the first tooltip. The value is in seconds.
1174
1175@item tooltip-short-delay
1176This variable specifies how long Emacs should wait before displaying
1177subsequent tooltips on different items, having already displayed the
1178first tooltip. The value is in seconds.
1179
1180@item tooltip-hide-delay
1181The number of seconds since displaying a tooltip to hide it, if the
1182mouse doesn't move.
1183
1184@item tooltip-x-offset
1185@itemx tooltip-y-offset
1186The X and Y offsets, in pixels, of the left top corner of the tooltip
1187from the mouse pointer position. Note that these are ignored if
1188@code{tooltip-frame-parameters} was customized to include,
1189respectively, the @code{left} and @code{top} parameters. The values
1190of the offsets should be chosen so that the tooltip doesn't cover the
1191mouse pointer's hot spot, or it might interfere with clicking the
1192mouse.
1193
1194@item tooltip-frame-parameters
1195The frame parameters used for displaying tooltips. @xref{Frame
1196Parameters,,, elisp, The Emacs Lisp Reference Manual}, and also
1197@ref{Tooltips,,, elisp, The Emacs Lisp Reference Manual}.
1198@end vtable
1199
1200For additional customization options for displaying tooltips, use
1201@kbd{M-x customize-group @key{RET} tooltip @key{RET}}.
1172 1202
1173@vindex x-gtk-use-system-tooltips 1203@vindex x-gtk-use-system-tooltips
1174 If Emacs is built with GTK+ support, it displays tooltips via GTK+, 1204 If Emacs is built with GTK+ support, it displays tooltips via GTK+,
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 1e45501482c..3cd1d4edf1c 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -34,6 +34,7 @@ that Emacs presents to the user.
34* Character Display:: How Emacs displays individual characters. 34* Character Display:: How Emacs displays individual characters.
35* Beeping:: Audible signal to the user. 35* Beeping:: Audible signal to the user.
36* Window Systems:: Which window system is being used. 36* Window Systems:: Which window system is being used.
37* Tooltips:: Tooltip display in Emacs.
37* Bidirectional Display:: Display of bidirectional scripts, such as 38* Bidirectional Display:: Display of bidirectional scripts, such as
38 Arabic and Farsi. 39 Arabic and Farsi.
39@end menu 40@end menu
@@ -7131,6 +7132,81 @@ indicator of Emacs capabilities on a given display type. Instead, use
7131@code{display-graphic-p} or any of the other @code{display-*-p} 7132@code{display-graphic-p} or any of the other @code{display-*-p}
7132predicates described in @ref{Display Feature Testing}. 7133predicates described in @ref{Display Feature Testing}.
7133 7134
7135@node Tooltips
7136@section Tooltips
7137@cindex tooltips
7138@dfn{Tooltips} are special frames (@pxref{Frames}) that are used to
7139display helpful hints (a.k.a.@: ``tips'') related to the current
7140position of the mouse pointer. Emacs uses tooltips to display help
7141strings about active portions of text (@pxref{Special Properties}) and
7142about various UI elements, such as menu items (@pxref{Extended Menu
7143Items}) and tool-bar buttons (@pxref{Tool Bar}).
7144
7145@defun tooltip-mode
7146Tooltip Mode is a minor mode that enables display of tooltips.
7147Turning off this mode causes the tooltips be displayed in the echo
7148area. On text-mode (a.k.a.@: ``TTY'') frames, tooltips are always
7149displayed in the echo area.
7150@end defun
7151
7152@vindex x-gtk-use-system-tooltips
7153When Emacs is built with GTK+ support, it by default displays tooltips
7154using GTK+ functions, and the appearance of the tooltips is then
7155controlled by GTK+ settings. GTK+ tooltips can be disabled by
7156changing the value of the variable @code{x-gtk-use-system-tooltips} to
7157@code{nil}. The rest of this subsection describes how to control
7158non-GTK+ tooltips, which are presented by Emacs itself.
7159
7160Since tooltips are special frames, they have their frame parameters
7161(@pxref{Frame Parameters}). Unlike other frames, the frame parameters
7162for tooltips are stored in a special variable.
7163
7164@defvar tooltip-frame-parameters
7165This customizable option holds the frame parameters used for
7166displaying tooltips. Any font and color parameters are ignored, and
7167the corresponding attributes of the @code{tooltip} face are used
7168instead. If @code{left} or @code{top} parameters are included, they
7169are used as absolute frame-relative coordinates where the tooltip
7170should be shown. (Mouse-relative position of the tooltip can be
7171customized using the variables described in @ref{Tooltips,,, emacs,
7172The GNU Emacs Manual}.) Note that the @code{left} and @code{top}
7173parameters, if present, override the values of mouse-relative offsets.
7174@end defvar
7175
7176@vindex tooltip@r{ face}
7177The @code{tooltip} face determines the appearance of text shown in
7178tooltips. It should generally use a variable-pitch font of size that
7179is preferably smaller than the default frame font.
7180
7181@findex tooltip-help-tips
7182@defvar tooltip-functions
7183This abnormal hook is a list of functions to call when Emacs needs to
7184display a tooltip. Each function is called with a single argument
7185@var{event} which is a copy of the last mouse movement event. If a
7186function on this list actually displays the tooltip, it should return
7187non-@code{nil}, and then the rest of the functions will not be
7188called. The default value of this variable is a single function
7189@code{tooltip-help-tips}.
7190@end defvar
7191
7192If you write your own function to be put on the
7193@code{tooltip-functions} list, you may need to know the buffer of the
7194mouse event that triggered the tooltip display. The following
7195function provides that information.
7196
7197@defun tooltip-event-buffer event
7198This function returns the buffer over which @var{event} occurred.
7199Call it with the argument of the function from
7200@code{tooltip-functions} to obtain the buffer whose text triggered the
7201tooltip. Note that the event might occur not over a buffer (e.g.,
7202over the tool bar), in which case this function will return
7203@code{nil}.
7204@end defun
7205
7206Other aspects of tooltip display are controlled by several
7207customizable settings; see @ref{Tooltips,,, emacs, The GNU Emacs
7208Manual}.
7209
7134@node Bidirectional Display 7210@node Bidirectional Display
7135@section Bidirectional Display 7211@section Bidirectional Display
7136@cindex bidirectional display 7212@cindex bidirectional display
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi
index 4c1541e98c6..a3bff0b07ac 100644
--- a/doc/lispref/elisp.texi
+++ b/doc/lispref/elisp.texi
@@ -1380,6 +1380,7 @@ Emacs Display
1380* Character Display:: How Emacs displays individual characters. 1380* Character Display:: How Emacs displays individual characters.
1381* Beeping:: Audible signal to the user. 1381* Beeping:: Audible signal to the user.
1382* Window Systems:: Which window system is being used. 1382* Window Systems:: Which window system is being used.
1383* Tooltips:: Tooltip display in Emacs.
1383* Bidirectional Display:: Display of bidirectional scripts, such as 1384* Bidirectional Display:: Display of bidirectional scripts, such as
1384 Arabic and Farsi. 1385 Arabic and Farsi.
1385 1386
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 55f02904fa1..991b47d20b4 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -3279,12 +3279,11 @@ or shorter, higher or lower, wider or narrow, or replaced with an image.
3279 3279
3280@item help-echo 3280@item help-echo
3281@kindex help-echo @r{(text property)} 3281@kindex help-echo @r{(text property)}
3282@cindex tooltip 3282@cindex tooltip for help strings
3283@anchor{Text help-echo} 3283@anchor{Text help-echo}
3284If text has a string as its @code{help-echo} property, then when you 3284If text has a string as its @code{help-echo} property, then when you
3285move the mouse onto that text, Emacs displays that string in the echo 3285move the mouse onto that text, Emacs displays that string in the echo
3286area, or in the tooltip window (@pxref{Tooltips,,, emacs, The GNU Emacs 3286area, or in the tooltip window (@pxref{Tooltips}).
3287Manual}).
3288 3287
3289If the value of the @code{help-echo} property is a function, that 3288If the value of the @code{help-echo} property is a function, that
3290function is called with three arguments, @var{window}, @var{object} and 3289function is called with three arguments, @var{window}, @var{object} and
diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi
index 5008db31f25..1fa46492080 100644
--- a/doc/misc/efaq.texi
+++ b/doc/misc/efaq.texi
@@ -2664,11 +2664,6 @@ by typing @kbd{M-x ansi-color-for-comint-mode} in the Shell buffer, or
2664by adding @code{(add-hook 'shell-mode-hook 2664by adding @code{(add-hook 'shell-mode-hook
2665'ansi-color-for-comint-mode-on)} to your init file. 2665'ansi-color-for-comint-mode-on)} to your init file.
2666 2666
2667In Emacs versions before 21.1, the @code{ansi-color} package is not
2668included. In that case, you need to unalias @code{ls} for interactive
2669shells running in Emacs; this can be done by checking the @code{EMACS}
2670variable in the environment.
2671
2672@node Fullscreen mode on MS-Windows 2667@node Fullscreen mode on MS-Windows
2673@section How can I start Emacs in fullscreen mode on MS-Windows? 2668@section How can I start Emacs in fullscreen mode on MS-Windows?
2674@cindex Maximize frame 2669@cindex Maximize frame
@@ -2757,11 +2752,9 @@ For @code{tcsh}, put this in your @file{.cshrc} (or @file{.tcshrc})
2757file: 2752file:
2758 2753
2759@example 2754@example
2760if ($?EMACS) then 2755if ($?INSIDE_EMACS && $?tcsh)
2761 if ("$EMACS" =~ /*) then 2756 unset edit
2762 if ($?tcsh) unset edit 2757 stty -icrnl -onlcr -echo susp ^Z
2763 stty nl
2764 endif
2765endif 2758endif
2766@end example 2759@end example
2767 2760
@@ -2769,7 +2762,7 @@ Or put this in your @file{.emacs_tcsh} or @file{~/.emacs.d/init_tcsh.sh} file:
2769 2762
2770@example 2763@example
2771unset edit 2764unset edit
2772stty nl 2765stty -icrnl -onlcr -echo susp ^Z
2773@end example 2766@end example
2774 2767
2775Alternatively, use @code{csh} in your shell buffers instead of 2768Alternatively, use @code{csh} in your shell buffers instead of
diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex
index 75017af5035..d164d451b89 100644
--- a/doc/misc/texinfo.tex
+++ b/doc/misc/texinfo.tex
@@ -3,7 +3,7 @@
3% Load plain if necessary, i.e., if running under initex. 3% Load plain if necessary, i.e., if running under initex.
4\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi 4\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5% 5%
6\def\texinfoversion{2016-03-25.17} 6\def\texinfoversion{2016-03-29.15}
7% 7%
8% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, 8% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
@@ -1550,8 +1550,7 @@ output) for that.)}
1550 \fi 1550 \fi
1551 \turnoffactive 1551 \turnoffactive
1552 \makevalueexpandable 1552 \makevalueexpandable
1553 % In the case of XeTeX, xdvipdfmx converts strings to UTF-16. 1553 \txiescapepdf\pdfdestname
1554 % Therefore \txiescapepdf is not necessary.
1555 \safewhatsit{\pdfdest name{\pdfdestname} xyz}% 1554 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1556 }} 1555 }}
1557 % 1556 %
@@ -1566,9 +1565,12 @@ output) for that.)}
1566 \fi 1565 \fi
1567 { 1566 {
1568 \turnoffactive 1567 \turnoffactive
1569 % In the case of XeTeX, xdvipdfmx converts strings to UTF-16. 1568 \txiescapepdf\pdfoutlinedest
1570 % Therefore \txiescapepdf is not necessary. 1569 \edef\pdfoutlinetext{#1}%
1571 \special{pdf:out [-] #2 << /Title (#1) /A << /S /GoTo /D (name\pdfoutlinedest) >> >> }% 1570 \txiescapepdf\pdfoutlinetext
1571 %
1572 \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1573 << /S /GoTo /D (name\pdfoutlinedest) >> >> }%
1572 } 1574 }
1573 } 1575 }
1574 % 1576 %
@@ -1624,6 +1626,20 @@ output) for that.)}
1624 % ``\special{pdf:dest ...}'' can not handle non-ASCII strings. 1626 % ``\special{pdf:dest ...}'' can not handle non-ASCII strings.
1625 % It fixed by xdvipdfmx 20160106 (TeX Live SVN r39753). 1627 % It fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1626% 1628%
1629 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1630 \ifx\PP\D\let\nextsp\relax
1631 \else\let\nextsp\skipspaces
1632 \addtokens{\filename}{\PP}%
1633 \advance\filenamelength by 1
1634 \fi
1635 \nextsp}
1636 \def\getfilename#1{%
1637 \filenamelength=0
1638 % If we don't expand the argument now, \skipspaces will get
1639 % snagged on things like "@value{foo}".
1640 \edef\temp{#1}%
1641 \expandafter\skipspaces\temp|\relax
1642 }
1627 % make a live url in pdf output. 1643 % make a live url in pdf output.
1628 \def\pdfurl#1{% 1644 \def\pdfurl#1{%
1629 \begingroup 1645 \begingroup
@@ -8760,6 +8776,7 @@ end
8760 % 8776 %
8761 % Make link in pdf output. 8777 % Make link in pdf output.
8762 \ifpdf 8778 \ifpdf
8779 % For pdfTeX and LuaTeX
8763 {\indexnofonts 8780 {\indexnofonts
8764 \turnoffactive 8781 \turnoffactive
8765 \makevalueexpandable 8782 \makevalueexpandable
@@ -8786,6 +8803,47 @@ end
8786 \fi 8803 \fi
8787 }% 8804 }%
8788 \setcolor{\linkcolor}% 8805 \setcolor{\linkcolor}%
8806 \else
8807 \ifx\XeTeXrevision\thisisundefined
8808 \else
8809 % For XeTeX
8810 {\indexnofonts
8811 \turnoffactive
8812 \makevalueexpandable
8813 % This expands tokens, so do it after making catcode changes, so _
8814 % etc. don't get their TeX definitions. This ignores all spaces in
8815 % #4, including (wrongly) those in the middle of the filename.
8816 \getfilename{#4}%
8817 %
8818 % This (wrongly) does not take account of leading or trailing
8819 % spaces in #1, which should be ignored.
8820 \iftxiuseunicodedestname
8821 \def\pdfxrefdest{#1}% Pass through Unicode characters.
8822 \else
8823 \edef\pdfxrefdest{#1}% Replace Unicode characters to ASCII.
8824 \fi
8825 \ifx\pdfxrefdest\empty
8826 \def\pdfxrefdest{Top}% no empty targets
8827 \else
8828 \txiescapepdf\pdfxrefdest % escape PDF special chars
8829 \fi
8830 %
8831 \leavevmode
8832 \ifnum\filenamelength>0
8833 % By the default settings,
8834 % XeTeX (xdvipdfmx) replaces link destination names with integers.
8835 % In this case, the replaced destination names of
8836 % remote PDF cannot be known. In order to avoid replacement,
8837 % you can use commandline option `-C 0x0010' for xdvipdfmx.
8838 \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8839 << /S /GoToR /F (\the\filename.pdf) /D (name\pdfxrefdest) >> >>}%
8840 \else
8841 \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8842 << /S /GoTo /D (name\pdfxrefdest) >> >>}%
8843 \fi
8844 }%
8845 \setcolor{\linkcolor}%
8846 \fi
8789 \fi 8847 \fi
8790 {% 8848 {%
8791 % Have to otherify everything special to allow the \csname to 8849 % Have to otherify everything special to allow the \csname to