configure support for MagickExportImagePixels and README
[emacs.git] / README.imagemagick
blob52214a23b25b957372e0ea5dfdcf9863047509f7
1 This is the imagemagick branch of Emacs. Imagemagick can now be used
2 to load many new image formats, and also do useful transforms like
3 scaling and rotation.
5 This file will attempt to contain draft NEWS, Changelog and manual
6 entries for the new functionality. 
8 You might need to regenerate the configure scripts:
9 aclocal
10 automake
11 autoheader
12 autoconf
13 ./configure --with-imagemagick
17 * TODO
18 ** complete documentation drafts below
20 ** fix inconsistencys with spelling of imagemagick in the src
21 ** report number of images in image bundle types somehow
22 ** probably add pdf to inhibited types
23 ** inhibit types is defconst should probably be defcustom
24 ** decide what to do with some uncommitted imagemagick support
25   functions for image size etc.
26 ** Test with more systems
27 Tested on Fedora 12 so far, and the libmagick that ships with it.
28 Ubuntu 8.04 was also tested, but it seems it ships a broken ImageMagick.
29 Also need some way to handle render methods that only work on newer ImageMagicks
32 * NEWS entry
33 ** ImageMagick support
34 It is now possible to use the Imagemagick library to load many new
35 image formats in Emacs.
37 To enable, use the following configure option:
38 --with-imagemagick
40 The new function (imagemagick-types) returns a list of image file
41 extensions that your installation of imagemagick supports.
43 The function (imagemagick-register-types) will enable the imagemagick
44 support for the extensions in imagemagick-types minus the types listed
45 in imagemagick-types-inhibit.
47 imagemagick-types-inhibit has the value  '(C HTML HTM TXT) by default.
48 This means imagemagick will be used also to load jpeg files, if you
49 have both jpeg and imagemagick libraries linked. Add 'JPG to
50 imagemagick-types-inhibit if you do not want this.
52 Images loaded with imagemagick will support a couple of new display
53 specifications:
55 - scale
56 - rotation
57 - index
59 See the ImageMagick manual for information on how these specifications
60 work.
62 The image-metadata function can be used to retrieve the total number
63 of images in an image bundle, and the :index property can be used to
64 show a particular image within the bundle. This is simmilar to how GIF
65 files work.
69 * Changelog entry
70 nothing yet
72 * Manual entry
73 nothing yet