# HG changeset patch # User Chong Yidong # Date 1126792954 0 # Node ID 6759056e76038723eddd2d1d39438f7bc71b595e # Parent 82ce0d75e8ed329b046d47e4283554e9189d5e96 Document `image-load-path'. diff -r 82ce0d75e8ed -r 6759056e7603 lispref/ChangeLog --- a/lispref/ChangeLog Thu Sep 15 14:01:04 2005 +0000 +++ b/lispref/ChangeLog Thu Sep 15 14:02:34 2005 +0000 @@ -1,3 +1,7 @@ +2005-09-15 Chong Yidong + + * display.texi (Defining Images): Document `image-load-path'. + 2005-09-15 Richard M. Stallman * objects.texi (Printed Representation): Minor cleanup. diff -r 82ce0d75e8ed -r 6759056e7603 lispref/display.texi --- a/lispref/display.texi Thu Sep 15 14:01:04 2005 +0000 +++ b/lispref/display.texi Thu Sep 15 14:02:34 2005 +0000 @@ -3946,10 +3946,29 @@ @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