aboutsummaryrefslogtreecommitdiffstats
path: root/lispref
diff options
context:
space:
mode:
authorJuri Linkov2005-09-29 23:41:05 +0000
committerJuri Linkov2005-09-29 23:41:05 +0000
commit1c145ce1bdebd80dbfab1071ea9dc3823d35ff2d (patch)
tree544b7a8a473d23c0635075bfff33ac1a9bb0c4a4 /lispref
parent867b9600bbc769f6efb56970b68f25dbb061f2de (diff)
downloademacs-1c145ce1bdebd80dbfab1071ea9dc3823d35ff2d.tar.gz
emacs-1c145ce1bdebd80dbfab1071ea9dc3823d35ff2d.zip
(Displaying Messages): Rename argument name `string' to `format-string'
in functions `message', `message-box', `message-or-box'.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/display.texi23
1 files changed, 12 insertions, 11 deletions
diff --git a/lispref/display.texi b/lispref/display.texi
index 0d27a9b0edc..ae346986fa3 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -208,9 +208,9 @@ explicitly.
208 This section describes the functions for explicitly producing echo 208 This section describes the functions for explicitly producing echo
209area messages. Many other Emacs features display messages there, too. 209area messages. Many other Emacs features display messages there, too.
210 210
211@defun message string &rest arguments 211@defun message format-string &rest arguments
212This function displays a message in the echo area. The 212This function displays a message in the echo area. The argument
213argument @var{string} is similar to a C language @code{printf} control 213@var{format-string} is similar to a C language @code{printf} format
214string. See @code{format} in @ref{Formatting Strings}, for the details 214string. See @code{format} in @ref{Formatting Strings}, for the details
215on the conversion specifications. @code{message} returns the 215on the conversion specifications. @code{message} returns the
216constructed string. 216constructed string.
@@ -218,14 +218,15 @@ constructed string.
218In batch mode, @code{message} prints the message text on the standard 218In batch mode, @code{message} prints the message text on the standard
219error stream, followed by a newline. 219error stream, followed by a newline.
220 220
221If @var{string}, or strings among the @var{arguments}, have @code{face} 221If @var{format-string}, or strings among the @var{arguments}, have
222text properties, these affect the way the message is displayed. 222@code{face} text properties, these affect the way the message is displayed.
223 223
224@c Emacs 19 feature 224@c Emacs 19 feature
225If @var{string} is @code{nil}, @code{message} clears the echo area; if 225If @var{format-string} is @code{nil} or the empty string,
226the echo area has been expanded automatically, this brings it back to 226@code{message} clears the echo area; if the echo area has been
227its normal size. If the minibuffer is active, this brings the 227expanded automatically, this brings it back to its normal size.
228minibuffer contents back onto the screen immediately. 228If the minibuffer is active, this brings the minibuffer contents back
229onto the screen immediately.
229 230
230@example 231@example
231@group 232@group
@@ -254,7 +255,7 @@ the execution of @var{body}. It displays @var{message}, executes
254the previous echo area contents. 255the previous echo area contents.
255@end defmac 256@end defmac
256 257
257@defun message-or-box string &rest arguments 258@defun message-or-box format-string &rest arguments
258This function displays a message like @code{message}, but may display it 259This function displays a message like @code{message}, but may display it
259in a dialog box instead of the echo area. If this function is called in 260in a dialog box instead of the echo area. If this function is called in
260a command that was invoked using the mouse---more precisely, if 261a command that was invoked using the mouse---more precisely, if
@@ -268,7 +269,7 @@ You can force use of the mouse or of the echo area by binding
268@code{last-nonmenu-event} to a suitable value around the call. 269@code{last-nonmenu-event} to a suitable value around the call.
269@end defun 270@end defun
270 271
271@defun message-box string &rest arguments 272@defun message-box format-string &rest arguments
272This function displays a message like @code{message}, but uses a dialog 273This function displays a message like @code{message}, but uses a dialog
273box (or a pop-up menu) whenever that is possible. If it is impossible 274box (or a pop-up menu) whenever that is possible. If it is impossible
274to use a dialog box or pop-up menu, because the terminal does not 275to use a dialog box or pop-up menu, because the terminal does not