diff options
| author | Glenn Morris | 2012-04-10 00:11:23 -0700 |
|---|---|---|
| committer | Glenn Morris | 2012-04-10 00:11:23 -0700 |
| commit | 2bb0eca1ebe1ff1b9939b6350a2e5310c17a7e8c (patch) | |
| tree | ccd6c79c4315efd0260cd3a885cf7b4dcdf74cbc | |
| parent | 62200c147ccf48fdff77438e05ca296a9d40ceb4 (diff) | |
| download | emacs-2bb0eca1ebe1ff1b9939b6350a2e5310c17a7e8c.tar.gz emacs-2bb0eca1ebe1ff1b9939b6350a2e5310c17a7e8c.zip | |
In doc/lispref, use @file for buffers, per the Texinfo manual.
It renders the same as @samp, so there is no visible change in most cases.
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/buffers.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/compile.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/customize.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/debugging.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 16 | ||||
| -rw-r--r-- | doc/lispref/edebug.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/eval.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 12 | ||||
| -rw-r--r-- | doc/lispref/intro.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/keymaps.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/minibuf.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 14 | ||||
| -rw-r--r-- | doc/lispref/processes.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 2 |
16 files changed, 60 insertions, 55 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index d53be2b57c6..256bbf6d20b 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,5 +1,10 @@ | |||
| 1 | 2012-04-10 Glenn Morris <rgm@gnu.org> | 1 | 2012-04-10 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * buffers.texi, compile.texi, customize.texi, debugging.texi: | ||
| 4 | * display.texi, edebug.texi, eval.texi, help.texi, intro.texi: | ||
| 5 | * keymaps.texi, minibuf.texi, modes.texi, os.texi, processes.texi: | ||
| 6 | * text.texi: Use @file for buffers, per the Texinfo manual. | ||
| 7 | |||
| 3 | * compile.texi (Compiler Errors): Add missing space in buffer name. | 8 | * compile.texi (Compiler Errors): Add missing space in buffer name. |
| 4 | 9 | ||
| 5 | 2012-04-08 Chong Yidong <cyd@gnu.org> | 10 | 2012-04-08 Chong Yidong <cyd@gnu.org> |
diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 125a886ecb2..433663b4260 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi | |||
| @@ -863,7 +863,7 @@ a buffer visible in any window on any visible frame, except as a last | |||
| 863 | resort. If @var{visible-ok} is non-@code{nil}, then it does not matter | 863 | resort. If @var{visible-ok} is non-@code{nil}, then it does not matter |
| 864 | whether a buffer is displayed somewhere or not. | 864 | whether a buffer is displayed somewhere or not. |
| 865 | 865 | ||
| 866 | If no suitable buffer exists, the buffer @samp{*scratch*} is returned | 866 | If no suitable buffer exists, the buffer @file{*scratch*} is returned |
| 867 | (and created, if necessary). | 867 | (and created, if necessary). |
| 868 | @end defun | 868 | @end defun |
| 869 | 869 | ||
| @@ -874,7 +874,7 @@ selected frame's buffer list. | |||
| 874 | 874 | ||
| 875 | The argument @var{visible-ok} is handled as with @code{other-buffer}, | 875 | The argument @var{visible-ok} is handled as with @code{other-buffer}, |
| 876 | see above. If no suitable buffer can be found, the buffer | 876 | see above. If no suitable buffer can be found, the buffer |
| 877 | @samp{*scratch*} is returned. | 877 | @file{*scratch*} is returned. |
| 878 | @end defun | 878 | @end defun |
| 879 | 879 | ||
| 880 | @deffn Command bury-buffer &optional buffer-or-name | 880 | @deffn Command bury-buffer &optional buffer-or-name |
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 1cc54bb2ac4..093c91f02b0 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -92,7 +92,7 @@ the @code{byte-compile} function. You can compile a whole file with | |||
| 92 | 92 | ||
| 93 | Sometimes, the byte compiler produces warning and/or error messages | 93 | Sometimes, the byte compiler produces warning and/or error messages |
| 94 | (@pxref{Compiler Errors}, for details). These messages are recorded | 94 | (@pxref{Compiler Errors}, for details). These messages are recorded |
| 95 | in a buffer called @samp{*Compile-Log*}, which uses Compilation mode. | 95 | in a buffer called @file{*Compile-Log*}, which uses Compilation mode. |
| 96 | @xref{Compilation Mode,,,emacs, The GNU Emacs Manual}. | 96 | @xref{Compilation Mode,,,emacs, The GNU Emacs Manual}. |
| 97 | 97 | ||
| 98 | @cindex macro compilation | 98 | @cindex macro compilation |
| @@ -443,14 +443,14 @@ to what @code{eval-when-compile} does. | |||
| 443 | @cindex compiler errors | 443 | @cindex compiler errors |
| 444 | 444 | ||
| 445 | Byte compilation outputs all errors and warnings into the buffer | 445 | Byte compilation outputs all errors and warnings into the buffer |
| 446 | @samp{*Compile-Log*}. The messages include file names and line | 446 | @file{*Compile-Log*}. The messages include file names and line |
| 447 | numbers that identify the location of the problem. The usual Emacs | 447 | numbers that identify the location of the problem. The usual Emacs |
| 448 | commands for operating on compiler diagnostics work properly on these | 448 | commands for operating on compiler diagnostics work properly on these |
| 449 | messages. | 449 | messages. |
| 450 | 450 | ||
| 451 | When an error is due to invalid syntax in the program, the byte | 451 | When an error is due to invalid syntax in the program, the byte |
| 452 | compiler might get confused about the errors' exact location. One way | 452 | compiler might get confused about the errors' exact location. One way |
| 453 | to investigate is to switch to the buffer @w{@samp{ *Compiler Input*}}. | 453 | to investigate is to switch to the buffer @w{@file{ *Compiler Input*}}. |
| 454 | (This buffer name starts with a space, so it does not show up in | 454 | (This buffer name starts with a space, so it does not show up in |
| 455 | @kbd{M-x list-buffers}.) This buffer contains the program being | 455 | @kbd{M-x list-buffers}.) This buffer contains the program being |
| 456 | compiled, and point shows how far the byte compiler was able to read; | 456 | compiled, and point shows how far the byte compiler was able to read; |
| @@ -602,7 +602,7 @@ the stack. | |||
| 602 | @deffn Command disassemble object &optional buffer-or-name | 602 | @deffn Command disassemble object &optional buffer-or-name |
| 603 | This command displays the disassembled code for @var{object}. In | 603 | This command displays the disassembled code for @var{object}. In |
| 604 | interactive use, or if @var{buffer-or-name} is @code{nil} or omitted, | 604 | interactive use, or if @var{buffer-or-name} is @code{nil} or omitted, |
| 605 | the output goes in a buffer named @samp{*Disassemble*}. If | 605 | the output goes in a buffer named @file{*Disassemble*}. If |
| 606 | @var{buffer-or-name} is non-@code{nil}, it must be a buffer or the | 606 | @var{buffer-or-name} is non-@code{nil}, it must be a buffer or the |
| 607 | name of an existing buffer. Then the output goes there, at point, and | 607 | name of an existing buffer. Then the output goes there, at point, and |
| 608 | point is left before the output. | 608 | point is left before the output. |
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 4c3adee0db5..167dfe7d4c5 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi | |||
| @@ -596,7 +596,7 @@ The value must be a coding-system name, and you can do completion with | |||
| 596 | @item color | 596 | @item color |
| 597 | The value must be a valid color name. The widget provides completion | 597 | The value must be a valid color name. The widget provides completion |
| 598 | for color names, as well as a sample and a button for selecting a | 598 | for color names, as well as a sample and a button for selecting a |
| 599 | color name from a list of color names shown in a @samp{*Colors*} | 599 | color name from a list of color names shown in a @file{*Colors*} |
| 600 | buffer. | 600 | buffer. |
| 601 | @end table | 601 | @end table |
| 602 | 602 | ||
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index 6e7d0078e07..115d8ff42de 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi | |||
| @@ -303,7 +303,7 @@ an implicit @code{progn} (@pxref{Sequencing}). | |||
| 303 | @subsection Using the Debugger | 303 | @subsection Using the Debugger |
| 304 | 304 | ||
| 305 | When the debugger is entered, it displays the previously selected | 305 | When the debugger is entered, it displays the previously selected |
| 306 | buffer in one window and a buffer named @samp{*Backtrace*} in another | 306 | buffer in one window and a buffer named @file{*Backtrace*} in another |
| 307 | window. The backtrace buffer contains one line for each level of Lisp | 307 | window. The backtrace buffer contains one line for each level of Lisp |
| 308 | function execution currently going on. At the beginning of this buffer | 308 | function execution currently going on. At the beginning of this buffer |
| 309 | is a message describing the reason that the debugger was invoked (such | 309 | is a message describing the reason that the debugger was invoked (such |
| @@ -412,7 +412,7 @@ the variable values within the debugger. | |||
| 412 | 412 | ||
| 413 | @item R | 413 | @item R |
| 414 | Like @kbd{e}, but also save the result of evaluation in the | 414 | Like @kbd{e}, but also save the result of evaluation in the |
| 415 | buffer @samp{*Debugger-record*}. | 415 | buffer @file{*Debugger-record*}. |
| 416 | 416 | ||
| 417 | @item q | 417 | @item q |
| 418 | Terminate the program being debugged; return to top-level Emacs | 418 | Terminate the program being debugged; return to top-level Emacs |
| @@ -450,7 +450,7 @@ to invoke the debugger. | |||
| 450 | 450 | ||
| 451 | @defun debug &rest debugger-args | 451 | @defun 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 @samp{*Backtrace*} (or @samp{*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 |
| 455 | about the stack of Lisp function calls. It then enters a recursive | 455 | about the stack of Lisp function calls. It then enters a recursive |
| 456 | edit, showing the backtrace buffer in Debugger mode. | 456 | edit, showing the backtrace buffer in Debugger mode. |
| @@ -461,7 +461,7 @@ buffer and returns to whatever called @code{debug}. This is the only | |||
| 461 | way the function @code{debug} can return to its caller. | 461 | way the function @code{debug} can return to its caller. |
| 462 | 462 | ||
| 463 | The use of the @var{debugger-args} is that @code{debug} displays the | 463 | The use of the @var{debugger-args} is that @code{debug} displays the |
| 464 | rest of its arguments at the top of the @samp{*Backtrace*} buffer, so | 464 | rest of its arguments at the top of the @file{*Backtrace*} buffer, so |
| 465 | that the user can see them. Except as described below, this is the | 465 | that the user can see them. Except as described below, this is the |
| 466 | @emph{only} way these arguments are used. | 466 | @emph{only} way these arguments are used. |
| 467 | 467 | ||
| @@ -560,7 +560,7 @@ of @code{debug} (@pxref{Invoking the Debugger}). | |||
| 560 | @cindex call stack | 560 | @cindex call stack |
| 561 | This function prints a trace of Lisp function calls currently active. | 561 | This function prints a trace of Lisp function calls currently active. |
| 562 | This is the function used by @code{debug} to fill up the | 562 | This is the function used by @code{debug} to fill up the |
| 563 | @samp{*Backtrace*} buffer. It is written in C, since it must have access | 563 | @file{*Backtrace*} buffer. It is written in C, since it must have access |
| 564 | to the stack to determine which function calls are active. The return | 564 | to the stack to determine which function calls are active. The return |
| 565 | value is always @code{nil}. | 565 | value is always @code{nil}. |
| 566 | 566 | ||
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 8382c2a1555..ee3ffd8d10c 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -268,7 +268,7 @@ objects for its format specifications, like in the @code{format} | |||
| 268 | function (@pxref{Formatting Strings}). The resulting formatted string | 268 | function (@pxref{Formatting Strings}). The resulting formatted string |
| 269 | is displayed in the echo area; if it contains @code{face} text | 269 | is displayed in the echo area; if it contains @code{face} text |
| 270 | properties, it is displayed with the specified faces (@pxref{Faces}). | 270 | properties, it is displayed with the specified faces (@pxref{Faces}). |
| 271 | The string is also added to the @samp{*Messages*} buffer, but without | 271 | The string is also added to the @file{*Messages*} buffer, but without |
| 272 | text properties (@pxref{Logging Messages}). | 272 | text properties (@pxref{Logging Messages}). |
| 273 | 273 | ||
| 274 | In batch mode, the message is printed to the standard error stream, | 274 | In batch mode, the message is printed to the standard error stream, |
| @@ -341,7 +341,7 @@ buffer is used, the window used to display it. | |||
| 341 | 341 | ||
| 342 | If @var{message} is a string, then the optional argument | 342 | If @var{message} is a string, then the optional argument |
| 343 | @var{buffer-name} is the name of the buffer used to display it when a | 343 | @var{buffer-name} is the name of the buffer used to display it when a |
| 344 | pop-up buffer is used, defaulting to @samp{*Message*}. In the case | 344 | pop-up buffer is used, defaulting to @file{*Message*}. In the case |
| 345 | where @var{message} is a string and displayed in the echo area, it is | 345 | where @var{message} is a string and displayed in the echo area, it is |
| 346 | not specified whether the contents are inserted into the buffer anyway. | 346 | not specified whether the contents are inserted into the buffer anyway. |
| 347 | 347 | ||
| @@ -474,16 +474,16 @@ this macro this way: | |||
| 474 | @end defmac | 474 | @end defmac |
| 475 | 475 | ||
| 476 | @node Logging Messages | 476 | @node Logging Messages |
| 477 | @subsection Logging Messages in @samp{*Messages*} | 477 | @subsection Logging Messages in @file{*Messages*} |
| 478 | @cindex logging echo-area messages | 478 | @cindex logging echo-area messages |
| 479 | 479 | ||
| 480 | Almost all the messages displayed in the echo area are also recorded | 480 | Almost all the messages displayed in the echo area are also recorded |
| 481 | in the @samp{*Messages*} buffer so that the user can refer back to | 481 | in the @file{*Messages*} buffer so that the user can refer back to |
| 482 | them. This includes all the messages that are output with | 482 | them. This includes all the messages that are output with |
| 483 | @code{message}. | 483 | @code{message}. |
| 484 | 484 | ||
| 485 | @defopt message-log-max | 485 | @defopt message-log-max |
| 486 | This variable specifies how many lines to keep in the @samp{*Messages*} | 486 | This variable specifies how many lines to keep in the @file{*Messages*} |
| 487 | buffer. The value @code{t} means there is no limit on how many lines to | 487 | buffer. The value @code{t} means there is no limit on how many lines to |
| 488 | keep. The value @code{nil} disables message logging entirely. Here's | 488 | keep. The value @code{nil} disables message logging entirely. Here's |
| 489 | how to display a message and prevent it from being logged: | 489 | how to display a message and prevent it from being logged: |
| @@ -494,7 +494,7 @@ how to display a message and prevent it from being logged: | |||
| 494 | @end example | 494 | @end example |
| 495 | @end defopt | 495 | @end defopt |
| 496 | 496 | ||
| 497 | To make @samp{*Messages*} more convenient for the user, the logging | 497 | To make @file{*Messages*} more convenient for the user, the logging |
| 498 | facility combines successive identical messages. It also combines | 498 | facility combines successive identical messages. It also combines |
| 499 | successive related messages for the sake of two cases: question | 499 | successive related messages for the sake of two cases: question |
| 500 | followed by answer, and a series of progress messages. | 500 | followed by answer, and a series of progress messages. |
| @@ -624,7 +624,7 @@ and @var{type} as the warning type. @var{level} should be the | |||
| 624 | severity level, with @code{:warning} being the default. | 624 | severity level, with @code{:warning} being the default. |
| 625 | 625 | ||
| 626 | @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer | 626 | @var{buffer-name}, if non-@code{nil}, specifies the name of the buffer |
| 627 | for logging the warning. By default, it is @samp{*Warnings*}. | 627 | for logging the warning. By default, it is @file{*Warnings*}. |
| 628 | @end defun | 628 | @end defun |
| 629 | 629 | ||
| 630 | @defun lwarn type level message &rest args | 630 | @defun lwarn type level message &rest args |
| @@ -2752,7 +2752,7 @@ For text matching a search command. | |||
| 2752 | @itemx warning | 2752 | @itemx warning |
| 2753 | @itemx success | 2753 | @itemx success |
| 2754 | For text concerning errors, warnings, or successes. For example, | 2754 | For text concerning errors, warnings, or successes. For example, |
| 2755 | these are used for messages in @samp{*Compilation*} buffers. | 2755 | these are used for messages in @file{*Compilation*} buffers. |
| 2756 | @end table | 2756 | @end table |
| 2757 | 2757 | ||
| 2758 | @node Font Selection | 2758 | @node Font Selection |
diff --git a/doc/lispref/edebug.texi b/doc/lispref/edebug.texi index 245aaf94c6d..9d50f5fb31f 100644 --- a/doc/lispref/edebug.texi +++ b/doc/lispref/edebug.texi | |||
| @@ -622,7 +622,7 @@ back to the stop point in the source code buffer from any buffer using | |||
| 622 | saved outside window configuration---so that even if you turn saving | 622 | saved outside window configuration---so that even if you turn saving |
| 623 | back @emph{on}, the current window configuration remains unchanged when | 623 | back @emph{on}, the current window configuration remains unchanged when |
| 624 | you next exit Edebug (by continuing the program). However, the | 624 | you next exit Edebug (by continuing the program). However, the |
| 625 | automatic redisplay of @samp{*edebug*} and @samp{*edebug-trace*} may | 625 | automatic redisplay of @file{*edebug*} and @file{*edebug-trace*} may |
| 626 | conflict with the buffers you wish to see unless you have enough windows | 626 | conflict with the buffers you wish to see unless you have enough windows |
| 627 | open. | 627 | open. |
| 628 | 628 | ||
| @@ -661,18 +661,18 @@ lexically bound symbols created by the following constructs in | |||
| 661 | @node Eval List | 661 | @node Eval List |
| 662 | @subsection Evaluation List Buffer | 662 | @subsection Evaluation List Buffer |
| 663 | 663 | ||
| 664 | You can use the @dfn{evaluation list buffer}, called @samp{*edebug*}, to | 664 | You can use the @dfn{evaluation list buffer}, called @file{*edebug*}, to |
| 665 | evaluate expressions interactively. You can also set up the | 665 | evaluate expressions interactively. You can also set up the |
| 666 | @dfn{evaluation list} of expressions to be evaluated automatically each | 666 | @dfn{evaluation list} of expressions to be evaluated automatically each |
| 667 | time Edebug updates the display. | 667 | time Edebug updates the display. |
| 668 | 668 | ||
| 669 | @table @kbd | 669 | @table @kbd |
| 670 | @item E | 670 | @item E |
| 671 | Switch to the evaluation list buffer @samp{*edebug*} | 671 | Switch to the evaluation list buffer @file{*edebug*} |
| 672 | (@code{edebug-visit-eval-list}). | 672 | (@code{edebug-visit-eval-list}). |
| 673 | @end table | 673 | @end table |
| 674 | 674 | ||
| 675 | In the @samp{*edebug*} buffer you can use the commands of Lisp | 675 | In the @file{*edebug*} buffer you can use the commands of Lisp |
| 676 | Interaction mode (@pxref{Lisp Interaction,,, emacs, The GNU Emacs | 676 | Interaction mode (@pxref{Lisp Interaction,,, emacs, The GNU Emacs |
| 677 | Manual}) as well as these special commands: | 677 | Manual}) as well as these special commands: |
| 678 | 678 | ||
| @@ -699,7 +699,7 @@ Switch back to the source code buffer at the current stop point | |||
| 699 | @end table | 699 | @end table |
| 700 | 700 | ||
| 701 | You can evaluate expressions in the evaluation list window with | 701 | You can evaluate expressions in the evaluation list window with |
| 702 | @kbd{C-j} or @kbd{C-x C-e}, just as you would in @samp{*scratch*}; | 702 | @kbd{C-j} or @kbd{C-x C-e}, just as you would in @file{*scratch*}; |
| 703 | but they are evaluated in the context outside of Edebug. | 703 | but they are evaluated in the context outside of Edebug. |
| 704 | 704 | ||
| 705 | The expressions you enter interactively (and their results) are lost | 705 | The expressions you enter interactively (and their results) are lost |
| @@ -758,8 +758,8 @@ the expression at a suitable place, insert a new comment line, then type | |||
| 758 | @kbd{C-c C-u}. You need not insert dashes in the comment line---its | 758 | @kbd{C-c C-u}. You need not insert dashes in the comment line---its |
| 759 | contents don't matter. | 759 | contents don't matter. |
| 760 | 760 | ||
| 761 | After selecting @samp{*edebug*}, you can return to the source code | 761 | After selecting @file{*edebug*}, you can return to the source code |
| 762 | buffer with @kbd{C-c C-w}. The @samp{*edebug*} buffer is killed when | 762 | buffer with @kbd{C-c C-w}. The @file{*edebug*} buffer is killed when |
| 763 | you continue execution, and recreated next time it is needed. | 763 | you continue execution, and recreated next time it is needed. |
| 764 | 764 | ||
| 765 | @node Printing in Edebug | 765 | @node Printing in Edebug |
| @@ -819,7 +819,7 @@ for details. | |||
| 819 | @cindex trace buffer | 819 | @cindex trace buffer |
| 820 | 820 | ||
| 821 | Edebug can record an execution trace, storing it in a buffer named | 821 | Edebug can record an execution trace, storing it in a buffer named |
| 822 | @samp{*edebug-trace*}. This is a log of function calls and returns, | 822 | @file{*edebug-trace*}. This is a log of function calls and returns, |
| 823 | showing the function names and their arguments and values. To enable | 823 | showing the function names and their arguments and values. To enable |
| 824 | trace recording, set @code{edebug-trace} to a non-@code{nil} value. | 824 | trace recording, set @code{edebug-trace} to a non-@code{nil} value. |
| 825 | 825 | ||
| @@ -1567,7 +1567,7 @@ The default value is @code{step}. | |||
| 1567 | 1567 | ||
| 1568 | @defopt edebug-trace | 1568 | @defopt edebug-trace |
| 1569 | If this is non-@code{nil}, trace each function entry and exit. | 1569 | If this is non-@code{nil}, trace each function entry and exit. |
| 1570 | Tracing output is displayed in a buffer named @samp{*edebug-trace*}, one | 1570 | Tracing output is displayed in a buffer named @file{*edebug-trace*}, one |
| 1571 | function entry or exit per line, indented by the recursion level. | 1571 | function entry or exit per line, indented by the recursion level. |
| 1572 | 1572 | ||
| 1573 | Also see @code{edebug-tracing}, in @ref{Trace Buffer}. | 1573 | Also see @code{edebug-tracing}, in @ref{Trace Buffer}. |
diff --git a/doc/lispref/eval.texi b/doc/lispref/eval.texi index 429d999a2c8..7f25b33eb43 100644 --- a/doc/lispref/eval.texi +++ b/doc/lispref/eval.texi | |||
| @@ -807,7 +807,7 @@ The value of this variable is a list of the values returned by all the | |||
| 807 | expressions that were read, evaluated, and printed from buffers | 807 | expressions that were read, evaluated, and printed from buffers |
| 808 | (including the minibuffer) by the standard Emacs commands which do | 808 | (including the minibuffer) by the standard Emacs commands which do |
| 809 | this. (Note that this does @emph{not} include evaluation in | 809 | this. (Note that this does @emph{not} include evaluation in |
| 810 | @samp{*ielm*} buffers, nor evaluation using @kbd{C-j} in | 810 | @file{*ielm*} buffers, nor evaluation using @kbd{C-j} in |
| 811 | @code{lisp-interaction-mode}.) The elements are ordered most recent | 811 | @code{lisp-interaction-mode}.) The elements are ordered most recent |
| 812 | first. | 812 | first. |
| 813 | 813 | ||
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 537514d7fb9..2575f5e5bd6 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -180,7 +180,7 @@ face. | |||
| 180 | @c Wordy to prevent overfull hboxes. --rjc 15mar92 | 180 | @c Wordy to prevent overfull hboxes. --rjc 15mar92 |
| 181 | Here is an example of using the two functions, @code{documentation} and | 181 | Here is an example of using the two functions, @code{documentation} and |
| 182 | @code{documentation-property}, to display the documentation strings for | 182 | @code{documentation-property}, to display the documentation strings for |
| 183 | several symbols in a @samp{*Help*} buffer. | 183 | several symbols in a @file{*Help*} buffer. |
| 184 | 184 | ||
| 185 | @anchor{describe-symbols example} | 185 | @anchor{describe-symbols example} |
| 186 | @smallexample | 186 | @smallexample |
| @@ -535,7 +535,7 @@ seems to be as a match. Each of the remaining elements is a | |||
| 535 | documentation string, or @code{nil}, for @var{symbol} as a function, | 535 | documentation string, or @code{nil}, for @var{symbol} as a function, |
| 536 | variable, etc. | 536 | variable, etc. |
| 537 | 537 | ||
| 538 | It also displays the symbols in a buffer named @samp{*Apropos*}, each | 538 | It also displays the symbols in a buffer named @file{*Apropos*}, each |
| 539 | with a one-line description taken from the beginning of its | 539 | with a one-line description taken from the beginning of its |
| 540 | documentation string. | 540 | documentation string. |
| 541 | 541 | ||
| @@ -648,7 +648,7 @@ certain documentation and text files that come with Emacs. | |||
| 648 | 648 | ||
| 649 | @defun help-buffer | 649 | @defun help-buffer |
| 650 | This function returns the name of the help buffer, which is normally | 650 | This function returns the name of the help buffer, which is normally |
| 651 | @samp{*Help*}; if such a buffer does not exist, it is first created. | 651 | @file{*Help*}; if such a buffer does not exist, it is first created. |
| 652 | @end defun | 652 | @end defun |
| 653 | 653 | ||
| 654 | @defmac with-help-window buffer-name body@dots{} | 654 | @defmac with-help-window buffer-name body@dots{} |
| @@ -662,16 +662,16 @@ scroll the help window. | |||
| 662 | @end defmac | 662 | @end defmac |
| 663 | 663 | ||
| 664 | @defun help-setup-xref item interactive-p | 664 | @defun help-setup-xref item interactive-p |
| 665 | This function updates the cross reference data in the @samp{*Help*} | 665 | This function updates the cross reference data in the @file{*Help*} |
| 666 | buffer, which is used to regenerate the help information when the user | 666 | buffer, which is used to regenerate the help information when the user |
| 667 | clicks on the @samp{Back} or @samp{Forward} buttons. Most commands | 667 | clicks on the @samp{Back} or @samp{Forward} buttons. Most commands |
| 668 | that use the @samp{*Help*} buffer should invoke this function before | 668 | that use the @file{*Help*} buffer should invoke this function before |
| 669 | clearing the buffer. The @var{item} argument should have the form | 669 | clearing the buffer. The @var{item} argument should have the form |
| 670 | @code{(@var{function} . @var{args})}, where @var{function} is a function | 670 | @code{(@var{function} . @var{args})}, where @var{function} is a function |
| 671 | to call, with argument list @var{args}, to regenerate the help buffer. | 671 | to call, with argument list @var{args}, to regenerate the help buffer. |
| 672 | The @var{interactive-p} argument is non-@code{nil} if the calling | 672 | The @var{interactive-p} argument is non-@code{nil} if the calling |
| 673 | command was invoked interactively; in that case, the stack of items | 673 | command was invoked interactively; in that case, the stack of items |
| 674 | for the @samp{*Help*} buffer's @samp{Back} buttons is cleared. | 674 | for the @file{*Help*} buffer's @samp{Back} buttons is cleared. |
| 675 | @end defun | 675 | @end defun |
| 676 | 676 | ||
| 677 | @xref{describe-symbols example}, for an example of using | 677 | @xref{describe-symbols example}, for an example of using |
diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi index 365c5f3122e..c963ba03545 100644 --- a/doc/lispref/intro.texi +++ b/doc/lispref/intro.texi | |||
| @@ -247,7 +247,7 @@ indicated with @samp{@equiv{}}. | |||
| 247 | 247 | ||
| 248 | Many of the examples in this manual print text when they are | 248 | Many of the examples in this manual print text when they are |
| 249 | evaluated. If you execute example code in a Lisp Interaction buffer | 249 | evaluated. If you execute example code in a Lisp Interaction buffer |
| 250 | (such as the buffer @samp{*scratch*}), the printed text is inserted into | 250 | (such as the buffer @file{*scratch*}), the printed text is inserted into |
| 251 | the buffer. If you execute the example by other means (such as by | 251 | the buffer. If you execute the example by other means (such as by |
| 252 | evaluating the function @code{eval-region}), the printed text is | 252 | evaluating the function @code{eval-region}), the printed text is |
| 253 | displayed in the echo area. | 253 | displayed in the echo area. |
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 5dd57ccb4ac..000bb2cbb08 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -808,7 +808,7 @@ bindings. | |||
| 808 | @defun current-local-map | 808 | @defun current-local-map |
| 809 | This function returns the current buffer's local keymap, or @code{nil} | 809 | This function returns the current buffer's local keymap, or @code{nil} |
| 810 | if it has none. In the following example, the keymap for the | 810 | if it has none. In the following example, the keymap for the |
| 811 | @samp{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap | 811 | @file{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap |
| 812 | in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse | 812 | in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse |
| 813 | keymap. | 813 | keymap. |
| 814 | 814 | ||
| @@ -1922,7 +1922,7 @@ other command. However, if @var{no-remap} is non-@code{nil}. | |||
| 1922 | 1922 | ||
| 1923 | @deffn Command describe-bindings &optional prefix buffer-or-name | 1923 | @deffn Command describe-bindings &optional prefix buffer-or-name |
| 1924 | This function creates a listing of all current key bindings, and | 1924 | This function creates a listing of all current key bindings, and |
| 1925 | displays it in a buffer named @samp{*Help*}. The text is grouped by | 1925 | displays it in a buffer named @file{*Help*}. The text is grouped by |
| 1926 | modes---minor modes first, then the major mode, then global bindings. | 1926 | modes---minor modes first, then the major mode, then global bindings. |
| 1927 | 1927 | ||
| 1928 | If @var{prefix} is non-@code{nil}, it should be a prefix key; then the | 1928 | If @var{prefix} is non-@code{nil}, it should be a prefix key; then the |
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index 4e11bc30d49..a6ef0f52cfb 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -1062,7 +1062,7 @@ using the value of the variable @code{minibuffer-completion-table} as | |||
| 1062 | the @var{collection} argument, and the value of | 1062 | the @var{collection} argument, and the value of |
| 1063 | @code{minibuffer-completion-predicate} as the @var{predicate} argument. | 1063 | @code{minibuffer-completion-predicate} as the @var{predicate} argument. |
| 1064 | The list of completions is displayed as text in a buffer named | 1064 | The list of completions is displayed as text in a buffer named |
| 1065 | @samp{*Completions*}. | 1065 | @file{*Completions*}. |
| 1066 | @end deffn | 1066 | @end deffn |
| 1067 | 1067 | ||
| 1068 | @defun display-completion-list completions &optional common-substring | 1068 | @defun display-completion-list completions &optional common-substring |
| @@ -1756,7 +1756,7 @@ completion behavior is overridden. @xref{Completion Variables}. | |||
| 1756 | The value should be a function for @dfn{annotating} completions. The | 1756 | The value should be a function for @dfn{annotating} completions. The |
| 1757 | function should take one argument, @var{string}, which is a possible | 1757 | function should take one argument, @var{string}, which is a possible |
| 1758 | completion. It should return a string, which is displayed after the | 1758 | completion. It should return a string, which is displayed after the |
| 1759 | completion @var{string} in the @samp{*Completions*} buffer. | 1759 | completion @var{string} in the @file{*Completions*} buffer. |
| 1760 | 1760 | ||
| 1761 | @item display-sort-function | 1761 | @item display-sort-function |
| 1762 | The value should be a function for sorting completions. The function | 1762 | The value should be a function for sorting completions. The function |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 946dcb91317..12abc2fcd2b 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -628,7 +628,7 @@ have set. | |||
| 628 | This function sets the major mode of @var{buffer} to the default value of | 628 | This function sets the major mode of @var{buffer} to the default value of |
| 629 | @code{major-mode}; if that is @code{nil}, it uses the | 629 | @code{major-mode}; if that is @code{nil}, it uses the |
| 630 | current buffer's major mode (if that is suitable). As an exception, | 630 | current buffer's major mode (if that is suitable). As an exception, |
| 631 | if @var{buffer}'s name is @samp{*scratch*}, it sets the mode to | 631 | if @var{buffer}'s name is @file{*scratch*}, it sets the mode to |
| 632 | @code{initial-major-mode}. | 632 | @code{initial-major-mode}. |
| 633 | 633 | ||
| 634 | The low-level primitives for creating buffers do not use this function, | 634 | The low-level primitives for creating buffers do not use this function, |
| @@ -637,9 +637,9 @@ but medium-level commands such as @code{switch-to-buffer} and | |||
| 637 | @end defun | 637 | @end defun |
| 638 | 638 | ||
| 639 | @defopt initial-major-mode | 639 | @defopt initial-major-mode |
| 640 | @cindex @samp{*scratch*} | 640 | @cindex @file{*scratch*} |
| 641 | The value of this variable determines the major mode of the initial | 641 | The value of this variable determines the major mode of the initial |
| 642 | @samp{*scratch*} buffer. The value should be a symbol that is a major | 642 | @file{*scratch*} buffer. The value should be a symbol that is a major |
| 643 | mode command. The default value is @code{lisp-interaction-mode}. | 643 | mode command. The default value is @code{lisp-interaction-mode}. |
| 644 | @end defopt | 644 | @end defopt |
| 645 | 645 | ||
| @@ -908,7 +908,7 @@ common bindings, including @kbd{q} for @code{quit-window}, @kbd{z} for | |||
| 908 | (@pxref{Reverting}). | 908 | (@pxref{Reverting}). |
| 909 | 909 | ||
| 910 | An example of a major mode derived from Special mode is Buffer Menu | 910 | An example of a major mode derived from Special mode is Buffer Menu |
| 911 | mode, which is used by the @samp{*Buffer List*} buffer. @xref{List | 911 | mode, which is used by the @file{*Buffer List*} buffer. @xref{List |
| 912 | Buffers,,Listing Existing Buffers, emacs, The GNU Emacs Manual}. | 912 | Buffers,,Listing Existing Buffers, emacs, The GNU Emacs Manual}. |
| 913 | @end deffn | 913 | @end deffn |
| 914 | 914 | ||
| @@ -2016,7 +2016,7 @@ identify the mode name in the mode line, use @code{format-mode-line} | |||
| 2016 | This buffer-local variable contains the mode line information on process | 2016 | This buffer-local variable contains the mode line information on process |
| 2017 | status in modes used for communicating with subprocesses. It is | 2017 | status in modes used for communicating with subprocesses. It is |
| 2018 | displayed immediately following the major mode name, with no intervening | 2018 | displayed immediately following the major mode name, with no intervening |
| 2019 | space. For example, its value in the @samp{*shell*} buffer is | 2019 | space. For example, its value in the @file{*shell*} buffer is |
| 2020 | @code{(":%s")}, which allows the shell to display its status along | 2020 | @code{(":%s")}, which allows the shell to display its status along |
| 2021 | with the major mode as: @samp{(Shell:run)}. Normally this variable | 2021 | with the major mode as: @samp{(Shell:run)}. Normally this variable |
| 2022 | is @code{nil}. | 2022 | is @code{nil}. |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 649b93e6082..7c49c9e04a0 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -170,7 +170,7 @@ measurement of how long it took. | |||
| 170 | It runs the normal hook @code{after-init-hook}. | 170 | It runs the normal hook @code{after-init-hook}. |
| 171 | 171 | ||
| 172 | @item | 172 | @item |
| 173 | If the buffer @samp{*scratch*} exists and is still in Fundamental mode | 173 | If the buffer @file{*scratch*} exists and is still in Fundamental mode |
| 174 | (as it should be by default), it sets its major mode according to | 174 | (as it should be by default), it sets its major mode according to |
| 175 | @code{initial-major-mode}. | 175 | @code{initial-major-mode}. |
| 176 | 176 | ||
| @@ -196,7 +196,7 @@ It now exits if the option @code{--batch} was specified. | |||
| 196 | 196 | ||
| 197 | @item | 197 | @item |
| 198 | If @code{initial-buffer-choice} is a string, it visits the file with | 198 | If @code{initial-buffer-choice} is a string, it visits the file with |
| 199 | that name. If the @samp{*scratch*} buffer exists and is | 199 | that name. If the @file{*scratch*} buffer exists and is |
| 200 | empty, it inserts @code{initial-scratch-message} into that buffer. | 200 | empty, it inserts @code{initial-scratch-message} into that buffer. |
| 201 | 201 | ||
| 202 | @c To make things nice and confusing, the next three items can be | 202 | @c To make things nice and confusing, the next three items can be |
| @@ -254,7 +254,7 @@ The following options affect some aspects of the startup sequence. | |||
| 254 | 254 | ||
| 255 | @defopt inhibit-startup-screen | 255 | @defopt inhibit-startup-screen |
| 256 | This variable, if non-@code{nil}, inhibits the startup screen. In | 256 | This variable, if non-@code{nil}, inhibits the startup screen. In |
| 257 | that case, Emacs typically displays the @samp{*scratch*} buffer; but | 257 | that case, Emacs typically displays the @file{*scratch*} buffer; but |
| 258 | see @code{initial-buffer-choice}, below. | 258 | see @code{initial-buffer-choice}, below. |
| 259 | 259 | ||
| 260 | Do not set this variable in the init file of a new user, or in a way | 260 | Do not set this variable in the init file of a new user, or in a way |
| @@ -274,7 +274,7 @@ startup screen. | |||
| 274 | @ignore | 274 | @ignore |
| 275 | @c I do not think this should be mentioned. AFAICS it is just a dodge | 275 | @c I do not think this should be mentioned. AFAICS it is just a dodge |
| 276 | @c around inhibit-startup-screen not being settable on a site-wide basis. | 276 | @c around inhibit-startup-screen not being settable on a site-wide basis. |
| 277 | If its value is @code{t}, Emacs displays the @samp{*scratch*} buffer. | 277 | If its value is @code{t}, Emacs displays the @file{*scratch*} buffer. |
| 278 | @end ignore | 278 | @end ignore |
| 279 | @end defopt | 279 | @end defopt |
| 280 | 280 | ||
| @@ -299,8 +299,8 @@ file will not inhibit the message for someone else. | |||
| 299 | 299 | ||
| 300 | @defopt initial-scratch-message | 300 | @defopt initial-scratch-message |
| 301 | This variable, if non-@code{nil}, should be a string, which is | 301 | This variable, if non-@code{nil}, should be a string, which is |
| 302 | inserted into the @samp{*scratch*} buffer when Emacs starts up. If it | 302 | inserted into the @file{*scratch*} buffer when Emacs starts up. If it |
| 303 | is @code{nil}, the @samp{*scratch*} buffer is empty. | 303 | is @code{nil}, the @file{*scratch*} buffer is empty. |
| 304 | @end defopt | 304 | @end defopt |
| 305 | 305 | ||
| 306 | @noindent | 306 | @noindent |
| @@ -2233,7 +2233,7 @@ non-@code{nil}, Emacs tells the session manager to cancel the | |||
| 2233 | shutdown. | 2233 | shutdown. |
| 2234 | @end defvar | 2234 | @end defvar |
| 2235 | 2235 | ||
| 2236 | Here is an example that just inserts some text into @samp{*scratch*} when | 2236 | Here is an example that just inserts some text into @file{*scratch*} when |
| 2237 | Emacs is restarted by the session manager. | 2237 | Emacs is restarted by the session manager. |
| 2238 | 2238 | ||
| 2239 | @example | 2239 | @example |
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index f59937da15d..1b788684d4b 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi | |||
| @@ -714,7 +714,7 @@ This command displays a listing of all living processes. In addition, | |||
| 714 | it finally deletes any process whose status was @samp{Exited} or | 714 | it finally deletes any process whose status was @samp{Exited} or |
| 715 | @samp{Signaled}. It returns @code{nil}. | 715 | @samp{Signaled}. It returns @code{nil}. |
| 716 | 716 | ||
| 717 | The processes are shown in a buffer named @samp{*Process List*}, whose | 717 | The processes are shown in a buffer named @file{*Process List*}, whose |
| 718 | major mode is named Process Menu mode. | 718 | major mode is named Process Menu mode. |
| 719 | 719 | ||
| 720 | If @var{query-only} is non-@code{nil} then it lists only processes | 720 | If @var{query-only} is non-@code{nil} then it lists only processes |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 770dd5b5777..bae145c1694 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -4345,7 +4345,7 @@ changed text, its length is simply the difference between the first two | |||
| 4345 | arguments. | 4345 | arguments. |
| 4346 | @end defvar | 4346 | @end defvar |
| 4347 | 4347 | ||
| 4348 | Output of messages into the @samp{*Messages*} buffer does not | 4348 | Output of messages into the @file{*Messages*} buffer does not |
| 4349 | call these functions. | 4349 | call these functions. |
| 4350 | 4350 | ||
| 4351 | @defmac combine-after-change-calls body@dots{} | 4351 | @defmac combine-after-change-calls body@dots{} |