diff options
| author | Martin Rudalics | 2012-05-15 11:38:50 +0200 |
|---|---|---|
| committer | Martin Rudalics | 2012-05-15 11:38:50 +0200 |
| commit | 0b128ac42684060c8183c645667dc4c6730e9ba3 (patch) | |
| tree | 6894427599039b38d0f17a109435c22498e4f336 | |
| parent | c8fb9dc689cdd9facc56d7220bdf3bb5864231f0 (diff) | |
| download | emacs-0b128ac42684060c8183c645667dc4c6730e9ba3.tar.gz emacs-0b128ac42684060c8183c645667dc4c6730e9ba3.zip | |
Some minor fixes of Elisp manual.
* commands.texi (Recursive Editing): recursive-edit is a
command.
* compile.texi (Docs and Compilation):
byte-compile-dynamic-docstrings is an option.
* debugging.texi (Invoking the Debugger): debug is a command.
* display.texi (Progress): progress-reporter-update and
progress-reporter-force-update have VALUE argument optional.
(Animated Images): Use non-@code{nil} instead of non-nil.
* files.texi (Format Conversion Round-Trip): Use non-@code{nil}
instead of non-nil.
* frames.texi (Creating Frames): make-frame is a command.
(Input Focus): select-frame is a command.
(Pointer Shape): void-text-area-pointer is an option.
* help.texi (Describing Characters): read-kbd-macro is a
command.
(Help Functions): describe-prefix-bindings is a command.
* markers.texi (Creating Markers): Both arguments of copy-marker
are optional.
* minibuf.texi (Reading File Names): Use @kbd instead of @code.
* modes.texi (Mode Line Variables): mode-line-remote and
mode-line-client are not options.
(Imenu): imenu-add-to-menubar is a command.
(SMIE Indentation Helpers): Use non-@code{nil} instead of
non-nil.
* os.texi (Sound Output): play-sound-file is a command.
* package.texi (Package Archives): Use @key{RET} instead of
@kbd{RET}.
* processes.texi (Signals to Processes): Use @key{RET} instead
of @code{RET}.
(Signals to Processes): signal-process is a command.
* text.texi (Clickable Text): Use @key{RET} instead of
@kbd{RET}.
(Base 64): base64-encode-string is not a command while
base64-decode-region is.
* windows.texi (Switching Buffers): pop-to-buffer is a command.
| -rw-r--r-- | doc/lispref/ChangeLog | 52 | ||||
| -rw-r--r-- | doc/lispref/commands.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/compile.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/debugging.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 6 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 12 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/markers.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/minibuf.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/package.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/processes.texi | 6 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 4 |
16 files changed, 100 insertions, 48 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 273396e57c3..935815bc00c 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,55 @@ | |||
| 1 | 2012-05-15 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * commands.texi (Recursive Editing): recursive-edit is a | ||
| 4 | command. | ||
| 5 | |||
| 6 | * compile.texi (Docs and Compilation): | ||
| 7 | byte-compile-dynamic-docstrings is an option. | ||
| 8 | |||
| 9 | * debugging.texi (Invoking the Debugger): debug is a command. | ||
| 10 | |||
| 11 | * display.texi (Progress): progress-reporter-update and | ||
| 12 | progress-reporter-force-update have VALUE argument optional. | ||
| 13 | (Animated Images): Use non-@code{nil} instead of non-nil. | ||
| 14 | |||
| 15 | * files.texi (Format Conversion Round-Trip): Use non-@code{nil} | ||
| 16 | instead of non-nil. | ||
| 17 | |||
| 18 | * frames.texi (Creating Frames): make-frame is a command. | ||
| 19 | (Input Focus): select-frame is a command. | ||
| 20 | (Pointer Shape): void-text-area-pointer is an option. | ||
| 21 | |||
| 22 | * help.texi (Describing Characters): read-kbd-macro is a | ||
| 23 | command. | ||
| 24 | (Help Functions): describe-prefix-bindings is a command. | ||
| 25 | |||
| 26 | * markers.texi (Creating Markers): Both arguments of copy-marker | ||
| 27 | are optional. | ||
| 28 | |||
| 29 | * minibuf.texi (Reading File Names): Use @kbd instead of @code. | ||
| 30 | |||
| 31 | * modes.texi (Mode Line Variables): mode-line-remote and | ||
| 32 | mode-line-client are not options. | ||
| 33 | (Imenu): imenu-add-to-menubar is a command. | ||
| 34 | (SMIE Indentation Helpers): Use non-@code{nil} instead of | ||
| 35 | non-nil. | ||
| 36 | |||
| 37 | * os.texi (Sound Output): play-sound-file is a command. | ||
| 38 | |||
| 39 | * package.texi (Package Archives): Use @key{RET} instead of | ||
| 40 | @kbd{RET}. | ||
| 41 | |||
| 42 | * processes.texi (Signals to Processes): Use @key{RET} instead | ||
| 43 | of @code{RET}. | ||
| 44 | (Signals to Processes): signal-process is a command. | ||
| 45 | |||
| 46 | * text.texi (Clickable Text): Use @key{RET} instead of | ||
| 47 | @kbd{RET}. | ||
| 48 | (Base 64): base64-encode-string is not a command while | ||
| 49 | base64-decode-region is. | ||
| 50 | |||
| 51 | * windows.texi (Switching Buffers): pop-to-buffer is a command. | ||
| 52 | |||
| 1 | 2012-05-08 Glenn Morris <rgm@gnu.org> | 53 | 2012-05-08 Glenn Morris <rgm@gnu.org> |
| 2 | 54 | ||
| 3 | * Makefile.in (clean, mostlyclean): Add some more vol1/2 items. | 55 | * Makefile.in (clean, mostlyclean): Add some more vol1/2 items. |
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index ec5a95a3f3b..a6dfbe2f8ee 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -3211,7 +3211,7 @@ a recursive edit but also provides the other features of the debugger. | |||
| 3211 | Recursive editing levels are also used when you type @kbd{C-r} in | 3211 | Recursive editing levels are also used when you type @kbd{C-r} in |
| 3212 | @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). | 3212 | @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). |
| 3213 | 3213 | ||
| 3214 | @defun recursive-edit | 3214 | @deffn Command recursive-edit |
| 3215 | @cindex suspend evaluation | 3215 | @cindex suspend evaluation |
| 3216 | This function invokes the editor command loop. It is called | 3216 | This function invokes the editor command loop. It is called |
| 3217 | automatically by the initialization of Emacs, to let the user begin | 3217 | automatically by the initialization of Emacs, to let the user begin |
| @@ -3238,7 +3238,7 @@ then type @kbd{C-M-c} to exit and continue executing @code{simple-rec}. | |||
| 3238 | (simple-rec) | 3238 | (simple-rec) |
| 3239 | @result{} nil | 3239 | @result{} nil |
| 3240 | @end example | 3240 | @end example |
| 3241 | @end defun | 3241 | @end deffn |
| 3242 | 3242 | ||
| 3243 | @deffn Command exit-recursive-edit | 3243 | @deffn Command exit-recursive-edit |
| 3244 | This function exits from the innermost recursive edit (including | 3244 | This function exits from the innermost recursive edit (including |
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 06767a4a329..032ba052484 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -291,10 +291,10 @@ is by adding this string to the file's first line: | |||
| 291 | -*-byte-compile-dynamic-docstrings: nil;-*- | 291 | -*-byte-compile-dynamic-docstrings: nil;-*- |
| 292 | @end example | 292 | @end example |
| 293 | 293 | ||
| 294 | @defvar byte-compile-dynamic-docstrings | 294 | @defopt byte-compile-dynamic-docstrings |
| 295 | If this is non-@code{nil}, the byte compiler generates compiled files | 295 | If this is non-@code{nil}, the byte compiler generates compiled files |
| 296 | that are set up for dynamic loading of documentation strings. | 296 | that are set up for dynamic loading of documentation strings. |
| 297 | @end defvar | 297 | @end defopt |
| 298 | 298 | ||
| 299 | @node Dynamic Loading | 299 | @node Dynamic Loading |
| 300 | @section Dynamic Loading of Individual Functions | 300 | @section Dynamic Loading of Individual Functions |
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index 115d8ff42de..885766bd1cc 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi | |||
| @@ -448,7 +448,7 @@ erroneously show up in this list. | |||
| 448 | Here we describe in full detail the function @code{debug} that is used | 448 | Here we describe in full detail the function @code{debug} that is used |
| 449 | to invoke the debugger. | 449 | to invoke the debugger. |
| 450 | 450 | ||
| 451 | @defun debug &rest debugger-args | 451 | @deffn Command debug &rest debugger-args |
| 452 | This function enters the debugger. It switches buffers to a buffer | 452 | This function enters the debugger. It switches buffers to a buffer |
| 453 | named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second | 453 | named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second |
| 454 | recursive entry to the debugger, etc.), and fills it with information | 454 | recursive entry to the debugger, etc.), and fills it with information |
| @@ -535,7 +535,7 @@ are printed on the top line of the buffer. You can use this feature to | |||
| 535 | display messages---for example, to remind yourself of the conditions | 535 | display messages---for example, to remind yourself of the conditions |
| 536 | under which @code{debug} is called. | 536 | under which @code{debug} is called. |
| 537 | @end table | 537 | @end table |
| 538 | @end defun | 538 | @end deffn |
| 539 | 539 | ||
| 540 | @node Internals of Debugger | 540 | @node Internals of Debugger |
| 541 | @subsection Internals of the Debugger | 541 | @subsection Internals of the Debugger |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 1fe5a92e8a3..bc2a905a043 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -414,7 +414,7 @@ This function calls @code{progress-reporter-update}, so the first | |||
| 414 | message is printed immediately. | 414 | message is printed immediately. |
| 415 | @end defun | 415 | @end defun |
| 416 | 416 | ||
| 417 | @defun progress-reporter-update reporter value | 417 | @defun progress-reporter-update reporter &optional value |
| 418 | This function does the main work of reporting progress of your | 418 | This function does the main work of reporting progress of your |
| 419 | operation. It displays the message of @var{reporter}, followed by | 419 | operation. It displays the message of @var{reporter}, followed by |
| 420 | progress percentage determined by @var{value}. If percentage is zero, | 420 | progress percentage determined by @var{value}. If percentage is zero, |
| @@ -435,7 +435,7 @@ try to reduce the number of calls to it: resulting overhead will most | |||
| 435 | likely negate your effort. | 435 | likely negate your effort. |
| 436 | @end defun | 436 | @end defun |
| 437 | 437 | ||
| 438 | @defun progress-reporter-force-update reporter value &optional new-message | 438 | @defun progress-reporter-force-update reporter &optional value new-message |
| 439 | This function is similar to @code{progress-reporter-update} except | 439 | This function is similar to @code{progress-reporter-update} except |
| 440 | that it prints a message in the echo area unconditionally. | 440 | that it prints a message in the echo area unconditionally. |
| 441 | 441 | ||
| @@ -4905,7 +4905,7 @@ create animation. Currently, Emacs only supports animated GIF files. | |||
| 4905 | The following functions related to animated images are available. | 4905 | The following functions related to animated images are available. |
| 4906 | 4906 | ||
| 4907 | @defun image-animated-p image | 4907 | @defun image-animated-p image |
| 4908 | This function returns non-nil if @var{image} can be animated. | 4908 | This function returns non-@code{nil} if @var{image} can be animated. |
| 4909 | The actual return value is a cons @code{(@var{nimages} . @var{delay})}, | 4909 | The actual return value is a cons @code{(@var{nimages} . @var{delay})}, |
| 4910 | where @var{nimages} is the number of frames and @var{delay} is the | 4910 | where @var{nimages} is the number of frames and @var{delay} is the |
| 4911 | delay in seconds between them. | 4911 | delay in seconds between them. |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index d18ba458969..f558089a205 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -3129,10 +3129,10 @@ in the order of appearance in the list. | |||
| 3129 | This command writes the current buffer contents into the file @var{file} | 3129 | This command writes the current buffer contents into the file @var{file} |
| 3130 | in a format based on @var{format}, which is a list of format names. It | 3130 | in a format based on @var{format}, which is a list of format names. It |
| 3131 | constructs the actual format starting from @var{format}, then appending | 3131 | constructs the actual format starting from @var{format}, then appending |
| 3132 | any elements from the value of @code{buffer-file-format} with a non-nil | 3132 | any elements from the value of @code{buffer-file-format} with a |
| 3133 | @var{preserve} flag (see above), if they are not already present in | 3133 | non-@code{nil} @var{preserve} flag (see above), if they are not already |
| 3134 | @var{format}. It then updates @code{buffer-file-format} with this | 3134 | present in @var{format}. It then updates @code{buffer-file-format} with |
| 3135 | format, making it the default for future saves. Except for the | 3135 | this format, making it the default for future saves. Except for the |
| 3136 | @var{format} argument, this command is similar to @code{write-file}. In | 3136 | @var{format} argument, this command is similar to @code{write-file}. In |
| 3137 | particular, @var{confirm} has the same meaning and interactive treatment | 3137 | particular, @var{confirm} has the same meaning and interactive treatment |
| 3138 | as the corresponding argument to @code{write-file}. @xref{Definition of | 3138 | as the corresponding argument to @code{write-file}. @xref{Definition of |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 9d10326c294..29c3dcad404 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -109,7 +109,7 @@ for @code{framep} above. | |||
| 109 | 109 | ||
| 110 | To create a new frame, call the function @code{make-frame}. | 110 | To create a new frame, call the function @code{make-frame}. |
| 111 | 111 | ||
| 112 | @defun make-frame &optional alist | 112 | @deffn Command make-frame &optional alist |
| 113 | This function creates and returns a new frame, displaying the current | 113 | This function creates and returns a new frame, displaying the current |
| 114 | buffer. | 114 | buffer. |
| 115 | 115 | ||
| @@ -135,7 +135,7 @@ This function itself does not make the new frame the selected frame. | |||
| 135 | @xref{Input Focus}. The previously selected frame remains selected. | 135 | @xref{Input Focus}. The previously selected frame remains selected. |
| 136 | On graphical terminals, however, the windowing system may select the | 136 | On graphical terminals, however, the windowing system may select the |
| 137 | new frame for its own reasons. | 137 | new frame for its own reasons. |
| 138 | @end defun | 138 | @end deffn |
| 139 | 139 | ||
| 140 | @defvar before-make-frame-hook | 140 | @defvar before-make-frame-hook |
| 141 | A normal hook run by @code{make-frame} before it creates the frame. | 141 | A normal hook run by @code{make-frame} before it creates the frame. |
| @@ -1396,7 +1396,7 @@ same meaning as for @code{select-frame} (see below). The return value | |||
| 1396 | of this function is not significant. | 1396 | of this function is not significant. |
| 1397 | @end defun | 1397 | @end defun |
| 1398 | 1398 | ||
| 1399 | @defun select-frame frame &optional norecord | 1399 | @deffn Command select-frame frame &optional norecord |
| 1400 | This function selects frame @var{frame}, temporarily disregarding the | 1400 | This function selects frame @var{frame}, temporarily disregarding the |
| 1401 | focus of the X server if any. The selection of @var{frame} lasts until | 1401 | focus of the X server if any. The selection of @var{frame} lasts until |
| 1402 | the next time the user does something to select a different frame, or | 1402 | the next time the user does something to select a different frame, or |
| @@ -1419,7 +1419,7 @@ been deleted. | |||
| 1419 | In general, you should never use @code{select-frame} in a way that | 1419 | In general, you should never use @code{select-frame} in a way that |
| 1420 | could switch to a different terminal without switching back when | 1420 | could switch to a different terminal without switching back when |
| 1421 | you're done. | 1421 | you're done. |
| 1422 | @end defun | 1422 | @end deffn |
| 1423 | 1423 | ||
| 1424 | Emacs cooperates with the window system by arranging to select frames as | 1424 | Emacs cooperates with the window system by arranging to select frames as |
| 1425 | the server and window manager request. It does so by generating a | 1425 | the server and window manager request. It does so by generating a |
| @@ -1882,12 +1882,12 @@ of the buffer contents), the mouse pointer usually uses the | |||
| 1882 | @code{arrow} style, but you can specify a different style (one of | 1882 | @code{arrow} style, but you can specify a different style (one of |
| 1883 | those above) by setting @code{void-text-area-pointer}. | 1883 | those above) by setting @code{void-text-area-pointer}. |
| 1884 | 1884 | ||
| 1885 | @defvar void-text-area-pointer | 1885 | @defopt void-text-area-pointer |
| 1886 | This variable specifies the mouse pointer style for void text areas. | 1886 | This variable specifies the mouse pointer style for void text areas. |
| 1887 | These include the areas after the end of a line or below the last line | 1887 | These include the areas after the end of a line or below the last line |
| 1888 | in the buffer. The default is to use the @code{arrow} (non-text) | 1888 | in the buffer. The default is to use the @code{arrow} (non-text) |
| 1889 | pointer style. | 1889 | pointer style. |
| 1890 | @end defvar | 1890 | @end defopt |
| 1891 | 1891 | ||
| 1892 | When using X, you can specify what the @code{text} pointer style | 1892 | When using X, you can specify what the @code{text} pointer style |
| 1893 | really looks like by setting the variable @code{x-pointer-shape}. | 1893 | really looks like by setting the variable @code{x-pointer-shape}. |
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 3edeac2b6d5..16a2caf03b4 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -512,7 +512,7 @@ for Meta. | |||
| 512 | @end smallexample | 512 | @end smallexample |
| 513 | @end defun | 513 | @end defun |
| 514 | 514 | ||
| 515 | @defun read-kbd-macro string &optional need-vector | 515 | @deffn Command read-kbd-macro string &optional need-vector |
| 516 | This function is used mainly for operating on keyboard macros, but it | 516 | This function is used mainly for operating on keyboard macros, but it |
| 517 | can also be used as a rough inverse for @code{key-description}. You | 517 | can also be used as a rough inverse for @code{key-description}. You |
| 518 | call it with a string containing key descriptions, separated by spaces; | 518 | call it with a string containing key descriptions, separated by spaces; |
| @@ -520,7 +520,7 @@ it returns a string or vector containing the corresponding events. | |||
| 520 | (This may or may not be a single valid key sequence, depending on what | 520 | (This may or may not be a single valid key sequence, depending on what |
| 521 | events you use; @pxref{Key Sequences}.) If @var{need-vector} is | 521 | events you use; @pxref{Key Sequences}.) If @var{need-vector} is |
| 522 | non-@code{nil}, the return value is always a vector. | 522 | non-@code{nil}, the return value is always a vector. |
| 523 | @end defun | 523 | @end deffn |
| 524 | 524 | ||
| 525 | @node Help Functions | 525 | @node Help Functions |
| 526 | @section Help Functions | 526 | @section Help Functions |
| @@ -627,12 +627,12 @@ character, and the help character has no binding after that prefix. The | |||
| 627 | variable's default value is @code{describe-prefix-bindings}. | 627 | variable's default value is @code{describe-prefix-bindings}. |
| 628 | @end defvar | 628 | @end defvar |
| 629 | 629 | ||
| 630 | @defun describe-prefix-bindings | 630 | @deffn Command describe-prefix-bindings |
| 631 | This function calls @code{describe-bindings} to display a list of all | 631 | This function calls @code{describe-bindings} to display a list of all |
| 632 | the subcommands of the prefix key of the most recent key sequence. The | 632 | the subcommands of the prefix key of the most recent key sequence. The |
| 633 | prefix described consists of all but the last event of that key | 633 | prefix described consists of all but the last event of that key |
| 634 | sequence. (The last event is, presumably, the help character.) | 634 | sequence. (The last event is, presumably, the help character.) |
| 635 | @end defun | 635 | @end deffn |
| 636 | 636 | ||
| 637 | The following two functions are meant for modes that want to provide | 637 | The following two functions are meant for modes that want to provide |
| 638 | help without relinquishing control, such as the ``electric'' modes. | 638 | help without relinquishing control, such as the ``electric'' modes. |
diff --git a/doc/lispref/markers.texi b/doc/lispref/markers.texi index 25a9fc88fc5..1e8829396a7 100644 --- a/doc/lispref/markers.texi +++ b/doc/lispref/markers.texi | |||
| @@ -206,7 +206,7 @@ chapter. | |||
| 206 | @end example | 206 | @end example |
| 207 | @end defun | 207 | @end defun |
| 208 | 208 | ||
| 209 | @defun copy-marker marker-or-integer &optional insertion-type | 209 | @defun copy-marker &optional marker-or-integer insertion-type |
| 210 | If passed a marker as its argument, @code{copy-marker} returns a | 210 | If passed a marker as its argument, @code{copy-marker} returns a |
| 211 | new marker that points to the same place and the same buffer as does | 211 | new marker that points to the same place and the same buffer as does |
| 212 | @var{marker-or-integer}. If passed an integer as its argument, | 212 | @var{marker-or-integer}. If passed an integer as its argument, |
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index e40cbd14687..7b4e589a704 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -1404,7 +1404,7 @@ returns the pre-inserted contents of the minibuffer. | |||
| 1404 | If the user types @key{RET} in an empty minibuffer, this function | 1404 | If the user types @key{RET} in an empty minibuffer, this function |
| 1405 | returns an empty string, regardless of the value of | 1405 | returns an empty string, regardless of the value of |
| 1406 | @var{require-match}. This is, for instance, how the user can make the | 1406 | @var{require-match}. This is, for instance, how the user can make the |
| 1407 | current buffer visit no file using @code{M-x set-visited-file-name}. | 1407 | current buffer visit no file using @kbd{M-x set-visited-file-name}. |
| 1408 | 1408 | ||
| 1409 | If @var{predicate} is non-@code{nil}, it specifies a function of one | 1409 | If @var{predicate} is non-@code{nil}, it specifies a function of one |
| 1410 | argument that decides which file names are acceptable completion | 1410 | argument that decides which file names are acceptable completion |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index e9be9f1763f..e42011c34a2 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -1991,14 +1991,14 @@ default value also displays the recursive editing level, information | |||
| 1991 | on the process status, and whether narrowing is in effect. | 1991 | on the process status, and whether narrowing is in effect. |
| 1992 | @end defopt | 1992 | @end defopt |
| 1993 | 1993 | ||
| 1994 | @defopt mode-line-remote | 1994 | @defvar mode-line-remote |
| 1995 | This variable is used to show whether @code{default-directory} for the | 1995 | This variable is used to show whether @code{default-directory} for the |
| 1996 | current buffer is remote. | 1996 | current buffer is remote. |
| 1997 | @end defopt | 1997 | @end defvar |
| 1998 | 1998 | ||
| 1999 | @defopt mode-line-client | 1999 | @defvar mode-line-client |
| 2000 | This variable is used to identify @code{emacsclient} frames. | 2000 | This variable is used to identify @code{emacsclient} frames. |
| 2001 | @end defopt | 2001 | @end defvar |
| 2002 | 2002 | ||
| 2003 | The following three variables are used in @code{mode-line-modes}: | 2003 | The following three variables are used in @code{mode-line-modes}: |
| 2004 | 2004 | ||
| @@ -2316,10 +2316,10 @@ definitions, or other named portions of the buffer; then the user can | |||
| 2316 | choose one of them and move point to it. Major modes can add a menu | 2316 | choose one of them and move point to it. Major modes can add a menu |
| 2317 | bar item to use Imenu using @code{imenu-add-to-menubar}. | 2317 | bar item to use Imenu using @code{imenu-add-to-menubar}. |
| 2318 | 2318 | ||
| 2319 | @defun imenu-add-to-menubar name | 2319 | @deffn Command imenu-add-to-menubar name |
| 2320 | This function defines a local menu bar item named @var{name} | 2320 | This function defines a local menu bar item named @var{name} |
| 2321 | to run Imenu. | 2321 | to run Imenu. |
| 2322 | @end defun | 2322 | @end deffn |
| 2323 | 2323 | ||
| 2324 | The user-level commands for using Imenu are described in the Emacs | 2324 | The user-level commands for using Imenu are described in the Emacs |
| 2325 | Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}). This section | 2325 | Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}). This section |
| @@ -3861,9 +3861,9 @@ Return non-@code{nil} if the current token's parent is among @var{parents}. | |||
| 3861 | @end defun | 3861 | @end defun |
| 3862 | 3862 | ||
| 3863 | @defun smie-rule-sibling-p | 3863 | @defun smie-rule-sibling-p |
| 3864 | Return non-nil if the current token's parent is actually a sibling. | 3864 | Return non-@code{nil} if the current token's parent is actually a |
| 3865 | This is the case for example when the parent of a @code{","} is just the | 3865 | sibling. This is the case for example when the parent of a @code{","} |
| 3866 | previous @code{","}. | 3866 | is just the previous @code{","}. |
| 3867 | @end defun | 3867 | @end defun |
| 3868 | 3868 | ||
| 3869 | @defun smie-rule-parent &optional offset | 3869 | @defun smie-rule-parent &optional offset |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 35ac7c20384..384531c8e37 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -2106,10 +2106,10 @@ calls the functions in the list @code{play-sound-functions}. | |||
| 2106 | Each function is called with one argument, @var{sound}. | 2106 | Each function is called with one argument, @var{sound}. |
| 2107 | @end defun | 2107 | @end defun |
| 2108 | 2108 | ||
| 2109 | @defun play-sound-file file &optional volume device | 2109 | @deffn Command play-sound-file file &optional volume device |
| 2110 | This function is an alternative interface to playing a sound @var{file} | 2110 | This function is an alternative interface to playing a sound @var{file} |
| 2111 | specifying an optional @var{volume} and @var{device}. | 2111 | specifying an optional @var{volume} and @var{device}. |
| 2112 | @end defun | 2112 | @end deffn |
| 2113 | 2113 | ||
| 2114 | @defvar play-sound-functions | 2114 | @defvar play-sound-functions |
| 2115 | A list of functions to be called before playing a sound. Each function | 2115 | A list of functions to be called before playing a sound. Each function |
diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi index e9737f15a1c..387fba52c63 100644 --- a/doc/lispref/package.texi +++ b/doc/lispref/package.texi | |||
| @@ -295,8 +295,8 @@ How to accomplish this is beyond the scope of this manual. | |||
| 295 | 295 | ||
| 296 | A convenient way to set up and update a package archive is via the | 296 | A convenient way to set up and update a package archive is via the |
| 297 | @code{package-x} library. This is included with Emacs, but not loaded | 297 | @code{package-x} library. This is included with Emacs, but not loaded |
| 298 | by default; type @kbd{M-x load-library @kbd{RET} package-x @kbd{RET}} | 298 | by default; type @kbd{M-x load-library @key{RET} package-x @key{RET}} to |
| 299 | to load it, or add @code{(require 'package-x)} to your init file. | 299 | load it, or add @code{(require 'package-x)} to your init file. |
| 300 | @xref{Lisp Libraries,, Lisp Libraries, emacs, The GNU Emacs Manual}. | 300 | @xref{Lisp Libraries,, Lisp Libraries, emacs, The GNU Emacs Manual}. |
| 301 | Once loaded, you can make use of the following: | 301 | Once loaded, you can make use of the following: |
| 302 | 302 | ||
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 6275ce0b1b7..7426437e6f0 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi | |||
| @@ -1071,7 +1071,7 @@ job-control shells won't work when a pipe is used. See | |||
| 1071 | @defun interrupt-process &optional process current-group | 1071 | @defun interrupt-process &optional process current-group |
| 1072 | This function interrupts the process @var{process} by sending the | 1072 | This function interrupts the process @var{process} by sending the |
| 1073 | signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt | 1073 | signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt |
| 1074 | character'' (normally @kbd{C-c} on some systems, and @code{DEL} on | 1074 | character'' (normally @kbd{C-c} on some systems, and @key{DEL} on |
| 1075 | others) sends this signal. When the argument @var{current-group} is | 1075 | others) sends this signal. When the argument @var{current-group} is |
| 1076 | non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' | 1076 | non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' |
| 1077 | on the terminal by which Emacs talks to the subprocess. | 1077 | on the terminal by which Emacs talks to the subprocess. |
| @@ -1110,7 +1110,7 @@ it the signal @code{SIGCONT}. This presumes that @var{process} was | |||
| 1110 | stopped previously. | 1110 | stopped previously. |
| 1111 | @end defun | 1111 | @end defun |
| 1112 | 1112 | ||
| 1113 | @defun signal-process process signal | 1113 | @deffn Command signal-process process signal |
| 1114 | This function sends a signal to process @var{process}. The argument | 1114 | This function sends a signal to process @var{process}. The argument |
| 1115 | @var{signal} specifies which signal to send; it should be an integer, | 1115 | @var{signal} specifies which signal to send; it should be an integer, |
| 1116 | or a symbol whose name is a signal. | 1116 | or a symbol whose name is a signal. |
| @@ -1118,7 +1118,7 @@ or a symbol whose name is a signal. | |||
| 1118 | The @var{process} argument can be a system process @acronym{ID} (an | 1118 | The @var{process} argument can be a system process @acronym{ID} (an |
| 1119 | integer); that allows you to send signals to processes that are not | 1119 | integer); that allows you to send signals to processes that are not |
| 1120 | children of Emacs. @xref{System Processes}. | 1120 | children of Emacs. @xref{System Processes}. |
| 1121 | @end defun | 1121 | @end deffn |
| 1122 | 1122 | ||
| 1123 | @node Output from Processes | 1123 | @node Output from Processes |
| 1124 | @section Receiving Output from Processes | 1124 | @section Receiving Output from Processes |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 3e9135a7d81..1963d2519a3 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3531,7 +3531,7 @@ properties. For simplicity, we will refer to the clickable text as a | |||
| 3531 | @dfn{link}. | 3531 | @dfn{link}. |
| 3532 | 3532 | ||
| 3533 | Implementing a link involves three separate steps: (1) indicating | 3533 | Implementing a link involves three separate steps: (1) indicating |
| 3534 | clickability when the mouse moves over the link; (2) making @kbd{RET} | 3534 | clickability when the mouse moves over the link; (2) making @key{RET} |
| 3535 | or @kbd{Mouse-2} on that link do something; and (3) setting up a | 3535 | or @kbd{Mouse-2} on that link do something; and (3) setting up a |
| 3536 | @code{follow-link} condition so that the link obeys | 3536 | @code{follow-link} condition so that the link obeys |
| 3537 | @code{mouse-1-click-follows-link}. | 3537 | @code{mouse-1-click-follows-link}. |
| @@ -4069,7 +4069,7 @@ text, to avoid overlong lines. However, if the optional argument | |||
| 4069 | the output is just one long line. | 4069 | the output is just one long line. |
| 4070 | @end deffn | 4070 | @end deffn |
| 4071 | 4071 | ||
| 4072 | @deffn Command base64-encode-string string &optional no-line-break | 4072 | @defun base64-encode-string string &optional no-line-break |
| 4073 | This function converts the string @var{string} into base 64 code. It | 4073 | This function converts the string @var{string} into base 64 code. It |
| 4074 | returns a string containing the encoded text. As for | 4074 | returns a string containing the encoded text. As for |
| 4075 | @code{base64-encode-region}, an error is signaled if a character in the | 4075 | @code{base64-encode-region}, an error is signaled if a character in the |
| @@ -4079,15 +4079,15 @@ Normally, this function inserts newline characters into the encoded | |||
| 4079 | text, to avoid overlong lines. However, if the optional argument | 4079 | text, to avoid overlong lines. However, if the optional argument |
| 4080 | @var{no-line-break} is non-@code{nil}, these newlines are not added, so | 4080 | @var{no-line-break} is non-@code{nil}, these newlines are not added, so |
| 4081 | the result string is just one long line. | 4081 | the result string is just one long line. |
| 4082 | @end deffn | 4082 | @end defun |
| 4083 | 4083 | ||
| 4084 | @defun base64-decode-region beg end | 4084 | @deffn Command base64-decode-region beg end |
| 4085 | This function converts the region from @var{beg} to @var{end} from base | 4085 | This function converts the region from @var{beg} to @var{end} from base |
| 4086 | 64 code into the corresponding decoded text. It returns the length of | 4086 | 64 code into the corresponding decoded text. It returns the length of |
| 4087 | the decoded text. | 4087 | the decoded text. |
| 4088 | 4088 | ||
| 4089 | The decoding functions ignore newline characters in the encoded text. | 4089 | The decoding functions ignore newline characters in the encoded text. |
| 4090 | @end defun | 4090 | @end deffn |
| 4091 | 4091 | ||
| 4092 | @defun base64-decode-string string | 4092 | @defun base64-decode-string string |
| 4093 | This function converts the string @var{string} from base 64 code into | 4093 | This function converts the string @var{string} from base 64 code into |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index c8a9316bcfa..75d4a9beb8c 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -1559,7 +1559,7 @@ displaying the buffer. Hence, all the variables affecting | |||
| 1559 | @code{display-buffer} will affect it as well. @xref{Choosing Window}, | 1559 | @code{display-buffer} will affect it as well. @xref{Choosing Window}, |
| 1560 | for the documentation of @code{display-buffer}. | 1560 | for the documentation of @code{display-buffer}. |
| 1561 | 1561 | ||
| 1562 | @defun pop-to-buffer buffer-or-name &optional action norecord | 1562 | @deffn Command pop-to-buffer buffer-or-name &optional action norecord |
| 1563 | This function makes @var{buffer-or-name} the current buffer and | 1563 | This function makes @var{buffer-or-name} the current buffer and |
| 1564 | displays it in some window, preferably not the window previously | 1564 | displays it in some window, preferably not the window previously |
| 1565 | selected. It then selects the displaying window. If that window is | 1565 | selected. It then selects the displaying window. If that window is |
| @@ -1582,7 +1582,7 @@ displayed in the selected window. | |||
| 1582 | 1582 | ||
| 1583 | Like @code{switch-to-buffer}, this function updates the buffer list | 1583 | Like @code{switch-to-buffer}, this function updates the buffer list |
| 1584 | unless @var{norecord} is non-@code{nil}. | 1584 | unless @var{norecord} is non-@code{nil}. |
| 1585 | @end defun | 1585 | @end deffn |
| 1586 | 1586 | ||
| 1587 | @node Choosing Window | 1587 | @node Choosing Window |
| 1588 | @section Choosing a Window for Display | 1588 | @section Choosing a Window for Display |