From: Chong Yidong Date: Sat, 13 Oct 2012 01:18:52 +0000 (+0800) Subject: Document 24.3 ImageMagick changes. X-Git-Url: http://git.hcoop.net/bpt/emacs.git/commitdiff_plain/73f2b4abf53a5391f995edacf39c6de89fdc8f45 Document 24.3 ImageMagick changes. * doc/emacs/files.texi (File Conveniences): ImageMagick enabled by default. * doc/lispref/display.texi (ImageMagick Images): ImageMagick enabled by default. --- diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 3aad65f7be..47a4c8da52 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,7 @@ +2012-10-13 Chong Yidong + + * files.texi (File Conveniences): ImageMagick enabled by default. + 2012-10-10 Dani Moncayo * basic.texi (Arguments): Fix typos. diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index c1cebc424c..e12bb38565 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi @@ -1931,15 +1931,22 @@ non-@code{nil}. Currently, Emacs only supports animation in GIF files. @cindex ImageMagick support - If your Emacs was compiled with ImageMagick support, it is possible -to view a much wider variety of image types in Image mode, by -rendering the images via ImageMagick. However, this feature is -currently disabled by default. To enable it, add the following line -to your init file: - -@example -(imagemagick-register-types) -@end example +@vindex imagemagick-enabled-types +@vindex imagemagick-types-inhibit + If Emacs was compiled with support for the ImageMagick library, it +can use ImageMagick to render a wide variety of images. The variable +@code{imagemagick-enabled-types} lists the image types that Emacs may +render using ImageMagick; each element in the list should be an +internal ImageMagick name for an image type, as a symbol or an +equivalent string (e.g.@: @code{BMP} for @file{.bmp} images). To +enable ImageMagick for all possible image types, change +@code{imagemagick-enabled-types} to @code{t}. The variable +@code{imagemagick-types-inhibit} lists the image types which should +never be rendered using ImageMagick, regardless of the value of +@code{imagemagick-enabled-types} (the default list includes types like +@code{C} and @code{HTML}, which ImageMagick can render as an ``image'' +but Emacs should not). To disable ImageMagick entirely, change +@code{imagemagick-types-inhibit} to @code{t}. @findex thumbs-mode @findex mode, thumbs diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 974a0d6719..40c457ffe0 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,7 @@ +2012-10-13 Chong Yidong + + * display.texi (ImageMagick Images): ImageMagick enabled by default. + 2012-10-05 Chong Yidong * minibuf.texi (Basic Completion): Clarify list form of completion diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 11a86f3c1c..3f92c50e2b 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -4579,57 +4579,35 @@ specifying the bounding box of the PostScript image, analogous to the @cindex images, support for more formats If you build Emacs with ImageMagick support, you can use the -ImageMagick library to load many image formats. The image type symbol +ImageMagick library to load many image formats (@pxref{File +Conveniences,,, emacs, The GNU Emacs Manual}). The image type symbol for images loaded via ImageMagick is @code{imagemagick}, regardless of the actual underlying image format. @defun imagemagick-types This function returns a list of image file extensions supported by the -current ImageMagick installation. -@end defun - - By default, Emacs does not use ImageMagick to display images in -Image mode, e.g.@: when visiting such files with @kbd{C-x C-f}. This -feature is enabled by calling @code{imagemagick-register-types}. - -@defun imagemagick-register-types -This function enables using Image mode to visit image files supported -by ImageMagick. @xref{File Conveniences,,, emacs, The GNU Emacs -Manual}. It also causes @code{create-image} and other helper -functions to associate such file names with the @code{imagemagick} -image type (@pxref{Defining Images}). - -All image file extensions supported by ImageMagick are registered, -except those specified in @code{imagemagick-types-inhibit}. If Emacs -was not compiled with ImageMagick support, this function does nothing. -@end defun +current ImageMagick installation. Each list element is a symbol +representing an internal ImageMagick name for an image type, such as +@code{BMP} for @file{.bmp} images. +@end defun + +@defopt imagemagick-enabled-types +The value of this variable is a list of ImageMagick image types which +Emacs may attempt to render using ImageMagick. Each list element +should be one of the symbols in the list returned by +@code{imagemagick-types}, or an equivalent string. Alternatively, a +value of @code{t} enables ImageMagick for all possible image types. +Regardless of the value of this variable, +@code{imagemagick-types-inhibit} (see below) takes precedence. +@end defopt @defopt imagemagick-types-inhibit -This variable specifies a list of image types that should @emph{not} -be registered by @code{imagemagick-register-types}. Each entry in -this list should be one of the symbols returned by -@code{imagemagick-types}. The default value lists several file types -that are considered ``images'' by ImageMagick, but which should not be -considered as images by Emacs, including C files and HTML files. +The value of this variable lists the ImageMagick image types which +should never be rendered using ImageMagick, regardless of the value of +@code{imagemagick-enabled-types}. A value of @code{t} disables +ImageMagick entirely. @end defopt -@ignore -@c I don't know what this means. I suspect it means eg loading jpg -@c images via libjpeg or ImageMagick. But it doesn't work. -@c If you don't have libjpeg support compiled in, you cannot -@c view jpeg images, even if you have imagemagick support: -@c http://debbugs.gnu.org/9045 -@c And if you have both compiled in, then you always get -@c the libjpeg version: -@c http://debbugs.gnu.org/10746 -There may be overlap between image loaders in your Emacs installation, -and you may prefer to use a different one for a given image type -(which loader will be used in practice depends on the priority of the -loaders). -For example, if you never want to use the ImageMagick loader to view -JPEG files, add @code{JPG} to this list. -@end ignore - Images loaded with ImageMagick support the following additional image descriptor properties: diff --git a/etc/NEWS b/etc/NEWS index 2b934741c2..5a310d8f82 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -137,16 +137,16 @@ It is no longer necessary to call `imagemagick-register-types' explicitly to install ImageMagick image types; that function is called automatically at startup, or when customizing a relevant imagemagick- option. - ++++ *** Setting `imagemagick-types-inhibit' to t now disables the use of ImageMagick to view images. You must call imagemagick-register-types afterwards if you do not use customize to change this. - ++++ *** The new variable `imagemagick-enabled-types' also affects which ImageMagick types are treated as images. The function `imagemagick-filter-types' returns the list of types that will be treated as images. - +--- *** Images displayed via ImageMagick now support transparency and the :background image spec property.