aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorPaul Eggert2017-11-02 21:01:44 -0700
committerPaul Eggert2017-11-02 21:01:44 -0700
commit1441eb76fd08572c25e0128c247cc1a628a79ff2 (patch)
treeaaa9a86485836a33618d258a55d8cdbe6082c91a /doc/lispref
parent3ca4a3c8d40ea89ed717e0673fa85f5c1ac851ed (diff)
parent460fe4a1bc40f2ba39deda6448a7baf57e0e6b76 (diff)
downloademacs-1441eb76fd08572c25e0128c247cc1a628a79ff2.tar.gz
emacs-1441eb76fd08572c25e0128c247cc1a628a79ff2.zip
Merge from origin/emacs-26
460fe4a1bc ; Doc fixes 41adf3281e Avoid duplicate calls to xfree for the same pointer 3e7ebbe1bd Don't clobber docstrings of explicitly-defined mode hook v... 9c8fe0248b Avoid fullscreen ediff control frames by default (Bug#29026) 7d32176acc Fix the bug#24034 change (revno 9eb028f) causing infloop (... ee493663ba Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/e... ca5eb0d0b7 Fix a typo in the ELisp manual d10c9479ca Fix doc and doc-strings for minibuffer window related func... 18331d00da Fix "Args out of range" error in c-determine-limit. Fixes... edde35e6f8 * lisp/progmodes/perl-mode.el: Fix electric indentation wi... 056587c45f Extend mhtml submode region when in comment 4c4ad80848 Fix mthml submode lighting at end of buffer 557e252aa2 Remember more variables in mhtml-mode 336cd0a11a ; * lisp/select.el (select-enable-primary): Add missing pe... 134099bc90 ; * etc/NEWS (EUDC): Mark as not requiring documentation. 1a340274bf * etc/NEWS (EUDC): Deprecate BBDB 2.x backward compatibility. 4189d0ef7b Fix minibuffer window related docs and strings (Bug#28978) 2ebdde6e9c Add ChkTeX flymake backend for latex-mode 5b59841791 Fix doc typos 82a16c547b Fix some duplicate word typos 266888b1d7 * doc/lispref/commands.texi (Adjusting Point): Fix wording... 00c3c6d88d Avoid segfaults in 64-bit Windows builds a8e6741066 Fix conversion of pixel coordinates to buffer position d43b486f6c Fix doc strings in desktop.el 9102fb603e Add Index to ERT manual 68182a4710 Make manuals and NEWS consistent 451823b0e5 Don't allow (minibuffer-window-active-p nil) to return t cc8f72ca22 Clarify obsolescence message for 'whitespace-tab' 50f711e7fa Fix some duplicate words typos 8bd9524a7c * lisp/button.el (button-activate): Fix doc typo. 0b0d91e60a * lisp/calendar/todo-mode.el (todo-toggle-mark-item): Fix ... e6b4e5ffdf Fix some doc typos e8636ac8cc Fix startup display on Cygwin 3926c5ad83 * src/fileio.c (Fset_default_file_modes): Fix typo in doc ... 9715317dfd * lisp/dired.el (dired-find-alternate-file): Doc fix. (Bu... 9e442a001a Improve documentation of how faces are applied to display ... 1bda71ec3b Improve pixel-scroll-mode 196106d37d Support Certification Authority Authorization in dns-mode.el ec08d70b4f Improve documentation of set-default-file-modes # Conflicts: # etc/NEWS
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/commands.texi10
-rw-r--r--doc/lispref/display.texi21
-rw-r--r--doc/lispref/files.texi4
-rw-r--r--doc/lispref/frames.texi11
-rw-r--r--doc/lispref/functions.texi6
-rw-r--r--doc/lispref/minibuf.texi78
-rw-r--r--doc/lispref/os.texi2
7 files changed, 82 insertions, 50 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index ff790e6304f..16b58d3d3c8 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -1005,11 +1005,11 @@ If the last event came from a keyboard macro, the value is @code{macro}.
1005@cindex @code{display} property, and point display 1005@cindex @code{display} property, and point display
1006@cindex @code{composition} property, and point display 1006@cindex @code{composition} property, and point display
1007 1007
1008 It is not easy to display a value of point in the middle of a 1008 Emacs cannot display the cursor when point is in the middle of a
1009sequence of text that has the @code{display}, @code{composition} or 1009sequence of text that has the @code{display} or @code{composition}
1010is invisible. Therefore, after a command finishes and returns to the 1010property, or is invisible. Therefore, after a command finishes and
1011command loop, if point is within such a sequence, the command loop 1011returns to the command loop, if point is within such a sequence, the
1012normally moves point to the edge of the sequence. 1012command loop normally moves point to the edge of the sequence.
1013 1013
1014 A command can inhibit this feature by setting the variable 1014 A command can inhibit this feature by setting the variable
1015@code{disable-point-adjustment}: 1015@code{disable-point-adjustment}:
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 17126ce72b9..a505639f514 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -807,7 +807,7 @@ mechanism can change the variable @code{delayed-warnings-hook}:
807 807
808@defvar delayed-warnings-hook 808@defvar delayed-warnings-hook
809This is a normal hook which is run by the Emacs command loop, after 809This is a normal hook which is run by the Emacs command loop, after
810@code{post-command-hook}, in order to to process and display delayed 810@code{post-command-hook}, in order to process and display delayed
811warnings. 811warnings.
812 812
813Its default value is a list of two functions: 813Its default value is a list of two functions:
@@ -2887,6 +2887,16 @@ non-selected window, Emacs applies the @code{mode-line-inactive} face.
2887For a header line, Emacs applies the @code{header-line} face. 2887For a header line, Emacs applies the @code{header-line} face.
2888 2888
2889@item 2889@item
2890If the text comes from an overlay string via @code{before-string} or
2891@code{after-string} properties (@pxref{Overlay Properties}), or from a
2892display string (@pxref{Other Display Specs}), and the string doesn't
2893contain a @code{face} or @code{mouse-face} property, but the buffer
2894text affected by the overlay/display property does define a face,
2895Emacs applies the face attributes of the ``underlying'' buffer text.
2896Note that this is so even if the overlay or display string is
2897displayed in the display margins (@pxref{Display Margins}).
2898
2899@item
2890If any given attribute has not been specified during the preceding 2900If any given attribute has not been specified during the preceding
2891steps, Emacs applies the attribute of the @code{default} face. 2901steps, Emacs applies the attribute of the @code{default} face.
2892@end itemize 2902@end itemize
@@ -4853,6 +4863,13 @@ certain buffer text, without altering or preventing the display of
4853that text, put a @code{before-string} property on the text and put the 4863that text, put a @code{before-string} property on the text and put the
4854margin display specification on the contents of the before-string. 4864margin display specification on the contents of the before-string.
4855 4865
4866 Note that if the string to be displayed in the margin doesn't
4867specify a face, its face is determined using the same rules and
4868priorities as it is for strings displayed in the text area
4869(@pxref{Displaying Faces}). If this results in undesirable
4870``leaking'' of faces into the margin, make sure the string has an
4871explicit face specified for it.
4872
4856 Before the display margins can display anything, you must give 4873 Before the display margins can display anything, you must give
4857them a nonzero width. The usual way to do that is to set these 4874them a nonzero width. The usual way to do that is to set these
4858variables: 4875variables:
@@ -7488,7 +7505,7 @@ and are continued or truncated at the left margin.
7488@cindex paragraph-separate, and bidirectional display 7505@cindex paragraph-separate, and bidirectional display
7489 Where exactly paragraphs start and end, for the purpose of the Emacs 7506 Where exactly paragraphs start and end, for the purpose of the Emacs
7490@acronym{UBA} implementation, is determined by the following two 7507@acronym{UBA} implementation, is determined by the following two
7491buffer-local variables (note that that @code{paragraph-start} and 7508buffer-local variables (note that @code{paragraph-start} and
7492@code{paragraph-separate} have no influence on this). By default both 7509@code{paragraph-separate} have no influence on this). By default both
7493of these variables are @code{nil}, and paragraphs are bounded by empty 7510of these variables are @code{nil}, and paragraphs are bounded by empty
7494lines, i.e., lines that consist entirely of zero or more whitespace 7511lines, i.e., lines that consist entirely of zero or more whitespace
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index 0f0ce157cad..b257c328f4d 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1821,7 +1821,9 @@ has these permissions, or a subset of them (@code{write-region} will
1821not grant execute permissions even if the default file permissions 1821not grant execute permissions even if the default file permissions
1822allow execution). On GNU and other POSIX-like systems, the default 1822allow execution). On GNU and other POSIX-like systems, the default
1823permissions are given by the bitwise complement of the @samp{umask} 1823permissions are given by the bitwise complement of the @samp{umask}
1824value. 1824value, i.e.@: each bit that is set in the argument @var{mode} will be
1825@emph{reset} in the default permissions with which Emacs creates
1826files.
1825 1827
1826The argument @var{mode} should be an integer which specifies the 1828The argument @var{mode} should be an integer which specifies the
1827permissions, similar to @code{set-file-modes} above. Only the lowest 1829permissions, similar to @code{set-file-modes} above. Only the lowest
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index ad853418ac4..5ea7125882f 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -1850,8 +1850,14 @@ yes, @code{nil} means no, @code{only} means this frame is just a
1850minibuffer. If the value is a minibuffer window (in some other 1850minibuffer. If the value is a minibuffer window (in some other
1851frame), the frame uses that minibuffer. 1851frame), the frame uses that minibuffer.
1852 1852
1853This frame parameter takes effect when the frame is created, and can 1853This parameter takes effect when the frame is created. If specified as
1854not be changed afterwards. 1854@code{nil}, Emacs will try to set it to the minibuffer window of
1855@code{default-minibuffer-frame} (@pxref{Minibuffers and Frames}). For
1856an existing frame, this parameter can be used exclusively to specify
1857another minibuffer window. It is not allowed to change it from a
1858minibuffer window to @code{t} and vice-versa, or from @code{t} to
1859@code{nil}. If the parameter specifies a minibuffer window already,
1860setting it to @code{nil} has no effect.
1855 1861
1856@vindex buffer-predicate, a frame parameter 1862@vindex buffer-predicate, a frame parameter
1857@item buffer-predicate 1863@item buffer-predicate
@@ -1872,6 +1878,7 @@ most-recently-selected first.
1872If non-@code{nil}, this frame's window is never split automatically. 1878If non-@code{nil}, this frame's window is never split automatically.
1873@end table 1879@end table
1874 1880
1881
1875@node Frame Interaction Parameters 1882@node Frame Interaction Parameters
1876@subsubsection Frame Interaction Parameters 1883@subsubsection Frame Interaction Parameters
1877@cindex frame interaction parameters 1884@cindex frame interaction parameters
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 116c2990ba2..466a12f7a48 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -712,7 +712,7 @@ the backquote (@pxref{Backquote}), but quotes code and accepts only
712@end defmac 712@end defmac
713 713
714@defmac inline-letevals (bindings@dots{}) body@dots{} 714@defmac inline-letevals (bindings@dots{}) body@dots{}
715This is is similar to @code{let} (@pxref{Local Variables}): it sets up 715This is similar to @code{let} (@pxref{Local Variables}): it sets up
716local variables as specified by @var{bindings}, and then evaluates 716local variables as specified by @var{bindings}, and then evaluates
717@var{body} with those bindings in effect. Each element of 717@var{body} with those bindings in effect. Each element of
718@var{bindings} should be either a symbol or a list of the form 718@var{bindings} should be either a symbol or a list of the form
@@ -2029,8 +2029,8 @@ It is equivalent to the following:
2029@end example 2029@end example
2030@end defmac 2030@end defmac
2031 2031
2032In addition, you can mark a certain a particular calling convention 2032In addition, you can mark a particular calling convention for a
2033for a function as obsolete: 2033function as obsolete:
2034 2034
2035@defun set-advertised-calling-convention function signature when 2035@defun set-advertised-calling-convention function signature when
2036This function specifies the argument list @var{signature} as the 2036This function specifies the argument list @var{signature} as the
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 1ece8996008..75dec13ab7c 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -59,15 +59,16 @@ boundary between the prompt and the actual text.
59 59
60@c See https://debbugs.gnu.org/11276 60@c See https://debbugs.gnu.org/11276
61 The minibuffer's window is normally a single line; it grows 61 The minibuffer's window is normally a single line; it grows
62automatically if the contents require more space. Whilst it is 62automatically if the contents require more space. Whilst the minibuffer
63active, you can explicitly resize it temporarily with the window 63is active, you can explicitly resize its window temporarily with the
64sizing commands; it reverts to its normal size when the minibuffer is 64window sizing commands; the window reverts to its normal size when the
65exited. When the minibuffer is not active, you can resize it 65minibuffer is exited. When the minibuffer is not active, you can resize
66permanently by using the window sizing commands in the frame's other 66its window permanently by using the window sizing commands in the
67window, or dragging the mode line with the mouse. (Due to details of 67frame's other window, or dragging the mode line with the mouse. (Due to
68the current implementation, for this to work @code{resize-mini-windows} 68details of the current implementation, for this to work
69must be @code{nil}.) If the frame contains just a minibuffer, you can 69@code{resize-mini-windows} must be @code{nil}.) If the frame contains
70change the minibuffer's size by changing the frame's size. 70just a minibuffer window, you can change its size by changing the
71frame's size.
71 72
72 Use of the minibuffer reads input events, and that alters the values 73 Use of the minibuffer reads input events, and that alters the values
73of variables such as @code{this-command} and @code{last-command} 74of variables such as @code{this-command} and @code{last-command}
@@ -2256,43 +2257,48 @@ contents of the minibuffer before the point.
2256These functions access and select minibuffer windows, test whether they 2257These functions access and select minibuffer windows, test whether they
2257are active and control how they get resized. 2258are active and control how they get resized.
2258 2259
2259@defun active-minibuffer-window
2260This function returns the currently active minibuffer window, or
2261@code{nil} if there is none.
2262@end defun
2263
2264@defun minibuffer-window &optional frame 2260@defun minibuffer-window &optional frame
2265@anchor{Definition of minibuffer-window} 2261@anchor{Definition of minibuffer-window}
2266This function returns the minibuffer window used for frame @var{frame}. 2262This function returns the minibuffer window used for frame @var{frame}.
2267If @var{frame} is @code{nil}, that stands for the current frame. Note 2263If @var{frame} is @code{nil}, that stands for the selected frame.
2268that the minibuffer window used by a frame need not be part of that 2264
2265Note that the minibuffer window used by a frame need not be part of that
2269frame---a frame that has no minibuffer of its own necessarily uses some 2266frame---a frame that has no minibuffer of its own necessarily uses some
2270other frame's minibuffer window. 2267other frame's minibuffer window. The minibuffer window of a
2268minibuffer-less frame can be changed by setting that frame's
2269@code{minibuffer} frame parameter (@pxref{Buffer Parameters}).
2271@end defun 2270@end defun
2272 2271
2273@defun set-minibuffer-window window 2272@defun set-minibuffer-window window
2274This function specifies @var{window} as the minibuffer window to use. 2273This function specifies @var{window} as the minibuffer window to use.
2275This affects where the minibuffer is displayed if you put text in it 2274This affects where the minibuffer is displayed if you put text in it
2276without invoking the usual minibuffer commands. It has no effect on 2275without invoking the usual minibuffer commands. It has no effect on the
2277the usual minibuffer input functions because they all start by 2276usual minibuffer input functions because they all start by choosing the
2278choosing the minibuffer window according to the current frame. 2277minibuffer window according to the selected frame.
2279@end defun 2278@end defun
2280 2279
2281@c Emacs 19 feature 2280@c Emacs 19 feature
2282@defun window-minibuffer-p &optional window 2281@defun window-minibuffer-p &optional window
2283This function returns non-@code{nil} if @var{window} is a minibuffer 2282This function returns non-@code{nil} if @var{window} is a minibuffer
2284window. 2283window. @var{window} defaults to the selected window.
2285@var{window} defaults to the selected window. 2284@end defun
2285
2286The following function returns the window showing the currently active
2287minibuffer.
2288
2289@defun active-minibuffer-window
2290This function returns the window of the currently active minibuffer, or
2291@code{nil} if there is no active minibuffer.
2286@end defun 2292@end defun
2287 2293
2288It is not correct to determine whether a given window is a minibuffer by 2294It is not sufficient to determine whether a given window shows the
2289comparing it with the result of @code{(minibuffer-window)}, because 2295currently active minibuffer by comparing it with the result of
2290there can be more than one minibuffer window if there is more than one 2296@code{(minibuffer-window)}, because there can be more than one
2291frame. 2297minibuffer window if there is more than one frame.
2292 2298
2293@defun minibuffer-window-active-p window 2299@defun minibuffer-window-active-p window
2294This function returns non-@code{nil} if @var{window} is the currently 2300This function returns non-@code{nil} if @var{window} shows the currently
2295active minibuffer window. 2301active minibuffer.
2296@end defun 2302@end defun
2297 2303
2298The following two options control whether minibuffer windows are resized 2304The following two options control whether minibuffer windows are resized
@@ -2374,14 +2380,14 @@ returns zero.
2374 2380
2375@defopt enable-recursive-minibuffers 2381@defopt enable-recursive-minibuffers
2376If this variable is non-@code{nil}, you can invoke commands (such as 2382If this variable is non-@code{nil}, you can invoke commands (such as
2377@code{find-file}) that use minibuffers even while the minibuffer window 2383@code{find-file}) that use minibuffers even while the minibuffer is
2378is active. Such invocation produces a recursive editing level for a new 2384active. Such invocation produces a recursive editing level for a new
2379minibuffer. The outer-level minibuffer is invisible while you are 2385minibuffer. The outer-level minibuffer is invisible while you are
2380editing the inner one. 2386editing the inner one.
2381 2387
2382If this variable is @code{nil}, you cannot invoke minibuffer 2388If this variable is @code{nil}, you cannot invoke minibuffer commands
2383commands when the minibuffer window is active, not even if you switch to 2389when the minibuffer is active, not even if you switch to another window
2384another window to do it. 2390to do it.
2385@end defopt 2391@end defopt
2386 2392
2387@c Emacs 19 feature 2393@c Emacs 19 feature
@@ -2439,9 +2445,9 @@ minibuffer, it scrolls this window.
2439@end defvar 2445@end defvar
2440 2446
2441@defun minibuffer-selected-window 2447@defun minibuffer-selected-window
2442This function returns the window that was selected when the 2448This function returns the window that was selected just before the
2443minibuffer was entered. If selected window is not a minibuffer 2449minibuffer window was selected. If the selected window is not a
2444window, it returns @code{nil}. 2450minibuffer window, it returns @code{nil}.
2445@end defun 2451@end defun
2446 2452
2447@defopt max-mini-window-height 2453@defopt max-mini-window-height
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 0cb9de9f9a8..501960bdc3f 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -514,7 +514,7 @@ On MS-DOS, Emacs sets the @env{TERM} environment variable to @samp{internal}.
514@end defopt 514@end defopt
515 515
516@defopt term-file-aliases 516@defopt term-file-aliases
517This variable is an an association list mapping terminal types to 517This variable is an association list mapping terminal types to
518their aliases. For example, an element of the form @code{("vt102" 518their aliases. For example, an element of the form @code{("vt102"
519. "vt100")} means to treat a terminal of type @samp{vt102} like one of 519. "vt100")} means to treat a terminal of type @samp{vt102} like one of
520type @samp{vt100}. 520type @samp{vt100}.