diff options
| author | Martin Rudalics | 2018-01-28 19:27:39 +0100 |
|---|---|---|
| committer | Martin Rudalics | 2018-01-28 19:27:39 +0100 |
| commit | 8d4500087f547e203cfba03f61dcbe641bf650de (patch) | |
| tree | 029c52952933d3b6d38d20dfb093ea21e9309216 /doc/lispref | |
| parent | 194ded59904b77e7073e697ebf8eac08e05a7ed3 (diff) | |
| download | emacs-8d4500087f547e203cfba03f61dcbe641bf650de.tar.gz emacs-8d4500087f547e203cfba03f61dcbe641bf650de.zip | |
Fix some issues in the emacs/lispref manuals
* doc/emacs/basic.texi (Continuation Lines):
* doc/emacs/building.texi (GDB User Interface Layout):
* doc/emacs/dired.texi (Misc Dired Features):
* doc/emacs/maintaining.texi (Identifier Search):
* doc/emacs/mark.texi (Using Region):
* doc/emacs/misc.texi (Document View, DocView Conversion):
* doc/emacs/modes.texi (Major Modes):
* doc/emacs/mule.texi (Input Methods, Unibyte Mode):
* doc/emacs/sending.texi (Mail Methods): Replace @code by
@kbd.
* doc/emacs/frames.texi (Text-Only Mouse):
* doc/lispref/maps.texi (Standard Keymaps): Replace @kbd by
@key.
* doc/lispref/compile.texi (Compiler Errors): Write
non-@code{nil} instead of non-nil.
* doc/lispref/debugging.texi (Internals of Debugger):
'backtrace' is not a command. 'debugger-stack-frame-as-list'
is an option.
* doc/lispref/display.texi (Size of Displayed Text):
'window-lines-pixel-dimensions' has a last argument 'left'.
* doc/lispref/display.texi (Attribute Functions):
'set-face-underline' and 'set-face-inverse-video' are
commands.
(Tooltips): 'tooltip-frame-parameters' is an option.
(Bidirectional Display): 'bidi-paragraph-direction' is an
option.
* doc/lispref/frames.texi (Cursor Parameters): 'cursor-type'
is an option.
(Input Focus): Argument FRAME of 'x-focus-frame' is not
optional.
(Child Frames): Both arguments of 'frame-ancestor-p' are
non-optional. 'iconify-child-frame' is an option.
* doc/lispref/os.texi (Killing Emacs):
'kill-emacs-query-functions' is an option.
* doc/lispref/windows.texi (Mouse Window Auto-selection):
'mouse-autoselect-window' is an option.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/compile.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/debugging.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 15 | ||||
| -rw-r--r-- | doc/lispref/maps.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 4 |
7 files changed, 26 insertions, 27 deletions
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 212b5a45dc6..0e39866d349 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -527,7 +527,7 @@ string for details. | |||
| 527 | @vindex byte-compile-error-on-warn | 527 | @vindex byte-compile-error-on-warn |
| 528 | Sometimes you may wish the byte-compiler warnings to be reported | 528 | Sometimes you may wish the byte-compiler warnings to be reported |
| 529 | using @code{error}. If so, set @code{byte-compile-error-on-warn} to a | 529 | using @code{error}. If so, set @code{byte-compile-error-on-warn} to a |
| 530 | non-nil value. | 530 | non-@code{nil} value. |
| 531 | 531 | ||
| 532 | @node Byte-Code Objects | 532 | @node Byte-Code Objects |
| 533 | @section Byte-Code Function Objects | 533 | @section Byte-Code Function Objects |
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index fbc5238dc07..2c757dd39d5 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi | |||
| @@ -619,7 +619,7 @@ was called. The convention for arguments is detailed in the description | |||
| 619 | of @code{debug} (@pxref{Invoking the Debugger}). | 619 | of @code{debug} (@pxref{Invoking the Debugger}). |
| 620 | @end defvar | 620 | @end defvar |
| 621 | 621 | ||
| 622 | @deffn Command backtrace | 622 | @defun backtrace |
| 623 | @cindex run time stack | 623 | @cindex run time stack |
| 624 | @cindex call stack | 624 | @cindex call stack |
| 625 | This function prints a trace of Lisp function calls currently active. | 625 | This function prints a trace of Lisp function calls currently active. |
| @@ -669,9 +669,9 @@ forms are elided. | |||
| 669 | ----------- Buffer: backtrace-output ------------ | 669 | ----------- Buffer: backtrace-output ------------ |
| 670 | @end group | 670 | @end group |
| 671 | @end smallexample | 671 | @end smallexample |
| 672 | @end deffn | 672 | @end defun |
| 673 | 673 | ||
| 674 | @defvar debugger-stack-frame-as-list | 674 | @defopt debugger-stack-frame-as-list |
| 675 | If this variable is non-@code{nil}, every stack frame of the backtrace | 675 | If this variable is non-@code{nil}, every stack frame of the backtrace |
| 676 | is displayed as a list. This aims at improving the backtrace | 676 | is displayed as a list. This aims at improving the backtrace |
| 677 | readability at the cost of special forms no longer being visually | 677 | readability at the cost of special forms no longer being visually |
| @@ -700,7 +700,7 @@ example would look as follows: | |||
| 700 | ----------- Buffer: backtrace-output ------------ | 700 | ----------- Buffer: backtrace-output ------------ |
| 701 | @end group | 701 | @end group |
| 702 | @end smallexample | 702 | @end smallexample |
| 703 | @end defvar | 703 | @end defopt |
| 704 | 704 | ||
| 705 | @defvar debug-on-next-call | 705 | @defvar debug-on-next-call |
| 706 | @cindex @code{eval}, and debugging | 706 | @cindex @code{eval}, and debugging |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 921fd104547..fbf943a08c7 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -1980,7 +1980,7 @@ height of both, if present, in the return value. | |||
| 1980 | whole and does not care about the size of individual lines. The | 1980 | whole and does not care about the size of individual lines. The |
| 1981 | following function does. | 1981 | following function does. |
| 1982 | 1982 | ||
| 1983 | @defun window-lines-pixel-dimensions &optional window first last body inverse | 1983 | @defun window-lines-pixel-dimensions &optional window first last body inverse left |
| 1984 | This function calculates the pixel dimensions of each line displayed in | 1984 | This function calculates the pixel dimensions of each line displayed in |
| 1985 | the specified @var{window}. It does so by walking @var{window}'s | 1985 | the specified @var{window}. It does so by walking @var{window}'s |
| 1986 | current glyph matrix---a matrix storing the glyph (@pxref{Glyphs}) of | 1986 | current glyph matrix---a matrix storing the glyph (@pxref{Glyphs}) of |
| @@ -2775,15 +2775,15 @@ This sets the @code{:slant} attribute of @var{face} to @var{normal} if | |||
| 2775 | @var{italic-p} is @code{nil}, and to @var{italic} otherwise. | 2775 | @var{italic-p} is @code{nil}, and to @var{italic} otherwise. |
| 2776 | @end defun | 2776 | @end defun |
| 2777 | 2777 | ||
| 2778 | @defun set-face-underline face underline &optional frame | 2778 | @deffn Command set-face-underline face underline &optional frame |
| 2779 | This sets the @code{:underline} attribute of @var{face} to | 2779 | This sets the @code{:underline} attribute of @var{face} to |
| 2780 | @var{underline}. | 2780 | @var{underline}. |
| 2781 | @end defun | 2781 | @end deffn |
| 2782 | 2782 | ||
| 2783 | @defun set-face-inverse-video face inverse-video-p &optional frame | 2783 | @deffn Command set-face-inverse-video face inverse-video-p &optional frame |
| 2784 | This sets the @code{:inverse-video} attribute of @var{face} to | 2784 | This sets the @code{:inverse-video} attribute of @var{face} to |
| 2785 | @var{inverse-video-p}. | 2785 | @var{inverse-video-p}. |
| 2786 | @end defun | 2786 | @end deffn |
| 2787 | 2787 | ||
| 2788 | @deffn Command invert-face face &optional frame | 2788 | @deffn Command invert-face face &optional frame |
| 2789 | This swaps the foreground and background colors of face @var{face}. | 2789 | This swaps the foreground and background colors of face @var{face}. |
| @@ -7362,7 +7362,7 @@ have their own frame parameters (@pxref{Frame Parameters}). Unlike | |||
| 7362 | other frames, the default parameters for tooltip frames are stored in a | 7362 | other frames, the default parameters for tooltip frames are stored in a |
| 7363 | special variable. | 7363 | special variable. |
| 7364 | 7364 | ||
| 7365 | @defvar tooltip-frame-parameters | 7365 | @defopt tooltip-frame-parameters |
| 7366 | This customizable option holds the default frame parameters used for | 7366 | This customizable option holds the default frame parameters used for |
| 7367 | displaying tooltips. Any font and color parameters are ignored, and the | 7367 | displaying tooltips. Any font and color parameters are ignored, and the |
| 7368 | corresponding attributes of the @code{tooltip} face are used instead. | 7368 | corresponding attributes of the @code{tooltip} face are used instead. |
| @@ -7372,7 +7372,7 @@ absolute frame-relative coordinates where the tooltip should be shown. | |||
| 7372 | variables described in @ref{Tooltips,,, emacs, The GNU Emacs Manual}.) | 7372 | variables described in @ref{Tooltips,,, emacs, The GNU Emacs Manual}.) |
| 7373 | Note that the @code{left} and @code{top} parameters, if present, | 7373 | Note that the @code{left} and @code{top} parameters, if present, |
| 7374 | override the values of mouse-relative offsets. | 7374 | override the values of mouse-relative offsets. |
| 7375 | @end defvar | 7375 | @end defopt |
| 7376 | 7376 | ||
| 7377 | @vindex tooltip@r{ face} | 7377 | @vindex tooltip@r{ face} |
| 7378 | The @code{tooltip} face determines the appearance of text shown in | 7378 | The @code{tooltip} face determines the appearance of text shown in |
| @@ -7547,7 +7547,7 @@ for its paragraphs. For example, buffers containing program source | |||
| 7547 | code should force all paragraphs to be displayed left-to-right. You | 7547 | code should force all paragraphs to be displayed left-to-right. You |
| 7548 | can use following variable to do this: | 7548 | can use following variable to do this: |
| 7549 | 7549 | ||
| 7550 | @defvar bidi-paragraph-direction | 7550 | @defopt bidi-paragraph-direction |
| 7551 | If the value of this buffer-local variable is the symbol | 7551 | If the value of this buffer-local variable is the symbol |
| 7552 | @code{right-to-left} or @code{left-to-right}, all paragraphs in the | 7552 | @code{right-to-left} or @code{left-to-right}, all paragraphs in the |
| 7553 | buffer are assumed to have that specified direction. Any other value | 7553 | buffer are assumed to have that specified direction. Any other value |
| @@ -7558,7 +7558,7 @@ the base direction of each paragraph from its contents. | |||
| 7558 | Modes for program source code should set this to @code{left-to-right}. | 7558 | Modes for program source code should set this to @code{left-to-right}. |
| 7559 | Prog mode does this by default, so modes derived from Prog mode do not | 7559 | Prog mode does this by default, so modes derived from Prog mode do not |
| 7560 | need to set this explicitly (@pxref{Basic Major Modes}). | 7560 | need to set this explicitly (@pxref{Basic Major Modes}). |
| 7561 | @end defvar | 7561 | @end defopt |
| 7562 | 7562 | ||
| 7563 | @defun current-bidi-paragraph-direction &optional buffer | 7563 | @defun current-bidi-paragraph-direction &optional buffer |
| 7564 | This function returns the paragraph direction at point in the named | 7564 | This function returns the paragraph direction at point in the named |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 9c25f4da4d4..43fdd8f9d54 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -2201,13 +2201,13 @@ The @code{cursor-type} frame parameter may be overridden by the | |||
| 2201 | variables @code{cursor-type} and | 2201 | variables @code{cursor-type} and |
| 2202 | @code{cursor-in-non-selected-windows}: | 2202 | @code{cursor-in-non-selected-windows}: |
| 2203 | 2203 | ||
| 2204 | @defvar cursor-type | 2204 | @defopt cursor-type |
| 2205 | This buffer-local variable controls how the cursor looks in a selected | 2205 | This buffer-local variable controls how the cursor looks in a selected |
| 2206 | window showing the buffer. If its value is @code{t}, that means to | 2206 | window showing the buffer. If its value is @code{t}, that means to |
| 2207 | use the cursor specified by the @code{cursor-type} frame parameter. | 2207 | use the cursor specified by the @code{cursor-type} frame parameter. |
| 2208 | Otherwise, the value should be one of the cursor types listed above, | 2208 | Otherwise, the value should be one of the cursor types listed above, |
| 2209 | and it overrides the @code{cursor-type} frame parameter. | 2209 | and it overrides the @code{cursor-type} frame parameter. |
| 2210 | @end defvar | 2210 | @end defopt |
| 2211 | 2211 | ||
| 2212 | @defopt cursor-in-non-selected-windows | 2212 | @defopt cursor-in-non-selected-windows |
| 2213 | This buffer-local variable controls how the cursor looks in a window | 2213 | This buffer-local variable controls how the cursor looks in a window |
| @@ -2725,7 +2725,7 @@ Ideally, the function described next should focus a frame without also | |||
| 2725 | raising it above other frames. Unfortunately, many window-systems or | 2725 | raising it above other frames. Unfortunately, many window-systems or |
| 2726 | window managers may refuse to comply. | 2726 | window managers may refuse to comply. |
| 2727 | 2727 | ||
| 2728 | @defun x-focus-frame &optional frame noactivate | 2728 | @defun x-focus-frame frame &optional noactivate |
| 2729 | This function gives @var{frame} the focus of the X server without | 2729 | This function gives @var{frame} the focus of the X server without |
| 2730 | necessarily raising it. @var{frame} @code{nil} means use the selected | 2730 | necessarily raising it. @var{frame} @code{nil} means use the selected |
| 2731 | frame. Under X, the optional argument @var{noactivate}, if | 2731 | frame. Under X, the optional argument @var{noactivate}, if |
| @@ -3261,13 +3261,12 @@ exists, @var{frame} is considered a child frame of that frame. | |||
| 3261 | This function returns @code{nil} if @var{frame} has no parent frame. | 3261 | This function returns @code{nil} if @var{frame} has no parent frame. |
| 3262 | @end defun | 3262 | @end defun |
| 3263 | 3263 | ||
| 3264 | @defun frame-ancestor-p &optional ancestor descendant | 3264 | @defun frame-ancestor-p ancestor descendant |
| 3265 | This functions returns non-@code{nil} if @var{ancestor} is an ancestor | 3265 | This functions returns non-@code{nil} if @var{ancestor} is an ancestor |
| 3266 | of @var{descendant}. @var{ancestor} is an ancestor of @var{descendant} | 3266 | of @var{descendant}. @var{ancestor} is an ancestor of @var{descendant} |
| 3267 | when it is either @var{descendant}'s parent frame or it is an ancestor | 3267 | when it is either @var{descendant}'s parent frame or it is an ancestor |
| 3268 | of @var{descendant}'s parent frame. Both, @var{ancestor} and | 3268 | of @var{descendant}'s parent frame. Both, @var{ancestor} and |
| 3269 | @var{descendant} must specify live frames and default to the selected | 3269 | @var{descendant} must specify live frames. |
| 3270 | frame. | ||
| 3271 | @end defun | 3270 | @end defun |
| 3272 | 3271 | ||
| 3273 | Note also the function @code{window-largest-empty-rectangle} | 3272 | Note also the function @code{window-largest-empty-rectangle} |
| @@ -3279,7 +3278,7 @@ window. | |||
| 3279 | Customizing the following option can be useful to tweak the behavior of | 3278 | Customizing the following option can be useful to tweak the behavior of |
| 3280 | @code{iconify-frame} for child frames. | 3279 | @code{iconify-frame} for child frames. |
| 3281 | 3280 | ||
| 3282 | @defvar iconify-child-frame | 3281 | @defopt iconify-child-frame |
| 3283 | This option tells Emacs how to proceed when it is asked to iconify a | 3282 | This option tells Emacs how to proceed when it is asked to iconify a |
| 3284 | child frame. If it is @code{nil}, @code{iconify-frame} will do nothing | 3283 | child frame. If it is @code{nil}, @code{iconify-frame} will do nothing |
| 3285 | when invoked on a child frame. If it is @code{iconify-top-level}, Emacs | 3284 | when invoked on a child frame. If it is @code{iconify-top-level}, Emacs |
| @@ -3291,7 +3290,7 @@ Any other value means to try iconifying the child frame. Since such an | |||
| 3291 | attempt may not be honored by all window managers and can even lead to | 3290 | attempt may not be honored by all window managers and can even lead to |
| 3292 | making the child frame unresponsive to user actions, the default is to | 3291 | making the child frame unresponsive to user actions, the default is to |
| 3293 | iconify the top level frame instead. | 3292 | iconify the top level frame instead. |
| 3294 | @end defvar | 3293 | @end defopt |
| 3295 | 3294 | ||
| 3296 | 3295 | ||
| 3297 | @node Mouse Tracking | 3296 | @node Mouse Tracking |
diff --git a/doc/lispref/maps.texi b/doc/lispref/maps.texi index 275b018b15a..fc40f28ded8 100644 --- a/doc/lispref/maps.texi +++ b/doc/lispref/maps.texi | |||
| @@ -51,7 +51,7 @@ A sparse keymap for subcommands of the prefix @kbd{C-x r}.@* | |||
| 51 | @xref{Registers,,, emacs, The GNU Emacs Manual}. | 51 | @xref{Registers,,, emacs, The GNU Emacs Manual}. |
| 52 | 52 | ||
| 53 | @item esc-map | 53 | @item esc-map |
| 54 | A full keymap for @kbd{ESC} (or @kbd{Meta}) commands. | 54 | A full keymap for @key{ESC} (or @key{Meta}) commands. |
| 55 | 55 | ||
| 56 | @item facemenu-keymap | 56 | @item facemenu-keymap |
| 57 | A sparse keymap used for the @kbd{M-o} prefix key. | 57 | A sparse keymap used for the @kbd{M-o} prefix key. |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 08544688350..1a4e2db44a6 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -699,7 +699,7 @@ inadvertently can lose a lot of work, the | |||
| 699 | you have buffers that need saving or subprocesses that are running. | 699 | you have buffers that need saving or subprocesses that are running. |
| 700 | It also runs the abnormal hook @code{kill-emacs-query-functions}: | 700 | It also runs the abnormal hook @code{kill-emacs-query-functions}: |
| 701 | 701 | ||
| 702 | @defvar kill-emacs-query-functions | 702 | @defopt kill-emacs-query-functions |
| 703 | When @code{save-buffers-kill-terminal} is killing Emacs, it calls the | 703 | When @code{save-buffers-kill-terminal} is killing Emacs, it calls the |
| 704 | functions in this hook, after asking the standard questions and before | 704 | functions in this hook, after asking the standard questions and before |
| 705 | calling @code{kill-emacs}. The functions are called in order of | 705 | calling @code{kill-emacs}. The functions are called in order of |
| @@ -708,7 +708,7 @@ confirmation from the user. If any of them returns @code{nil}, | |||
| 708 | @code{save-buffers-kill-emacs} does not kill Emacs, and does not run | 708 | @code{save-buffers-kill-emacs} does not kill Emacs, and does not run |
| 709 | the remaining functions in this hook. Calling @code{kill-emacs} | 709 | the remaining functions in this hook. Calling @code{kill-emacs} |
| 710 | directly does not run this hook. | 710 | directly does not run this hook. |
| 711 | @end defvar | 711 | @end defopt |
| 712 | 712 | ||
| 713 | @node Suspending Emacs | 713 | @node Suspending Emacs |
| 714 | @subsection Suspending Emacs | 714 | @subsection Suspending Emacs |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 170924f6060..3691a2c04f4 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -4701,7 +4701,7 @@ managers that give focus to a frame (and thus trigger its subsequent | |||
| 4701 | selection) whenever the mouse pointer enters its window-system window | 4701 | selection) whenever the mouse pointer enters its window-system window |
| 4702 | (@pxref{Input Focus}). | 4702 | (@pxref{Input Focus}). |
| 4703 | 4703 | ||
| 4704 | @defvar mouse-autoselect-window | 4704 | @defopt mouse-autoselect-window |
| 4705 | If this variable is non-@code{nil}, Emacs will try to automatically | 4705 | If this variable is non-@code{nil}, Emacs will try to automatically |
| 4706 | select the window under the mouse pointer. The following values are | 4706 | select the window under the mouse pointer. The following values are |
| 4707 | meaningful: | 4707 | meaningful: |
| @@ -4729,7 +4729,7 @@ mode line of a window conceptually should not cause its auto-selection. | |||
| 4729 | 4729 | ||
| 4730 | Mouse auto-selection selects the minibuffer window only if it is active, | 4730 | Mouse auto-selection selects the minibuffer window only if it is active, |
| 4731 | and never deselects the active minibuffer window. | 4731 | and never deselects the active minibuffer window. |
| 4732 | @end defvar | 4732 | @end defopt |
| 4733 | 4733 | ||
| 4734 | Mouse auto-selection can be used to emulate a focus follows mouse policy | 4734 | Mouse auto-selection can be used to emulate a focus follows mouse policy |
| 4735 | for child frames (@pxref{Child Frames}) which usually are not tracked by | 4735 | for child frames (@pxref{Child Frames}) which usually are not tracked by |