From: Chong Yidong <cyd@stupidchicken.com>
Date: Thu, 15 Sep 2005 14:02:34 +0000 (+0000)
Subject: Document `image-load-path'.
X-Git-Tag: emacs-pretest-22.0.90~7077
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=5b51c03716d7c487d1c2336df2a76a6417a2343c;p=emacs.git

Document `image-load-path'.
---

diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index 82cfcab4699..3252e671c11 100644
--- a/lispref/ChangeLog
+++ b/lispref/ChangeLog
@@ -1,3 +1,7 @@
+2005-09-15  Chong Yidong  <cyd@stupidchicken.com>
+
+	* display.texi (Defining Images): Document `image-load-path'.
+
 2005-09-15  Richard M. Stallman  <rms@gnu.org>
 
 	* objects.texi (Printed Representation): Minor cleanup.
diff --git a/lispref/display.texi b/lispref/display.texi
index b6348800fad..96aa2335a6a 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -3946,10 +3946,29 @@ The first specification in the list whose @var{type} is supported, and
 @var{file} exists, is used to construct the image specification to be
 returned.  If no specification is satisfied, @code{nil} is returned.
 
-The image is looked for first on @code{load-path} and then in
-@code{data-directory}.
+The image is looked for in @code{image-load-path}.
 @end defun
 
+@defvar image-load-path
+@tindex image-load-path
+This variable's value is a list of locations in which to search for
+image files.  If an element is a string, it is taken to be the name of
+a directory to search.  If an element is a variable symbol, the value
+of that variable is used as a list of directories to search.
+
+The default is to search in @file{@code{data-directory}/images}, then
+in @code{data-directory}, and finally in the directories specified by
+@code{load-path}.  Subdirectories are not automatically included in
+the search, so if you put an image file in a subdirectory, you have to
+supply the subdirectory name explicitly.  For example, if you put an
+image file @file{bar.xpm} in @file{@code{data-directory}/images/foo/},
+you should define the image as:
+
+@example
+  (defimage foo-image '((:type xpm :file "foo/bar.xpm")))
+@end example
+@end defvar
+
 @node Showing Images
 @subsection Showing Images