procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

In doc/emacs, use @file for buffers, per the Texinfo manual.

Browse source 
It renders the same as @samp, so there is no visible change in most cases.
This commit is contained in:
Glenn Morris 2012-04-09 23:54:43 -07:00
parent 20331c1c40
commit 1c64e6ed6d
23 changed files with 125 additions and 118 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/emacs/ChangeLog
View file

@ -1,5 +1,12 @@
2012-04-10 Glenn Morris <rgm@gnu.org>
* abbrevs.texi, arevert-xtra.texi, buffers.texi, building.texi:
* cmdargs.texi, custom.texi, entering.texi, files.texi, frames.texi:
* glossary.texi, help.texi, macos.texi, maintaining.texi, mini.texi:
* misc.texi, package.texi, programs.texi, screen.texi, search.texi:
* sending.texi, text.texi, trouble.texi:
Use @file for buffers, per the Texinfo manual.
* entering.texi (Entering Emacs):
Do not mention initial-buffer-choice = t.

4
doc/emacs/abbrevs.texi
View file

@ -261,12 +261,12 @@ expands to itself, and save it to your abbrev file.
@kbd{M-x edit-abbrevs} allows you to add, change or kill abbrev
definitions by editing a list of them in an Emacs buffer. The list has
the same format described above. The buffer of abbrevs is called
@samp{*Abbrevs*}, and is in Edit-Abbrevs mode. Type @kbd{C-c C-c} in
@file{*Abbrevs*}, and is in Edit-Abbrevs mode. Type @kbd{C-c C-c} in
this buffer to install the abbrev definitions as specified in the
buffer---and delete any abbrev definitions not listed.
The command @code{edit-abbrevs} is actually the same as
@code{list-abbrevs} except that it selects the buffer @samp{*Abbrevs*}
@code{list-abbrevs} except that it selects the buffer @file{*Abbrevs*}
whereas @code{list-abbrevs} merely displays it in another window.
@node Saving Abbrevs

4
doc/emacs/arevert-xtra.texi
View file

@ -93,8 +93,8 @@ deleting or changing marks or flags will mark it modified again.
Remote Dired buffers are not auto-reverted (because it may be slow).
Neither are Dired buffers for which you used shell wildcards or file
arguments to list only some of the files. @samp{*Find*} and
@samp{*Locate*} buffers do not auto-revert either.
arguments to list only some of the files. @file{*Find*} and
@file{*Locate*} buffers do not auto-revert either.
@c FIXME? This should be in the elisp manual?
@node Supporting additional buffers

28
doc/emacs/buffers.texi
View file

@ -11,7 +11,7 @@
the file's text. Each time you invoke Dired, a buffer is used to hold
the directory listing. If you send a message with @kbd{C-x m}, a
buffer is used to hold the text of the message. When you ask for a
command's documentation, that appears in a buffer named @samp{*Help*}.
command's documentation, that appears in a buffer named @file{*Help*}.
Each buffer has a unique name, which can be of any length. When a
buffer is displayed in a window, its name is shown in the mode line
@ -19,7 +19,7 @@ buffer is displayed in a window, its name is shown in the mode line
matters in buffer names. Most buffers are made by visiting files, and
their names are derived from the files' names; however, you can also
create an empty buffer with any name you want. A newly started Emacs
has several buffers, including one named @samp{*scratch*}, which can
has several buffers, including one named @file{*scratch*}, which can
be used for evaluating Lisp expressions and is not associated with any
file (@pxref{Lisp Interaction}).
@ -198,7 +198,7 @@ CRM Buffer Size Mode File
@end smallexample
@noindent
The buffer @samp{*Help*} was made by a help request (@pxref{Help}); it
The buffer @file{*Help*} was made by a help request (@pxref{Help}); it
is not visiting any file. The buffer @code{src} was made by Dired on
the directory @file{~/cvs/emacs/src/}. You can list only buffers that
are visiting files by giving the command a prefix argument, as in
@ -248,9 +248,9 @@ happens and no renaming is done.
@kbd{M-x rename-uniquely} renames the current buffer to a similar
name with a numeric suffix added to make it both different and unique.
This command does not need an argument. It is useful for creating
multiple shell buffers: if you rename the @samp{*shell*} buffer, then
multiple shell buffers: if you rename the @file{*shell*} buffer, then
do @kbd{M-x shell} again, it makes a new shell buffer named
@samp{*shell*}; meanwhile, the old shell buffer continues to exist
@file{*shell*}; meanwhile, the old shell buffer continues to exist
under its new name. This method is also good for mail buffers,
compilation buffers, and most Emacs features that create special
buffers with particular names. (With some of these features, such as
@ -354,7 +354,7 @@ operations on buffers, through an interface similar to Dired
@findex buffer-menu
@findex buffer-menu-other-window
To use the buffer menu, type @kbd{C-x C-b} and switch to the window
displaying the @samp{*Buffer List*} buffer. You can also type
displaying the @file{*Buffer List*} buffer. You can also type
@kbd{M-x buffer-menu} to open the buffer menu in the selected window.
Alternatively, the command @kbd{M-x buffer-menu-other-window} opens
the buffer menu in another window, and selects that window.
@ -409,11 +409,11 @@ Quit the buffer menu---immediately display the most recent formerly
visible buffer in its place.
@item @key{RET}
@itemx f
Immediately select this line's buffer in place of the @samp{*Buffer
Immediately select this line's buffer in place of the @file{*Buffer
List*} buffer.
@item o
Immediately select this line's buffer in another window as if by
@kbd{C-x 4 b}, leaving @samp{*Buffer List*} visible.
@kbd{C-x 4 b}, leaving @file{*Buffer List*} visible.
@item C-o
Immediately display this line's buffer in another window, but don't
select the window.
@ -422,7 +422,7 @@ Immediately select this line's buffer in a full-screen window.
@item 2
Immediately set up two windows, with this line's buffer selected in
one, and the previously current buffer (aside from the buffer
@samp{*Buffer List*}) displayed in the other.
@file{*Buffer List*}) displayed in the other.
@item b
Bury the buffer listed on this line.
@item m
@ -448,19 +448,19 @@ the inclusion of such buffers in the buffer list.
suitable buffer, and turn on Buffer Menu mode in it. Everything else
described above is implemented by the special commands provided in
Buffer Menu mode. One consequence of this is that you can switch from
the @samp{*Buffer List*} buffer to another Emacs buffer, and edit
there. You can reselect the @samp{*Buffer List*} buffer later, to
the @file{*Buffer List*} buffer to another Emacs buffer, and edit
there. You can reselect the @file{*Buffer List*} buffer later, to
perform the operations already requested, or you can kill it, or pay
no further attention to it.
Normally, the buffer @samp{*Buffer List*} is not updated
Normally, the buffer @file{*Buffer List*} is not updated
automatically when buffers are created and killed; its contents are
just text. If you have created, deleted or renamed buffers, the way
to update @samp{*Buffer List*} to show what you have done is to type
to update @file{*Buffer List*} to show what you have done is to type
@kbd{g} (@code{revert-buffer}). You can make this happen regularly
every @code{auto-revert-interval} seconds if you enable Auto Revert
mode in this buffer, as long as it is not marked modified. Global
Auto Revert mode applies to the @samp{*Buffer List*} buffer only if
Auto Revert mode applies to the @file{*Buffer List*} buffer only if
@code{global-auto-revert-non-file-buffers} is non-@code{nil}.
@iftex
@inforef{Autorevert,, emacs-xtra}, for details.

