diff options
| author | Glenn Morris <rgm@gnu.org> | 2012-04-10 00:11:23 -0700 |
|---|---|---|
| committer | Glenn Morris <rgm@gnu.org> | 2012-04-10 00:11:23 -0700 |
| commit | 2bb0eca1ebe1ff1b9939b6350a2e5310c17a7e8c (patch) | |
| tree | ccd6c79c4315efd0260cd3a885cf7b4dcdf74cbc /doc/lispref/help.texi | |
| parent | 62200c147ccf48fdff77438e05ca296a9d40ceb4 (diff) | |
| download | emacs-2bb0eca1ebe1ff1b9939b6350a2e5310c17a7e8c.tar.gz emacs-2bb0eca1ebe1ff1b9939b6350a2e5310c17a7e8c.tar.bz2 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.
Diffstat (limited to 'doc/lispref/help.texi')
| -rw-r--r-- | doc/lispref/help.texi | 12 |
1 files changed, 6 insertions, 6 deletions
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. @c Wordy to prevent overfull hboxes. --rjc 15mar92 Here is an example of using the two functions, @code{documentation} and @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} @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, 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 documentation string. @@ -648,7 +648,7 @@ certain documentation and text files that come with Emacs. @defun help-buffer 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 @defmac with-help-window buffer-name body@dots{} @@ -662,16 +662,16 @@ scroll the help window. @end defmac @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 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 @code{(@var{function} . @var{args})}, where @var{function} is a function to call, with argument list @var{args}, to regenerate the help buffer. The @var{interactive-p} argument is non-@code{nil} if the calling 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 @xref{describe-symbols example}, for an example of using |