* display.texi (Showing Images): Document max-image-size.

2 files changed, 19 insertions, 0 deletions

diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index 36c3fd342de..c2d799cee95 100644
--- a/lispref/ChangeLog
+++ b/lispref/ChangeLog
@@ -1,3 +1,7 @@
+2005-10-18  Chong Yidong  <cyd@stupidchicken.com>
+
+        * display.texi (Showing Images): Document max-image-size.
+
 2005-10-17  Richard M. Stallman  <rms@gnu.org>
 
         * commands.texi (Quitting): Minor clarification.
diff --git a/lispref/display.texi b/lispref/display.texi
index 4c534282011..071be35e01c 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -4058,6 +4058,21 @@ font).  @var{frame} is the frame on which the image will be displayed.
 Focus}).
 @end defun
 
+@defvar max-image-size
+@tindex max-image-size
+This variable is used to define the maximum size of image that Emacs
+will load.  If its value is a floating point number, that number is
+multiplied by the width and height of the selected frame, in pixels,
+to give the maximum image width and height.  Emacs will refuse to load
+and display any image that is larger than this.
+
+The purpose of this variable is to prevent unreasonably large images
+from accidentally being loaded into Emacs.  It only takes effect the
+first time an image is loaded.  Once an image is placed in the image
+cache, it can always be displayed, even if the value of
+@var{max-image-size} is subsequently changed (@pxref{Image Cache}).
+@end defvar
+
 @node Image Cache
 @subsection Image Cache