66
doc/emacs/building.texi
View file

@ -44,7 +44,7 @@ messages and show you where the errors occurred.
@table @kbd
@item M-x compile
Run a compiler asynchronously under Emacs, with error messages going to
the @samp{*compilation*} buffer.
the @file{*compilation*} buffer.
@item M-x recompile
Invoke a compiler with the same command as in the last invocation of
@kbd{M-x compile}.
@ -57,7 +57,7 @@ Kill the running compilation subprocess.
compile}. This reads a shell command line using the minibuffer, and
then executes the command by running a shell as a subprocess (or
@dfn{inferior process}) of Emacs. The output is inserted in a buffer
named @samp{*compilation*}. The current buffer's default directory is
named @file{*compilation*}. The current buffer's default directory is
used as the working directory for the execution of the command;
normally, therefore, compilation takes place in this directory.
@ -72,19 +72,19 @@ specified is automatically stored in the variable
type @kbd{M-x compile}. A file can also specify a file-local value
for @code{compile-command} (@pxref{File Variables}).
Starting a compilation displays the @samp{*compilation*} buffer in
Starting a compilation displays the @file{*compilation*} buffer in
another window but does not select it. While the compilation is
running, the word @samp{run} is shown in the major mode indicator for
the @samp{*compilation*} buffer, and the word @samp{Compiling} appears
in all mode lines. You do not have to keep the @samp{*compilation*}
the @file{*compilation*} buffer, and the word @samp{Compiling} appears
in all mode lines. You do not have to keep the @file{*compilation*}
buffer visible while compilation is running; it continues in any case.
When the compilation ends, for whatever reason, the mode line of the
@samp{*compilation*} buffer changes to say @samp{exit} (followed by
@file{*compilation*} buffer changes to say @samp{exit} (followed by
the exit code: @samp{[0]} for a normal exit), or @samp{signal} (if a
signal terminated the process).
If you want to watch the compilation transcript as it appears,
switch to the @samp{*compilation*} buffer and move point to the end of
switch to the @file{*compilation*} buffer and move point to the end of
the buffer. When point is at the end, new compilation output is
inserted above point, which remains at the end. Otherwise, point
remains fixed while compilation output is added at the end of the
@ -93,7 +93,7 @@ buffer.
@cindex compilation buffer, keeping point at end
@vindex compilation-scroll-output
If you change the variable @code{compilation-scroll-output} to a
non-@code{nil} value, the @samp{*compilation*} buffer scrolls
non-@code{nil} value, the @file{*compilation*} buffer scrolls
automatically to follow the output. If the value is
@code{first-error}, scrolling stops when the first error appears,
leaving point at that error. For any other non-@code{nil} value,
@ -103,22 +103,22 @@ scrolling continues until there is no more output.
To rerun the last compilation with the same command, type @kbd{M-x
recompile}. This reuses the compilation command from the last
invocation of @kbd{M-x compile}. It also reuses the
@samp{*compilation*} buffer and starts the compilation in its default
@file{*compilation*} buffer and starts the compilation in its default
directory, which is the directory in which the previous compilation
was started.
@findex kill-compilation
Starting a new compilation also kills any compilation already
running in @samp{*compilation*}, as the buffer can only handle one
running in @file{*compilation*}, as the buffer can only handle one
compilation at any time. However, @kbd{M-x compile} asks for
confirmation before actually killing a compilation that is running.
You can also kill the compilation process with @kbd{M-x
kill-compilation}.
To run two compilations at once, start the first one, then rename
the @samp{*compilation*} buffer (perhaps using @code{rename-uniquely};
the @file{*compilation*} buffer (perhaps using @code{rename-uniquely};
@pxref{Misc Buffer}), then switch buffers and start the other
compilation. This will create a new @samp{*compilation*} buffer.
compilation. This will create a new @file{*compilation*} buffer.
@vindex compilation-environment
You can control the environment passed to the compilation command
@ -133,7 +133,7 @@ variable settings override the usual ones.
@cindex Compilation mode
@cindex mode, Compilation
@cindex locus
The @samp{*compilation*} buffer uses a major mode called Compilation
The @file{*compilation*} buffer uses a major mode called Compilation
mode. Compilation mode turns each error message in the buffer into a
hyperlink; you can move point to it and type @key{RET}, or click on it
with the mouse (@pxref{Mouse References}), to visit the @dfn{locus} of
@ -145,10 +145,10 @@ position in a file where that error occurred.
If you change the variable
@code{compilation-auto-jump-to-first-error} to a non-@code{nil} value,
Emacs automatically visits the locus of the first error message that
appears in the @samp{*compilation*} buffer.
appears in the @file{*compilation*} buffer.
Compilation mode provides the following additional commands. These
commands can also be used in @samp{*grep*} buffers, where the
commands can also be used in @file{*grep*} buffers, where the
hyperlinks are search matches rather than error messages (@pxref{Grep
Searching}).
@ -190,7 +190,7 @@ mode buffer. The first time you invoke it after a compilation, it
visits the locus of the first error message. Each subsequent
@w{@kbd{C-x `}} visits the next error, in a similar fashion. If you
visit a specific error with @key{RET} or a mouse click in the
@samp{*compilation*} buffer, subsequent @w{@kbd{C-x `}} commands
@file{*compilation*} buffer, subsequent @w{@kbd{C-x `}} commands
advance from there. When @w{@kbd{C-x `}} finds no more error messages
to visit, it signals an error. @w{@kbd{C-u C-x `}} starts again from
the beginning of the compilation buffer, and visits the first locus.
@ -199,8 +199,8 @@ the beginning of the compilation buffer, and visits the first locus.
through errors in the opposite direction.
The @code{next-error} and @code{previous-error} commands don't just
act on the errors or matches listed in @samp{*compilation*} and
@samp{*grep*} buffers; they also know how to iterate through error or
act on the errors or matches listed in @file{*compilation*} and
@file{*grep*} buffers; they also know how to iterate through error or
match lists produced by other commands, such as @kbd{M-x occur}
(@pxref{Other Repeating Search}). If you are already in a buffer
containing error messages or matches, those are the ones that are
@ -224,7 +224,7 @@ highlights the relevant source line. The duration of this highlight
is determined by the variable @code{next-error-highlight}.
@vindex compilation-context-lines
If the @samp{*compilation*} buffer is shown in a window with a left
If the @file{*compilation*} buffer is shown in a window with a left
fringe (@pxref{Fringes}), the locus-visiting commands put an arrow in
the fringe, pointing to the current error message. If the window has
no left fringe, such as on a text-only terminal, these commands scroll
@ -276,7 +276,7 @@ Names}).
command, but specifies the option for a noninteractive shell. This
means, in particular, that the shell should start with no prompt. If
you find your usual shell prompt making an unsightly appearance in the
@samp{*compilation*} buffer, it means you have made a mistake in your
@file{*compilation*} buffer, it means you have made a mistake in your
shell's init file by setting the prompt unconditionally. (This init
file may be named @file{.bashrc}, @file{.profile}, @file{.cshrc},
@file{.shrc}, etc., depending on what shell you use.) The shell init
@ -339,14 +339,14 @@ mode (@pxref{Compilation Mode}).
@item M-x grep
@itemx M-x lgrep
Run @command{grep} asynchronously under Emacs, listing matching lines in
the buffer named @samp{*grep*}.
the buffer named @file{*grep*}.
@item M-x grep-find
@itemx M-x find-grep
@itemx M-x rgrep
Run @command{grep} via @code{find}, and collect output in the
@samp{*grep*} buffer.
@file{*grep*} buffer.
@item M-x zrgrep
Run @code{zgrep} and collect output in the @samp{*grep*} buffer.
Run @code{zgrep} and collect output in the @file{*grep*} buffer.
@item M-x kill-grep
Kill the running @command{grep} subprocess.
@end table
@ -369,7 +369,7 @@ can chain @command{grep} commands, like this:
grep -nH -e foo *.el | grep bar | grep toto
@end example
The output from @command{grep} goes in the @samp{*grep*} buffer. You
The output from @command{grep} goes in the @file{*grep*} buffer. You
can find the corresponding lines in the original files using @w{@kbd{C-x
`}}, @key{RET}, and so forth, just like compilation errors.
@ -1506,14 +1506,14 @@ commands are used; its default is @code{t}.
@section Lisp Interaction Buffers
@findex lisp-interaction-mode
When Emacs starts up, it contains a buffer named @samp{*scratch*},
When Emacs starts up, it contains a buffer named @file{*scratch*},
which is provided for evaluating Emacs Lisp expressions interactively.
Its major mode is Lisp Interaction mode. You can also enable Lisp
Interaction mode by typing @kbd{M-x lisp-interaction-mode}.
@findex eval-print-last-sexp
@kindex C-j @r{(Lisp Interaction mode)}
In the @samp{*scratch*} buffer, and other Lisp Interaction mode
In the @file{*scratch*} buffer, and other Lisp Interaction mode
buffers, @kbd{C-j} (@code{eval-print-last-sexp}) evaluates the Lisp
expression before point, and inserts the value at point. Thus, as you
type expressions into the buffer followed by @kbd{C-j} after each
@ -1522,7 +1522,7 @@ expressions and their values. All other commands in Lisp Interaction
mode are the same as in Emacs Lisp mode.
@vindex initial-scratch-message
At startup, the @samp{*scratch*} buffer contains a short message, in
At startup, the @file{*scratch*} buffer contains a short message, in
the form of a Lisp comment, that explains what it is for. This
message is controlled by the variable @code{initial-scratch-message},
which should be either a string, or @code{nil} (which means to
@ -1533,7 +1533,7 @@ suppress the message).
interactively is to use Inferior Emacs Lisp mode, which provides an
interface rather like Shell mode (@pxref{Shell Mode}) for evaluating
Emacs Lisp expressions. Type @kbd{M-x ielm} to create an
@samp{*ielm*} buffer which uses this mode. For more information, see
@file{*ielm*} buffer which uses this mode. For more information, see
that command's documentation.
@node External Lisp
@ -1555,13 +1555,13 @@ whose names end in @file{.l}, @file{.lsp}, or @file{.lisp}.
evaluated. To begin an external Lisp session, type @kbd{M-x
run-lisp}. This runs the program named @command{lisp}, and sets it up
so that both input and output go through an Emacs buffer named
@samp{*inferior-lisp*}. To change the name of the Lisp program run by
@file{*inferior-lisp*}. To change the name of the Lisp program run by
@kbd{M-x run-lisp}, change the variable @code{inferior-lisp-program}.
The major mode for the @samp{*lisp*} buffer is Inferior Lisp mode,
The major mode for the @file{*lisp*} buffer is Inferior Lisp mode,
which combines the characteristics of Lisp mode and Shell mode
(@pxref{Shell Mode}). To send input to the Lisp session, go to the
end of the @samp{*lisp*} buffer and type the input, followed by
end of the @file{*lisp*} buffer and type the input, followed by
@key{RET}. Terminal output from the Lisp session is automatically
inserted in the buffer.
@ -1572,7 +1572,7 @@ inserted in the buffer.
buffer to a Lisp session that you had started with @kbd{M-x run-lisp}.
The expression sent is the top-level Lisp expression at or following
point. The resulting value goes as usual into the
@samp{*inferior-lisp*} buffer. Note that the effect of @kbd{C-M-x} in
@file{*inferior-lisp*} buffer. Note that the effect of @kbd{C-M-x} in
Lisp mode is thus very similar to its effect in Emacs Lisp mode
(@pxref{Lisp Eval}), except that the expression is sent to a different
Lisp environment instead of being evaluated in Emacs.
@ -1587,4 +1587,4 @@ to a Scheme subprocess, are very similar. Scheme source files are
edited in Scheme mode, which can be explicitly enabled with @kbd{M-x
scheme-mode}. You can initiate a Scheme session by typing @kbd{M-x
run-scheme} (the buffer for interacting with Scheme is named
@samp{*scheme*}), and send expressions to it by typing @kbd{C-M-x}.
@file{*scheme*}), and send expressions to it by typing @kbd{C-M-x}.

2
doc/emacs/cmdargs.texi
View file

@ -157,7 +157,7 @@ Evaluate Lisp expression @var{expression}.
@item --insert=@var{file}
@opindex --insert
@cindex insert file contents, command-line argument
Insert the contents of @var{file} into the @samp{*scratch*} buffer
Insert the contents of @var{file} into the @file{*scratch*} buffer
(@pxref{Lisp Interaction}). This is like what @kbd{M-x insert-file}
does (@pxref{Misc File Ops}).

20
doc/emacs/custom.texi
View file

@ -561,7 +561,7 @@ format of a theme file and how to make one.
@vindex custom-theme-directory
@cindex color scheme
Type @kbd{M-x customize-themes} to switch to a buffer named
@samp{*Custom Themes*}, which lists the Custom themes that Emacs knows
@file{*Custom Themes*}, which lists the Custom themes that Emacs knows
about. By default, Emacs looks for theme files in two locations: the
directory specified by the variable @code{custom-theme-directory}
(which defaults to @file{~/.emacs.d/}), and a directory named
@ -580,11 +580,11 @@ add the directory name to the list variable
@code{custom-theme-directory} has the special meaning of the value of
the variable @code{custom-theme-directory}, while @code{t} stands for
the built-in theme directory @file{etc/themes}. The themes listed in
the @samp{*Custom Themes*} buffer are those found in the directories
the @file{*Custom Themes*} buffer are those found in the directories
specified by @code{custom-theme-load-path}.
@kindex C-x C-s @r{(Custom Themes buffer)}
In the @samp{*Custom Themes*} buffer, you can activate the checkbox
In the @file{*Custom Themes*} buffer, you can activate the checkbox
next to a Custom theme to enable or disable the theme for the current
Emacs session. When a Custom theme is enabled, all of its settings
(variables and faces) take effect in the Emacs session. To apply the
@ -608,7 +608,7 @@ always considered safe.
Setting or saving Custom themes actually works by customizing the
variable @code{custom-enabled-themes}. The value of this variable is
a list of Custom theme names (as Lisp symbols, e.g.@: @code{tango}).
Instead of using the @samp{*Custom Themes*} buffer to set
Instead of using the @file{*Custom Themes*} buffer to set
@code{custom-enabled-themes}, you can customize the variable using the
usual customization interface, e.g.@: with @kbd{M-x customize-option}.
Note that Custom themes are not allowed to set
@ -635,7 +635,7 @@ type @kbd{M-x disable-theme}.
@findex describe-theme
To see a description of a Custom theme, type @kbd{?} on its line in
the @samp{*Custom Themes*} buffer; or type @kbd{M-x describe-theme}
the @file{*Custom Themes*} buffer; or type @kbd{M-x describe-theme}
anywhere in Emacs and enter the theme name in the minibuffer.
@node Creating Custom Themes
@ -645,12 +645,12 @@ anywhere in Emacs and enter the theme name in the minibuffer.
@findex customize-create-theme
You can define a Custom theme using an interface similar to the
customization buffer, by typing @kbd{M-x customize-create-theme}.
This switches to a buffer named @samp{*Custom Theme*}. It also offers
This switches to a buffer named @file{*Custom Theme*}. It also offers
to insert some common Emacs faces into the theme (a convenience, since
Custom themes are often used to customize faces). If you answer no,
the theme will initially contain no settings.
Near the top of the @samp{*Custom Theme*} buffer are editable fields
Near the top of the @file{*Custom Theme*} buffer are editable fields
where you can enter the theme's name and description. The name can be
anything except @samp{user}. The description is the one that will be
shown when you invoke @kbd{M-x describe-theme} for the theme. Its
@ -673,7 +673,7 @@ theme, uncheck the checkbox next to its name.
@file{@var{name}-theme.el} where @var{name} is the theme name, in the
directory named by @code{custom-theme-directory}.
From the @samp{*Custom Theme*} buffer, you can view and edit an
From the @file{*Custom Theme*} buffer, you can view and edit an
existing Custom theme by activating the @samp{[Visit Theme]} button
and specifying the theme name. You can also add the settings of
another theme into the buffer, using the @samp{[Merge Theme]} button.
@ -683,7 +683,7 @@ the @samp{[Merge Theme]} button and specifying the special theme named
A theme file is simply an Emacs Lisp source file, and loading the
Custom theme works by loading the Lisp file. Therefore, you can edit
a theme file directly instead of using the @samp{*Custom Theme*}
a theme file directly instead of using the @file{*Custom Theme*}
buffer.
@c Add link to the relevant Emacs Lisp Reference manual node, once
@c that is written.
@ -809,7 +809,7 @@ can set any variable with a Lisp expression like this:
@noindent
To execute such an expression, type @kbd{M-:} (@code{eval-expression})
and enter the expression in the minibuffer (@pxref{Lisp Eval}).
Alternatively, go to the @samp{*scratch*} buffer, type in the
Alternatively, go to the @file{*scratch*} buffer, type in the
expression, and then type @kbd{C-j} (@pxref{Lisp Interaction}).
Setting variables, like all means of customizing Emacs except where

4
doc/emacs/entering.texi
View file

@ -63,7 +63,7 @@ certain Lisp files, where to put the initial frame, and so forth.
If the variable @code{inhibit-startup-screen} is non-@code{nil},
Emacs does not display the startup screen. In that case, if one or
more files were specified on the command line, Emacs simply displays
those files; otherwise, it displays a buffer named @samp{*scratch*},
those files; otherwise, it displays a buffer named @file{*scratch*},
which can be used to evaluate Emacs Lisp expressions interactively.
@xref{Lisp Interaction}. You can set the variable
@code{inhibit-startup-screen} using the Customize facility
@ -82,7 +82,7 @@ the desired file or directory.
@ignore
@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.
or @code{t}, which means to display the @samp{*scratch*} buffer.
or @code{t}, which means to display the @file{*scratch*} buffer.
@end ignore
@node Exiting, Basic, Entering Emacs, Top

4
doc/emacs/files.texi
View file

@ -976,7 +976,7 @@ are not visiting files are auto-saved only if you request it explicitly;
when they are auto-saved, the auto-save file name is made by appending
@samp{#} to the front and rear of buffer name, then
adding digits and letters at the end for uniqueness. For
example, the @samp{*mail*} buffer in which you compose messages to be
example, the @file{*mail*} buffer in which you compose messages to be
sent might be auto-saved in a file named @file{#*mail*#704juu}. Auto-save file
names are made this way unless you reprogram parts of Emacs to do
something different (the functions @code{make-auto-save-file-name} and
@ -1245,7 +1245,7 @@ for more information about using the Trash.
@vindex diff-switches
The command @kbd{M-x diff} prompts for two file names, using the
minibuffer, and displays the differences between the two files in a
buffer named @samp{*diff*}. This works by running the @command{diff}
buffer named @file{*diff*}. This works by running the @command{diff}
program, using options taken from the variable @code{diff-switches}.
The value of @code{diff-switches} should be a string; the default is
@code{"-c"} to specify a context diff. @xref{Top,, Diff, diff,

2
doc/emacs/frames.texi
View file

@ -257,7 +257,7 @@ highlighting.
@key{RET}, or by clicking either @kbd{Mouse-1} or @kbd{Mouse-2} on the
button. For example, in a Dired buffer, each file name is a button;
activating it causes Emacs to visit that file (@pxref{Dired}). In a
@samp{*Compilation*} buffer, each error message is a button, and
@file{*Compilation*} buffer, each error message is a button, and
activating it visits the source code for that error
(@pxref{Compilation}).

2
doc/emacs/glossary.texi
View file

@ -421,7 +421,7 @@ tell it to. @xref{Bugs}.
The echo area is the bottom line of the screen, used for echoing the
arguments to commands, for asking questions, and showing brief messages
(including error messages). The messages are stored in the buffer
@samp{*Messages*} so you can review them later. @xref{Echo Area}.
@file{*Messages*} so you can review them later. @xref{Echo Area}.
@item Echoing
Echoing is acknowledging the receipt of input events by displaying

6
doc/emacs/help.texi
View file

@ -102,7 +102,7 @@ to (@code{describe-key-briefly}). Here @kbd{c} stands for
Display the commands and variables whose documentation matches
@var{topics} (@code{apropos-documentation}).
@item C-h e
Display the @code{*Messages*} buffer
Display the @file{*Messages*} buffer
(@code{view-echo-area-messages}).
@item C-h f @var{function} @key{RET}
Display documentation on the Lisp function named @var{function}
@ -168,7 +168,7 @@ programming language you are editing (@code{info-lookup-symbol}).
@item C-h .
Display the help message for a special text area, if point is in one
(@code{display-local-help}). (These include, for example, links in
@samp{*Help*} buffers.)
@file{*Help*} buffers.)
@end table
@node Key Help
@ -519,7 +519,7 @@ use @kbd{C-h c} to find out what they do.
@findex view-echo-area-messages
To review recent echo area messages, use @kbd{C-h e}
(@code{view-echo-area-messages}). This displays the buffer
@code{*Messages*}, where those messages are kept.
@file{*Messages*}, where those messages are kept.
@kindex C-h m
@findex describe-mode

2
doc/emacs/macos.texi
View file

@ -142,7 +142,7 @@ Emacs open a file. A typical reason for this would be a user
double-clicking a file in the Finder application. By default, Emacs
responds to this event by opening a new frame and visiting the file in
that frame (@code{ns-find-file}). As an exception, if the selected
buffer is the @samp{*scratch*} buffer, Emacs visits the file in the
buffer is the @file{*scratch*} buffer, Emacs visits the file in the
selected frame.
You can change how Emacs responds to a @code{ns-open-file} event by

32
doc/emacs/maintaining.texi
View file

@ -477,7 +477,7 @@ If every work file in the VC fileset is unchanged, do nothing.
@item
If every work file in the VC fileset has been modified, commit the
changes. To do this, Emacs pops up a @samp{*vc-log*} buffer; type the
changes. To do this, Emacs pops up a @file{*vc-log*} buffer; type the
desired log entry for the new revision, followed by @kbd{C-c C-c} to
commit. @xref{Log Buffer}.
@ -530,7 +530,7 @@ so that you can begin to edit it.
@item
If each file is locked by you and contains changes, commit the
changes. To do this, Emacs pops up a @samp{*vc-log*} buffer; type the
changes. To do this, Emacs pops up a @file{*vc-log*} buffer; type the
desired log entry for the new revision, followed by @kbd{C-c C-c} to
commit (@pxref{Log Buffer}).
@ -588,7 +588,7 @@ they use the concept of ``checking out'' individual files.
@cindex C-c C-c @r{(Log Edit mode)}
@findex log-edit-done
When you tell VC to commit a change, it pops up a buffer named
@samp{*vc-log*}. In this buffer, you should write a @dfn{log entry}
@file{*vc-log*}. In this buffer, you should write a @dfn{log entry}
describing the changes you have made (@pxref{Why Version Control?}).
After you are done, type @kbd{C-c C-c} (@code{log-edit-done}) to exit
the buffer and commit the change, together with your log entry.
@ -596,12 +596,12 @@ the buffer and commit the change, together with your log entry.
@cindex Log Edit mode
@cindex mode, Log Edit
@vindex vc-log-mode-hook
The major mode for the @samp{*vc-log*} buffer is Log Edit mode, a
The major mode for the @file{*vc-log*} buffer is Log Edit mode, a
variant of Text mode (@pxref{Text Mode}). On entering Log Edit mode,
Emacs runs the hooks @code{text-mode-hook} and @code{vc-log-mode-hook}
(@pxref{Hooks}).
In the @samp{*vc-log*} buffer, you can write one or more @dfn{header
In the @file{*vc-log*} buffer, you can write one or more @dfn{header
lines}, specifying additional information to be supplied to the
version control system. Each header line must occupy a single line at
the top of the buffer; the first line that is not a header line is
@ -626,7 +626,7 @@ support it, the header is treated as part of the log entry.
@findex log-edit-show-files
@kindex C-c C-d @r{(Log Edit mode)}
@findex log-edit-show-diff
While in the @samp{*vc-log*} buffer, the ``current VC fileset'' is
While in the @file{*vc-log*} buffer, the ``current VC fileset'' is
considered to be the fileset that will be committed if you type
@w{@kbd{C-c C-c}}. To view a list of the files in the VC fileset,
type @w{@kbd{C-c C-f}} (@code{log-edit-show-files}). To view a diff
@ -639,7 +639,7 @@ started editing (@pxref{Old Revisions}), type @kbd{C-c C-d}
If the VC fileset includes one or more @file{ChangeLog} files
(@pxref{Change Log}), type @kbd{C-c C-a}
(@code{log-edit-insert-changelog}) to pull the relevant entries into
the @samp{*vc-log*} buffer. If the topmost item in each
the @file{*vc-log*} buffer. If the topmost item in each
@file{ChangeLog} was made under your user name on the current date,
this command searches that item for entries matching the file(s) to be
committed, and inserts them.
@ -652,7 +652,7 @@ Edit buffer.
To abort a commit, just @strong{don't} type @kbd{C-c C-c} in that
buffer. You can switch buffers and do other editing. As long as you
don't try to make another commit, the entry you were editing remains
in the @samp{*vc-log*} buffer, and you can go back to that buffer at
in the @file{*vc-log*} buffer, and you can go back to that buffer at
any time to complete the commit.
@kindex M-n @r{(Log Edit mode)}
@ -904,10 +904,10 @@ Display the changes that will be sent by the next push operation
@kindex C-x v l
@findex vc-print-log
The command @kbd{C-x v l} (@code{vc-print-log}) displays a buffer
named @samp{*vc-change-log*}, showing the history of changes made to
named @file{*vc-change-log*}, showing the history of changes made to
the current file, including who made the changes, the dates, and the
log entry for each change (these are the same log entries you would
enter via the @samp{*vc-log*} buffer; @pxref{Log Buffer}). Point is
enter via the @file{*vc-log*} buffer; @pxref{Log Buffer}). Point is
centered at the revision of the file currently being visited. With a
prefix argument, the command prompts for the revision to center on,
and the maximum number of revisions to display.
@ -919,7 +919,7 @@ file listed on the current line.
@findex vc-print-root-log
@findex log-view-toggle-entry-display
@kbd{C-x v L} (@code{vc-print-root-log}) displays a
@samp{*vc-change-log*} buffer showing the history of the entire
@file{*vc-change-log*} buffer showing the history of the entire
version-controlled directory tree (RCS, SCCS, and CVS do not support
this feature). With a prefix argument, the command prompts for the
maximum number of revisions to display.
@ -927,7 +927,7 @@ maximum number of revisions to display.
The @kbd{C-x v L} history is shown in a compact form, usually
showing only the first line of each log entry. However, you can type
@key{RET} (@code{log-view-toggle-entry-display}) in the
@samp{*vc-change-log*} buffer to reveal the entire log entry for the
@file{*vc-change-log*} buffer to reveal the entire log entry for the
revision at point. A second @key{RET} hides it again.
On a decentralized version control system, the @kbd{C-x v I}
@ -942,7 +942,7 @@ specific repository. Similarly, @kbd{C-x v O}
another repository, the next time you run the ``push'' command; with a
prefix argument, it prompts for a specific destination repository.
In the @samp{*vc-change-log*} buffer, you can use the following keys
In the @file{*vc-change-log*} buffer, you can use the following keys
to move between the logs of revisions and of files, and to examine and
compare past revisions (@pxref{Old Revisions}):
@ -993,11 +993,11 @@ revision at point.
@vindex vc-log-show-limit
Because fetching many log entries can be slow, the
@samp{*vc-change-log*} buffer displays no more than 2000 revisions by
@file{*vc-change-log*} buffer displays no more than 2000 revisions by
default. The variable @code{vc-log-show-limit} specifies this limit;
if you set the value to zero, that removes the limit. You can also
increase the number of revisions shown in an existing
@samp{*vc-change-log*} buffer by clicking on the @samp{Show 2X
@file{*vc-change-log*} buffer by clicking on the @samp{Show 2X
entries} or @samp{Show unlimited entries} buttons at the end of the
buffer. However, RCS, SCCS, and CVS do not support this feature.
@ -1045,7 +1045,7 @@ it is used to specify multi-file VC filesets for commands like
To use the VC Directory buffer, type @kbd{C-x v d} (@code{vc-dir}).
This reads a directory name using the minibuffer, and switches to a VC
Directory buffer for that directory. By default, the buffer is named
@samp{*vc-dir*}. Its contents are described
@file{*vc-dir*}. Its contents are described
@iftex
below.
@end iftex

2
doc/emacs/mini.texi
View file

@ -197,7 +197,7 @@ set the variable @code{enable-recursive-minibuffers} to @code{t}.
@findex minibuffer-inactive-mode
When not active, the minibuffer is in @code{minibuffer-inactive-mode},
and clicking @kbd{Mouse-1} there shows the @samp{*Messages*} buffer.
and clicking @kbd{Mouse-1} there shows the @file{*Messages*} buffer.
If you use a dedicated frame for minibuffers, Emacs also recognizes
certain keys there, for example @kbd{n} to make a new frame.

22
doc/emacs/misc.texi
View file

@ -507,7 +507,7 @@ minibuffer and executes it as a shell command, in a subshell made just
for that command. Standard input for the command comes from the null
device. If the shell command produces any output, the output appears
either in the echo area (if it is short), or in an Emacs buffer named
@samp{*Shell Command Output*}, displayed in another window (if the
@file{*Shell Command Output*}, displayed in another window (if the
output is long).
For instance, one way to decompress a file named @file{foo.gz} is to
@ -554,7 +554,7 @@ old region and replaces it with the output from the shell command.
see what keys are in the buffer. If the buffer contains a GnuPG key,
type @kbd{C-x h M-| gpg @key{RET}} to feed the entire buffer contents
to @command{gpg}. This will output the list of keys to the
@samp{*Shell Command Output*} buffer.
@file{*Shell Command Output*} buffer.
@vindex shell-file-name
The above commands use the shell specified by the variable
@ -577,7 +577,7 @@ inserted into a buffer of that name.
@findex shell
To run a subshell interactively, type @kbd{M-x shell}. This creates
(or reuses) a buffer named @samp{*shell*}, and runs a shell subprocess
(or reuses) a buffer named @file{*shell*}, and runs a shell subprocess
with input coming from and output going to that buffer. That is to
say, any terminal output from the subshell goes into the buffer,
advancing point, and any terminal input for the subshell comes from
@ -600,8 +600,8 @@ easier to distinguish input lines from the shell output.
To make multiple subshells, invoke @kbd{M-x shell} with a prefix
argument (e.g. @kbd{C-u M-x shell}). Then the command will read a
buffer name, and create (or reuse) a subshell in that buffer. You can
also rename the @samp{*shell*} buffer using @kbd{M-x rename-uniquely},
then create a new @samp{*shell*} buffer using plain @kbd{M-x shell}.
also rename the @file{*shell*} buffer using @kbd{M-x rename-uniquely},
then create a new @file{*shell*} buffer using plain @kbd{M-x shell}.
Subshells in different buffers run independently and in parallel.
@vindex explicit-shell-file-name
@ -1183,7 +1183,7 @@ underlying shell, of course.
@findex term
To run a subshell in a terminal emulator, use @kbd{M-x term}. This
creates (or reuses) a buffer named @samp{*terminal*}, and runs a
creates (or reuses) a buffer named @file{*terminal*}, and runs a
subshell with input coming from your keyboard, and output going to
that buffer.
@ -1212,7 +1212,7 @@ serial port. @xref{Serial Terminal}.
The file name used to load the subshell is determined the same way
as for Shell mode. To make multiple terminal emulators, rename the
buffer @samp{*terminal*} to something different using @kbd{M-x
buffer @file{*terminal*} to something different using @kbd{M-x
rename-uniquely}, just as with Shell mode.
Unlike Shell mode, Term mode does not track the current directory by
@ -1511,7 +1511,7 @@ systems, such as MS-Windows (@pxref{Windows Startup, emacsclient}),
where it cannot create graphical frames when started from a text-only
terminal, it creates a new text-only terminal frame (@pxref{Frames}).
If you omit a filename argument while supplying the @samp{-c} option,
the new frame displays the @samp{*scratch*} buffer (@pxref{Buffers}).
the new frame displays the @file{*scratch*} buffer (@pxref{Buffers}).
@item -F @var{alist}
@itemx --frame-parameters=@var{alist}
@ -1600,7 +1600,7 @@ graphical display. On systems, such as MS-Windows, where this is
impossible, Emacs will create a new frame, either GUI or text-only, on
the same terminal where it was started (@pxref{Windows Startup,
emacsclient}). If you omit a filename argument while supplying this
option, the new frame displays the @samp{*scratch*} buffer.
option, the new frame displays the @file{*scratch*} buffer.
@xref{Buffers}.
@end table
@ -1868,7 +1868,7 @@ init file (@pxref{Init File}), followed by @code{(pr-update-menus)}.
This function replaces the usual printing commands in the menu bar
with a @samp{Printing} submenu that contains various printing options.
You can also type @kbd{M-x pr-interface RET}; this creates a
@samp{*Printing Interface*} buffer, similar to a customization buffer,
@file{*Printing Interface*} buffer, similar to a customization buffer,
where you can set the printing options. After selecting what and how
to print, you start the print job using the @samp{Print} button (click
@kbd{mouse-2} on it, or move point over it and type @kbd{RET}). For
@ -2482,7 +2482,7 @@ encrypted in a simple monoalphabetic substitution cipher.
@findex dissociated-press
@kbd{M-x dissociated-press} scrambles the text in the current Emacs
buffer, word by word or character by character, writing its output to
a buffer named @samp{*Dissociation*}. A positive argument tells it to
a buffer named @file{*Dissociation*}. A positive argument tells it to
operate character by character, and specifies the number of overlap
characters. A negative argument tells it to operate word by word, and
specifies the number of overlap words. Dissociated Press produces

2
doc/emacs/package.texi
View file

@ -14,7 +14,7 @@ Emacs includes a facility that lets you easily download and install
separate Emacs Lisp program, sometimes including other components such
as an Info manual.
@kbd{M-x list-packages} brings up a buffer named @samp{*Packages*}
@kbd{M-x list-packages} brings up a buffer named @file{*Packages*}
with a list of all packages. You can install or uninstall packages
via this buffer. @xref{Package Menu}.

6
doc/emacs/programs.texi
View file

@ -1130,7 +1130,7 @@ prompts for a topic, with completion (@pxref{Completion}), and runs
the @command{man} program to format the corresponding man page. If
the system permits, it runs @command{man} asynchronously, so that you
can keep on editing while the page is being formatted. The result
goes in a buffer named @samp{*Man @var{topic}*}. These buffers use a
goes in a buffer named @file{*Man @var{topic}*}. These buffers use a
special major mode, Man mode, that facilitates scrolling and jumping
to other manual pages. For details, type @kbd{C-h m} while in a Man
mode buffer.
@ -1165,7 +1165,7 @@ command. Unlike @kbd{M-x man}, it does not run any external programs
to format and display the man pages; the formatting is done by Emacs,
so it works on systems such as MS-Windows where the @command{man}
program may be unavailable. It prompts for a man page, and displays
it in a buffer named @samp{*WoMan @var{section} @var{topic}}.
it in a buffer named @file{*WoMan @var{section} @var{topic}}.
@kbd{M-x woman} computes the completion list for manpages the first
time you invoke the command. With a numeric argument, it recomputes
@ -1705,7 +1705,7 @@ inserted on that line, and any @samp{\} there is deleted.
@cindex preprocessor highlighting
@findex cpp-highlight-buffer
Highlight parts of the text according to its preprocessor conditionals.
This command displays another buffer named @samp{*CPP Edit*}, which
This command displays another buffer named @file{*CPP Edit*}, which
serves as a graphic menu for selecting how to display particular kinds
of conditionals and their contents. After changing various settings,
click on @samp{[A]pply these settings} (or go to that buffer and type

6
doc/emacs/screen.texi
View file

@ -131,15 +131,15 @@ Commands that take a long time often display messages ending in
progress has been made, as a percentage), and add @samp{done} when
they are finished.
@cindex @samp{*Messages*} buffer
@cindex @file{*Messages*} buffer
@cindex saved echo area messages
@cindex messages saved from echo area
@vindex message-log-max
Informative echo area messages are saved in a special buffer named
@samp{*Messages*}. (We have not explained buffers yet; see
@file{*Messages*}. (We have not explained buffers yet; see
@ref{Buffers}, for more information about them.) If you miss a
message that appeared briefly on the screen, you can switch to the
@samp{*Messages*} buffer to see it again. The @samp{*Messages*}
@file{*Messages*} buffer to see it again. The @file{*Messages*}
buffer is limited to a certain number of lines, specified by the
variable @code{message-log-max}. (We have not explained variables
either; see @ref{Variables}, for more information about them.) Beyond

4
doc/emacs/search.texi
View file

@ -1308,7 +1308,7 @@ displayed before and after each matching line.
@kindex RET @r{(Occur mode)}
@kindex o @r{(Occur mode)}
@kindex C-o @r{(Occur mode)}
In the @samp{*Occur*} buffer, you can click on each entry, or move
In the @file{*Occur*} buffer, you can click on each entry, or move
point there and type @key{RET}, to visit the corresponding position in
the buffer that was searched. @kbd{o} and @kbd{C-o} display the match
in another window; @kbd{C-o} does not select it. Alternatively, you
@ -1317,7 +1317,7 @@ occurrences one by one (@pxref{Compilation Mode}).
@cindex Occur Edit mode
@cindex mode, Occur Edit
Typing @kbd{e} in the @samp{*Occur*} buffer switches to Occur Edit
Typing @kbd{e} in the @file{*Occur*} buffer switches to Occur Edit
mode, in which edits made to the entries are also applied to the text
in the originating buffer. Type @kbd{C-c C-c} to return to Occur
mode.

4
doc/emacs/sending.texi
View file

@ -12,7 +12,7 @@
@kindex C-x m
@findex compose-mail
To send an email message from Emacs, type @kbd{C-x m}. This
switches to a buffer named @samp{*unsent mail*}, where you can edit
switches to a buffer named @file{*unsent mail*}, where you can edit
the text and headers of the message. When done, type @kbd{C-c C-s} or
@kbd{C-c C-c} to send it.
@ -306,7 +306,7 @@ completion, and inserts its definition at point.
@cindex Message mode
@cindex mode, Message
The default major mode for the @samp{*mail*} buffer is called
The default major mode for the @file{*mail*} buffer is called
Message mode. It behaves like Text mode in many ways, but provides
several additional commands on the @kbd{C-c} prefix, which make
editing a message more convenient.

4
doc/emacs/text.texi
View file

@ -1548,7 +1548,7 @@ text that belongs inside. Afterward, use the command @kbd{C-c @}}
point, and inserts two newlines to start a new paragraph. It outputs
a message in the echo area if any mismatch is found. @kbd{M-x
tex-validate-region} checks a region, paragraph by paragraph. The
errors are listed in an @samp{*Occur*} buffer; you can use the usual
errors are listed in an @file{*Occur*} buffer; you can use the usual
Occur mode commands in that buffer, such as @kbd{C-c C-c}, to visit a
particular mismatch (@pxref{Other Repeating Search}).
@ -1694,7 +1694,7 @@ name with @samp{*} in the command string. For example,
@findex tex-recenter-output-buffer
@kindex C-c C-l @r{(@TeX{} mode)}
The terminal output from @TeX{}, including any error messages,
appears in a buffer called @samp{*tex-shell*}. If @TeX{} gets an
appears in a buffer called @file{*tex-shell*}. If @TeX{} gets an
error, you can switch to this buffer and feed it input (this works as
in Shell mode; @pxref{Interactive Shell}). Without switching to this
buffer you can scroll it so that its last line is visible by typing

10
doc/emacs/trouble.texi
View file

@ -636,7 +636,7 @@ Emacs, so you will have to report the bug somewhere else.
The type of machine you are using, and the operating system name and
version number (again, automatically included by @kbd{M-x
report-emacs-bug}). @kbd{M-x emacs-version @key{RET}} provides this
information too. Copy its output from the @samp{*Messages*} buffer,
information too. Copy its output from the @file{*Messages*} buffer,
so that you get it all and get it accurately.
@item
@ -699,7 +699,7 @@ The way to collect the terminal output is to execute the Lisp expression
@end example
@noindent
using @kbd{M-:} or from the @samp{*scratch*} buffer just after
using @kbd{M-:} or from the @file{*scratch*} buffer just after
starting Emacs. From then on, Emacs copies all terminal output to the
specified termscript file as well, until the Emacs process is killed.
If the problem happens when Emacs starts up, put this expression into
@ -725,10 +725,10 @@ Alternatively, use the @command{locale} command, if your system has it,
to display your locale settings.
You can use the @kbd{M-!} command to execute these commands from
Emacs, and then copy the output from the @samp{*Messages*} buffer into
Emacs, and then copy the output from the @file{*Messages*} buffer into
the bug report. Alternatively, @kbd{M-x getenv @key{RET} LC_ALL
@key{RET}} will display the value of @code{LC_ALL} in the echo area, and
you can copy its output from the @samp{*Messages*} buffer.
you can copy its output from the @file{*Messages*} buffer.
@item
A description of what behavior you observe that you believe is
@ -761,7 +761,7 @@ important to report the precise text of the error message, and a
backtrace showing how the Lisp program in Emacs arrived at the error.
To get the error message text accurately, copy it from the
@samp{*Messages*} buffer into the bug report. Copy all of it, not just
@file{*Messages*} buffer into the bug report. Copy all of it, not just
part.
@findex toggle-debug-on-error