mirror of
https://github.com/masscollaborationlabs/emacs.git
synced 2025-07-04 11:23:24 +00:00
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.
This commit is contained in:
parent
62200c147c
commit
2bb0eca1eb
16 changed files with 60 additions and 55 deletions
|
@ -1,5 +1,10 @@
|
||||||
2012-04-10 Glenn Morris <rgm@gnu.org>
|
2012-04-10 Glenn Morris <rgm@gnu.org>
|
||||||
|
|
||||||
|
* buffers.texi, compile.texi, customize.texi, debugging.texi:
|
||||||
|
* display.texi, edebug.texi, eval.texi, help.texi, intro.texi:
|
||||||
|
* keymaps.texi, minibuf.texi, modes.texi, os.texi, processes.texi:
|
||||||
|
* text.texi: Use @file for buffers, per the Texinfo manual.
|
||||||
|
|
||||||
* compile.texi (Compiler Errors): Add missing space in buffer name.
|
* compile.texi (Compiler Errors): Add missing space in buffer name.
|
||||||
|
|
||||||
2012-04-08 Chong Yidong <cyd@gnu.org>
|
2012-04-08 Chong Yidong <cyd@gnu.org>
|
||||||
|
|
|
@ -863,7 +863,7 @@ a buffer visible in any window on any visible frame, except as a last
|
||||||
resort. If @var{visible-ok} is non-@code{nil}, then it does not matter
|
resort. If @var{visible-ok} is non-@code{nil}, then it does not matter
|
||||||
whether a buffer is displayed somewhere or not.
|
whether a buffer is displayed somewhere or not.
|
||||||
|
|
||||||
If no suitable buffer exists, the buffer @samp{*scratch*} is returned
|
If no suitable buffer exists, the buffer @file{*scratch*} is returned
|
||||||
(and created, if necessary).
|
(and created, if necessary).
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
|
@ -874,7 +874,7 @@ selected frame's buffer list.
|
||||||
|
|
||||||
The argument @var{visible-ok} is handled as with @code{other-buffer},
|
The argument @var{visible-ok} is handled as with @code{other-buffer},
|
||||||
see above. If no suitable buffer can be found, the buffer
|
see above. If no suitable buffer can be found, the buffer
|
||||||
@samp{*scratch*} is returned.
|
@file{*scratch*} is returned.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@deffn Command bury-buffer &optional buffer-or-name
|
@deffn Command bury-buffer &optional buffer-or-name
|
||||||
|
|
|
@ -92,7 +92,7 @@ the @code{byte-compile} function. You can compile a whole file with
|
||||||
|
|
||||||
Sometimes, the byte compiler produces warning and/or error messages
|
Sometimes, the byte compiler produces warning and/or error messages
|
||||||
(@pxref{Compiler Errors}, for details). These messages are recorded
|
(@pxref{Compiler Errors}, for details). These messages are recorded
|
||||||
in a buffer called @samp{*Compile-Log*}, which uses Compilation mode.
|
in a buffer called @file{*Compile-Log*}, which uses Compilation mode.
|
||||||
@xref{Compilation Mode,,,emacs, The GNU Emacs Manual}.
|
@xref{Compilation Mode,,,emacs, The GNU Emacs Manual}.
|
||||||
|
|
||||||
@cindex macro compilation
|
@cindex macro compilation
|
||||||
|
@ -443,14 +443,14 @@ to what @code{eval-when-compile} does.
|
||||||
@cindex compiler errors
|
@cindex compiler errors
|
||||||
|
|
||||||
Byte compilation outputs all errors and warnings into the buffer
|
Byte compilation outputs all errors and warnings into the buffer
|
||||||
@samp{*Compile-Log*}. The messages include file names and line
|
@file{*Compile-Log*}. The messages include file names and line
|
||||||
numbers that identify the location of the problem. The usual Emacs
|
numbers that identify the location of the problem. The usual Emacs
|
||||||
commands for operating on compiler diagnostics work properly on these
|
commands for operating on compiler diagnostics work properly on these
|
||||||
messages.
|
messages.
|
||||||
|
|
||||||
When an error is due to invalid syntax in the program, the byte
|
When an error is due to invalid syntax in the program, the byte
|
||||||
compiler might get confused about the errors' exact location. One way
|
compiler might get confused about the errors' exact location. One way
|
||||||
to investigate is to switch to the buffer @w{@samp{ *Compiler Input*}}.
|
to investigate is to switch to the buffer @w{@file{ *Compiler Input*}}.
|
||||||
(This buffer name starts with a space, so it does not show up in
|
(This buffer name starts with a space, so it does not show up in
|
||||||
@kbd{M-x list-buffers}.) This buffer contains the program being
|
@kbd{M-x list-buffers}.) This buffer contains the program being
|
||||||
compiled, and point shows how far the byte compiler was able to read;
|
compiled, and point shows how far the byte compiler was able to read;
|
||||||
|
@ -602,7 +602,7 @@ the stack.
|
||||||
@deffn Command disassemble object &optional buffer-or-name
|
@deffn Command disassemble object &optional buffer-or-name
|
||||||
This command displays the disassembled code for @var{object}. In
|
This command displays the disassembled code for @var{object}. In
|
||||||
interactive use, or if @var{buffer-or-name} is @code{nil} or omitted,
|
interactive use, or if @var{buffer-or-name} is @code{nil} or omitted,
|
||||||
the output goes in a buffer named @samp{*Disassemble*}. If
|
the output goes in a buffer named @file{*Disassemble*}. If
|
||||||
@var{buffer-or-name} is non-@code{nil}, it must be a buffer or the
|
@var{buffer-or-name} is non-@code{nil}, it must be a buffer or the
|
||||||
name of an existing buffer. Then the output goes there, at point, and
|
name of an existing buffer. Then the output goes there, at point, and
|
||||||
point is left before the output.
|
point is left before the output.
|
||||||
|
|
|
@ -596,7 +596,7 @@ The value must be a coding-system name, and you can do completion with
|
||||||
@item color
|
@item color
|
||||||
The value must be a valid color name. The widget provides completion
|
The value must be a valid color name. The widget provides completion
|
||||||
for color names, as well as a sample and a button for selecting a
|
for color names, as well as a sample and a button for selecting a
|
||||||
color name from a list of color names shown in a @samp{*Colors*}
|
color name from a list of color names shown in a @file{*Colors*}
|
||||||
buffer.
|
buffer.
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
|
|
|
@ -303,7 +303,7 @@ an implicit @code{progn} (@pxref{Sequencing}).
|
||||||
@subsection Using the Debugger
|
@subsection Using the Debugger
|
||||||
|
|
||||||
When the debugger is entered, it displays the previously selected
|
When the debugger is entered, it displays the previously selected
|
||||||
buffer in one window and a buffer named @samp{*Backtrace*} in another
|
buffer in one window and a buffer named @file{*Backtrace*} in another
|
||||||
window. The backtrace buffer contains one line for each level of Lisp
|
window. The backtrace buffer contains one line for each level of Lisp
|
||||||
function execution currently going on. At the beginning of this buffer
|
function execution currently going on. At the beginning of this buffer
|
||||||
is a message describing the reason that the debugger was invoked (such
|
is a message describing the reason that the debugger was invoked (such
|
||||||
|
@ -412,7 +412,7 @@ the variable values within the debugger.
|
||||||
|
|
||||||
@item R
|
@item R
|
||||||
Like @kbd{e}, but also save the result of evaluation in the
|
Like @kbd{e}, but also save the result of evaluation in the
|
||||||
buffer @samp{*Debugger-record*}.
|
buffer @file{*Debugger-record*}.
|
||||||
|
|
||||||
@item q
|
@item q
|
||||||
Terminate the program being debugged; return to top-level Emacs
|
Terminate the program being debugged; return to top-level Emacs
|
||||||
|
@ -450,7 +450,7 @@ to invoke the debugger.
|
||||||
|
|
||||||
@defun debug &rest debugger-args
|
@defun debug &rest debugger-args
|
||||||
This function enters the debugger. It switches buffers to a buffer
|
This function enters the debugger. It switches buffers to a buffer
|
||||||
named @samp{*Backtrace*} (or @samp{*Backtrace*<2>} if it is the second
|
named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second
|
||||||
recursive entry to the debugger, etc.), and fills it with information
|
recursive entry to the debugger, etc.), and fills it with information
|
||||||
about the stack of Lisp function calls. It then enters a recursive
|
about the stack of Lisp function calls. It then enters a recursive
|
||||||
edit, showing the backtrace buffer in Debugger mode.
|
edit, showing the backtrace buffer in Debugger mode.
|
||||||
|
@ -461,7 +461,7 @@ buffer and returns to whatever called @code{debug}. This is the only
|
||||||
way the function @code{debug} can return to its caller.
|
way the function @code{debug} can return to its caller.
|
||||||
|
|
||||||
The use of the @var{debugger-args} is that @code{debug} displays the
|
The use of the @var{debugger-args} is that @code{debug} displays the
|
||||||
rest of its arguments at the top of the @samp{*Backtrace*} buffer, so
|
rest of its arguments at the top of the @file{*Backtrace*} buffer, so
|
||||||
that the user can see them. Except as described below, this is the
|
that the user can see them. Except as described below, this is the
|
||||||
@emph{only} way these arguments are used.
|
@emph{only} way these arguments are used.
|
||||||
|
|
||||||
|
@ -560,7 +560,7 @@ of @code{debug} (@pxref{Invoking the Debugger}).
|
||||||
@cindex call stack
|
@cindex call stack
|
||||||
This function prints a trace of Lisp function calls currently active.
|
This function prints a trace of Lisp function calls currently active.
|
||||||
This is the function used by @code{debug} to fill up the
|
This is the function used by @code{debug} to fill up the
|
||||||
@samp{*Backtrace*} buffer. It is written in C, since it must have access
|
@file{*Backtrace*} buffer. It is written in C, since it must have access
|
||||||
to the stack to determine which function calls are active. The return
|
to the stack to determine which function calls are active. The return
|
||||||
value is always @code{nil}.
|
value is always @code{nil}.
|
||||||
|
|
||||||
|
|
|
@ -268,7 +268,7 @@ objects for its format specifications, like in the @code{format}
|
||||||
function (@pxref{Formatting Strings}). The resulting formatted string
|
function (@pxref{Formatting Strings}). The resulting formatted string
|
||||||
is displayed in the echo area; if it contains @code{face} text
|
is displayed in the echo area; if it contains @code{face} text
|
||||||
properties, it is displayed with the specified faces (@pxref{Faces}).
|
properties, it is displayed with the specified faces (@pxref{Faces}).
|
||||||
The string is also added to the @samp{*Messages*} buffer, but without
|
The string is also added to the @file{*Messages*} buffer, but without
|
||||||
text properties (@pxref{Logging Messages}).
|
text properties (@pxref{Logging Messages}).
|
||||||
|
|
||||||
In batch mode, the message is printed to the standard error stream,
|
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.
|
||||||
|
|
||||||
If @var{message} is a string, then the optional argument
|
If @var{message} is a string, then the optional argument
|
||||||
@var{buffer-name} is the name of the buffer used to display it when a
|
@var{buffer-name} is the name of the buffer used to display it when a
|
||||||
pop-up buffer is used, defaulting to @samp{*Message*}. In the case
|
pop-up buffer is used, defaulting to @file{*Message*}. In the case
|
||||||
where @var{message} is a string and displayed in the echo area, it is
|
where @var{message} is a string and displayed in the echo area, it is
|
||||||
not specified whether the contents are inserted into the buffer anyway.
|
not specified whether the contents are inserted into the buffer anyway.
|
||||||
|
|
||||||
|
@ -474,16 +474,16 @@ this macro this way:
|
||||||
@end defmac
|
@end defmac
|
||||||
|
|
||||||
@node Logging Messages
|
@node Logging Messages
|
||||||
@subsection Logging Messages in @samp{*Messages*}
|
@subsection Logging Messages in @file{*Messages*}
|
||||||
@cindex logging echo-area messages
|
@cindex logging echo-area messages
|
||||||
|
|
||||||
Almost all the messages displayed in the echo area are also recorded
|
Almost all the messages displayed in the echo area are also recorded
|
||||||
in the @samp{*Messages*} buffer so that the user can refer back to
|
in the @file{*Messages*} buffer so that the user can refer back to
|
||||||
them. This includes all the messages that are output with
|
them. This includes all the messages that are output with
|
||||||
@code{message}.
|
@code{message}.
|
||||||
|
|
||||||
@defopt message-log-max
|
@defopt message-log-max
|
||||||
This variable specifies how many lines to keep in the @samp{*Messages*}
|
This variable specifies how many lines to keep in the @file{*Messages*}
|
||||||
buffer. The value @code{t} means there is no limit on how many lines to
|
buffer. The value @code{t} means there is no limit on how many lines to
|
||||||
keep. The value @code{nil} disables message logging entirely. Here's
|
keep. The value @code{nil} disables message logging entirely. Here's
|
||||||
how to display a message and prevent it from being logged:
|
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:
|
||||||
@end example
|
@end example
|
||||||
@end defopt
|
@end defopt
|
||||||
|
|
||||||
To make @samp{*Messages*} more convenient for the user, the logging
|
To make @file{*Messages*} more convenient for the user, the logging
|
||||||
facility combines successive identical messages. It also combines
|
facility combines successive identical messages. It also combines
|
||||||
successive related messages for the sake of two cases: question
|
successive related messages for the sake of two cases: question
|
||||||
followed by answer, and a series of progress messages.
|
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
|
||||||
severity level, with @code{:warning} being the default.
|
severity level, with @code{:warning} being the default.
|
||||||
|
|
||||||
@var{buffer-name}, if non-@code{nil}, specifies the name of the buffer
|
@var{buffer-name}, if non-@code{nil}, specifies the name of the buffer
|
||||||
for logging the warning. By default, it is @samp{*Warnings*}.
|
for logging the warning. By default, it is @file{*Warnings*}.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@defun lwarn type level message &rest args
|
@defun lwarn type level message &rest args
|
||||||
|
@ -2752,7 +2752,7 @@ For text matching a search command.
|
||||||
@itemx warning
|
@itemx warning
|
||||||
@itemx success
|
@itemx success
|
||||||
For text concerning errors, warnings, or successes. For example,
|
For text concerning errors, warnings, or successes. For example,
|
||||||
these are used for messages in @samp{*Compilation*} buffers.
|
these are used for messages in @file{*Compilation*} buffers.
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
@node Font Selection
|
@node Font Selection
|
||||||
|
|
|
@ -622,7 +622,7 @@ back to the stop point in the source code buffer from any buffer using
|
||||||
saved outside window configuration---so that even if you turn saving
|
saved outside window configuration---so that even if you turn saving
|
||||||
back @emph{on}, the current window configuration remains unchanged when
|
back @emph{on}, the current window configuration remains unchanged when
|
||||||
you next exit Edebug (by continuing the program). However, the
|
you next exit Edebug (by continuing the program). However, the
|
||||||
automatic redisplay of @samp{*edebug*} and @samp{*edebug-trace*} may
|
automatic redisplay of @file{*edebug*} and @file{*edebug-trace*} may
|
||||||
conflict with the buffers you wish to see unless you have enough windows
|
conflict with the buffers you wish to see unless you have enough windows
|
||||||
open.
|
open.
|
||||||
|
|
||||||
|
@ -661,18 +661,18 @@ lexically bound symbols created by the following constructs in
|
||||||
@node Eval List
|
@node Eval List
|
||||||
@subsection Evaluation List Buffer
|
@subsection Evaluation List Buffer
|
||||||
|
|
||||||
You can use the @dfn{evaluation list buffer}, called @samp{*edebug*}, to
|
You can use the @dfn{evaluation list buffer}, called @file{*edebug*}, to
|
||||||
evaluate expressions interactively. You can also set up the
|
evaluate expressions interactively. You can also set up the
|
||||||
@dfn{evaluation list} of expressions to be evaluated automatically each
|
@dfn{evaluation list} of expressions to be evaluated automatically each
|
||||||
time Edebug updates the display.
|
time Edebug updates the display.
|
||||||
|
|
||||||
@table @kbd
|
@table @kbd
|
||||||
@item E
|
@item E
|
||||||
Switch to the evaluation list buffer @samp{*edebug*}
|
Switch to the evaluation list buffer @file{*edebug*}
|
||||||
(@code{edebug-visit-eval-list}).
|
(@code{edebug-visit-eval-list}).
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
In the @samp{*edebug*} buffer you can use the commands of Lisp
|
In the @file{*edebug*} buffer you can use the commands of Lisp
|
||||||
Interaction mode (@pxref{Lisp Interaction,,, emacs, The GNU Emacs
|
Interaction mode (@pxref{Lisp Interaction,,, emacs, The GNU Emacs
|
||||||
Manual}) as well as these special commands:
|
Manual}) as well as these special commands:
|
||||||
|
|
||||||
|
@ -699,7 +699,7 @@ Switch back to the source code buffer at the current stop point
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
You can evaluate expressions in the evaluation list window with
|
You can evaluate expressions in the evaluation list window with
|
||||||
@kbd{C-j} or @kbd{C-x C-e}, just as you would in @samp{*scratch*};
|
@kbd{C-j} or @kbd{C-x C-e}, just as you would in @file{*scratch*};
|
||||||
but they are evaluated in the context outside of Edebug.
|
but they are evaluated in the context outside of Edebug.
|
||||||
|
|
||||||
The expressions you enter interactively (and their results) are lost
|
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
|
||||||
@kbd{C-c C-u}. You need not insert dashes in the comment line---its
|
@kbd{C-c C-u}. You need not insert dashes in the comment line---its
|
||||||
contents don't matter.
|
contents don't matter.
|
||||||
|
|
||||||
After selecting @samp{*edebug*}, you can return to the source code
|
After selecting @file{*edebug*}, you can return to the source code
|
||||||
buffer with @kbd{C-c C-w}. The @samp{*edebug*} buffer is killed when
|
buffer with @kbd{C-c C-w}. The @file{*edebug*} buffer is killed when
|
||||||
you continue execution, and recreated next time it is needed.
|
you continue execution, and recreated next time it is needed.
|
||||||
|
|
||||||
@node Printing in Edebug
|
@node Printing in Edebug
|
||||||
|
@ -819,7 +819,7 @@ for details.
|
||||||
@cindex trace buffer
|
@cindex trace buffer
|
||||||
|
|
||||||
Edebug can record an execution trace, storing it in a buffer named
|
Edebug can record an execution trace, storing it in a buffer named
|
||||||
@samp{*edebug-trace*}. This is a log of function calls and returns,
|
@file{*edebug-trace*}. This is a log of function calls and returns,
|
||||||
showing the function names and their arguments and values. To enable
|
showing the function names and their arguments and values. To enable
|
||||||
trace recording, set @code{edebug-trace} to a non-@code{nil} value.
|
trace recording, set @code{edebug-trace} to a non-@code{nil} value.
|
||||||
|
|
||||||
|
@ -1567,7 +1567,7 @@ The default value is @code{step}.
|
||||||
|
|
||||||
@defopt edebug-trace
|
@defopt edebug-trace
|
||||||
If this is non-@code{nil}, trace each function entry and exit.
|
If this is non-@code{nil}, trace each function entry and exit.
|
||||||
Tracing output is displayed in a buffer named @samp{*edebug-trace*}, one
|
Tracing output is displayed in a buffer named @file{*edebug-trace*}, one
|
||||||
function entry or exit per line, indented by the recursion level.
|
function entry or exit per line, indented by the recursion level.
|
||||||
|
|
||||||
Also see @code{edebug-tracing}, in @ref{Trace Buffer}.
|
Also see @code{edebug-tracing}, in @ref{Trace Buffer}.
|
||||||
|
|
|
@ -807,7 +807,7 @@ The value of this variable is a list of the values returned by all the
|
||||||
expressions that were read, evaluated, and printed from buffers
|
expressions that were read, evaluated, and printed from buffers
|
||||||
(including the minibuffer) by the standard Emacs commands which do
|
(including the minibuffer) by the standard Emacs commands which do
|
||||||
this. (Note that this does @emph{not} include evaluation in
|
this. (Note that this does @emph{not} include evaluation in
|
||||||
@samp{*ielm*} buffers, nor evaluation using @kbd{C-j} in
|
@file{*ielm*} buffers, nor evaluation using @kbd{C-j} in
|
||||||
@code{lisp-interaction-mode}.) The elements are ordered most recent
|
@code{lisp-interaction-mode}.) The elements are ordered most recent
|
||||||
first.
|
first.
|
||||||
|
|
||||||
|
|
|
@ -180,7 +180,7 @@ face.
|
||||||
@c Wordy to prevent overfull hboxes. --rjc 15mar92
|
@c Wordy to prevent overfull hboxes. --rjc 15mar92
|
||||||
Here is an example of using the two functions, @code{documentation} and
|
Here is an example of using the two functions, @code{documentation} and
|
||||||
@code{documentation-property}, to display the documentation strings for
|
@code{documentation-property}, to display the documentation strings for
|
||||||
several symbols in a @samp{*Help*} buffer.
|
several symbols in a @file{*Help*} buffer.
|
||||||
|
|
||||||
@anchor{describe-symbols example}
|
@anchor{describe-symbols example}
|
||||||
@smallexample
|
@smallexample
|
||||||
|
@ -535,7 +535,7 @@ seems to be as a match. Each of the remaining elements is a
|
||||||
documentation string, or @code{nil}, for @var{symbol} as a function,
|
documentation string, or @code{nil}, for @var{symbol} as a function,
|
||||||
variable, etc.
|
variable, etc.
|
||||||
|
|
||||||
It also displays the symbols in a buffer named @samp{*Apropos*}, each
|
It also displays the symbols in a buffer named @file{*Apropos*}, each
|
||||||
with a one-line description taken from the beginning of its
|
with a one-line description taken from the beginning of its
|
||||||
documentation string.
|
documentation string.
|
||||||
|
|
||||||
|
@ -648,7 +648,7 @@ certain documentation and text files that come with Emacs.
|
||||||
|
|
||||||
@defun help-buffer
|
@defun help-buffer
|
||||||
This function returns the name of the help buffer, which is normally
|
This function returns the name of the help buffer, which is normally
|
||||||
@samp{*Help*}; if such a buffer does not exist, it is first created.
|
@file{*Help*}; if such a buffer does not exist, it is first created.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@defmac with-help-window buffer-name body@dots{}
|
@defmac with-help-window buffer-name body@dots{}
|
||||||
|
@ -662,16 +662,16 @@ scroll the help window.
|
||||||
@end defmac
|
@end defmac
|
||||||
|
|
||||||
@defun help-setup-xref item interactive-p
|
@defun help-setup-xref item interactive-p
|
||||||
This function updates the cross reference data in the @samp{*Help*}
|
This function updates the cross reference data in the @file{*Help*}
|
||||||
buffer, which is used to regenerate the help information when the user
|
buffer, which is used to regenerate the help information when the user
|
||||||
clicks on the @samp{Back} or @samp{Forward} buttons. Most commands
|
clicks on the @samp{Back} or @samp{Forward} buttons. Most commands
|
||||||
that use the @samp{*Help*} buffer should invoke this function before
|
that use the @file{*Help*} buffer should invoke this function before
|
||||||
clearing the buffer. The @var{item} argument should have the form
|
clearing the buffer. The @var{item} argument should have the form
|
||||||
@code{(@var{function} . @var{args})}, where @var{function} is a function
|
@code{(@var{function} . @var{args})}, where @var{function} is a function
|
||||||
to call, with argument list @var{args}, to regenerate the help buffer.
|
to call, with argument list @var{args}, to regenerate the help buffer.
|
||||||
The @var{interactive-p} argument is non-@code{nil} if the calling
|
The @var{interactive-p} argument is non-@code{nil} if the calling
|
||||||
command was invoked interactively; in that case, the stack of items
|
command was invoked interactively; in that case, the stack of items
|
||||||
for the @samp{*Help*} buffer's @samp{Back} buttons is cleared.
|
for the @file{*Help*} buffer's @samp{Back} buttons is cleared.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@xref{describe-symbols example}, for an example of using
|
@xref{describe-symbols example}, for an example of using
|
||||||
|
|
|
@ -247,7 +247,7 @@ indicated with @samp{@equiv{}}.
|
||||||
|
|
||||||
Many of the examples in this manual print text when they are
|
Many of the examples in this manual print text when they are
|
||||||
evaluated. If you execute example code in a Lisp Interaction buffer
|
evaluated. If you execute example code in a Lisp Interaction buffer
|
||||||
(such as the buffer @samp{*scratch*}), the printed text is inserted into
|
(such as the buffer @file{*scratch*}), the printed text is inserted into
|
||||||
the buffer. If you execute the example by other means (such as by
|
the buffer. If you execute the example by other means (such as by
|
||||||
evaluating the function @code{eval-region}), the printed text is
|
evaluating the function @code{eval-region}), the printed text is
|
||||||
displayed in the echo area.
|
displayed in the echo area.
|
||||||
|
|
|
@ -808,7 +808,7 @@ bindings.
|
||||||
@defun current-local-map
|
@defun current-local-map
|
||||||
This function returns the current buffer's local keymap, or @code{nil}
|
This function returns the current buffer's local keymap, or @code{nil}
|
||||||
if it has none. In the following example, the keymap for the
|
if it has none. In the following example, the keymap for the
|
||||||
@samp{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap
|
@file{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap
|
||||||
in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse
|
in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse
|
||||||
keymap.
|
keymap.
|
||||||
|
|
||||||
|
@ -1922,7 +1922,7 @@ other command. However, if @var{no-remap} is non-@code{nil}.
|
||||||
|
|
||||||
@deffn Command describe-bindings &optional prefix buffer-or-name
|
@deffn Command describe-bindings &optional prefix buffer-or-name
|
||||||
This function creates a listing of all current key bindings, and
|
This function creates a listing of all current key bindings, and
|
||||||
displays it in a buffer named @samp{*Help*}. The text is grouped by
|
displays it in a buffer named @file{*Help*}. The text is grouped by
|
||||||
modes---minor modes first, then the major mode, then global bindings.
|
modes---minor modes first, then the major mode, then global bindings.
|
||||||
|
|
||||||
If @var{prefix} is non-@code{nil}, it should be a prefix key; then the
|
If @var{prefix} is non-@code{nil}, it should be a prefix key; then the
|
||||||
|
|
|
@ -1062,7 +1062,7 @@ using the value of the variable @code{minibuffer-completion-table} as
|
||||||
the @var{collection} argument, and the value of
|
the @var{collection} argument, and the value of
|
||||||
@code{minibuffer-completion-predicate} as the @var{predicate} argument.
|
@code{minibuffer-completion-predicate} as the @var{predicate} argument.
|
||||||
The list of completions is displayed as text in a buffer named
|
The list of completions is displayed as text in a buffer named
|
||||||
@samp{*Completions*}.
|
@file{*Completions*}.
|
||||||
@end deffn
|
@end deffn
|
||||||
|
|
||||||
@defun display-completion-list completions &optional common-substring
|
@defun display-completion-list completions &optional common-substring
|
||||||
|
@ -1756,7 +1756,7 @@ completion behavior is overridden. @xref{Completion Variables}.
|
||||||
The value should be a function for @dfn{annotating} completions. The
|
The value should be a function for @dfn{annotating} completions. The
|
||||||
function should take one argument, @var{string}, which is a possible
|
function should take one argument, @var{string}, which is a possible
|
||||||
completion. It should return a string, which is displayed after the
|
completion. It should return a string, which is displayed after the
|
||||||
completion @var{string} in the @samp{*Completions*} buffer.
|
completion @var{string} in the @file{*Completions*} buffer.
|
||||||
|
|
||||||
@item display-sort-function
|
@item display-sort-function
|
||||||
The value should be a function for sorting completions. The function
|
The value should be a function for sorting completions. The function
|
||||||
|
|
|
@ -628,7 +628,7 @@ have set.
|
||||||
This function sets the major mode of @var{buffer} to the default value of
|
This function sets the major mode of @var{buffer} to the default value of
|
||||||
@code{major-mode}; if that is @code{nil}, it uses the
|
@code{major-mode}; if that is @code{nil}, it uses the
|
||||||
current buffer's major mode (if that is suitable). As an exception,
|
current buffer's major mode (if that is suitable). As an exception,
|
||||||
if @var{buffer}'s name is @samp{*scratch*}, it sets the mode to
|
if @var{buffer}'s name is @file{*scratch*}, it sets the mode to
|
||||||
@code{initial-major-mode}.
|
@code{initial-major-mode}.
|
||||||
|
|
||||||
The low-level primitives for creating buffers do not use this function,
|
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
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@defopt initial-major-mode
|
@defopt initial-major-mode
|
||||||
@cindex @samp{*scratch*}
|
@cindex @file{*scratch*}
|
||||||
The value of this variable determines the major mode of the initial
|
The value of this variable determines the major mode of the initial
|
||||||
@samp{*scratch*} buffer. The value should be a symbol that is a major
|
@file{*scratch*} buffer. The value should be a symbol that is a major
|
||||||
mode command. The default value is @code{lisp-interaction-mode}.
|
mode command. The default value is @code{lisp-interaction-mode}.
|
||||||
@end defopt
|
@end defopt
|
||||||
|
|
||||||
|
@ -908,7 +908,7 @@ common bindings, including @kbd{q} for @code{quit-window}, @kbd{z} for
|
||||||
(@pxref{Reverting}).
|
(@pxref{Reverting}).
|
||||||
|
|
||||||
An example of a major mode derived from Special mode is Buffer Menu
|
An example of a major mode derived from Special mode is Buffer Menu
|
||||||
mode, which is used by the @samp{*Buffer List*} buffer. @xref{List
|
mode, which is used by the @file{*Buffer List*} buffer. @xref{List
|
||||||
Buffers,,Listing Existing Buffers, emacs, The GNU Emacs Manual}.
|
Buffers,,Listing Existing Buffers, emacs, The GNU Emacs Manual}.
|
||||||
@end deffn
|
@end deffn
|
||||||
|
|
||||||
|
@ -2016,7 +2016,7 @@ identify the mode name in the mode line, use @code{format-mode-line}
|
||||||
This buffer-local variable contains the mode line information on process
|
This buffer-local variable contains the mode line information on process
|
||||||
status in modes used for communicating with subprocesses. It is
|
status in modes used for communicating with subprocesses. It is
|
||||||
displayed immediately following the major mode name, with no intervening
|
displayed immediately following the major mode name, with no intervening
|
||||||
space. For example, its value in the @samp{*shell*} buffer is
|
space. For example, its value in the @file{*shell*} buffer is
|
||||||
@code{(":%s")}, which allows the shell to display its status along
|
@code{(":%s")}, which allows the shell to display its status along
|
||||||
with the major mode as: @samp{(Shell:run)}. Normally this variable
|
with the major mode as: @samp{(Shell:run)}. Normally this variable
|
||||||
is @code{nil}.
|
is @code{nil}.
|
||||||
|
|
|
@ -170,7 +170,7 @@ measurement of how long it took.
|
||||||
It runs the normal hook @code{after-init-hook}.
|
It runs the normal hook @code{after-init-hook}.
|
||||||
|
|
||||||
@item
|
@item
|
||||||
If the buffer @samp{*scratch*} exists and is still in Fundamental mode
|
If the buffer @file{*scratch*} exists and is still in Fundamental mode
|
||||||
(as it should be by default), it sets its major mode according to
|
(as it should be by default), it sets its major mode according to
|
||||||
@code{initial-major-mode}.
|
@code{initial-major-mode}.
|
||||||
|
|
||||||
|
@ -196,7 +196,7 @@ It now exits if the option @code{--batch} was specified.
|
||||||
|
|
||||||
@item
|
@item
|
||||||
If @code{initial-buffer-choice} is a string, it visits the file with
|
If @code{initial-buffer-choice} is a string, it visits the file with
|
||||||
that name. If the @samp{*scratch*} buffer exists and is
|
that name. If the @file{*scratch*} buffer exists and is
|
||||||
empty, it inserts @code{initial-scratch-message} into that buffer.
|
empty, it inserts @code{initial-scratch-message} into that buffer.
|
||||||
|
|
||||||
@c To make things nice and confusing, the next three items can be
|
@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.
|
||||||
|
|
||||||
@defopt inhibit-startup-screen
|
@defopt inhibit-startup-screen
|
||||||
This variable, if non-@code{nil}, inhibits the startup screen. In
|
This variable, if non-@code{nil}, inhibits the startup screen. In
|
||||||
that case, Emacs typically displays the @samp{*scratch*} buffer; but
|
that case, Emacs typically displays the @file{*scratch*} buffer; but
|
||||||
see @code{initial-buffer-choice}, below.
|
see @code{initial-buffer-choice}, below.
|
||||||
|
|
||||||
Do not set this variable in the init file of a new user, or in a way
|
Do not set this variable in the init file of a new user, or in a way
|
||||||
|
@ -274,7 +274,7 @@ startup screen.
|
||||||
@ignore
|
@ignore
|
||||||
@c I do not think this should be mentioned. AFAICS it is just a dodge
|
@c I do not think this should be mentioned. AFAICS it is just a dodge
|
||||||
@c around inhibit-startup-screen not being settable on a site-wide basis.
|
@c around inhibit-startup-screen not being settable on a site-wide basis.
|
||||||
If its value is @code{t}, Emacs displays the @samp{*scratch*} buffer.
|
If its value is @code{t}, Emacs displays the @file{*scratch*} buffer.
|
||||||
@end ignore
|
@end ignore
|
||||||
@end defopt
|
@end defopt
|
||||||
|
|
||||||
|
@ -299,8 +299,8 @@ file will not inhibit the message for someone else.
|
||||||
|
|
||||||
@defopt initial-scratch-message
|
@defopt initial-scratch-message
|
||||||
This variable, if non-@code{nil}, should be a string, which is
|
This variable, if non-@code{nil}, should be a string, which is
|
||||||
inserted into the @samp{*scratch*} buffer when Emacs starts up. If it
|
inserted into the @file{*scratch*} buffer when Emacs starts up. If it
|
||||||
is @code{nil}, the @samp{*scratch*} buffer is empty.
|
is @code{nil}, the @file{*scratch*} buffer is empty.
|
||||||
@end defopt
|
@end defopt
|
||||||
|
|
||||||
@noindent
|
@noindent
|
||||||
|
@ -2233,7 +2233,7 @@ non-@code{nil}, Emacs tells the session manager to cancel the
|
||||||
shutdown.
|
shutdown.
|
||||||
@end defvar
|
@end defvar
|
||||||
|
|
||||||
Here is an example that just inserts some text into @samp{*scratch*} when
|
Here is an example that just inserts some text into @file{*scratch*} when
|
||||||
Emacs is restarted by the session manager.
|
Emacs is restarted by the session manager.
|
||||||
|
|
||||||
@example
|
@example
|
||||||
|
|
|
@ -714,7 +714,7 @@ This command displays a listing of all living processes. In addition,
|
||||||
it finally deletes any process whose status was @samp{Exited} or
|
it finally deletes any process whose status was @samp{Exited} or
|
||||||
@samp{Signaled}. It returns @code{nil}.
|
@samp{Signaled}. It returns @code{nil}.
|
||||||
|
|
||||||
The processes are shown in a buffer named @samp{*Process List*}, whose
|
The processes are shown in a buffer named @file{*Process List*}, whose
|
||||||
major mode is named Process Menu mode.
|
major mode is named Process Menu mode.
|
||||||
|
|
||||||
If @var{query-only} is non-@code{nil} then it lists only processes
|
If @var{query-only} is non-@code{nil} then it lists only processes
|
||||||
|
|
|
@ -4345,7 +4345,7 @@ changed text, its length is simply the difference between the first two
|
||||||
arguments.
|
arguments.
|
||||||
@end defvar
|
@end defvar
|
||||||
|
|
||||||
Output of messages into the @samp{*Messages*} buffer does not
|
Output of messages into the @file{*Messages*} buffer does not
|
||||||
call these functions.
|
call these functions.
|
||||||
|
|
||||||
@defmac combine-after-change-calls body@dots{}
|
@defmac combine-after-change-calls body@dots{}
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue